REST Resource: advertisers

Resource: Advertiser

A single advertiser in Display & Video 360 (DV360).

JSON representation
{
  "name": string,
  "advertiserId": string,
  "partnerId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "generalConfig": {
    object (AdvertiserGeneralConfig)
  },
  "adServerConfig": {
    object (AdvertiserAdServerConfig)
  },
  "creativeConfig": {
    object (AdvertiserCreativeConfig)
  },
  "dataAccessConfig": {
    object (AdvertiserDataAccessConfig)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "servingConfig": {
    object (AdvertiserTargetingConfig)
  }
}
Fields
name

string

Output only. The resource name of the advertiser.

advertiserId

string (int64 format)

Output only. The unique ID of the advertiser. Assigned by the system.

partnerId

string (int64 format)

Required. Immutable. The unique ID of the partner that the advertiser belongs to.

displayName

string

Required. The display name of the advertiser.

Must be UTF-8 encoded with a maximum size of 240 bytes.

entityStatus

enum (EntityStatus)

Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory.

  • Accepted values are ENTITY_STATUS_ACTIVE and ENTITY_STATUS_SCHEDULED_FOR_DELETION.
  • If set to ENTITY_STATUS_SCHEDULED_FOR_DELETION, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
updateTime

string (Timestamp format)

Output only. The timestamp when the advertiser was last updated. Assigned by the system.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

generalConfig

object (AdvertiserGeneralConfig)

Required. General settings of the advertiser.

adServerConfig

object (AdvertiserAdServerConfig)

Required. Immutable. Ad server related settings of the advertiser.

creativeConfig

object (AdvertiserCreativeConfig)

Required. Creative related settings of the advertiser.

dataAccessConfig

object (AdvertiserDataAccessConfig)

Settings that control how advertiser data may be accessed.

integrationDetails

object (IntegrationDetails)

Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided.

servingConfig

object (AdvertiserTargetingConfig)

Targeting settings related to ad serving of the advertiser.

AdvertiserGeneralConfig

General settings of an advertiser.

JSON representation
{
  "domainUrl": string,
  "timeZone": string,
  "currencyCode": string
}
Fields
domainUrl

string

Required. The domain URL of the advertiser's primary website. The system will send this information to publishers that require website URL to associate a campaign with an advertiser.

Provide a URL with no path or query string, beginning with http: or https:. For example, http://www.example.com

timeZone

string

Output only. The standard TZ database name of the advertiser's time zone. For example, America/New_York.

See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

For CM hybrid advertisers, the time zone is the same as that of the associated CM account; for third-party only advertisers, the time zone is the same as that of the parent partner.

currencyCode

string

Required. Immutable. Advertiser's currency in ISO 4217 format.

Accepted codes and the currencies they represent are:

Currency Code : Currency Name

  • ARS : Argentine Peso
  • AUD : Australian Dollar
  • BRL : Brazilian Real
  • CAD : Canadian Dollar
  • CHF : Swiss Franc
  • CLP : Chilean Peso
  • CNY : Chinese Yuan
  • COP : Colombian Peso
  • CZK : Czech Koruna
  • DKK : Danish Krone
  • EGP : Egyption Pound
  • EUR : Euro
  • GBP : British Pound
  • HKD : Hong Kong Dollar
  • HUF : Hungarian Forint
  • IDR : Indonesian Rupiah
  • ILS : Israeli Shekel
  • INR : Indian Rupee
  • JPY : Japanese Yen
  • KRW : South Korean Won
  • MXN : Mexican Pesos
  • MYR : Malaysian Ringgit
  • NGN : Nigerian Naira
  • NOK : Norwegian Krone
  • NZD : New Zealand Dollar
  • PEN : Peruvian Nuevo Sol
  • PLN : Polish Zloty
  • RON : New Romanian Leu
  • RUB : Russian Ruble
  • SEK : Swedish Krona
  • TRY : Turkish Lira
  • TWD : New Taiwan Dollar
  • USD : US Dollar
  • ZAR : South African Rand

AdvertiserAdServerConfig

Ad server related settings of an advertiser.

JSON representation
{

  // Union field ad_server_config_scheme can be only one of the following:
  "thirdPartyOnlyConfig": {
    object (ThirdPartyOnlyConfig)
  },
  "cmHybridConfig": {
    object (CmHybridConfig)
  }
  // End of list of possible types for union field ad_server_config_scheme.
}
Fields
Union field ad_server_config_scheme. Required. ad_server_config_scheme can be only one of the following:
thirdPartyOnlyConfig

