List
|
|||||
|
|
||||
Gets a list of subaccounts, 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 subaccounts 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, "subaccount2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" |
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 subaccounts 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, "subaccount2015" will return objects with names like "subaccount June 2015", "subaccount April 2015", or simply "subaccount 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 "subaccount" will match objects with name "my subaccount", "subaccount 2015", or simply "subaccount" |
|
sortField ENUMERATION Field by which to sort the list |
|
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 8 output parameters
| Name | Format | Description |
|---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
subaccounts[] |
OBJECT |
Contains properties of a Campaign Manager subaccount |
subaccounts[].accountId |
INTEGER |
ID of the account that contains this subaccount. This is a read-only field that can be left blank |
subaccounts[].availablePermissionIds[] |
INTEGER |
|
subaccounts[].id |
INTEGER |
ID of this subaccount. This is a read-only, auto-generated field |
subaccounts[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount" |
subaccounts[].name |
STRING |
Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account |
= Parameter name
= Format
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccountsListResponse" |
|
nextPageToken STRING Pagination token to be used for the next list operation |
|
subaccounts[] OBJECT Contains properties of a Campaign Manager subaccount |
|
subaccounts[].accountId INTEGER ID of the account that contains this subaccount. This is a read-only field that can be left blank |
|
subaccounts[].availablePermissionIds[] INTEGER |
|
subaccounts[].id INTEGER ID of this subaccount. This is a read-only, auto-generated field |
|
subaccounts[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#subaccount" |
|
subaccounts[].name STRING Name of this subaccount. This is a required field. Must be less than 128 characters long and be unique among subaccounts of the same account |