The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Dec 24th, 2021. All users must migrate to a newer API version by that date.

REST Resource: advertisers

Resource: Advertiser

Contains properties of a Campaign Manager advertiser.

JSON representation
{
  "id": string,
  "name": string,
  "accountId": string,
  "subaccountId": string,
  "floodlightConfigurationId": string,
  "advertiserGroupId": string,
  "status": enum (Status),
  "defaultEmail": string,
  "clickThroughUrlSuffix": string,
  "defaultClickThroughEventTagId": string,
  "idDimensionValue": {
    object (DimensionValue)
  },
  "floodlightConfigurationIdDimensionValue": {
    object (DimensionValue)
  },
  "originalFloodlightConfigurationId": string,
  "kind": string,
  "suspended": boolean,
  "measurementPartnerLink": {
    object (MeasurementPartnerAdvertiserLink)
  }
}
Fields
id

string (int64 format)

ID of this advertiser. This is a read-only, auto-generated field.

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.

accountId

string (int64 format)

Account ID of this advertiser.This is a read-only field that can be left blank.

subaccountId

string (int64 format)

Subaccount ID of this advertiser.This is a read-only field that can be left blank.

floodlightConfigurationId

string (int64 format)

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.

advertiserGroupId

string (int64 format)

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.

status

enum (Status)

Status of this advertiser.

defaultEmail

string

Default email address used in sender field for tag emails.

clickThroughUrlSuffix

string

Suffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.

defaultClickThroughEventTagId

string (int64 format)

ID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this advertiser. This is a read-only, auto-generated field.

floodlightConfigurationIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the floodlight configuration. This is a read-only, auto-generated field.

originalFloodlightConfigurationId

string (int64 format)

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.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#advertiser"

.

suspended

boolean

Suspension status of this advertiser.

Status

Enums
APPROVED
ON_HOLD

MeasurementPartner

Enums
NONE
INTEGRAL_AD_SCIENCE

LinkStatus

Enums
MEASUREMENT_PARTNER_UNLINKED
MEASUREMENT_PARTNER_LINKED
MEASUREMENT_PARTNER_MODE_CHANGE_PENDING

Methods

get

Gets one advertiser by ID.

insert

Inserts a new advertiser.

list

Retrieves a list of advertisers, possibly filtered.

patch

Updates an existing advertiser.

update

Updates an existing advertiser.