List

Retrieves the list of accounts, possibly filtered

8 variables
27 variables

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

  = 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

  = 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:

  • "1" for USD
  • "2" for GBP
  • "3" for ESP
  • "4" for SEK
  • "5" for CAD
  • "6" for JPY
  • "7" for DEM
  • "8" for AUD
  • "9" for FRF
  • "10" for ITL
  • "11" for DKK
  • "12" for NOK
  • "13" for FIM
  • "14" for ZAR
  • "15" for IEP
  • "16" for NLG
  • "17" for EUR
  • "18" for KRW
  • "19" for TWD
  • "20" for SGD
  • "21" for CNY
  • "22" for HKD
  • "23" for NZD
  • "24" for MYR
  • "25" for BRL
  • "26" for PTE
  • "27" for MXP
  • "28" for CLP
  • "29" for TRY
  • "30" for ARS
  • "31" for PEN
  • "32" for ILS
  • "33" for CHF
  • "34" for VEF
  • "35" for COP
  • "36" for GTQ
  • "37" for PLN
  • "39" for INR
  • "40" for THB
  • "41" for IDR
  • "42" for CZK
  • "43" for RON
  • "44" for HUF
  • "45" for RUB
  • "46" for AED
  • "47" for BGN
  • "48" for HRK
  • "49" for MXN
  • "50" for NGN

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:

  • "cs" (Czech)
  • "de" (German)
  • "en" (English)
  • "en-GB" (English United Kingdom)
  • "es" (Spanish)
  • "fr" (French)
  • "it" (Italian)
  • "ja" (Japanese)
  • "ko" (Korean)
  • "pl" (Polish)
  • "pt-BR" (Portuguese Brazil)
  • "ru" (Russian)
  • "sv" (Swedish)
  • "tr" (Turkish)
  • "zh-CN" (Chinese Simplified)
  • "zh-TW" (Chinese Traditional)

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:

  • "1" for "America/New_York"
  • "2" for "Europe/London"
  • "3" for "Europe/Paris"
  • "4" for "Africa/Johannesburg"
  • "5" for "Asia/Jerusalem"
  • "6" for "Asia/Shanghai"
  • "7" for "Asia/Hong_Kong"
  • "8" for "Asia/Tokyo"
  • "9" for "Australia/Sydney"
  • "10" for "Asia/Dubai"
  • "11" for "America/Los_Angeles"
  • "12" for "Pacific/Auckland"
  • "13" for "America/Sao_Paulo"

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