--- title: "PATCH /userprofiles/{+profileId}/creatives" method: PATCH path: "/userprofiles/{+profileId}/creatives" tags: ["creatives"] --- # PATCH /userprofiles/{+profileId}/creatives `PATCH /userprofiles/{+profileId}/creatives` Updates an existing creative. This method supports patch semantics. ## Path parameters - `profileId` string, required ## Query parameters - `id` string, required ## Request body - Creative — Contains properties of a Creative. - `htmlCode` string — HTML code for the creative. This is a required field when applicable. This field is ignored if htmlCodeLocked is true. Applicable to the following creative types: all CUSTOM, FLASH_INPAGE, and HTML5_BANNER, and all RICH_MEDIA. - `backupImageReportingLabel` string — Reporting label used for HTML5 banner backup image. Applicable to the following creative types: DISPLAY when the primary asset type is not HTML_IMAGE. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#creative". - `type` 'IMAGE' | 'DISPLAY_REDIRECT' | 'CUSTOM_DISPLAY' | 'INTERNAL_REDIRECT' | 'CUSTOM_DISPLAY_INTERSTITIAL' | 'INTERSTITIAL_INTERNAL_REDIRECT' | 'TRACKING_TEXT' | 'RICH_MEDIA_DISPLAY_BANNER' | 'RICH_MEDIA_INPAGE_FLOATING' | 'RICH_MEDIA_IM_EXPAND' | 'RICH_MEDIA_DISPLAY_EXPANDING' | 'RICH_MEDIA_DISPLAY_INTERSTITIAL' | 'RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL' | 'RICH_MEDIA_MOBILE_IN_APP' | 'FLASH_INPAGE' | 'INSTREAM_VIDEO' | 'VPAID_LINEAR_VIDEO' | 'VPAID_NON_LINEAR_VIDEO' | 'INSTREAM_VIDEO_REDIRECT' | 'RICH_MEDIA_PEEL_DOWN' | 'HTML5_BANNER' | 'DISPLAY' | 'DISPLAY_IMAGE_GALLERY' | 'BRAND_SAFE_DEFAULT_INSTREAM_VIDEO' | 'INSTREAM_AUDIO' — Required. Type of this creative. Applicable to all creative types. *Note:* FLASH_INPAGE, HTML5_BANNER, and IMAGE are only used for existing creatives. New creatives should use DISPLAY as a replacement for these types. - `totalFileSize` string, int64 — Combined size of all creative assets. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `lastModifiedInfo` LastModifiedInfo — Modification timestamp. - `time` string, int64 — Timestamp of the last change in milliseconds since epoch. - `size` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `creativeAssets` CreativeAsset[] — Assets associated with a creative. Applicable to all but the following creative types: INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and REDIRECT - `hideSelectionBoxes` boolean — Whether to hide selection boxes flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - `hideFlashObjects` boolean — Whether to hide Flash objects flag for an asset. Applicable to the following creative types: all RICH_MEDIA. - `windowMode` 'OPAQUE' | 'WINDOW' | 'TRANSPARENT' — Window mode options for flash assets. Applicable to the following creative types: FLASH_INPAGE, RICH_MEDIA_DISPLAY_EXPANDING, RICH_MEDIA_IM_EXPAND, RICH_MEDIA_DISPLAY_BANNER, and RICH_MEDIA_INPAGE_FLOATING. - `durationType` 'ASSET_DURATION_TYPE_AUTO' | 'ASSET_DURATION_TYPE_NONE' | 'ASSET_DURATION_TYPE_CUSTOM' — Duration type for which an asset will be displayed. Applicable to the following creative types: all RICH_MEDIA. - `size` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `mimeType` string — Detected MIME type for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `duration` integer — Duration in seconds for which an asset will be displayed. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID_LINEAR_VIDEO. Value must be greater than or equal to 1. - `customStartTimeValue` integer — Custom start time in seconds for making the asset visible. Applicable to the following creative types: all RICH_MEDIA. Value must be greater than or equal to 0. - `detectedFeatures` string[] — List of feature dependencies for the creative asset that are detected by Campaign Manager. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative correctly. This is a read-only, auto-generated field. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `originalBackup` boolean — Whether the backup asset is original or changed by the user in Campaign Manager. Applicable to the following creative types: all RICH_MEDIA. - `frameRate` number, float — Video frame rate for video asset in frames per second. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Artwork type of rich media creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - `verticallyLocked` boolean — Whether the asset is vertically locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - `bitRate` integer — Detected bit-rate for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `transparency` boolean — Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. - `position` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `startTimeType` 'ASSET_START_TIME_TYPE_NONE' | 'ASSET_START_TIME_TYPE_CUSTOM' — Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. - `zIndex` integer — zIndex value of an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable to assets whose displayType is NOT one of the following types: ASSET_DISPLAY_TYPE_INPAGE or ASSET_DISPLAY_TYPE_OVERLAY. Acceptable values are -999999999 to 999999999, inclusive. - `orientation` 'LANDSCAPE' | 'PORTRAIT' | 'SQUARE' — Orientation of video asset. This is a read-only, auto-generated field. - `audioSampleRate` integer — Audio sample bit rate in hertz. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `actionScript3` boolean — Whether ActionScript3 is enabled for the flash asset. This is a read-only field. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `pushdown` boolean — Whether the asset pushes down other content. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable when the asset offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. - `assetIdentifier` CreativeAssetId — Creative Asset ID. - `type` 'IMAGE' | 'FLASH' | 'VIDEO' | 'HTML' | 'HTML_IMAGE' | 'AUDIO' — Type of asset to upload. This is a required field. FLASH and IMAGE are no longer supported for new uploads. All image assets should use HTML_IMAGE. - `name` string — Name of the creative asset. This is a required field while inserting an asset. After insertion, this assetIdentifier is used to identify the uploaded asset. Characters in the name must be alphanumeric or one of the following: ".-_ ". Spaces are allowed. - `horizontallyLocked` boolean — Whether the asset is horizontally locked. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - `childAssetType` 'CHILD_ASSET_TYPE_FLASH' | 'CHILD_ASSET_TYPE_VIDEO' | 'CHILD_ASSET_TYPE_IMAGE' | 'CHILD_ASSET_TYPE_DATA' — Rich media child asset type. This is a read-only field. Applicable to the following creative types: all VPAID. - `positionTopUnit` 'OFFSET_UNIT_PIXEL' | 'OFFSET_UNIT_PERCENT' | 'OFFSET_UNIT_PIXEL_FROM_CENTER' — Offset top unit for an asset. This is a read-only field if the asset displayType is ASSET_DISPLAY_TYPE_OVERLAY. Applicable to the following creative types: all RICH_MEDIA. - `mediaDuration` number, float — Detected duration for audio or video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `sslCompliant` boolean — Whether the asset is SSL-compliant. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - `role` 'PRIMARY' | 'BACKUP_IMAGE' | 'ADDITIONAL_IMAGE' | 'ADDITIONAL_FLASH' | 'PARENT_VIDEO' | 'TRANSCODED_VIDEO' | 'OTHER' | 'ALTERNATE_VIDEO' | 'PARENT_AUDIO' | 'TRANSCODED_AUDIO' — Role of the asset in relation to creative. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. This is a required field. PRIMARY applies to DISPLAY, FLASH_INPAGE, HTML5_BANNER, IMAGE, DISPLAY_IMAGE_GALLERY, all RICH_MEDIA (which may contain multiple primary assets), and all VPAID creatives. BACKUP_IMAGE applies to FLASH_INPAGE, HTML5_BANNER, all RICH_MEDIA, and all VPAID creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. ADDITIONAL_IMAGE and ADDITIONAL_FLASH apply to FLASH_INPAGE creatives. OTHER refers to assets from sources other than Campaign Manager, such as Studio uploaded assets, applicable to all RICH_MEDIA and all VPAID creatives. PARENT_VIDEO refers to videos uploaded by the user in Campaign Manager and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. TRANSCODED_VIDEO refers to videos transcoded by Campaign Manager from PARENT_VIDEO assets and is applicable to INSTREAM_VIDEO and VPAID_LINEAR_VIDEO creatives. ALTERNATE_VIDEO refers to the Campaign Manager representation of child asset videos from Studio, and is applicable to VPAID_LINEAR_VIDEO creatives. These cannot be added or removed within Campaign Manager. For VPAID_LINEAR_VIDEO creatives, PARENT_VIDEO, TRANSCODED_VIDEO and ALTERNATE_VIDEO assets that are marked active serve as backup in case the VPAID creative cannot be served. Only PARENT_VIDEO assets can be added or removed for an INSTREAM_VIDEO or VPAID_LINEAR_VIDEO creative. PARENT_AUDIO refers to audios uploaded by the user in Campaign Manager and is applicable to INSTREAM_AUDIO creatives. TRANSCODED_AUDIO refers to audios transcoded by Campaign Manager from PARENT_AUDIO assets and is applicable to INSTREAM_AUDIO creatives. - `id` string, int64 — Numeric ID of this creative asset. This is a required field and should not be modified. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - `active` boolean — Whether the video or audio asset is active. This is a read-only field for VPAID_NON_LINEAR_VIDEO assets. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `additionalSizes` Size[] — Additional sizes associated with this creative asset. HTML5 asset generated by compatible software such as GWD will be able to support more sizes this creative asset can render. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `offset` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `positionLeftUnit` 'OFFSET_UNIT_PIXEL' | 'OFFSET_UNIT_PERCENT' | 'OFFSET_UNIT_PIXEL_FROM_CENTER' — Offset left unit for an asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - `alignment` 'ALIGNMENT_TOP' | 'ALIGNMENT_RIGHT' | 'ALIGNMENT_BOTTOM' | 'ALIGNMENT_LEFT' — Possible alignments for an asset. This is a read-only field. Applicable to the following creative types: RICH_MEDIA_DISPLAY_MULTI_FLOATING_INTERSTITIAL . - `backupImageExit` CreativeCustomEvent — Creative Custom Event. - `targetType` 'TARGET_BLANK' | 'TARGET_TOP' | 'TARGET_SELF' | 'TARGET_PARENT' | 'TARGET_POPUP' — Target type used by the event. - `popupWindowProperties` PopupWindowProperties — Popup Window Properties. - `showScrollBar` boolean — Whether to display the browser scroll bar. - `showAddressBar` boolean — Whether to display the browser address bar. - `title` string — Title of popup window. - `positionType` 'CENTER' | 'COORDINATES' — Popup window position either centered or at specific coordinate. - `showToolBar` boolean — Whether to display the browser tool bar. - `showMenuBar` boolean — Whether to display the browser menu bar. - `showStatusBar` boolean — Whether to display the browser status bar. - `offset` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `dimension` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `exitClickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `id` string, int64 — ID of this event. This is a required field and should not be modified after insertion. - `advertiserCustomEventId` string, int64 — Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - `artworkLabel` string — Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - `videoReportingId` string — Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - `advertiserCustomEventType` 'ADVERTISER_EVENT_TIMER' | 'ADVERTISER_EVENT_EXIT' | 'ADVERTISER_EVENT_COUNTER' — Type of the event. This is a read-only field. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Artwork type used by the creative.This is a read-only field. - `advertiserCustomEventName` string — User-entered name for the event. - `politeLoad` boolean — Whether this asset is used as a polite load asset. - `zipFilename` string — File name of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - `streamingServingUrl` string — Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - `pushdownDuration` number, float — Pushdown duration in seconds for an asset. Applicable to the following creative types: all RICH_MEDIA.Additionally, only applicable when the asset pushdown field is true, the offsets are 0, the collapsedSize.width matches size.width, and the collapsedSize.height is less than size.height. Acceptable values are 0 to 9.99, inclusive. - `progressiveServingUrl` string — Progressive URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. - `collapsedSize` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `fileSize` string, int64 — File size associated with this creative asset. This is a read-only field. Applicable to all but the following creative types: all REDIRECT and TRACKING_TEXT. - `zipFilesize` string — Size of zip file. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - `flashVersion` integer — Flash version of the asset. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `audioBitRate` integer — Audio stream bit rate in kbps. This is a read-only field. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and all VPAID. - `expandedDimension` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `companionCreativeIds` string[] — List of companion creatives assigned to an in-stream video creative asset. Acceptable values include IDs of existing flash and image creatives. Applicable to INSTREAM_VIDEO creative type with dynamicAssetSelection set to true. - `idDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `displayType` 'ASSET_DISPLAY_TYPE_INPAGE' | 'ASSET_DISPLAY_TYPE_FLOATING' | 'ASSET_DISPLAY_TYPE_OVERLAY' | 'ASSET_DISPLAY_TYPE_EXPANDING' | 'ASSET_DISPLAY_TYPE_FLASH_IN_FLASH' | 'ASSET_DISPLAY_TYPE_FLASH_IN_FLASH_EXPANDING' | 'ASSET_DISPLAY_TYPE_PEEL_DOWN' | 'ASSET_DISPLAY_TYPE_VPAID_LINEAR' | 'ASSET_DISPLAY_TYPE_VPAID_NON_LINEAR' | 'ASSET_DISPLAY_TYPE_BACKDROP' — Type of rich media asset. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA. - `compatibility` string[] — Compatibilities associated with this creative. This is a read-only field. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering either on desktop or on mobile devices or in mobile apps for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. Only pre-existing creatives may have these compatibilities since new creatives will either be assigned DISPLAY or DISPLAY_INTERSTITIAL instead. IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. IN_STREAM_AUDIO refers to rendering in in-stream audio ads developed with the VAST standard. Applicable to all creative types. Acceptable values are: - "APP" - "APP_INTERSTITIAL" - "IN_STREAM_VIDEO" - "IN_STREAM_AUDIO" - "DISPLAY" - "DISPLAY_INTERSTITIAL" - `htmlCodeLocked` boolean — Whether HTML code is generated by Campaign Manager or manually entered. Set to true to ignore changes to htmlCode. Applicable to the following creative types: FLASH_INPAGE and HTML5_BANNER. - `overrideCss` string — Override CSS value for rich media creatives. Applicable to the following creative types: all RICH_MEDIA. - `studioTraffickedCreativeId` string, int64 — Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `convertFlashToHtml5` boolean — Whether Flash assets associated with the creative need to be automatically converted to HTML5. This flag is enabled by default and users can choose to disable it if they don't want the system to generate and use HTML5 asset for this creative. Applicable to the following creative type: FLASH_INPAGE. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `latestTraffickedCreativeId` string, int64 — Latest Studio trafficked creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `progressOffset` VideoOffset — Video Offset - `offsetPercentage` integer — Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer — Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `skipOffset` VideoOffset — Video Offset - `offsetPercentage` integer — Duration, as a percentage of video duration. Do not set when offsetSeconds is set. Acceptable values are 0 to 100, inclusive. - `offsetSeconds` integer — Duration, in seconds. Do not set when offsetPercentage is set. Acceptable values are 0 to 86399, inclusive. - `universalAdId` UniversalAdId — A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. - `value` string — ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. - `registry` 'OTHER' | 'AD_ID_OFFICIAL' | 'CLEARCAST' | 'DCM' | 'ARPP' | 'CUSV' — Registry used for the Ad ID value. - `clickTags` ClickTag[] — Click tags of the creative. For DISPLAY, FLASH_INPAGE, and HTML5_BANNER creatives, this is a subset of detected click tags for the assets associated with this creative. After creating a flash asset, detected click tags will be returned in the creativeAssetMetadata. When inserting the creative, populate the creative clickTags field using the creativeAssetMetadata.clickTags field. For DISPLAY_IMAGE_GALLERY creatives, there should be exactly one entry in this list for each image creative asset. A click tag is matched with a corresponding creative asset by matching the clickTag.name field with the creativeAsset.assetIdentifier.name field. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, FLASH_INPAGE, HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `name` string — Parameter name for the specified click tag. For DISPLAY_IMAGE_GALLERY creative assets, this field must match the value of the creative asset's creativeAssetId.name field. - `clickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `eventName` string — Advertiser event name associated with the click tag. This field is used by DISPLAY_IMAGE_GALLERY and HTML5_BANNER creatives. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `advertiserId` string, int64 — Required. Advertiser ID of this creative. This is a required field. Applicable to all creative types. - `customKeyValues` string[] — Custom key-values for a Rich Media creative. Key-values let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use key-values to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `creativeFieldAssignments` CreativeFieldAssignment[] — Creative field assignments for this creative. Applicable to all creative types. - `creativeFieldId` string, int64 — ID of the creative field. - `creativeFieldValueId` string, int64 — ID of the creative field value. - `obaIcon` ObaIcon — Online Behavioral Advertiser icon. - `yPosition` string — OBA icon y coordinate position. Accepted values are top or bottom. - `xPosition` string — OBA icon x coordinate position. Accepted values are left or right. - `size` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `resourceUrl` string — OBA icon resource URL. Campaign Manager only supports image and JavaScript icons. Learn more - `program` string — Identifies the industry initiative that the icon supports. For example, AdChoices. - `iconClickThroughUrl` string — URL to redirect to when an OBA icon is clicked. - `iconClickTrackingUrl` string — URL to track click when an OBA icon is clicked. - `iconViewTrackingUrl` string — URL to track view when an OBA icon is clicked. - `thirdPartyRichMediaImpressionsUrl` string — Third-party URL used to record rich media impressions. Applicable to the following creative types: all RICH_MEDIA. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Type of artwork used for the creative. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `exitCustomEvents` CreativeCustomEvent[] — List of exit events configured for the creative. For DISPLAY and DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags, For DISPLAY, an event is also created from the backupImageReportingLabel. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `targetType` 'TARGET_BLANK' | 'TARGET_TOP' | 'TARGET_SELF' | 'TARGET_PARENT' | 'TARGET_POPUP' — Target type used by the event. - `popupWindowProperties` PopupWindowProperties — Popup Window Properties. - `showScrollBar` boolean — Whether to display the browser scroll bar. - `showAddressBar` boolean — Whether to display the browser address bar. - `title` string — Title of popup window. - `positionType` 'CENTER' | 'COORDINATES' — Popup window position either centered or at specific coordinate. - `showToolBar` boolean — Whether to display the browser tool bar. - `showMenuBar` boolean — Whether to display the browser menu bar. - `showStatusBar` boolean — Whether to display the browser status bar. - `offset` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `dimension` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `exitClickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `id` string, int64 — ID of this event. This is a required field and should not be modified after insertion. - `advertiserCustomEventId` string, int64 — Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - `artworkLabel` string — Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - `videoReportingId` string — Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - `advertiserCustomEventType` 'ADVERTISER_EVENT_TIMER' | 'ADVERTISER_EVENT_EXIT' | 'ADVERTISER_EVENT_COUNTER' — Type of the event. This is a read-only field. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Artwork type used by the creative.This is a read-only field. - `advertiserCustomEventName` string — User-entered name for the event. - `redirectUrl` string — URL of hosted image or hosted video or another ad tag. For INSTREAM_VIDEO_REDIRECT creatives this is the in-stream video redirect URL. The standard for a VAST (Video Ad Serving Template) ad response allows for a redirect link to another VAST 2.0 or 3.0 call. This is a required field when applicable. Applicable to the following creative types: DISPLAY_REDIRECT, INTERNAL_REDIRECT, INTERSTITIAL_INTERNAL_REDIRECT, and INSTREAM_VIDEO_REDIRECT - `backupImageFeatures` string[] — List of feature dependencies that will cause a backup image to be served if the browser that serves the ad does not support them. Feature dependencies are features that a browser must be able to support in order to render your HTML5 creative asset correctly. This field is initially auto-generated to contain all features detected by Campaign Manager for all the assets of this creative and can then be modified by the client. To reset this field, copy over all the creativeAssets' detected features. Applicable to the following creative types: HTML5_BANNER. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `thirdPartyUrls` ThirdPartyTrackingUrl[] — Third-party URLs for tracking in-stream creative events. Applicable to the following creative types: all INSTREAM_VIDEO, all INSTREAM_AUDIO, and all VPAID. - `thirdPartyUrlType` 'IMPRESSION' | 'CLICK_TRACKING' | 'VIDEO_START' | 'VIDEO_FIRST_QUARTILE' | 'VIDEO_MIDPOINT' | 'VIDEO_THIRD_QUARTILE' | 'VIDEO_COMPLETE' | 'VIDEO_MUTE' | 'VIDEO_PAUSE' | 'VIDEO_REWIND' | 'VIDEO_FULLSCREEN' | 'VIDEO_STOP' | 'VIDEO_CUSTOM' | 'SURVEY' | 'RICH_MEDIA_IMPRESSION' | 'RICH_MEDIA_RM_IMPRESSION' | 'RICH_MEDIA_BACKUP_IMPRESSION' | 'VIDEO_SKIP' | 'VIDEO_PROGRESS' — Third-party URL type for in-stream video and in-stream audio creatives. - `url` string — URL for the specified third-party URL type. - `backupImageClickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `thirdPartyBackupImageImpressionsUrl` string — Third-party URL used to record backup image impressions. Applicable to the following creative types: all RICH_MEDIA. - `authoringTool` 'NINJA' | 'SWIFFY' — Authoring tool for HTML5 banner creatives. This is a read-only field. Applicable to the following creative types: HTML5_BANNER. - `subaccountId` string, int64 — Subaccount ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - `authoringSource` 'CREATIVE_AUTHORING_SOURCE_DCM' | 'CREATIVE_AUTHORING_SOURCE_DBM' | 'CREATIVE_AUTHORING_SOURCE_STUDIO' | 'CREATIVE_AUTHORING_SOURCE_GWD' | 'CREATIVE_AUTHORING_SOURCE_ACS' | 'CREATIVE_AUTHORING_SOURCE_ADOBE' | 'CREATIVE_AUTHORING_SOURCE_TYPEFACE_AI' | 'CREATIVE_AUTHORING_SOURCE_REMBRAND' | 'CREATIVE_AUTHORING_SOURCE_TRACKTO_STUDIO' | 'CREATIVE_AUTHORING_SOURCE_BORNLOGIC' | 'CREATIVE_AUTHORING_SOURCE_BEGEN_AI' — Source application where creative was authored. Presently, only DBM authored creatives will have this field set. Applicable to all creative types. - `id` string, int64 — ID of this creative. This is a read-only, auto-generated field. Applicable to all creative types. - `backgroundColor` string — The 6-character HTML color code, beginning with #, for the background of the window area where the Flash file is displayed. Default is white. Applicable to the following creative types: FLASH_INPAGE. - `renderingId` string, int64 — ID of current rendering version. This is a read-only field. Applicable to all creative types. - `active` boolean — Whether the creative is active. Applicable to all creative types. - `additionalSizes` Size[] — Additional sizes associated with a responsive creative. When inserting or updating a creative either the size ID field or size width and height fields can be used. Applicable to DISPLAY creatives when the primary asset type is HTML_IMAGE. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `version` integer — The version number helps you keep track of multiple versions of your creative in your reports. The version number will always be auto-generated during insert operations to start at 1. For tracking creatives the version cannot be incremented and will always remain at 1. For all other creative types the version can be incremented only by 1 during update operations. In addition, the version will be automatically incremented by 1 when undergoing Rich Media creative merging. Applicable to all creative types. - `autoAdvanceImages` boolean — Whether images are automatically advanced for image gallery creatives. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY. - `requiredFlashVersion` integer — The internal Flash version for this creative as calculated by Studio. This is a read-only field. Applicable to the following creative types: FLASH_INPAGE all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset type is not HTML_IMAGE. - `mediaDuration` number, float — Creative audio or video duration in seconds. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO, INSTREAM_AUDIO, all RICH_MEDIA, and all VPAID. - `sslCompliant` boolean — Whether the creative is SSL-compliant. This is a read-only field. Applicable to all creative types. - `accountId` string, int64 — Account ID of this creative. This field, if left unset, will be auto-generated for both insert and update operations. Applicable to all creative types. - `name` string — Required. Name of the creative. This must be less than 256 characters long. Applicable to all creative types. - `backupImageTargetWindow` TargetWindow — Target Window. - `targetWindowOption` 'NEW_WINDOW' | 'CURRENT_WINDOW' | 'CUSTOM' — Type of browser window for which the backup image of the flash creative can be displayed. - `customHtml` string — User-entered value. - `sslOverride` boolean — Whether creative should be treated as SSL compliant even if the system scan shows it's not. Applicable to all creative types. - `adParameters` string — Ad parameters user for VPAID creative. This is a read-only field. Applicable to the following creative types: all VPAID. - `fsCommand` FsCommand — FsCommand. - `windowHeight` integer — Height of the window. - `positionOption` 'CENTERED' | 'DISTANCE_FROM_TOP_LEFT_CORNER' — Position in the browser where the window will open. - `left` integer — Distance from the left of the browser.Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - `windowWidth` integer — Width of the window. - `top` integer — Distance from the top of the browser. Applicable when positionOption is DISTANCE_FROM_TOP_LEFT_CORNER. - `allowScriptAccess` boolean — Whether script access is allowed for this creative. This is a read-only and deprecated field which will automatically be set to true on update. Applicable to the following creative types: FLASH_INPAGE. - `mediaDescription` string — Description of the audio or video ad. Applicable to the following creative types: all INSTREAM_VIDEO, INSTREAM_AUDIO, and all VPAID. - `renderingIdDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `requiredFlashPluginVersion` string — The minimum required Flash plugin version for this creative. For example, 11.2.202.235. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `commercialId` string — Industry standard ID assigned to creative for reach and frequency. Applicable to INSTREAM_VIDEO_REDIRECT creatives. - `idDimensionValue` DimensionValue — Represents a DimensionValue resource. - `id` string — The ID associated with the value if available. - `dimensionName` string — The name of the dimension. - `value` string — The value of the dimension. - `matchType` 'EXACT' | 'BEGINS_WITH' | 'CONTAINS' | 'WILDCARD_EXPRESSION' — Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. - `kind` string — The kind of resource this is, in this case dfareporting#dimensionValue. - `etag` string — The eTag of this response for caching purposes. - `adTagKeys` string[] — Keywords for a Rich Media creative. Keywords let you customize the creative settings of a Rich Media ad running on your site without having to contact the advertiser. You can use keywords to dynamically change the look or functionality of a creative. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `timerCustomEvents` CreativeCustomEvent[] — List of timer events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. Applicable to DISPLAY when the primary asset is not HTML_IMAGE. - `targetType` 'TARGET_BLANK' | 'TARGET_TOP' | 'TARGET_SELF' | 'TARGET_PARENT' | 'TARGET_POPUP' — Target type used by the event. - `popupWindowProperties` PopupWindowProperties — Popup Window Properties. - `showScrollBar` boolean — Whether to display the browser scroll bar. - `showAddressBar` boolean — Whether to display the browser address bar. - `title` string — Title of popup window. - `positionType` 'CENTER' | 'COORDINATES' — Popup window position either centered or at specific coordinate. - `showToolBar` boolean — Whether to display the browser tool bar. - `showMenuBar` boolean — Whether to display the browser menu bar. - `showStatusBar` boolean — Whether to display the browser status bar. - `offset` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `dimension` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `exitClickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `id` string, int64 — ID of this event. This is a required field and should not be modified after insertion. - `advertiserCustomEventId` string, int64 — Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - `artworkLabel` string — Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - `videoReportingId` string — Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - `advertiserCustomEventType` 'ADVERTISER_EVENT_TIMER' | 'ADVERTISER_EVENT_EXIT' | 'ADVERTISER_EVENT_COUNTER' — Type of the event. This is a read-only field. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Artwork type used by the creative.This is a read-only field. - `advertiserCustomEventName` string — User-entered name for the event. - `skippable` boolean — Whether the user can choose to skip the creative. Applicable to the following creative types: all INSTREAM_VIDEO and all VPAID. - `counterCustomEvents` CreativeCustomEvent[] — List of counter events configured for the creative. For DISPLAY_IMAGE_GALLERY creatives, these are read-only and auto-generated from clickTags. Applicable to the following creative types: DISPLAY_IMAGE_GALLERY, all RICH_MEDIA, and all VPAID. - `targetType` 'TARGET_BLANK' | 'TARGET_TOP' | 'TARGET_SELF' | 'TARGET_PARENT' | 'TARGET_POPUP' — Target type used by the event. - `popupWindowProperties` PopupWindowProperties — Popup Window Properties. - `showScrollBar` boolean — Whether to display the browser scroll bar. - `showAddressBar` boolean — Whether to display the browser address bar. - `title` string — Title of popup window. - `positionType` 'CENTER' | 'COORDINATES' — Popup window position either centered or at specific coordinate. - `showToolBar` boolean — Whether to display the browser tool bar. - `showMenuBar` boolean — Whether to display the browser menu bar. - `showStatusBar` boolean — Whether to display the browser status bar. - `offset` OffsetPosition — Offset Position. - `left` integer — Offset distance from left side of an asset or a window. - `top` integer — Offset distance from top side of an asset or a window. - `dimension` Size — Represents the dimensions of ads, placements, creatives, or creative assets. - `kind` string — Identifies what kind of resource this is. Value: the fixed string "dfareporting#size". - `id` string, int64 — ID of this size. This is a read-only, auto-generated field. - `width` integer — Width of this size. Acceptable values are 0 to 32767, inclusive. - `height` integer — Height of this size. Acceptable values are 0 to 32767, inclusive. - `iab` boolean — IAB standard size. This is a read-only, auto-generated field. - `exitClickThroughUrl` CreativeClickThroughUrl — Click-through URL - `computedClickThroughUrl` string — Read-only convenience field representing the actual URL that will be used for this click-through. The URL is computed as follows: - If landingPageId is specified then that landing page's URL is assigned to this field. - Otherwise, the customClickThroughUrl is assigned to this field. - `landingPageId` string, int64 — ID of the landing page for the click-through URL. - `customClickThroughUrl` string — Custom click-through URL. Applicable if the landingPageId field is left unset. - `id` string, int64 — ID of this event. This is a required field and should not be modified after insertion. - `advertiserCustomEventId` string, int64 — Unique ID of this event used by Reporting and Data Transfer. This is a read-only field. - `artworkLabel` string — Artwork label column, used to link events in Campaign Manager back to events in Studio. This is a required field and should not be modified after insertion. - `videoReportingId` string — Video reporting ID, used to differentiate multiple videos in a single creative. This is a read-only field. - `advertiserCustomEventType` 'ADVERTISER_EVENT_TIMER' | 'ADVERTISER_EVENT_EXIT' | 'ADVERTISER_EVENT_COUNTER' — Type of the event. This is a read-only field. - `artworkType` 'ARTWORK_TYPE_FLASH' | 'ARTWORK_TYPE_HTML5' | 'ARTWORK_TYPE_MIXED' | 'ARTWORK_TYPE_IMAGE' — Artwork type used by the creative.This is a read-only field. - `advertiserCustomEventName` string — User-entered name for the event. - `studioAdvertiserId` string, int64 — Studio advertiser ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `studioCreativeId` string, int64 — Studio creative ID associated with rich media and VPAID creatives. This is a read-only field. Applicable to the following creative types: all RICH_MEDIA, and all VPAID. - `archived` boolean — Whether the creative is archived. Applicable to all creative types. - `companionCreatives` string[] — List of companion creatives assigned to an in-Stream video creative. Acceptable values include IDs of existing flash and image creatives. Applicable to the following creative types: all VPAID, all INSTREAM_AUDIO and all INSTREAM_VIDEO with dynamicAssetSelection set to false. ## Response `200` Successful response --- [API](https://skmtc.net/google/apis/dfareporting.md) · [All operations](https://skmtc.net/google/apis/dfareporting/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/google/dfareporting/revisions/8163d57aeb31/schema)