The DCM/DFA Reporting and Trafficking API v3.1 is deprecated and will be sunset on February 28th, 2019. All users must migrate to a newer API version by that date.

Accounts

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Campaign Manager account.

{
  "kind": "dfareporting#account",
  "id": long,
  "name": string,
  "active": boolean,
  "description": string,
  "currencyId": long,
  "maximumImageSize": long,
  "defaultCreativeSizeId": long,
  "activeAdsLimitTier": string,
  "countryId": long,
  "reportsConfiguration": {
    "reportGenerationTimeZoneId": long,
    "exposureToConversionEnabled": boolean,
    "lookbackConfiguration": {
      "clickDuration": integer,
      "postImpressionActivitiesDuration": integer
    }
  },
  "activeViewOptOut": boolean,
  "teaserSizeLimit": long,
  "accountPermissionIds": [
    long
  ],
  "availablePermissionIds": [
    long
  ],
  "accountProfile": string,
  "nielsenOcrEnabled": boolean,
  "locale": string,
  "shareReportsWithTwitter": boolean
}
Property name Value Description Notes
accountPermissionIds[] list Account permissions assigned to this account.
accountProfile string Profile for this account. This is a read-only field that can be left blank.

Acceptable values are:
  • "ACCOUNT_PROFILE_BASIC"
  • "ACCOUNT_PROFILE_STANDARD"
active boolean Whether this account is active.
activeAdsLimitTier string Maximum number of active ads allowed for this account.

Acceptable values are:
  • "ACTIVE_ADS_TIER_100K"
  • "ACTIVE_ADS_TIER_1M"
  • "ACTIVE_ADS_TIER_200K"
  • "ACTIVE_ADS_TIER_300K"
  • "ACTIVE_ADS_TIER_40K"
  • "ACTIVE_ADS_TIER_500K"
  • "ACTIVE_ADS_TIER_750K"
  • "ACTIVE_ADS_TIER_75K"
activeViewOptOut boolean Whether to serve creatives with Active View tags. If disabled, viewability data will not be available for any impressions.
availablePermissionIds[] list User role permissions available to the user roles of this account.
countryId long ID of the country associated with this account.
currencyId long 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

defaultCreativeSizeId long Default placement dimensions for this account.
description string Description of this account.
id long ID of this account. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#account".
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)

maximumImageSize long Maximum image size allowed for this account, in kilobytes. Value must be greater than or equal to 1.
name string Name of this account. This is a required field, and must be less than 128 characters long and be globally unique.
nielsenOcrEnabled boolean Whether campaigns created in this account will be enabled for Nielsen OCR reach ratings by default.
reportsConfiguration nested object Reporting configuration of this account.
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.
reportsConfiguration.lookbackConfiguration nested object Default lookback windows for new advertisers in this account.
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.
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.
reportsConfiguration.reportGenerationTimeZoneId long 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"

shareReportsWithTwitter boolean Share Path to Conversion reports with Twitter.
teaserSizeLimit long File size limit in kilobytes of Rich Media teaser creatives. Acceptable values are 1 to 10240, inclusive.

Methods

get
Gets one account by ID.
list
Retrieves the list of accounts, possibly filtered. This method supports paging.
patch
Updates an existing account. This method supports patch semantics.
update
Updates an existing account.

Send feedback about...

Campaign Manager
Campaign Manager