GOgoogle
advertisers

PUT /userprofiles/{userprofilesId}/advertisers

Updates an existing advertiser.

Request

  • Base URL
    https://dfareporting.googleapis.com/dfareporting/v5
  • Auth
    OAuth 2 and OAuth 2
    Implicithttps://accounts.google.com/o/oauth2/auth
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
    Authorization codehttps://accounts.google.com/o/oauth2/auth
    Token URLhttps://accounts.google.com/o/oauth2/token
    Scopeshttps://www.googleapis.com/auth/dfatrafficking
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

userprofilesIdstring required

Request body

accountIdstring int64

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

advertiserGroupIdstring int64

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.

clickThroughUrlSuffixstring

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

defaultClickThroughEventTagIdstring int64

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

defaultEmailstring

Default email address used in sender field for tag emails.

euPoliticalAdsDeclaration'ADVERTISER_PLANS_TO_SERVE_EU_POLITICAL_ADS' | 'ADVERTISER_DOES_NOT_PLAN_TO_SERVE_EU_POLITICAL_ADS'

Optional. Whether the advertiser plans to serve EU political ads.

floodlightConfigurationIdstring int64

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.

idstring int64

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

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".

namestring

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.

originalFloodlightConfigurationIdstring int64

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'APPROVED' | 'ON_HOLD'

Status of this advertiser.

subaccountIdstring int64

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

suspendedboolean

Suspension status of this advertiser.

Response

Successful response

accountIdstring int64

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

advertiserGroupIdstring int64

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.

clickThroughUrlSuffixstring

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

defaultClickThroughEventTagIdstring int64

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

defaultEmailstring

Default email address used in sender field for tag emails.

euPoliticalAdsDeclaration'ADVERTISER_PLANS_TO_SERVE_EU_POLITICAL_ADS' | 'ADVERTISER_DOES_NOT_PLAN_TO_SERVE_EU_POLITICAL_ADS'

Optional. Whether the advertiser plans to serve EU political ads.

floodlightConfigurationIdstring int64

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.

idstring int64

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

kindstring

Identifies what kind of resource this is. Value: the fixed string "dfareporting#advertiser".

namestring

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.

originalFloodlightConfigurationIdstring int64

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'APPROVED' | 'ON_HOLD'

Status of this advertiser.

subaccountIdstring int64

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

suspendedboolean

Suspension status of this advertiser.

Changes

No recorded changes to this operation across all 5 revisions of this API.