List
|
|||||
|
|
Retrieves the list of accounts, 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 8 input parameters
Name | Format | Description |
---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
active |
BOOLEAN |
Select only active accounts. Don't set this field to select both active and non-active accounts |
ids |
INTEGER |
Select only accounts 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, "account2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 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 "account" will match objects with name "my account", "account 2015", or simply "account" |
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 |
active BOOLEAN Select only active accounts. Don't set this field to select both active and non-active accounts |
ids INTEGER Select only accounts 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, "account2015" will return objects with names like "account June 2015", "account April 2015", or simply "account 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 "account" will match objects with name "my account", "account 2015", or simply "account" |
sortField ENUMERATION Field by which to sort the list |
sortOrder ENUMERATION Order of sorted results |
Output
This building block provides 27 output parameters
Name | Format | Description |
---|---|---|
accounts[] |
OBJECT |
Contains properties of a Campaign Manager account |
accounts[].accountPermissionIds[] |
INTEGER |
|
accounts[].accountProfile |
ENUMERATION |
Profile for this account. This is a read-only field that can be left blank |
accounts[].active |
BOOLEAN |
Whether this account is active |
accounts[].activeAdsLimitTier |
ENUMERATION |
Maximum number of active ads allowed for this account |
accounts[].activeViewOptOut |
BOOLEAN |
Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions |
accounts[].availablePermissionIds[] |
INTEGER |
|
accounts[].countryId |
INTEGER |
ID of the country associated with this account |
accounts[].currencyId |
INTEGER |
ID of currency associated with this account. This is a required field. Acceptable values are:
|
accounts[].defaultCreativeSizeId |
INTEGER |
Default placement dimensions for this account |
accounts[].description |
STRING |
Description of this account |
accounts[].id |
INTEGER |
ID of this account. This is a read-only, auto-generated field |
accounts[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#account" |
accounts[].locale |
STRING |
Locale of this account. Acceptable values are:
|
accounts[].maximumImageSize |
INTEGER |
Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1 |
accounts[].name |
STRING |
Name of this account. This is a required field, and must be less than 128 characters long and be globally unique |
accounts[].nielsenOcrEnabled |
BOOLEAN |
Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default |
accounts[].reportsConfiguration |
OBJECT |
Reporting Configuration |
accounts[].reportsConfiguration.exposureToConversionEnabled |
BOOLEAN |
Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting |
accounts[].reportsConfiguration.lookbackConfiguration |
OBJECT |
Lookback configuration settings |
accounts[].reportsConfiguration.lookbackConfiguration.clickDuration |
INTEGER |
Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive |
accounts[].reportsConfiguration.lookbackConfiguration.postImpressionActivitiesDuration |
INTEGER |
Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive |
accounts[].reportsConfiguration.reportGenerationTimeZoneId |
INTEGER |
Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are:
|
accounts[].shareReportsWithTwitter |
BOOLEAN |
Share Path to Conversion reports with Twitter |
accounts[].teaserSizeLimit |
INTEGER |
File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse" |
nextPageToken |
STRING |
Pagination token to be used for the next list operation |
= Parameter name
= Format
accounts[] OBJECT Contains properties of a Campaign Manager account |
accounts[].accountPermissionIds[] INTEGER |
accounts[].accountProfile ENUMERATION Profile for this account. This is a read-only field that can be left blank |
accounts[].active BOOLEAN Whether this account is active |
accounts[].activeAdsLimitTier ENUMERATION Maximum number of active ads allowed for this account |
accounts[].activeViewOptOut BOOLEAN Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions |
accounts[].availablePermissionIds[] INTEGER |
accounts[].countryId INTEGER ID of the country associated with this account |
accounts[].currencyId INTEGER ID of currency associated with this account. This is a required field. Acceptable values are:
|
accounts[].defaultCreativeSizeId INTEGER Default placement dimensions for this account |
accounts[].description STRING Description of this account |
accounts[].id INTEGER ID of this account. This is a read-only, auto-generated field |
accounts[].kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#account" |
accounts[].locale STRING Locale of this account. Acceptable values are:
|
accounts[].maximumImageSize INTEGER Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1 |
accounts[].name STRING Name of this account. This is a required field, and must be less than 128 characters long and be globally unique |
accounts[].nielsenOcrEnabled BOOLEAN Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default |
accounts[].reportsConfiguration OBJECT Reporting Configuration |
accounts[].reportsConfiguration.exposureToConversionEnabled BOOLEAN Whether the exposure to conversion report is enabled. This report shows detailed pathway information on up to 10 of the most recent ad exposures seen by a user before converting |
accounts[].reportsConfiguration.lookbackConfiguration OBJECT Lookback configuration settings |
accounts[].reportsConfiguration.lookbackConfiguration.clickDuration INTEGER Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive |
accounts[].reportsConfiguration.lookbackConfiguration.postImpressionActivitiesDuration INTEGER Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive |
accounts[].reportsConfiguration.reportGenerationTimeZoneId INTEGER Report generation time zone ID of this account. This is a required field that can only be changed by a superuser. Acceptable values are:
|
accounts[].shareReportsWithTwitter BOOLEAN Share Path to Conversion reports with Twitter |
accounts[].teaserSizeLimit INTEGER File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive |
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#accountsListResponse" |
nextPageToken STRING Pagination token to be used for the next list operation |