REST Resource: accounts.users
Stay organized with collections
Save and categorize content based on your preferences.
Resource: User
JSON representation |
{
"name": string,
"state": enum (State ),
"accessRights": [
enum (AccessRight )
]
} |
Fields |
name |
string
Identifier. The resource name of the user. Format: accounts/{account}/user/{email} Use me to refer to your own email address, for example accounts/{account}/users/me .
|
state |
enum (State )
Output only. The state of the user.
|
accessRights[] |
enum (AccessRight )
Required. The access rights the user has.
|
State
The possible states of a user.
Enums |
STATE_UNSPECIFIED |
Default value. This value is unused. |
PENDING |
The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions. |
VERIFIED |
The user is verified. |
AccessRight
Enums |
ACCESS_RIGHT_UNSPECIFIED |
Default value. This value is unused. |
STANDARD |
Standard access rights. |
READ_ONLY |
Has access to the same read-only methods as STANDARD, but no access to any mutating methods. |
ADMIN |
Admin access rights. |
PERFORMANCE_REPORTING |
Users with this right have access to performance and insights. |
API_DEVELOPER |
Users with this right have access to Merchant API and its notifications. This role is only accessible to accounts that has a developer registration. |
Methods |
|
Creates a Merchant Center account user. |
|
Deletes a Merchant Center account user. |
|
Retrieves a Merchant Center account user. |
|
Lists all users of a Merchant Center account. |
|
Updates a Merchant Center account user. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-07-17 UTC.
[null,null,["Last updated 2025-07-17 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eUser\u003c/code\u003e resource manages user permissions and access within a Merchant Center account, allowing for control over who can access and modify account data.\u003c/p\u003e\n"],["\u003cp\u003eUsers can have different states (\u003ccode\u003ePENDING\u003c/code\u003e, \u003ccode\u003eVERIFIED\u003c/code\u003e) and access rights (\u003ccode\u003eSTANDARD\u003c/code\u003e, \u003ccode\u003eADMIN\u003c/code\u003e, \u003ccode\u003ePERFORMANCE_REPORTING\u003c/code\u003e) which determine their level of access and functionality within the account.\u003c/p\u003e\n"],["\u003cp\u003eYou can manage users through various methods: creating, deleting, retrieving, listing, and updating user details, using the provided API methods (\u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, \u003ccode\u003epatch\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eUser\u003c/code\u003e resource is identified by a unique name in the format \u003ccode\u003eaccounts/{account}/user/{email}\u003c/code\u003e, and their state and access rights are key attributes that control user access within a Merchant Center account.\u003c/p\u003e\n"]]],[],null,["# REST Resource: accounts.users\n\n- [Resource: User](#User)\n - [JSON representation](#User.SCHEMA_REPRESENTATION)\n- [State](#State)\n- [AccessRight](#AccessRight)\n- [Methods](#METHODS_SUMMARY)\n\nResource: User\n--------------\n\nThe `User` message represents a user associated with a Merchant Center account. It is used to manage user permissions and access rights within the account. For more information, see [Frequently asked questions about people and access levels](//support.google.com/merchants/answer/12160472).\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"state\": enum (/merchant/api/reference/rest/accounts_v1beta/accounts.users#State), \"accessRights\": [ enum (/merchant/api/reference/rest/accounts_v1beta/accounts.users#AccessRight) ] } ``` |\n\n| Fields ||\n|------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the user. Format: `accounts/{account}/user/{email}` Use `me` to refer to your own email address, for example `accounts/{account}/users/me`. |\n| `state` | `enum (`[State](/merchant/api/reference/rest/accounts_v1beta/accounts.users#State)`)` Output only. The state of the user. |\n| `accessRights[]` | `enum (`[AccessRight](/merchant/api/reference/rest/accounts_v1beta/accounts.users#AccessRight)`)` Required. The [access rights](https://support.google.com/merchants/answer/12160472?sjid=6789834943175119429-EU#accesstypes) the user has. |\n\nState\n-----\n\nThe possible states of a user.\n\n| Enums ||\n|---------------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | Default value. This value is unused. |\n| `PENDING` | The user is pending confirmation. In this state, the user first needs to accept the invitation before performing other actions. |\n| `VERIFIED` | The user is verified. |\n\nAccessRight\n-----------\n\nThe access right.\n\n| Enums ||\n|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `ACCESS_RIGHT_UNSPECIFIED` | Default value. This value is unused. |\n| `STANDARD` | Standard access rights. |\n| `READ_ONLY` | Has access to the same read-only methods as STANDARD, but no access to any mutating methods. |\n| `ADMIN` | Admin access rights. |\n| `PERFORMANCE_REPORTING` | Users with this right have access to performance and insights. |\n| `API_DEVELOPER` | Users with this right have access to Merchant API and its notifications. This role is only accessible to accounts that has a developer registration. |\n\n| Methods ------- ||\n|----------------------------------------------------------------------------------|-----------------------------------------------|\n| ### [create](/merchant/api/reference/rest/accounts_v1beta/accounts.users/create) | Creates a Merchant Center account user. |\n| ### [delete](/merchant/api/reference/rest/accounts_v1beta/accounts.users/delete) | Deletes a Merchant Center account user. |\n| ### [get](/merchant/api/reference/rest/accounts_v1beta/accounts.users/get) | Retrieves a Merchant Center account user. |\n| ### [list](/merchant/api/reference/rest/accounts_v1beta/accounts.users/list) | Lists all users of a Merchant Center account. |\n| ### [patch](/merchant/api/reference/rest/accounts_v1beta/accounts.users/patch) | Updates a Merchant Center account user. |"]]