REST Resource: accounts.users

  • The User resource manages user permissions and access within a Merchant Center account, allowing for control over who can access and modify account data.

  • Users can have different states (PENDING, VERIFIED) and access rights (STANDARD, ADMIN, PERFORMANCE_REPORTING) which determine their level of access and functionality within the account.

  • You can manage users through various methods: creating, deleting, retrieving, listing, and updating user details, using the provided API methods (create, delete, get, list, patch).

  • The User resource is identified by a unique name in the format accounts/{account}/user/{email}, and their state and access rights are key attributes that control user access within a Merchant Center account.

Resource: User

The 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.

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

The access right.

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 have a developer registration.

Methods

create

 Creates a Merchant Center account user.

delete

 Deletes a Merchant Center account user.

get

 Retrieves a Merchant Center account user.

list

 Lists all users of a Merchant Center account.

patch

 Updates a Merchant Center account user.