REST Resource: accounts.clients.users
Stay organized with collections
Save and categorize content based on your preferences.
Resource: ClientUser
A client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer.
The only way a new client user can be created is through accepting an email invitation (see the accounts.clients.invitations.create method).
All fields are required unless otherwise specified.
| JSON representation |
{
"userId": string,
"clientAccountId": string,
"status": enum (UserStatus),
"email": string
} |
| Fields |
userId |
string (int64 format)
The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation.
|
clientAccountId |
string (int64 format)
Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation.
|
status |
enum (UserStatus)
The status of the client user.
|
email |
string
User's email address. The value of this field is ignored in an update operation.
|
UserStatus
| Enums |
USER_STATUS_UNSPECIFIED |
A placeholder for an undefined user status. |
PENDING |
A user who was already created but hasn't accepted the invitation yet. |
ACTIVE |
A user that is currently active. |
DISABLED |
A user that is currently disabled. |
Methods |
|
|
Retrieves an existing client user. |
|
|
Lists all the known client users for a specified sponsor buyer account ID. |
|
|
Updates an existing client 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 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eClientUsers are created under client buyers with restricted access based on their role and are created through email invitations.\u003c/p\u003e\n"],["\u003cp\u003eA ClientUser's status can be pending, active, or disabled, reflecting their current state within the system.\u003c/p\u003e\n"],["\u003cp\u003eClientUsers have unique numerical IDs and are associated with a specific client buyer account.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve, list, and update existing ClientUsers via available API methods.\u003c/p\u003e\n"]]],[],null,["# REST Resource: accounts.clients.users\n\n- [Resource: ClientUser](#ClientUser)\n - [JSON representation](#ClientUser.SCHEMA_REPRESENTATION)\n- [UserStatus](#UserStatus)\n- [Methods](#METHODS_SUMMARY)\n\nResource: ClientUser\n--------------------\n\nA client user is created under a client buyer and has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client buyer.\n\nThe only way a new client user can be created is through accepting an [email invitation](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations#ClientUserInvitation) (see the [accounts.clients.invitations.create](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations/create#google.ads.adexchange.buyer.v2beta1.ClientUserInvitationService.CreateClientUserInvitation) method).\n\nAll fields are required unless otherwise specified.\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"userId\": string, \"clientAccountId\": string, \"status\": enum (/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users#UserStatus), \"email\": string } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The unique numerical ID of the client user that has accepted an invitation. The value of this field is ignored in an update operation. |\n| `clientAccountId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Numerical account ID of the client buyer with which the user is associated; the buyer must be a client of the current sponsor buyer. The value of this field is ignored in an update operation. |\n| `status` | `enum (`[UserStatus](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users#UserStatus)`)` The status of the client user. |\n| `email` | `string` User's email address. The value of this field is ignored in an update operation. |\n\nUserStatus\n----------\n\nValid user status.\n\n| Enums ||\n|---------------------------|------------------------------------------------------------------------|\n| `USER_STATUS_UNSPECIFIED` | A placeholder for an undefined user status. |\n| `PENDING` | A user who was already created but hasn't accepted the invitation yet. |\n| `ACTIVE` | A user that is currently active. |\n| `DISABLED` | A user that is currently disabled. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------|\n| ### [get](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/get) | Retrieves an existing client user. |\n| ### [list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/list) | Lists all the known client users for a specified sponsor buyer account ID. |\n| ### [update](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.users/update) | Updates an existing client user. |"]]
