docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/displayvideo_v1.advertisers.creatives.html b/docs/dyn/displayvideo_v1.advertisers.creatives.html
index 56cf310..14491d8 100644
--- a/docs/dyn/displayvideo_v1.advertisers.creatives.html
+++ b/docs/dyn/displayvideo_v1.advertisers.creatives.html
@@ -104,24 +104,338 @@
The object takes the form of:
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -131,15 +445,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -151,6 +469,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -183,20 +504,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -264,331 +585,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
}
x__xgafv: string, V1 error format.
@@ -600,24 +600,338 @@
An object of the form:
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -627,15 +941,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -647,6 +965,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -679,20 +1000,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -760,331 +1081,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
}</pre>
</div>
@@ -1135,24 +1135,338 @@
An object of the form:
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -1162,15 +1476,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -1182,6 +1500,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -1214,20 +1535,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -1295,331 +1616,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
}</pre>
</div>
@@ -1713,24 +1713,338 @@
#
# This list will be absent if empty.
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -1740,15 +2054,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -1760,6 +2078,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -1792,20 +2113,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -1873,331 +2194,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
@@ -2234,24 +2234,338 @@
The object takes the form of:
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -2261,15 +2575,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -2281,6 +2599,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -2313,20 +2634,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -2394,331 +2715,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
}
updateMask: string, Required. The mask to control which fields to update.
@@ -2731,24 +2731,338 @@
An object of the form:
{ # A single Creative.
- "counterEvents": [ # Counter events for a rich media creative.
- # Counters track the number of times that a user interacts with any part of a
- # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
- # taps, data loading, keyboard entries, etc.).
- # Any event that can be captured in the creative can be recorded as a
- # counter.
- # Leave it empty or unset for creatives containing image assets only.
- { # Counter event of the creative.
- "reportingName": "A String", # Required. The name used to identify this counter event in reports.
- "name": "A String", # Required. The name of the counter event.
+ "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
+ "A String",
+ ],
+ "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
+ "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
+ #
+ # Accepted values are:
+ #
+ # * `ENTITY_STATUS_ACTIVE`
+ # * `ENTITY_STATUS_ARCHIVED`
+ # * `ENTITY_STATUS_PAUSED`
+ "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
+ #
+ # This field is required when skippable is true.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "percentage": "A String", # The offset in percentage of the audio or video duration.
+ "seconds": "A String", # The offset in seconds from the start of the audio or video.
+ },
+ "requireHtml5": True or 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`
+ "name": "A String", # Output only. The resource name of the creative.
+ "skippable": True or False, # Whether the user can choose to skip a video creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
+ # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
+ # supported.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
+ # creative.
+ #
+ # This field is only supported for the following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_AUDIO`
+ # * `CREATIVE_TYPE_VIDEO`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ { # Tracking URLs from third parties to track interactions with an audio or a
+ # video creative.
+ "type": "A String", # The type of interaction needs to be tracked by the tracking URL
+ "url": "A String", # Tracking URL used to track the interaction.
+ #
+ # Provide a URL with optional path or query string, beginning with `https:`.
+ # For example, https://www.example.com/path
},
],
+ "expandOnHover": True or 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`
+ "exitEvents": [ # Required. Exit events for this creative.
+ # An exit (also known as a click tag) is any area in your creative that
+ # someone can click or tap to open an advertiser's landing page.
+ # Every creative must include at least one exit.
+ # You can add an exit to your creative in any of the following ways:
+ #
+ # * Use Google Web Designer's tap area.
+ # * Define a JavaScript variable called "clickTag".
+ # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
+ { # Exit event of the creative.
+ "url": "A String", # Required. The click through URL of the exit event.
+ # This is required when type is:
+ #
+ # * `EXIT_EVENT_TYPE_DEFAULT`
+ # * `EXIT_EVENT_TYPE_BACKUP`
+ "name": "A String", # The name of the click tag of the exit event.
+ #
+ # The name must be unique within one creative.
+ #
+ # Leave it empty or unset for creatives containing image assets only.
+ "type": "A String", # Required. The type of the exit event.
+ "reportingName": "A String", # The name used to identify this event in reports.
+ # Leave it empty or unset for creatives containing image assets only.
+ },
+ ],
+ "additionalDimensions": [ # Additional dimensions.
+ # Applicable when creative_type is one of:
+ #
+ # * `CREATIVE_TYPE_STANDARD`
+ # * `CREATIVE_TYPE_EXPANDABLE`
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_LIGHTBOX`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
+ #
+ # If this field is specified, width_pixels and
+ # height_pixels are both required and must be
+ # greater than or equal to 0.
+ { # Dimensions.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ ],
+ "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
+ # the system.
+ "trackerUrls": [ # 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 supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_NATIVE`
+ # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
+ # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
+ # * `CREATIVE_TYPE_NATIVE_VIDEO`
+ "A String",
+ ],
+ "iasCampaignMonitoring": True or False, # 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.
+ "integrationCode": "A String", # 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.
+ "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
+ # creative.
+ # This field is only applicable for creatives that are synced from Campaign
+ # Manager.
+ "requireMraid": True or False, # 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`
+ "companionCreativeIds": [ # 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`
+ "A String",
+ ],
+ "creativeType": "A String", # Required. Immutable. The type of the creative.
+ "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
+ #
+ # This field is only supported in following
+ # creative_type:
+ #
+ # * `CREATIVE_TYPE_VIDEO`
+ "dimensions": { # Dimensions. # The dimensions of the OBA icon.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
+ "viewTrackingUrl": "A String", # 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
+ "clickTrackingUrl": "A String", # 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
+ "position": "A String", # The position of the OBA icon on the creative.
+ "resourceUrl": "A String", # The URL of the OBA icon resource.
+ "landingPageUrl": "A String", # 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
+ "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
+ },
+ "timerEvents": [ # Timer custom events for a rich media creative.
+ # Timers track the time during which a user views and interacts with a
+ # specified part of a rich media creative.
+ # A creative can have multiple timer events, each timed independently.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Timer event of the creative.
+ "name": "A String", # Required. The name of the timer event.
+ "reportingName": "A String", # Required. The name used to identify this timer event in reports.
+ },
+ ],
+ "notes": "A String", # User notes for this creative.
+ # Must be UTF-8 encoded with a length of no more than 20,000 characters.
+ "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
+ "assets": [ # Required. Assets associated to this creative.
+ # Assets can be associated to the creative in one of following roles:
+ #
+ # * `ASSET_ROLE_UNSPECIFIED`
+ # * `ASSET_ROLE_MAIN`
+ # * `ASSET_ROLE_BACKUP`
+ # * `ASSET_ROLE_POLITE_LOAD`
+ { # Asset association for the creative.
+ "asset": { # A single asset. # The associated asset.
+ "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
+ # This ID can be passed to other API calls, e.g.
+ # CreateCreative to associate
+ # the asset with a creative.
+ "content": "A String", # The asset content.
+ # For uploaded assets, the content is the serving path.
+ },
+ "role": "A String", # The role of this asset for the creative.
+ },
+ ],
+ "vpaid": True or False, # 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`
+ "expandingDirection": "A String", # 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`
+ "thirdPartyTag": "A String", # 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`
+ "displayName": "A String", # Required. The display name of the creative.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "hostingSource": "A String", # Required. Indicates where the creative is hosted.
+ "mediaDuration": "A String", # 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`
+ "vastTagUrl": "A String", # 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_VIDEO`
"reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process.
+ "approvalStatus": "A String", # 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.
"creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative.
"exchangeReviewStatuses": [ # Exchange review statuses for the creative.
{ # Exchange review status for the creative.
- "exchange": "A String", # The exchange reviewing the creative.
"status": "A String", # Status of the exchange review.
+ "exchange": "A String", # The exchange reviewing the creative.
},
],
"contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative.
@@ -2758,15 +3072,19 @@
"publisherName": "A String", # The publisher reviewing the creative.
},
],
- "approvalStatus": "A String", # 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.
},
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
- "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
- # the system.
+ "counterEvents": [ # Counter events for a rich media creative.
+ # Counters track the number of times that a user interacts with any part of a
+ # rich media creative in a specified way (mouse-overs, mouse-outs, clicks,
+ # taps, data loading, keyboard entries, etc.).
+ # Any event that can be captured in the creative can be recorded as a
+ # counter.
+ # Leave it empty or unset for creatives containing image assets only.
+ { # Counter event of the creative.
+ "name": "A String", # Required. The name of the counter event.
+ "reportingName": "A String", # Required. The name used to identify this counter event in reports.
+ },
+ ],
"progressOffset": { # The length an audio or a video has been played. # Amount of time to play the video before counting a view.
#
# This field is required when skippable is true.
@@ -2778,6 +3096,9 @@
"percentage": "A String", # The offset in percentage of the audio or video duration.
"seconds": "A String", # The offset in seconds from the start of the audio or video.
},
+ "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by
+ # the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to.
"universalAdId": { # A creative identifier provided by a registry that is unique across all # Optional. An optional creative identifier provided by a registry that is unique
# across all platforms.
#
@@ -2810,20 +3131,20 @@
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_AUDIO`
{ # Represents information about the transcoded audio or video file.
+ "mimeType": "A String", # The MIME type of the transcoded file.
+ "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
+ "dimensions": { # Dimensions. # The dimensions of the transcoded video.
+ "heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
+ },
+ "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
+ "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
+ # rate for the transcoded audio, in hertz.
"transcoded": True or False, # Indicates if the transcoding was successful.
"audioBitRateKbps": "A String", # The bit rate for the audio stream of the transcoded video, or the bit rate
# for the transcoded audio, in kilobits per second.
"fileSizeBytes": "A String", # The size of the transcoded file, in bytes.
"name": "A String", # The name of the transcoded file.
- "mimeType": "A String", # The MIME type of the transcoded file.
- "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second.
- "dimensions": { # Dimensions. # The dimensions of the transcoded video.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second.
- "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample
- # rate for the transcoded audio, in hertz.
},
],
"cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative.
@@ -2891,331 +3212,10 @@
# * `CREATIVE_TYPE_AUDIO`
# * `CREATIVE_TYPE_NATIVE_VIDEO`
# * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO`
- "widthPixels": 42, # The width in pixels.
"heightPixels": 42, # The height in pixels.
+ "widthPixels": 42, # The width in pixels.
},
"appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag.
- "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system.
- "A String",
- ],
- "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system.
- "entityStatus": "A String", # Required. Controls whether or not the creative can serve.
- #
- # Accepted values are:
- #
- # * `ENTITY_STATUS_ACTIVE`
- # * `ENTITY_STATUS_ARCHIVED`
- # * `ENTITY_STATUS_PAUSED`
- "skipOffset": { # The length an audio or a video has been played. # Amount of time to play the video before the skip button appears.
- #
- # This field is required when skippable is true.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "percentage": "A String", # The offset in percentage of the audio or video duration.
- "seconds": "A String", # The offset in seconds from the start of the audio or video.
- },
- "requireHtml5": True or 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`
- "name": "A String", # Output only. The resource name of the creative.
- "skippable": True or False, # Whether the user can choose to skip a video creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "jsTrackerUrl": "A String", # JavaScript measurement URL from supported third-party verification
- # providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not
- # supported.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "thirdPartyUrls": [ # Tracking URLs from third parties to track interactions with a video
- # creative.
- #
- # This field is only supported for the following
- # creative_type:
- #
- # * `CREATIVE_TYPE_AUDIO`
- # * `CREATIVE_TYPE_VIDEO`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- { # Tracking URLs from third parties to track interactions with an audio or a
- # video creative.
- "url": "A String", # Tracking URL used to track the interaction.
- #
- # Provide a URL with optional path or query string, beginning with `https:`.
- # For example, https://www.example.com/path
- "type": "A String", # The type of interaction needs to be tracked by the tracking URL
- },
- ],
- "expandOnHover": True or 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`
- "trackerUrls": [ # 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 supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_NATIVE_VIDEO`
- "A String",
- ],
- "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by
- # the system.
- "additionalDimensions": [ # Additional dimensions.
- # Applicable when creative_type is one of:
- #
- # * `CREATIVE_TYPE_STANDARD`
- # * `CREATIVE_TYPE_EXPANDABLE`
- # * `CREATIVE_TYPE_NATIVE`
- # * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`
- # * `CREATIVE_TYPE_LIGHTBOX`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL`
- # * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE`
- # * `CREATIVE_TYPE_PUBLISHER_HOSTED`
- #
- # If this field is specified, width_pixels and
- # height_pixels are both required and must be
- # greater than or equal to 0.
- { # Dimensions.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- ],
- "exitEvents": [ # Required. Exit events for this creative.
- # An exit (also known as a click tag) is any area in your creative that
- # someone can click or tap to open an advertiser's landing page.
- # Every creative must include at least one exit.
- # You can add an exit to your creative in any of the following ways:
- #
- # * Use Google Web Designer's tap area.
- # * Define a JavaScript variable called "clickTag".
- # * Use the Enabler (Enabler.exit()) to track exits in rich media formats.
- { # Exit event of the creative.
- "name": "A String", # The name of the click tag of the exit event.
- #
- # The name must be unique within one creative.
- #
- # Leave it empty or unset for creatives containing image assets only.
- "type": "A String", # Required. The type of the exit event.
- "reportingName": "A String", # The name used to identify this event in reports.
- # Leave it empty or unset for creatives containing image assets only.
- "url": "A String", # Required. The click through URL of the exit event.
- # This is required when type is:
- #
- # * `EXIT_EVENT_TYPE_DEFAULT`
- # * `EXIT_EVENT_TYPE_BACKUP`
- },
- ],
- "iasCampaignMonitoring": True or False, # 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.
- "integrationCode": "A String", # 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.
- "cmPlacementId": "A String", # Output only. The unique ID of the Campaign Manager placement associated with the
- # creative.
- # This field is only applicable for creatives that are synced from Campaign
- # Manager.
- "requireMraid": True or False, # 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`
- "companionCreativeIds": [ # 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`
- "A String",
- ],
- "creativeType": "A String", # Required. Immutable. The type of the creative.
- "obaIcon": { # OBA Icon for a Creative # Specifies the OBA icon for a video creative.
- #
- # This field is only supported in following
- # creative_type:
- #
- # * `CREATIVE_TYPE_VIDEO`
- "viewTrackingUrl": "A String", # 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
- "position": "A String", # The position of the OBA icon on the creative.
- "clickTrackingUrl": "A String", # 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
- "resourceUrl": "A String", # The URL of the OBA icon resource.
- "landingPageUrl": "A String", # 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
- "program": "A String", # The program of the OBA icon. For example: “AdChoices”.
- "resourceMimeType": "A String", # The MIME type of the OBA icon resource.
- "dimensions": { # Dimensions. # The dimensions of the OBA icon.
- "widthPixels": 42, # The width in pixels.
- "heightPixels": 42, # The height in pixels.
- },
- },
- "timerEvents": [ # Timer custom events for a rich media creative.
- # Timers track the time during which a user views and interacts with a
- # specified part of a rich media creative.
- # A creative can have multiple timer events, each timed independently.
- # Leave it empty or unset for creatives containing image assets only.
- { # Timer event of the creative.
- "reportingName": "A String", # Required. The name used to identify this timer event in reports.
- "name": "A String", # Required. The name of the timer event.
- },
- ],
- "notes": "A String", # User notes for this creative.
- # Must be UTF-8 encoded with a length of no more than 20,000 characters.
- "dynamic": True or False, # Output only. Indicates whether the creative is dynamic.
- "assets": [ # Required. Assets associated to this creative.
- # Assets can be associated to the creative in one of following roles:
- #
- # * `ASSET_ROLE_UNSPECIFIED`
- # * `ASSET_ROLE_MAIN`
- # * `ASSET_ROLE_BACKUP`
- # * `ASSET_ROLE_POLITE_LOAD`
- { # Asset association for the creative.
- "asset": { # A single asset. # The associated asset.
- "mediaId": "A String", # Media ID of the uploaded asset. This is a unique identifier for the asset.
- # This ID can be passed to other API calls, e.g.
- # CreateCreative to associate
- # the asset with a creative.
- "content": "A String", # The asset content.
- # For uploaded assets, the content is the serving path.
- },
- "role": "A String", # The role of this asset for the creative.
- },
- ],
- "vpaid": True or False, # 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`
- "expandingDirection": "A String", # 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`
- "thirdPartyTag": "A String", # 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`
- "displayName": "A String", # Required. The display name of the creative.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "hostingSource": "A String", # Required. Indicates where the creative is hosted.
- "vastTagUrl": "A String", # 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_VIDEO`
- "mediaDuration": "A String", # 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`
}</pre>
</div>