Updates a creative.

Scopes

You will need authorization for the https://www.googleapis.com/auth/realtime-bidding scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/realtime-bidding. You can set the scope for this method like this: realtimebidding1 --scope <scope> buyers creatives-patch ...

Required Scalar Argument

<name> (string)
- Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

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:

Creative:
  account-id: string
  ad-choices-destination-url: string
  advertiser-name: string
  agency-id: string
  api-update-time: string
  creative-format: string
  creative-id: string
  creative-serving-decision:
    ad-technology-providers:
      detected-gvl-ids: [string]
      detected-provider-ids: [string]
      unidentified-provider-domains: [string]
    china-policy-compliance:
      status: string
    deals-policy-compliance:
      status: string
    detected-attributes: [string]
    detected-click-through-urls: [string]
    detected-domains: [string]
    detected-languages: [string]
    detected-product-categories: [integer]
    detected-sensitive-categories: [integer]
    detected-vendor-ids: [integer]
    last-status-update: string
    network-policy-compliance:
      status: string
    platform-policy-compliance:
      status: string
    russia-policy-compliance:
      status: string
  deal-ids: [string]
  declared-attributes: [string]
  declared-click-through-urls: [string]
  declared-restricted-categories: [string]
  declared-vendor-ids: [integer]
  html:
    height: integer
    snippet: string
    width: integer
  impression-tracking-urls: [string]
  name: string
  native:
    advertiser-name: string
    app-icon:
      height: integer
      url: string
      width: integer
    body: string
    call-to-action: string
    click-link-url: string
    click-tracking-url: string
    headline: string
    image:
      height: integer
      url: string
      width: integer
    logo:
      height: integer
      url: string
      width: integer
    price-display-text: string
    star-rating: number
    video-url: string
    video-vast-xml: string
  render-url: string
  restricted-categories: [string]
  version: integer
  video:
    video-metadata:
      duration: string
      is-valid-vast: boolean
      is-vpaid: boolean
      skip-offset: string
      vast-version: string
    video-url: string
    video-vast-xml: 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 . account-id=elitr
- Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.
ad-choices-destination-url=duo
- The link to AdChoices destination page. This is only supported for native ads.
advertiser-name=diam
- The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.
agency-id=est
- The agency ID for this creative.
api-update-time=sit
- Output only. The last update timestamp of the creative through the API.
creative-format=sed
- Output only. The format of this creative. Can be used to filter the response of the creatives.list method.
creative-id=eos
- Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.
creative-serving-decision.ad-technology-providers detected-gvl-ids=lorem
- The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB Global Vendor List at https://vendor-list.consensu.org/v2/vendor-list.json for details about the vendors.
- Each invocation of this argument appends the given value to the array.
detected-provider-ids=ea
- The detected Google Ad Tech Providers (ATP) for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider.
- Each invocation of this argument appends the given value to the array.
unidentified-provider-domains=stet
- Domains of detected unidentified ad technology providers (if any). You must ensure that the creatives used in bids placed for inventory that will serve to EEA or UK users does not contain unidentified ad technology providers. Google reserves the right to filter non-compliant bids.
- Each invocation of this argument appends the given value to the array.
..china-policy-compliance status=dolores
- Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
..deals-policy-compliance status=eos
- Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
.. detected-attributes=et
- Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
- Each invocation of this argument appends the given value to the array.
detected-click-through-urls=sea
- The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
detected-domains=et
- The detected domains for this creative.
- Each invocation of this argument appends the given value to the array.
detected-languages=at
- The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
detected-product-categories=17
- Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
detected-sensitive-categories=61
- Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
- Each invocation of this argument appends the given value to the array.
detected-vendor-ids=50
- IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the allowed_vendor_type field of a bid request does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
- Each invocation of this argument appends the given value to the array.
last-status-update=accusam
- The last time the creative status was updated. Can be used to filter the response of the creatives.list method.
network-policy-compliance status=amet
- Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
..platform-policy-compliance status=erat
- Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
..russia-policy-compliance status=dolores
- Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
... deal-ids=erat
- Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
declared-attributes=accusam
- All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the excluded_attribute field of a bid request contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
- Each invocation of this argument appends the given value to the array.
declared-click-through-urls=sea
- The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
declared-restricted-categories=takimata
- All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
declared-vendor-ids=50
- IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.
- Each invocation of this argument appends the given value to the array.
html height=79
- The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.
snippet=at
- The HTML snippet that displays the ad when inserted in the web page.
width=97
- The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.
.. impression-tracking-urls=et
- The set of URLs to be called to record an impression.
- Each invocation of this argument appends the given value to the array.
name=sit
- Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.
native advertiser-name=erat
- The name of the advertiser or sponsor, to be displayed in the ad creative.
app-icon height=91
- Image height in pixels.
url=nonumy
- The URL of the image.
width=79
- Image width in pixels.
.. body=gubergren
- A long description of the ad.
call-to-action=justo
- A label for the button that the user is supposed to click.
click-link-url=sea
- The URL that the browser/SDK will load when the user clicks the ad.
click-tracking-url=consetetur
- The URL to use for click tracking.
headline=sit
- A short title for the ad.
image height=69
- Image height in pixels.
url=eos
- The URL of the image.
width=24
- Image width in pixels.
..logo height=82
- Image height in pixels.
url=consetetur
- The URL of the image.
width=39
- Image width in pixels.
.. price-display-text=dolor
- The price of the promoted app including currency info.
star-rating=0.9429759678190598
- The app rating in the app store. Must be in the range [0-5].
video-url=aliquyam
- The URL to fetch a native video ad.
video-vast-xml=no
- The contents of a VAST document for a native video ad.
.. render-url=amet.
- Experimental field that can be used during the FLEDGE Origin Trial. The URL to fetch an interest group ad used in TURTLEDOVE on-device auction. This should be unique among all creatives for a given accountId. This URL should be the same as the URL returned by generateBid().
restricted-categories=ipsum
- All restricted categories for the ads that may be shown from this creative.
- Each invocation of this argument appends the given value to the array.
version=45
- Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.
video.video-metadata duration=accusam
- The duration of the ad. Can be used to filter the response of the creatives.list method.
is-valid-vast=true
- Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
is-vpaid=true
- Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
skip-offset=at
- The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.
vast-version=sit
- The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.
.. video-url=duo
- The URL to fetch a video ad.
video-vast-xml=sit
- The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard.

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.

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
- Field mask to use for partial in-place updates.

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").