Advertisers

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

Resource representations

Contains properties of a DCM advertiser.

{
  "kind": "dfareporting#advertiser",
  "originalFloodlightConfigurationId": long,
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "name": string,
  "accountId": long,
  "subaccountId": long,
  "floodlightConfigurationId": long,
  "floodlightConfigurationIdDimensionValue": dimensionValues Resource,
  "advertiserGroupId": long,
  "status": string,
  "defaultEmail": string,
  "clickThroughUrlSuffix": string,
  "defaultClickThroughEventTagId": long,
  "suspended": boolean
}
Property name Value Description Notes
accountId long Account ID of this advertiser.This is a read-only field that can be left blank.
advertiserGroupId long ID of the advertiser group this advertiser belongs to. You can group advertisers for reporting purposes, allowing you to see aggregated information for all advertisers in each group.
clickThroughUrlSuffix string Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
defaultClickThroughEventTagId long ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
defaultEmail string Default email address used in sender field for tag emails.
floodlightConfigurationId long Floodlight configuration ID of this advertiser. The floodlight configuration ID will be created automatically, so on insert this field should be left blank. This field can be set to another advertiser's floodlight configuration ID in order to share that advertiser's floodlight configuration with this advertiser, so long as:
  • This advertiser's original floodlight configuration is not already associated with floodlight activities or floodlight activity groups.
  • This advertiser's original floodlight configuration is not already shared with another advertiser.
floodlightConfigurationIdDimensionValue nested object Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.
id long ID of this advertiser. This is a read-only, auto-generated field.
idDimensionValue nested object Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.
kind string Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
name string Name of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
originalFloodlightConfigurationId long Original floodlight configuration before any sharing occurred. Set the floodlightConfigurationId of this advertiser to originalFloodlightConfigurationId to unshare the advertiser's current floodlight configuration. You cannot unshare an advertiser's floodlight configuration if the shared configuration has activities associated with any campaign or placement.
status string Status of this advertiser.

Acceptable values are:
  • "APPROVED"
  • "ON_HOLD"
subaccountId long Subaccount ID of this advertiser.This is a read-only field that can be left blank.
suspended boolean Suspension status of this advertiser.

Methods

get
Gets one advertiser by ID.
insert
Inserts a new advertiser.
list
Retrieves a list of advertisers, possibly filtered. This method supports paging.
patch
Updates an existing advertiser. This method supports patch semantics.
update
Updates an existing advertiser.

Send feedback about...

DoubleClick Campaign Manager
DoubleClick Campaign Manager