Updates an existing advertiser. Returns the updated advertiser if successful.
Scopes
You will need authorization for the https://www.googleapis.com/auth/display-video scope to make a valid call.
If unset, the scope for this method defaults to https://www.googleapis.com/auth/display-video.
You can set the scope for this method like this: displayvideo1 --scope <scope> advertisers patch ...
Required Scalar Argument
- <advertiser-id> (string)
- Output only. The unique ID of the advertiser. Assigned by the system.
Required Request Value
The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.
For example, a structure like this:
Advertiser:
ad-server-config:
cm-hybrid-config:
cm-account-id: string
cm-advertiser-ids: [string]
cm-floodlight-config-id: string
cm-floodlight-linking-authorized: boolean
cm-syncable-site-ids: [string]
dv360-to-cm-cost-reporting-enabled: boolean
dv360-to-cm-data-sharing-enabled: boolean
third-party-only-config:
pixel-order-id-reporting-enabled: boolean
advertiser-id: string
creative-config:
dynamic-creative-enabled: boolean
ias-client-id: string
oba-compliance-disabled: boolean
video-creative-data-sharing-authorized: boolean
data-access-config:
sdf-config:
override-partner-sdf-config: boolean
sdf-config:
admin-email: string
version: string
display-name: string
entity-status: string
general-config:
currency-code: string
domain-url: string
time-zone: string
integration-details:
details: string
integration-code: string
name: string
partner-id: string
prisma-enabled: boolean
serving-config:
exempt-tv-from-viewability-targeting: boolean
update-time: string
can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.
-r .ad-server-config.cm-hybrid-config cm-account-id=et
- Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
cm-advertiser-ids=labore
- Output only. The set of CM360 Advertiser IDs sharing the CM360 Floodlight configuration.
- Each invocation of this argument appends the given value to the array.
cm-floodlight-config-id=labore
- Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser.
cm-floodlight-linking-authorized=false
- 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.
- Required. Immutable. By setting this field to
cm-syncable-site-ids=ut
- A list of CM360 sites whose placements will be synced to DV360 as creatives. If absent or empty in CreateAdvertiser method, the system will automatically create a CM360 site. Removing sites from this list may cause DV360 creatives synced from CM360 to be deleted. At least one site must be specified.
- Each invocation of this argument appends the given value to the array.
dv360-to-cm-cost-reporting-enabled=true
- Whether or not to report DV360 cost to CM360.
-
dv360-to-cm-data-sharing-enabled=true
- Whether or not to include DV360 data in CM360 data transfer reports.
-
..third-party-only-config pixel-order-id-reporting-enabled=true
- Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to
true
.
- Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to
-
... advertiser-id=erat
- Output only. The unique ID of the advertiser. Assigned by the system.
creative-config dynamic-creative-enabled=false
- Whether or not the advertiser is enabled for dynamic creatives.
ias-client-id=amet.
- 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.
oba-compliance-disabled=true
- Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. Learn more. If you choose to set this field to
true
, note that ads served through Display & Video 360 must comply to the following: * Be Online Behavioral Advertising (OBA) compliant, as per your contract with Google Marketing Platform. * In the European Economic Area (EEA), include transparency information and a mechanism for users to report illegal content in ads. If using an alternative ad badging, transparency, and reporting solution, you must ensure it includes the required transparency information and illegal content flagging mechanism and that you notify Google of any illegal content reports using the appropriate form.
- Whether or not to disable Google's About this Ad feature that adds badging (to identify the content as an ad) and transparency information (on interaction with About this Ad) to your ads for Online Behavioral Advertising (OBA) and regulatory requirements. About this Ad gives users greater control over the ads they see and helps you explain why they're seeing your ad. Learn more. If you choose to set this field to
-
video-creative-data-sharing-authorized=false
- 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 CM360 hybrid ad server configuration.
- By setting this field to
-
..data-access-config.sdf-config override-partner-sdf-config=true
- 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.
- 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
sdf-config admin-email=takimata
- An administrator email address to which the SDF processing status reports will be sent.
-
version=amet.
- Required. The version of SDF being used.
-
.... display-name=et
- Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.
entity-status=labore
- 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
,ENTITY_STATUS_PAUSED
andENTITY_STATUS_SCHEDULED_FOR_DELETION
. * If set toENTITY_STATUS_SCHEDULED_FOR_DELETION
, the advertiser will be deleted 30 days from when it was first scheduled for deletion.
- Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are
general-config currency-code=sed
- 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
- Required. Immutable. Advertiser's currency in ISO 4217 format. Accepted codes and the currencies they represent are: Currency Code : Currency Name *
domain-url=sit
- 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:
orhttps:
. For example, http://www.example.com
- 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
-
time-zone=sit
- 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 CM360 hybrid advertisers, the time zone is the same as that of the associated CM360 account; for third-party only advertisers, the time zone is the same as that of the parent partner.
- Output only. The standard TZ database name of the advertiser's time zone. For example,
-
..integration-details details=invidunt
- Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
-
integration-code=elitr
- An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
-
.. name=voluptua.
- Output only. The resource name of the advertiser.
partner-id=justo
- Required. Immutable. The unique ID of the partner that the advertiser belongs to.
prisma-enabled=false
- Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.
-
serving-config exempt-tv-from-viewability-targeting=false
- Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser.
-
.. update-time=gubergren
- Output only. The timestamp when the advertiser was last updated. Assigned by the system.
About Cursors
The cursor position is key to comfortably set complex nested structures. The following rules apply:
- The cursor position is always set relative to the current one, unless the field name starts with the
.
character. Fields can be nested such as in-r f.s.o
. - The cursor position is set relative to the top-level structure if it starts with
.
, e.g.-r .s.s
- You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify
-r struct.sub_struct=bar
. - You can move the cursor one level up by using
..
. Each additional.
moves it up one additional level. E.g....
would go three levels up.
Optional Output Flags
The method's return value a JSON encoded structure, which will be written to standard output by default.
- -o out
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
-
to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.
- out specifies the destination to which to write the server's result to.
It will be a JSON-encoded structure.
The destination may be
Optional Method Properties
You may set the following properties to further configure the call. Please note that -p
is followed by one
or more key-value-pairs, and is called like this -p k1=v1 k2=v2
even though the listing below repeats the
-p
for completeness.
- -p update-mask=string
- Required. The mask to control which fields to update.
Optional General Properties
The following properties can configure any call, and are not specific to this method.
-
-p $-xgafv=string
- V1 error format.
-
-p access-token=string
- OAuth access token.
-
-p alt=string
- Data format for response.
-
-p callback=string
- JSONP
-
-p fields=string
- Selector specifying which fields to include in a partial response.
-
-p key=string
- API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
-
-p oauth-token=string
- OAuth 2.0 token for the current user.
-
-p pretty-print=boolean
- Returns response with indentations and line breaks.
-
-p quota-user=string
- Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
-
-p upload-type=string
- Legacy upload protocol for media (e.g. "media", "multipart").
-
-p upload-protocol=string
- Upload protocol for media (e.g. "raw", "multipart").