List
|
|||||
|
|
Retrieves a list of account user profiles, possibly filtered. This method supports paging
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 10 input parameters
Name | Format | Description |
---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
active |
BOOLEAN |
Select only active user profiles |
ids |
INTEGER |
Select only user profiles with these IDs |
maxResults |
INTEGER |
Maximum number of results to return |
pageToken |
STRING |
Value of the nextPageToken from the previous result page |
searchString |
STRING |
Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile" |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
subaccountId |
INTEGER |
Select only user profiles with the specified subaccount ID |
userRoleId |
INTEGER |
Select only user profiles with the specified user role ID |
= Parameter name
= Format
profileId INTEGER Required User profile ID associated with this request |
active BOOLEAN Select only active user profiles |
ids INTEGER Select only user profiles with these IDs |
maxResults INTEGER Maximum number of results to return |
pageToken STRING Value of the nextPageToken from the previous result page |
searchString STRING Allows searching for objects by name, ID or email. Wildcards () are allowed. For example, "user profile2015" will return objects with names like "user profile June 2015", "user profile April 2015", or simply "user profile 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "user profile" will match objects with name "my user profile", "user profile 2015", or simply "user profile" |
sortField ENUMERATION Field by which to sort the list |
sortOrder ENUMERATION Order of sorted results |
subaccountId INTEGER Select only user profiles with the specified subaccount ID |
userRoleId INTEGER Select only user profiles with the specified user role ID |
Output
This building block provides 31 output parameters
Name | Format | Description |
---|---|---|
accountUserProfiles[] |
OBJECT |
AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API |
accountUserProfiles[].accountId |
INTEGER |
Account ID of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].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 |
accountUserProfiles[].advertiserFilter |
OBJECT |
Object Filter |
accountUserProfiles[].advertiserFilter.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].advertiserFilter.objectIds[] |
INTEGER |
|
accountUserProfiles[].advertiserFilter.status |
ENUMERATION |
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 |
accountUserProfiles[].campaignFilter |
OBJECT |
Object Filter |
accountUserProfiles[].campaignFilter.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].campaignFilter.objectIds[] |
INTEGER |
|
accountUserProfiles[].campaignFilter.status |
ENUMERATION |
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 |
accountUserProfiles[].comments |
STRING |
Comments for this user profile |
accountUserProfiles[].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 |
accountUserProfiles[].id |
INTEGER |
ID of the user profile. This is a read-only, auto-generated field |
accountUserProfiles[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile" |
accountUserProfiles[].locale |
STRING |
Locale of the user profile. This is a required field. Acceptable values are:
|
accountUserProfiles[].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: "&;"#%," |
accountUserProfiles[].siteFilter |
OBJECT |
Object Filter |
accountUserProfiles[].siteFilter.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].siteFilter.objectIds[] |
INTEGER |
|
accountUserProfiles[].siteFilter.status |
ENUMERATION |
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 |
accountUserProfiles[].subaccountId |
INTEGER |
Subaccount ID of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].traffickerType |
ENUMERATION |
Trafficker type of this user profile. This is a read-only field |
accountUserProfiles[].userAccessType |
ENUMERATION |
User type of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].userRoleFilter |
OBJECT |
Object Filter |
accountUserProfiles[].userRoleFilter.kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].userRoleFilter.objectIds[] |
INTEGER |
|
accountUserProfiles[].userRoleFilter.status |
ENUMERATION |
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 |
accountUserProfiles[].userRoleId |
INTEGER |
User role ID of the user profile. This is a required field |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
accountUserProfiles[] OBJECT AccountUserProfiles contains properties of a Campaign Manager user profile. This resource is specifically for managing user profiles, whereas UserProfiles is for accessing the API |
accountUserProfiles[].accountId INTEGER Account ID of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].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 |
accountUserProfiles[].advertiserFilter OBJECT Object Filter |
accountUserProfiles[].advertiserFilter.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].advertiserFilter.objectIds[] INTEGER |
accountUserProfiles[].advertiserFilter.status ENUMERATION 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 |
accountUserProfiles[].campaignFilter OBJECT Object Filter |
accountUserProfiles[].campaignFilter.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].campaignFilter.objectIds[] INTEGER |
accountUserProfiles[].campaignFilter.status ENUMERATION 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 |
accountUserProfiles[].comments STRING Comments for this user profile |
accountUserProfiles[].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 |
accountUserProfiles[].id INTEGER ID of the user profile. This is a read-only, auto-generated field |
accountUserProfiles[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfile" |
accountUserProfiles[].locale STRING Locale of the user profile. This is a required field. Acceptable values are:
|
accountUserProfiles[].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: "&;"#%," |
accountUserProfiles[].siteFilter OBJECT Object Filter |
accountUserProfiles[].siteFilter.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].siteFilter.objectIds[] INTEGER |
accountUserProfiles[].siteFilter.status ENUMERATION 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 |
accountUserProfiles[].subaccountId INTEGER Subaccount ID of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].traffickerType ENUMERATION Trafficker type of this user profile. This is a read-only field |
accountUserProfiles[].userAccessType ENUMERATION User type of the user profile. This is a read-only field that can be left blank |
accountUserProfiles[].userRoleFilter OBJECT Object Filter |
accountUserProfiles[].userRoleFilter.kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#objectFilter" |
accountUserProfiles[].userRoleFilter.objectIds[] INTEGER |
accountUserProfiles[].userRoleFilter.status ENUMERATION 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 |
accountUserProfiles[].userRoleId INTEGER User role ID of the user profile. This is a required field |
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountUserProfilesListResponse" |
nextPageToken STRING Pagination token to be used for the next list operation |