Updates an existing creative. Returns the updated creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

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 creatives-patch ...

Required Scalar Arguments

• <advertiser-id> (string)
  • Output only. The unique ID of the advertiser the creative belongs to.
• <creative-id> (string)
  • Output only. The unique ID of the creative. 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:

Creative:
  advertiser-id: string
  appended-tag: string
  cm-placement-id: string
  cm-tracking-ad:
    cm-ad-id: string
    cm-creative-id: string
    cm-placement-id: string
  companion-creative-ids: [string]
  create-time: string
  creative-attributes: [string]
  creative-id: string
  creative-type: string
  dimensions:
    height-pixels: integer
    width-pixels: integer
  display-name: string
  dynamic: boolean
  entity-status: string
  expand-on-hover: boolean
  expanding-direction: string
  hosting-source: string
  html5-video: boolean
  ias-campaign-monitoring: boolean
  integration-code: string
  js-tracker-url: string
  line-item-ids: [string]
  media-duration: string
  mp3-audio: boolean
  name: string
  notes: string
  oba-icon:
    click-tracking-url: string
    dimensions:
      height-pixels: integer
      width-pixels: integer
    landing-page-url: string
    position: string
    program: string
    resource-mime-type: string
    resource-url: string
    view-tracking-url: string
  ogg-audio: boolean
  progress-offset:
    percentage: string
    seconds: string
  require-html5: boolean
  require-mraid: boolean
  require-ping-for-attribution: boolean
  review-status:
    approval-status: string
    content-and-policy-review-status: string
    creative-and-landing-page-review-status: string
  skip-offset:
    percentage: string
    seconds: string
  skippable: boolean
  third-party-tag: string
  tracker-urls: [string]
  universal-ad-id:
    id: string
    registry: string
  update-time: string
  vast-tag-url: string
  vpaid: boolean

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 . advertiser-id=erat
  • Output only. The unique ID of the advertiser the creative belongs to.
• appended-tag=accusam
  • Third-party HTML tracking tag to be appended to the creative tag.
• cm-placement-id=sea
  • Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.
• cm-tracking-ad cm-ad-id=takimata
  • The ad ID of the campaign manager 360 tracking Ad.
• cm-creative-id=lorem
  • The creative ID of the campaign manager 360 tracking Ad.

• cm-placement-id=et

  • The placement ID of the campaign manager 360 tracking Ad.

• .. companion-creative-ids=at

  • The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO
  • Each invocation of this argument appends the given value to the array.
• create-time=dolor
  • Output only. The timestamp when the creative was created. Assigned by the system.
• creative-attributes=et
  • Output only. A list of attributes of the creative that is generated by the system.
  • Each invocation of this argument appends the given value to the array.
• creative-id=sit
  • Output only. The unique ID of the creative. Assigned by the system.
• creative-type=erat
  • Required. Immutable. The type of the creative.
• dimensions height-pixels=91
  • The height in pixels.

• width-pixels=60

  • The width in pixels.

• .. display-name=et

  • Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.
• dynamic=true
  • Output only. Indicates whether the creative is dynamic.
• entity-status=consetetur
  • Required. Controls whether or not the creative can serve. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED * ENTITY_STATUS_PAUSED
• expand-on-hover=false
  • Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE
• expanding-direction=aliquyam
  • Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_EXPANDABLE
• hosting-source=eos
  • Required. Indicates where the creative is hosted.
• html5-video=false
  • Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO
• ias-campaign-monitoring=true
  • Indicates whether Integral Ad Science (IAS) campaign monitoring is enabled. To enable this for the creative, make sure the Advertiser.creative_config.ias_client_id has been set to your IAS client ID.
• integration-code=gubergren
  • ID information used to link this creative to an external system. Must be UTF-8 encoded with a length of no more than 10,000 characters.
• js-tracker-url=dolor
  • JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
• line-item-ids=aliquyam
  • Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.
  • Each invocation of this argument appends the given value to the array.
• media-duration=no
  • Output only. Media duration of the creative. Applicable when creative_type is one of: * CREATIVE_TYPE_VIDEO * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_NATIVE_VIDEO * CREATIVE_TYPE_PUBLISHER_HOSTED
• mp3-audio=true
  • Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO
• name=lorem
  • Output only. The resource name of the creative.
• notes=accusam
  • User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.
• oba-icon click-tracking-url=gubergren
  • Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com
• dimensions height-pixels=56
  • The height in pixels.

• width-pixels=74

  • The width in pixels.

• .. landing-page-url=sit

  • Required. The landing page URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com
• position=duo
  • The position of the OBA icon on the creative.
• program=sit
  • The program of the OBA icon. For example: “AdChoices”.
• resource-mime-type=magna
  • The MIME type of the OBA icon resource.
• resource-url=et
  • The URL of the OBA icon resource.

• view-tracking-url=rebum.

  • Required. The view tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com

• .. ogg-audio=false

  • Output only. Indicates the third-party audio creative supports OGG. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO
• progress-offset percentage=amet.
  • The offset in percentage of the audio or video duration.

• seconds=no

  • The offset in seconds from the start of the audio or video.

• .. require-html5=false

  • Optional. Indicates that the creative relies on HTML5 to render properly. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE
• require-mraid=true
  • Optional. Indicates that the creative requires MRAID (Mobile Rich Media Ad Interface Definitions system). Set this if the creative relies on mobile gestures for interactivity, such as swiping or tapping. Optional and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE
• require-ping-for-attribution=false
  • Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager 360 tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO
• review-status approval-status=sanctus
  • Represents the basic approval needed for a creative to begin serving. Summary of creative_and_landing_page_review_status and content_and_policy_review_status.
• content-and-policy-review-status=nonumy
  • Content and policy review status for the creative.

• creative-and-landing-page-review-status=rebum.

  • Creative and landing page review status for the creative.

• ..skip-offset percentage=tempor

  • The offset in percentage of the audio or video duration.

• seconds=dolore

  • The offset in seconds from the start of the audio or video.

• .. skippable=true

  • Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO
• third-party-tag=dolore
  • Optional. The original third-party tag used for the creative. Required and only valid for third-party tag creatives. Third-party tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_STANDARD * CREATIVE_TYPE_EXPANDABLE
• tracker-urls=amet
  • Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO
  • Each invocation of this argument appends the given value to the array.
• universal-ad-id id=ut
  • The unique creative identifier.

• registry=at

  • The registry provides unique creative identifiers.

• .. update-time=sit

  • Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.
• vast-tag-url=vero
  • Optional. The URL of the VAST tag for a third-party VAST tag creative. Required and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO
• vpaid=true
  • Output only. Indicates the third-party VAST tag creative requires VPAID (Digital Video Player-Ad Interface). Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * HOSTING_SOURCE_THIRD_PARTY combined with following creative_type: * CREATIVE_TYPE_VIDEO

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