Resource: AccountUserProfile
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
JSON representation |
---|
{ "id": string, "name": string, "email": string, "accountId": string, "subaccountId": string, "locale": string, "userRoleId": string, "userAccessType": enum ( |
Fields | |
---|---|
id |
ID of the user profile. This is a read-only, auto-generated field. |
name |
Name of the user profile. This is a required field. Must be less than 64 characters long, must be globally unique, and cannot contain whitespace or any of the following characters: "
". |
email |
Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion. |
account |
Account ID of the user profile. This is a read-only field that can be left blank. |
subaccount |
Subaccount ID of the user profile. This is a read-only field that can be left blank. |
locale |
Locale of the user profile. This is a required field. Acceptable values are:
|
user |
User role ID of the user profile. This is a required field. |
user |
User type of the user profile. This is a read-only field that can be left blank. |
active |
Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. |
comments |
Comments for this user profile. |
trafficker |
Trafficker type of this user profile. This is a read-only field. |
campaign |
Filter that describes which campaigns are visible to the user profile. |
site |
Filter that describes which sites are visible to the user profile. |
user |
Filter that describes which user roles are visible to the user profile. |
advertiser |
Filter that describes which advertisers are visible to the user profile. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
UserProfileType
Type of a user profile.
Enums | |
---|---|
NORMAL_USER |
Normal user managed by the customer. |
SUPER_USER |
Super user managed by internal support teams. |
INTERNAL_ADMINISTRATOR |
Internal administrator having super user access to only a specific set of networks. |
READ_ONLY_SUPER_USER |
A super-user without permission to mutate any data. |
TraffickerType
accountUserProfiles.list of trafficker types for any user profile.
Enums | |
---|---|
INTERNAL_NON_TRAFFICKER |
Internal profile, but is not a trafficker. |
INTERNAL_TRAFFICKER |
Internal profile who is a trafficker. |
EXTERNAL_TRAFFICKER |
External profile who is a trafficker. |
ObjectFilter
Object Filter.
JSON representation |
---|
{
"objectIds": [
string
],
"status": enum ( |
Fields | |
---|---|
object |
Applicable when
is
. The user has access to objects with these object IDs. |
status |
Status of the filter.
means the user has access to none of the objects.
means the user has access to all objects.
means the user has access to the objects with IDs in the
list. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
ObjectFilterStatus
Status of the object filter assigned to a profile.
Enums | |
---|---|
NONE |
Profile has access to none of the objects. |
ASSIGNED |
Profile has access to only specific objects. |
ALL |
Profile has access to all objects. |
Methods |
|
---|---|
|
Gets one account user profile by ID. |
|
Inserts a new account user profile. |
|
Retrieves a list of account user profiles, possibly filtered. |
|
Updates an existing account user profile. |
|
Updates an existing account user profile. |