Skip to main content

advertisers

Overview

Nameadvertisers
TypeResource
Idgoogleads.dfareporting.advertisers

Fields

NameDatatypeDescription
idstringID of this advertiser. This is a read-only, auto-generated field.
namestringName of this advertiser. This is a required field and must be less than 256 characters long and unique among advertisers of the same account.
originalFloodlightConfigurationIdstringOriginal 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.
defaultClickThroughEventTagIdstringID of the click-through event tag to apply by default to the landing pages of this advertiser's campaigns.
kindstringIdentifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".
subaccountIdstringSubaccount ID of this advertiser.This is a read-only field that can be left blank.
advertiserGroupIdstringID 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.
suspendedbooleanSuspension status of this advertiser.
floodlightConfigurationIdDimensionValueobjectRepresents a DimensionValue resource.
idDimensionValueobjectRepresents a DimensionValue resource.
measurementPartnerLinkobject
accountIdstringAccount ID of this advertiser.This is a read-only field that can be left blank.
floodlightConfigurationIdstringFloodlight 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.
statusstringStatus of this advertiser.
clickThroughUrlSuffixstringSuffix added to click-through URL of ad creative associations under this advertiser. Must be less than 129 characters long.
defaultEmailstringDefault email address used in sender field for tag emails.

Methods

NameAccessible byRequired ParamsDescription
getSELECTid, profileIdGets one advertiser by ID.
listSELECTprofileIdRetrieves a list of advertisers, possibly filtered. This method supports paging.
insertINSERTprofileIdInserts a new advertiser.
patchEXECid, profileIdUpdates an existing advertiser. This method supports patch semantics.
updateEXECprofileIdUpdates an existing advertiser.