List
|
|||||
|
|
||||
Retrieves a list of advertiser groups, 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 7 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
ids |
INTEGER |
Select only advertiser groups 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 or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup" |
sortField |
ENUMERATION |
Field by which to sort the list |
sortOrder |
ENUMERATION |
Order of sorted results |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
ids INTEGER Select only advertiser groups 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 or ID. Wildcards () are allowed. For example, "advertiser2015" will return objects with names like "advertiser group June 2015", "advertiser group April 2015", or simply "advertiser group 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 "advertisergroup" will match objects with name "my advertisergroup", "advertisergroup 2015", or simply "advertisergroup" |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 7 output parameters
| Name | Format | Description |
|---|---|---|
advertiserGroups[] |
OBJECT |
Groups advertisers together so that reports can be generated for the entire group at once |
advertiserGroups[].accountId |
INTEGER |
Account ID of this advertiser group. This is a read-only field that can be left blank |
advertiserGroups[].id |
INTEGER |
ID of this advertiser group. This is a read-only, auto-generated field |
advertiserGroups[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup" |
advertiserGroups[].name |
STRING |
Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
|
advertiserGroups[] OBJECT Groups advertisers together so that reports can be generated for the entire group at once |
|
advertiserGroups[].accountId INTEGER Account ID of this advertiser group. This is a read-only field that can be left blank |
|
advertiserGroups[].id INTEGER ID of this advertiser group. This is a read-only, auto-generated field |
|
advertiserGroups[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroup" |
|
advertiserGroups[].name STRING Name of this advertiser group. This is a required field and must be less than 256 characters long and unique among advertiser groups of the same account |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiserGroupsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |