For a list of methods for this resource, see the end of this page.
Resource representations
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API.
{ "kind": "dfareporting#accountUserProfile", "id": long, "name": string, "email": string, "accountId": long, "subaccountId": long, "locale": string, "userRoleId": long, "userAccessType": string, "active": boolean, "comments": string, "traffickerType": string, "campaignFilter": { "kind": "dfareporting#objectFilter", "objectIds": [ long ], "status": string }, "siteFilter": { "kind": "dfareporting#objectFilter", "objectIds": [ long ], "status": string }, "userRoleFilter": { "kind": "dfareporting#objectFilter", "objectIds": [ long ], "status": string }, "advertiserFilter": { "kind": "dfareporting#objectFilter", "objectIds": [ long ], "status": string } }
Property name | Value | Description | Notes |
---|---|---|---|
accountId |
long |
Account ID of the user profile. This is a read-only field that can be left blank. | |
active |
boolean |
Whether this user profile is active. This defaults to false, and must be set true on insert for the user profile to be usable. | |
advertiserFilter |
nested object |
Filter that describes which advertisers are visible to the user profile. | |
advertiserFilter.kind |
string |
Kind of resource this is. Value: the fixed string "dfareporting#objectFilter" . |
|
advertiserFilter.objectIds[] |
list |
Applicable when the status is ASSIGNED . The user has access to objects with these object IDs. |
|
advertiserFilter.status |
string |
Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
Acceptable values are:
|
|
campaignFilter |
nested object |
Filter that describes which campaigns are visible to the user profile. | |
campaignFilter.kind |
string |
Kind of resource this is. Value: the fixed string "dfareporting#objectFilter" . |
|
campaignFilter.objectIds[] |
list |
Applicable when the status is ASSIGNED . The user has access to objects with these object IDs. |
|
campaignFilter.status |
string |
Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
Acceptable values are:
|
|
comments |
string |
Comments for this user profile. | |
email |
string |
Email of the user profile. The email addresss must be linked to a Google Account. This field is required on insertion and is read-only after insertion. | |
id |
long |
ID of the user profile. This is a read-only, auto-generated field. | |
kind |
string |
Kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile" . |
|
locale |
string |
Locale of the user profile. This is a required field. Acceptable values are:
|
|
name |
string |
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: "&;<>"#%, ". |
|
siteFilter |
nested object |
Sites that are visible to the user profile. | |
siteFilter.kind |
string |
Kind of resource this is. Value: the fixed string "dfareporting#objectFilter" . |
|
siteFilter.objectIds[] |
list |
Applicable when the status is ASSIGNED . The user has access to objects with these object IDs. |
|
siteFilter.status |
string |
Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
Acceptable values are:
|
|
subaccountId |
long |
Subaccount ID of the user profile. This is a read-only field that can be left blank. | |
traffickerType |
string |
Trafficker type of this user profile. This is a read-only field.
Acceptable values are:
|
|
userAccessType |
string |
User type of the user profile. This is a read-only field that can be left blank.
Acceptable values are:
|
|
userRoleFilter |
nested object |
User roles that are visible to the user profile. | |
userRoleFilter.kind |
string |
Kind of resource this is. Value: the fixed string "dfareporting#objectFilter" . |
|
userRoleFilter.objectIds[] |
list |
Applicable when the status is ASSIGNED . The user has access to objects with these object IDs. |
|
userRoleFilter.status |
string |
Status of the filter. NONE means the user has access to none of the objects. ALL means the user has access to all objects. ASSIGNED means the user has access to the objects with IDs in the objectIds list.
Acceptable values are:
|
|
userRoleId |
long |
User role ID of the user profile. This is a required field. |
Methods
- get
- Gets one account user profile by ID.
- insert
- Inserts a new account user profile.
- list
- Retrieves a list of account user profiles, possibly filtered. This method supports paging.
- patch
- Updates an existing account user profile. This method supports patch semantics.
- update
- Updates an existing account user profile.