advertisers

Changed on

Creates a new creative. Returns the newly created creative if successful. A "Standard" user role or greater for the parent advertiser or partner is required to make this request.

post/v4/advertisers/{+advertiserId}/creatives

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/advertisers/{+advertiserId}/creatives
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)

Path parameters

advertiserIdstring required

Output only. The unique ID of the advertiser the creative belongs to.

Request body

advertiserIdstring int64

Output only. The unique ID of the advertiser the creative belongs to.

appendedTagstring

Optional. Third-party HTML tracking tag to be appended to the creative tag.

cmPlacementIdstring int64

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.

companionCreativeIdsstring[]

Optional. 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 the following creative_type: * CREATIVE_TYPE_AUDIO * CREATIVE_TYPE_VIDEO

createTimestring google-datetime

Output only. The timestamp when the creative was created. Assigned by the system.

creativeAttributesstring[]

Output only. A list of attributes of the creative that is generated by the system.

creativeIdstring int64

Output only. The unique ID of the creative. Assigned by the system.

creativeType'CREATIVE_TYPE_UNSPECIFIED' | 'CREATIVE_TYPE_STANDARD' | 'CREATIVE_TYPE_EXPANDABLE' | 'CREATIVE_TYPE_VIDEO' | 'CREATIVE_TYPE_NATIVE' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL' | 'CREATIVE_TYPE_NATIVE_SITE_SQUARE' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL' | 'CREATIVE_TYPE_LIGHTBOX' | 'CREATIVE_TYPE_NATIVE_APP_INSTALL' | 'CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE' | 'CREATIVE_TYPE_AUDIO' | 'CREATIVE_TYPE_PUBLISHER_HOSTED' | 'CREATIVE_TYPE_NATIVE_VIDEO' | 'CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO' | 'CREATIVE_TYPE_ASSET_BASED_CREATIVE'

Required. Immutable. The type of the creative.

displayNamestring

Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.

dynamicboolean

Output only. Indicates whether the creative is dynamic.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Required. Controls whether or not the creative can serve. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED * ENTITY_STATUS_PAUSED

expandOnHoverboolean

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

expandingDirection'EXPANDING_DIRECTION_UNSPECIFIED' | 'EXPANDING_DIRECTION_NONE' | 'EXPANDING_DIRECTION_UP' | 'EXPANDING_DIRECTION_DOWN' | 'EXPANDING_DIRECTION_LEFT' | 'EXPANDING_DIRECTION_RIGHT' | 'EXPANDING_DIRECTION_UP_AND_LEFT' | 'EXPANDING_DIRECTION_UP_AND_RIGHT' | 'EXPANDING_DIRECTION_DOWN_AND_LEFT' | 'EXPANDING_DIRECTION_DOWN_AND_RIGHT' | 'EXPANDING_DIRECTION_UP_OR_DOWN' | 'EXPANDING_DIRECTION_LEFT_OR_RIGHT' | 'EXPANDING_DIRECTION_ANY_DIAGONAL'

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

hostingSource'HOSTING_SOURCE_UNSPECIFIED' | 'HOSTING_SOURCE_CM' | 'HOSTING_SOURCE_THIRD_PARTY' | 'HOSTING_SOURCE_HOSTED' | 'HOSTING_SOURCE_RICH_MEDIA'

Required. Indicates where the creative is hosted.

html5Videoboolean

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

iasCampaignMonitoringboolean

Optional. 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.

integrationCodestring

Optional. 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.

jsTrackerUrlstring

Optional. 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 the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

lineItemIdsstring[]

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.

mediaDurationstring google-duration

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

mp3Audioboolean

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

namestring

Output only. The resource name of the creative.

notesstring

Optional. User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters.

oggAudioboolean

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

requireHtml5boolean

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

requireMraidboolean

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

requirePingForAttributionboolean

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

skippableboolean

Optional. Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * CREATIVE_TYPE_VIDEO

syntheticContentAttestationStatus'SYNTHETIC_CONTENT_ATTESTATION_STATUS_UNSPECIFIED' | 'NOT_SYNTHETIC' | 'IS_SYNTHETIC'

Optional. Whether to add a label to the creative as created or edited using AI when served in regions with local AI labeling regulations.

thirdPartyTagstring

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

trackerUrlsstring[]

Optional. 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 the following creative_type: * CREATIVE_TYPE_NATIVE * CREATIVE_TYPE_NATIVE_SITE_SQUARE * CREATIVE_TYPE_NATIVE_VIDEO

updateTimestring google-datetime

Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system.

vastTagUrlstring

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

vpaidboolean

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

Response

Successful response

Changes

  • 52cdb4885336Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status

  • 0f73dc785c76Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status