object (ThirdPartyOnlyConfig)

The configuration for advertisers that use third-party ad servers only.

cmHybridConfig

object (CmHybridConfig)

The configuration for advertisers that use both Campaign Manager (CM) and third-party ad servers.

ThirdPartyOnlyConfig

Settings for advertisers that use third-party ad servers only.

JSON representation
{
  "pixelOrderIdReportingEnabled": boolean
}
Fields
pixelOrderIdReportingEnabled

boolean

Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to true.

CmHybridConfig

Settings for advertisers that use both Campaign Manager (CM) and third-party ad servers.

JSON representation
{
  "cmAccountId": string,
  "cmFloodlightConfigId": string,
  "cmSyncableSiteIds": [
    string
  ],
  "dv360ToCmDataSharingEnabled": boolean,
  "dv360ToCmCostReportingEnabled": boolean,
  "cmFloodlightLinkingAuthorized": boolean
}
Fields
cmAccountId

string (int64 format)

Required. Immutable. Account ID of the CM Floodlight configuration linked with the DV360 advertiser.

cmFloodlightConfigId

string (int64 format)

Required. Immutable. ID of the CM Floodlight configuration linked with the DV360 advertiser.

cmSyncableSiteIds[]

string (int64 format)

A list of CM sites whose placements will be synced to DV360 as creatives.

If absent or empty in advertisers.create method, the system will automatically create a CM site.

Removing sites from this list may cause DV360 creatives synced from CM to be deleted. At least one site must be specified.

dv360ToCmDataSharingEnabled

boolean

Whether or not to include DV360 data in CM data transfer reports.

dv360ToCmCostReportingEnabled

boolean

Whether or not to report DV360 cost to CM.

cmFloodlightLinkingAuthorized

boolean

Required. Immutable. By setting this field to true, you, on behalf of your company, authorize the sharing of information from the given Floodlight configuration to this Display & Video 360 advertiser.

AdvertiserCreativeConfig

Creatives related settings of an advertiser.

JSON representation
{
  "iasClientId": string,
  "obaComplianceDisabled": boolean,
  "dynamicCreativeEnabled": boolean,
  "videoCreativeDataSharingAuthorized": boolean
}
Fields
iasClientId

string (int64 format)

An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS "Campaign Monitor" tag containing this ID to the creative tag.

obaComplianceDisabled

boolean

Whether or not to use DV360's Online Behavioral Advertising (OBA) compliance.

Warning: Changing OBA settings may cause the audit status of your creatives to be reset by some ad exchanges, making them ineligible to serve until they are re-approved.

dynamicCreativeEnabled

boolean

Whether or not the advertiser is enabled for dynamic creatives.

videoCreativeDataSharingAuthorized

boolean

By setting this field to true, you, on behalf of your company, authorize Google to use video creatives associated with this Display & Video 360 advertiser to provide reporting and features related to the advertiser's television campaigns.

Applicable only when the advertiser has a CM hybrid ad server configuration.

AdvertiserDataAccessConfig

Settings that control how advertiser related data may be accessed.

JSON representation
{
  "sdfConfig": {
    object (AdvertiserSdfConfig)
  }
}
Fields
sdfConfig

object (AdvertiserSdfConfig)

Structured Data Files (SDF) settings for the advertiser.

If not specified, the SDF settings of the parent partner are used.

AdvertiserSdfConfig

Structured Data Files (SDF) settings of an advertiser.

JSON representation
{
  "overridePartnerSdfConfig": boolean,
  "sdfConfig": {
    object (SdfConfig)
  }
}
Fields
overridePartnerSdfConfig

boolean

Whether or not this advertiser overrides the SDF configuration of its parent partner.

By default, an advertiser inherits the SDF configuration from the parent partner. To override the partner configuration, set this field to true and provide the new configuration in sdfConfig.

sdfConfig

object (SdfConfig)

The SDF configuration for the advertiser.

AdvertiserTargetingConfig

Targeting settings related to ad serving of an advertiser.

JSON representation
{
  "exemptTvFromViewabilityTargeting": boolean
}
Fields
exemptTvFromViewabilityTargeting

boolean

Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.

Methods

audit

Audits an advertiser.

bulkEditAdvertiserAssignedTargetingOptions

Bulk edits targeting options under a single advertiser.

bulkListAdvertiserAssignedTargetingOptions

Lists assigned targeting options of an advertiser across targeting types.

create

Creates a new advertiser.

delete

Deletes an advertiser.

get

Gets an advertiser.

list

Lists advertisers that are accessible to the current user.

patch

Updates an existing advertiser.