| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.creatives.html">creatives</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 79 | <p class="firstline">Creates a new creative. Returns the newly created creative if successful.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(advertiserId, creativeId, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 82 | <p class="firstline">Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(advertiserId, creativeId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets a creative.</p> |
| 86 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 87 | <code><a href="#list">list(advertiserId, filter=None, pageToken=None, pageSize=None, orderBy=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#patch">patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 94 | <p class="firstline">Updates an existing creative. Returns the updated creative if successful.</p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 98 | <pre>Creates a new creative. Returns the newly created creative if successful. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 99 | |
| 100 | Args: |
| 101 | advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required) |
| 102 | body: object, The request body. |
| 103 | The object takes the form of: |
| 104 | |
| 105 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 106 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 107 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 108 | "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` |
| 109 | "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 |
| 110 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 111 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 112 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 113 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 114 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 115 | "heightPixels": 42, # The height in pixels. |
| 116 | "widthPixels": 42, # The width in pixels. |
| 117 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 118 | "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 |
| 119 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 120 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 121 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 122 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 123 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 124 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 125 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 126 | { # Publisher review status for the creative. |
| 127 | "status": "A String", # Status of the publisher review. |
| 128 | "publisherName": "A String", # The publisher reviewing the creative. |
| 129 | }, |
| 130 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 131 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 132 | "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. |
| 133 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 134 | { # Exchange review status for the creative. |
| 135 | "status": "A String", # Status of the exchange review. |
| 136 | "exchange": "A String", # The exchange reviewing the creative. |
| 137 | }, |
| 138 | ], |
| 139 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 140 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 141 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 142 | "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` |
| 143 | { # Asset association for the creative. |
| 144 | "role": "A String", # The role of this asset for the creative. |
| 145 | "asset": { # A single asset. # The associated asset. |
| 146 | "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. |
| 147 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 148 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 149 | }, |
| 150 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 151 | "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` |
| 152 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 153 | "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 |
| 154 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 155 | }, |
| 156 | ], |
| 157 | "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` |
| 158 | "A String", |
| 159 | ], |
| 160 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 161 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 162 | "name": "A String", # Output only. The resource name of the creative. |
| 163 | "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` |
| 164 | "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. |
| 165 | { # Timer event of the creative. |
| 166 | "name": "A String", # Required. The name of the timer event. |
| 167 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 168 | }, |
| 169 | ], |
| 170 | "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` |
| 171 | "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. |
| 172 | { # Counter event of the creative. |
| 173 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 174 | "name": "A String", # Required. The name of the counter event. |
| 175 | }, |
| 176 | ], |
| 177 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 178 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 179 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 180 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 181 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 182 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 183 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 184 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 185 | }, |
| 186 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 187 | "heightPixels": 42, # The height in pixels. |
| 188 | "widthPixels": 42, # The width in pixels. |
| 189 | }, |
| 190 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 191 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 192 | "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. |
| 193 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 194 | "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` |
| 195 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 196 | "A String", |
| 197 | ], |
| 198 | "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` |
| 199 | "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` |
| 200 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 201 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 202 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | "name": "A String", # The name of the transcoded file. |
| 204 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 205 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 206 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 207 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 208 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 209 | "heightPixels": 42, # The height in pixels. |
| 210 | "widthPixels": 42, # The width in pixels. |
| 211 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 212 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 213 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 214 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | }, |
| 216 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 217 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 218 | "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` |
| 219 | "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` |
| 220 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 221 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 222 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 223 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 224 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 225 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 226 | "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. |
| 227 | { # Exit event of the creative. |
| 228 | "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` |
| 229 | "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. |
| 230 | "type": "A String", # Required. The type of the exit event. |
| 231 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 232 | }, |
| 233 | ], |
| 234 | "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. |
| 235 | { # Dimensions. |
| 236 | "heightPixels": 42, # The height in pixels. |
| 237 | "widthPixels": 42, # The width in pixels. |
| 238 | }, |
| 239 | ], |
| 240 | "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. |
| 241 | "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. |
| 242 | "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` |
| 243 | "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` |
| 244 | "A String", |
| 245 | ], |
| 246 | "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` |
| 247 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 248 | "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` |
| 249 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 250 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 251 | }, |
| 252 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 253 | } |
| 254 | |
| 255 | x__xgafv: string, V1 error format. |
| 256 | Allowed values |
| 257 | 1 - v1 error format |
| 258 | 2 - v2 error format |
| 259 | |
| 260 | Returns: |
| 261 | An object of the form: |
| 262 | |
| 263 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 264 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 265 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 266 | "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` |
| 267 | "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 |
| 268 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 269 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 270 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 271 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 272 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 273 | "heightPixels": 42, # The height in pixels. |
| 274 | "widthPixels": 42, # The width in pixels. |
| 275 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 276 | "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 |
| 277 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 278 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 279 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 280 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 281 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 284 | { # Publisher review status for the creative. |
| 285 | "status": "A String", # Status of the publisher review. |
| 286 | "publisherName": "A String", # The publisher reviewing the creative. |
| 287 | }, |
| 288 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 289 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 290 | "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. |
| 291 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 292 | { # Exchange review status for the creative. |
| 293 | "status": "A String", # Status of the exchange review. |
| 294 | "exchange": "A String", # The exchange reviewing the creative. |
| 295 | }, |
| 296 | ], |
| 297 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 299 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 300 | "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` |
| 301 | { # Asset association for the creative. |
| 302 | "role": "A String", # The role of this asset for the creative. |
| 303 | "asset": { # A single asset. # The associated asset. |
| 304 | "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. |
| 305 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 306 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 307 | }, |
| 308 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 309 | "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` |
| 310 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 311 | "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 |
| 312 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 313 | }, |
| 314 | ], |
| 315 | "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` |
| 316 | "A String", |
| 317 | ], |
| 318 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 319 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 320 | "name": "A String", # Output only. The resource name of the creative. |
| 321 | "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` |
| 322 | "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. |
| 323 | { # Timer event of the creative. |
| 324 | "name": "A String", # Required. The name of the timer event. |
| 325 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 326 | }, |
| 327 | ], |
| 328 | "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` |
| 329 | "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. |
| 330 | { # Counter event of the creative. |
| 331 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 332 | "name": "A String", # Required. The name of the counter event. |
| 333 | }, |
| 334 | ], |
| 335 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 336 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 337 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 338 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 339 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 340 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 341 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 342 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 343 | }, |
| 344 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 345 | "heightPixels": 42, # The height in pixels. |
| 346 | "widthPixels": 42, # The width in pixels. |
| 347 | }, |
| 348 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 349 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 350 | "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. |
| 351 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 352 | "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` |
| 353 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 354 | "A String", |
| 355 | ], |
| 356 | "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` |
| 357 | "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` |
| 358 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 359 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 361 | "name": "A String", # The name of the transcoded file. |
| 362 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 363 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 364 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 365 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 366 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 367 | "heightPixels": 42, # The height in pixels. |
| 368 | "widthPixels": 42, # The width in pixels. |
| 369 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 370 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 371 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 372 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | }, |
| 374 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 375 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 376 | "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` |
| 377 | "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` |
| 378 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 380 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 381 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 382 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 383 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 384 | "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. |
| 385 | { # Exit event of the creative. |
| 386 | "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` |
| 387 | "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. |
| 388 | "type": "A String", # Required. The type of the exit event. |
| 389 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 390 | }, |
| 391 | ], |
| 392 | "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. |
| 393 | { # Dimensions. |
| 394 | "heightPixels": 42, # The height in pixels. |
| 395 | "widthPixels": 42, # The width in pixels. |
| 396 | }, |
| 397 | ], |
| 398 | "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. |
| 399 | "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. |
| 400 | "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` |
| 401 | "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` |
| 402 | "A String", |
| 403 | ], |
| 404 | "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` |
| 405 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 406 | "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` |
| 407 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 408 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 409 | }, |
| 410 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 411 | }</pre> |
| 412 | </div> |
| 413 | |
| 414 | <div class="method"> |
| 415 | <code class="details" id="delete">delete(advertiserId, creativeId, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 416 | <pre>Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | |
| 418 | Args: |
| 419 | advertiserId: string, The ID of the advertiser this creative belongs to. (required) |
| 420 | creativeId: string, The ID of the creative to be deleted. (required) |
| 421 | x__xgafv: string, V1 error format. |
| 422 | Allowed values |
| 423 | 1 - v1 error format |
| 424 | 2 - v2 error format |
| 425 | |
| 426 | Returns: |
| 427 | An object of the form: |
| 428 | |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 429 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 430 | }</pre> |
| 431 | </div> |
| 432 | |
| 433 | <div class="method"> |
| 434 | <code class="details" id="get">get(advertiserId, creativeId, x__xgafv=None)</code> |
| 435 | <pre>Gets a creative. |
| 436 | |
| 437 | Args: |
| 438 | advertiserId: string, Required. The ID of the advertiser this creative belongs to. (required) |
| 439 | creativeId: string, Required. The ID of the creative to fetch. (required) |
| 440 | x__xgafv: string, V1 error format. |
| 441 | Allowed values |
| 442 | 1 - v1 error format |
| 443 | 2 - v2 error format |
| 444 | |
| 445 | Returns: |
| 446 | An object of the form: |
| 447 | |
| 448 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 449 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 450 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 451 | "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` |
| 452 | "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 |
| 453 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 454 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 455 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 456 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 457 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 458 | "heightPixels": 42, # The height in pixels. |
| 459 | "widthPixels": 42, # The width in pixels. |
| 460 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 461 | "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 |
| 462 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 463 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 464 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 465 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 466 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 468 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 469 | { # Publisher review status for the creative. |
| 470 | "status": "A String", # Status of the publisher review. |
| 471 | "publisherName": "A String", # The publisher reviewing the creative. |
| 472 | }, |
| 473 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 474 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 475 | "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. |
| 476 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 477 | { # Exchange review status for the creative. |
| 478 | "status": "A String", # Status of the exchange review. |
| 479 | "exchange": "A String", # The exchange reviewing the creative. |
| 480 | }, |
| 481 | ], |
| 482 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 483 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 484 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 485 | "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` |
| 486 | { # Asset association for the creative. |
| 487 | "role": "A String", # The role of this asset for the creative. |
| 488 | "asset": { # A single asset. # The associated asset. |
| 489 | "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. |
| 490 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 491 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 492 | }, |
| 493 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 494 | "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` |
| 495 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 496 | "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 |
| 497 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 498 | }, |
| 499 | ], |
| 500 | "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` |
| 501 | "A String", |
| 502 | ], |
| 503 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 504 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 505 | "name": "A String", # Output only. The resource name of the creative. |
| 506 | "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` |
| 507 | "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. |
| 508 | { # Timer event of the creative. |
| 509 | "name": "A String", # Required. The name of the timer event. |
| 510 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 511 | }, |
| 512 | ], |
| 513 | "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` |
| 514 | "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. |
| 515 | { # Counter event of the creative. |
| 516 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 517 | "name": "A String", # Required. The name of the counter event. |
| 518 | }, |
| 519 | ], |
| 520 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 521 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 522 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 523 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 524 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 525 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 526 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 527 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 528 | }, |
| 529 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 530 | "heightPixels": 42, # The height in pixels. |
| 531 | "widthPixels": 42, # The width in pixels. |
| 532 | }, |
| 533 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 534 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 535 | "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. |
| 536 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 537 | "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` |
| 538 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 539 | "A String", |
| 540 | ], |
| 541 | "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` |
| 542 | "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` |
| 543 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 544 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 545 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 546 | "name": "A String", # The name of the transcoded file. |
| 547 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 548 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 549 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 550 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 551 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 552 | "heightPixels": 42, # The height in pixels. |
| 553 | "widthPixels": 42, # The width in pixels. |
| 554 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 555 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 556 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 557 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 558 | }, |
| 559 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 560 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 561 | "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` |
| 562 | "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` |
| 563 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 564 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 565 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 567 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 568 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 569 | "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. |
| 570 | { # Exit event of the creative. |
| 571 | "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` |
| 572 | "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. |
| 573 | "type": "A String", # Required. The type of the exit event. |
| 574 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 575 | }, |
| 576 | ], |
| 577 | "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. |
| 578 | { # Dimensions. |
| 579 | "heightPixels": 42, # The height in pixels. |
| 580 | "widthPixels": 42, # The width in pixels. |
| 581 | }, |
| 582 | ], |
| 583 | "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. |
| 584 | "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. |
| 585 | "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` |
| 586 | "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` |
| 587 | "A String", |
| 588 | ], |
| 589 | "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` |
| 590 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 591 | "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` |
| 592 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 593 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 594 | }, |
| 595 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 596 | }</pre> |
| 597 | </div> |
| 598 | |
| 599 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 600 | <code class="details" id="list">list(advertiserId, filter=None, pageToken=None, pageSize=None, orderBy=None, x__xgafv=None)</code> |
| 601 | <pre>Lists creatives in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, creatives with `ENTITY_STATUS_ARCHIVED` will not be included in the results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 602 | |
| 603 | Args: |
| 604 | advertiserId: string, Required. The ID of the advertiser to list creatives for. (required) |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 605 | filter: string, Allows filtering by creative properties. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restriction for the same field must be combined by `OR`. * Restriction for different fields must be combined by `AND`. * Between `(` and `)` there can only be restrictions combined by `OR` for the same field. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `EQUALS (=)` for the following fields: - `entityStatus` - `creativeType`. - `dimensions` - `minDuration` - `maxDuration` - `approvalStatus` - `exchangeReviewStatus` - `dynamic` - `creativeId` * The operator must be `HAS (:)` for the following fields: - `lineItemIds` * For `entityStatus`, `minDuration`, `maxDuration`, and `dynamic` there may be at most one restriction. * For `dimensions`, the value is in the form of `"{width}x{height}"`. * For `exchangeReviewStatus`, the value is in the form of `{exchange}-{reviewStatus}`. * For `minDuration` and `maxDuration`, the value is in the form of `"{duration}s"`. Only seconds are supported with millisecond granularity. * There may be multiple `lineItemIds` restrictions in order to search against multiple possible line item IDs. * There may be multiple `creativeId` restrictions in order to search against multiple possible creative IDs. Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms. `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` The length of this field should be no more than 500 characters. |
| 606 | pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned. |
| 607 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |
| 608 | orderBy: string, Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `createTime desc`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 609 | x__xgafv: string, V1 error format. |
| 610 | Allowed values |
| 611 | 1 - v1 error format |
| 612 | 2 - v2 error format |
| 613 | |
| 614 | Returns: |
| 615 | An object of the form: |
| 616 | |
| 617 | { |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 618 | "creatives": [ # The list of creatives. This list will be absent if empty. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 619 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 620 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 621 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 622 | "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` |
| 623 | "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 |
| 624 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 625 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 626 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 627 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 628 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 629 | "heightPixels": 42, # The height in pixels. |
| 630 | "widthPixels": 42, # The width in pixels. |
| 631 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 632 | "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 |
| 633 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 634 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 635 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 636 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 637 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 638 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 639 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 640 | { # Publisher review status for the creative. |
| 641 | "status": "A String", # Status of the publisher review. |
| 642 | "publisherName": "A String", # The publisher reviewing the creative. |
| 643 | }, |
| 644 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 645 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 646 | "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. |
| 647 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 648 | { # Exchange review status for the creative. |
| 649 | "status": "A String", # Status of the exchange review. |
| 650 | "exchange": "A String", # The exchange reviewing the creative. |
| 651 | }, |
| 652 | ], |
| 653 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 654 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 655 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 656 | "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` |
| 657 | { # Asset association for the creative. |
| 658 | "role": "A String", # The role of this asset for the creative. |
| 659 | "asset": { # A single asset. # The associated asset. |
| 660 | "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. |
| 661 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 662 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 663 | }, |
| 664 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 665 | "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` |
| 666 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 667 | "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 |
| 668 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 669 | }, |
| 670 | ], |
| 671 | "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` |
| 672 | "A String", |
| 673 | ], |
| 674 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 675 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 676 | "name": "A String", # Output only. The resource name of the creative. |
| 677 | "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` |
| 678 | "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. |
| 679 | { # Timer event of the creative. |
| 680 | "name": "A String", # Required. The name of the timer event. |
| 681 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 682 | }, |
| 683 | ], |
| 684 | "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` |
| 685 | "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. |
| 686 | { # Counter event of the creative. |
| 687 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 688 | "name": "A String", # Required. The name of the counter event. |
| 689 | }, |
| 690 | ], |
| 691 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 692 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 693 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 694 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 695 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 696 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 697 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 698 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 699 | }, |
| 700 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 701 | "heightPixels": 42, # The height in pixels. |
| 702 | "widthPixels": 42, # The width in pixels. |
| 703 | }, |
| 704 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 705 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 706 | "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. |
| 707 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 708 | "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` |
| 709 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 710 | "A String", |
| 711 | ], |
| 712 | "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` |
| 713 | "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` |
| 714 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 715 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 716 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 717 | "name": "A String", # The name of the transcoded file. |
| 718 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 719 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 720 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 721 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 722 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 723 | "heightPixels": 42, # The height in pixels. |
| 724 | "widthPixels": 42, # The width in pixels. |
| 725 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 726 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 727 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 728 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 729 | }, |
| 730 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 731 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 732 | "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` |
| 733 | "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` |
| 734 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 735 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 736 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 737 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 738 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 739 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 740 | "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. |
| 741 | { # Exit event of the creative. |
| 742 | "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` |
| 743 | "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. |
| 744 | "type": "A String", # Required. The type of the exit event. |
| 745 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 746 | }, |
| 747 | ], |
| 748 | "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. |
| 749 | { # Dimensions. |
| 750 | "heightPixels": 42, # The height in pixels. |
| 751 | "widthPixels": 42, # The width in pixels. |
| 752 | }, |
| 753 | ], |
| 754 | "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. |
| 755 | "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. |
| 756 | "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` |
| 757 | "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` |
| 758 | "A String", |
| 759 | ], |
| 760 | "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` |
| 761 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 762 | "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` |
| 763 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 764 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 765 | }, |
| 766 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 767 | }, |
| 768 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 769 | "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCreativesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 770 | }</pre> |
| 771 | </div> |
| 772 | |
| 773 | <div class="method"> |
| 774 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 775 | <pre>Retrieves the next page of results. |
| 776 | |
| 777 | Args: |
| 778 | previous_request: The request for the previous page. (required) |
| 779 | previous_response: The response from the request for the previous page. (required) |
| 780 | |
| 781 | Returns: |
| 782 | A request object that you can call 'execute()' on to request the next |
| 783 | page. Returns None if there are no more items in the collection. |
| 784 | </pre> |
| 785 | </div> |
| 786 | |
| 787 | <div class="method"> |
| 788 | <code class="details" id="patch">patch(advertiserId, creativeId, body=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 789 | <pre>Updates an existing creative. Returns the updated creative if successful. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 790 | |
| 791 | Args: |
| 792 | advertiserId: string, Output only. The unique ID of the advertiser the creative belongs to. (required) |
| 793 | creativeId: string, Output only. The unique ID of the creative. Assigned by the system. (required) |
| 794 | body: object, The request body. |
| 795 | The object takes the form of: |
| 796 | |
| 797 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 798 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 799 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 800 | "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` |
| 801 | "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 |
| 802 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 803 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 804 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 805 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 806 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 807 | "heightPixels": 42, # The height in pixels. |
| 808 | "widthPixels": 42, # The width in pixels. |
| 809 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 810 | "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 |
| 811 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 812 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 813 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 814 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 815 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 816 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 817 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 818 | { # Publisher review status for the creative. |
| 819 | "status": "A String", # Status of the publisher review. |
| 820 | "publisherName": "A String", # The publisher reviewing the creative. |
| 821 | }, |
| 822 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 823 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 824 | "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. |
| 825 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 826 | { # Exchange review status for the creative. |
| 827 | "status": "A String", # Status of the exchange review. |
| 828 | "exchange": "A String", # The exchange reviewing the creative. |
| 829 | }, |
| 830 | ], |
| 831 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 832 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 833 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 834 | "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` |
| 835 | { # Asset association for the creative. |
| 836 | "role": "A String", # The role of this asset for the creative. |
| 837 | "asset": { # A single asset. # The associated asset. |
| 838 | "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. |
| 839 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 840 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 841 | }, |
| 842 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 843 | "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` |
| 844 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 845 | "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 |
| 846 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 847 | }, |
| 848 | ], |
| 849 | "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` |
| 850 | "A String", |
| 851 | ], |
| 852 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 853 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 854 | "name": "A String", # Output only. The resource name of the creative. |
| 855 | "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` |
| 856 | "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. |
| 857 | { # Timer event of the creative. |
| 858 | "name": "A String", # Required. The name of the timer event. |
| 859 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 860 | }, |
| 861 | ], |
| 862 | "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` |
| 863 | "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. |
| 864 | { # Counter event of the creative. |
| 865 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 866 | "name": "A String", # Required. The name of the counter event. |
| 867 | }, |
| 868 | ], |
| 869 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 870 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 871 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 872 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 873 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 874 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 875 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 876 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 877 | }, |
| 878 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 879 | "heightPixels": 42, # The height in pixels. |
| 880 | "widthPixels": 42, # The width in pixels. |
| 881 | }, |
| 882 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 883 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 884 | "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. |
| 885 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 886 | "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` |
| 887 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 888 | "A String", |
| 889 | ], |
| 890 | "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` |
| 891 | "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` |
| 892 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 893 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 894 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 895 | "name": "A String", # The name of the transcoded file. |
| 896 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 897 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 898 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 899 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 900 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 901 | "heightPixels": 42, # The height in pixels. |
| 902 | "widthPixels": 42, # The width in pixels. |
| 903 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 904 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 905 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 906 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 907 | }, |
| 908 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 909 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 910 | "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` |
| 911 | "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` |
| 912 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 913 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 914 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 915 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 916 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 917 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 918 | "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. |
| 919 | { # Exit event of the creative. |
| 920 | "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` |
| 921 | "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. |
| 922 | "type": "A String", # Required. The type of the exit event. |
| 923 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 924 | }, |
| 925 | ], |
| 926 | "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. |
| 927 | { # Dimensions. |
| 928 | "heightPixels": 42, # The height in pixels. |
| 929 | "widthPixels": 42, # The width in pixels. |
| 930 | }, |
| 931 | ], |
| 932 | "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. |
| 933 | "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. |
| 934 | "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` |
| 935 | "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` |
| 936 | "A String", |
| 937 | ], |
| 938 | "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` |
| 939 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 940 | "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` |
| 941 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 942 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 943 | }, |
| 944 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 945 | } |
| 946 | |
| 947 | updateMask: string, Required. The mask to control which fields to update. |
| 948 | x__xgafv: string, V1 error format. |
| 949 | Allowed values |
| 950 | 1 - v1 error format |
| 951 | 2 - v2 error format |
| 952 | |
| 953 | Returns: |
| 954 | An object of the form: |
| 955 | |
| 956 | { # A single Creative. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 957 | "requirePingForAttribution": True or False, # Optional. Indicates that the creative will wait for a return ping for attribution. Only valid when using a Campaign Manager tracking ad with a third-party ad server parameter and the ${DC_DBM_TOKEN} macro. Optional and only valid for third-party tag creatives or third-party VAST tag creatives. Third-party tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 958 | "creativeId": "A String", # Output only. The unique ID of the creative. Assigned by the system. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 959 | "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` |
| 960 | "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 |
| 961 | "program": "A String", # The program of the OBA icon. For example: “AdChoices”. |
| 962 | "resourceUrl": "A String", # The URL of the OBA icon resource. |
| 963 | "resourceMimeType": "A String", # The MIME type of the OBA icon resource. |
| 964 | "position": "A String", # The position of the OBA icon on the creative. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 965 | "dimensions": { # Dimensions. # The dimensions of the OBA icon. |
| 966 | "heightPixels": 42, # The height in pixels. |
| 967 | "widthPixels": 42, # The width in pixels. |
| 968 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 969 | "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 |
| 970 | "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 |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 971 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 972 | "lineItemIds": [ # Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead. |
| 973 | "A String", |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 974 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 975 | "reviewStatus": { # Review statuses for the creative. # Output only. The current status of the creative review process. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 976 | "publisherReviewStatuses": [ # Publisher review statuses for the creative. |
| 977 | { # Publisher review status for the creative. |
| 978 | "status": "A String", # Status of the publisher review. |
| 979 | "publisherName": "A String", # The publisher reviewing the creative. |
| 980 | }, |
| 981 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 982 | "contentAndPolicyReviewStatus": "A String", # Content and policy review status for the creative. |
| 983 | "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. |
| 984 | "exchangeReviewStatuses": [ # Exchange review statuses for the creative. |
| 985 | { # Exchange review status for the creative. |
| 986 | "status": "A String", # Status of the exchange review. |
| 987 | "exchange": "A String", # The exchange reviewing the creative. |
| 988 | }, |
| 989 | ], |
| 990 | "creativeAndLandingPageReviewStatus": "A String", # Creative and landing page review status for the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 991 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 992 | "html5Video": True or False, # Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 993 | "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` |
| 994 | { # Asset association for the creative. |
| 995 | "role": "A String", # The role of this asset for the creative. |
| 996 | "asset": { # A single asset. # The associated asset. |
| 997 | "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. |
| 998 | "content": "A String", # The asset content. For uploaded assets, the content is the serving path. |
| 999 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1000 | }, |
| 1001 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1002 | "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` |
| 1003 | { # Tracking URLs from third parties to track interactions with an audio or a video creative. |
| 1004 | "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 |
| 1005 | "type": "A String", # The type of interaction needs to be tracked by the tracking URL |
| 1006 | }, |
| 1007 | ], |
| 1008 | "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` |
| 1009 | "A String", |
| 1010 | ], |
| 1011 | "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` |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1012 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the creative belongs to. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1013 | "name": "A String", # Output only. The resource name of the creative. |
| 1014 | "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` |
| 1015 | "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. |
| 1016 | { # Timer event of the creative. |
| 1017 | "name": "A String", # Required. The name of the timer event. |
| 1018 | "reportingName": "A String", # Required. The name used to identify this timer event in reports. |
| 1019 | }, |
| 1020 | ], |
| 1021 | "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` |
| 1022 | "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. |
| 1023 | { # Counter event of the creative. |
| 1024 | "reportingName": "A String", # Required. The name used to identify this counter event in reports. |
| 1025 | "name": "A String", # Required. The name of the counter event. |
| 1026 | }, |
| 1027 | ], |
| 1028 | "universalAdId": { # A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. # Optional. An optional creative identifier provided by a registry that is unique across all platforms. Universal Ad ID is part of the VAST 4.0 standard. It can be modified after the creative is created. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1029 | "registry": "A String", # The registry provides unique creative identifiers. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1030 | "id": "A String", # The unique creative identifier. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1031 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1032 | "hostingSource": "A String", # Required. Indicates where the creative is hosted. |
| 1033 | "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. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` |
| 1034 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 1035 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| 1036 | }, |
| 1037 | "dimensions": { # Dimensions. # Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_INTERSTITIAL` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_TEMPLATED_APP_INSTALL_VIDEO` |
| 1038 | "heightPixels": 42, # The height in pixels. |
| 1039 | "widthPixels": 42, # The width in pixels. |
| 1040 | }, |
| 1041 | "dynamic": True or False, # Output only. Indicates whether the creative is dynamic. |
| 1042 | "notes": "A String", # User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. |
| 1043 | "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. |
| 1044 | "updateTime": "A String", # Output only. The timestamp when the creative was last updated. Assigned by the system. |
| 1045 | "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` |
| 1046 | "creativeAttributes": [ # Output only. A list of attributes of the creative that is generated by the system. |
| 1047 | "A String", |
| 1048 | ], |
| 1049 | "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` |
| 1050 | "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` |
| 1051 | "displayName": "A String", # Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 1052 | "transcodes": [ # Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1053 | { # Represents information about the transcoded audio or video file. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1054 | "name": "A String", # The name of the transcoded file. |
| 1055 | "frameRate": 3.14, # The frame rate of the transcoded video, in frames per second. |
| 1056 | "fileSizeBytes": "A String", # The size of the transcoded file, in bytes. |
| 1057 | "audioSampleRateHz": "A String", # The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. |
| 1058 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1059 | "dimensions": { # Dimensions. # The dimensions of the transcoded video. |
| 1060 | "heightPixels": 42, # The height in pixels. |
| 1061 | "widthPixels": 42, # The width in pixels. |
| 1062 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1063 | "transcoded": True or False, # Indicates if the transcoding was successful. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1064 | "mimeType": "A String", # The MIME type of the transcoded file. |
| 1065 | "bitRateKbps": "A String", # The transcoding bit rate of the transcoded video, in kilobits per second. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1066 | }, |
| 1067 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1068 | "creativeType": "A String", # Required. Immutable. The type of the creative. |
| 1069 | "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` |
| 1070 | "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` |
| 1071 | "cmTrackingAd": { # A Campaign Manager tracking ad. # The Campaign Manager tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_APP_INSTALL` * `CREATIVE_TYPE_NATIVE_APP_INSTALL_SQUARE` Output only for other cases. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1072 | "cmAdId": "A String", # The ad ID of the campaign manager tracking Ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1073 | "cmCreativeId": "A String", # The creative ID of the campaign manager tracking Ad. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1074 | "cmPlacementId": "A String", # The placement ID of the campaign manager tracking Ad. |
| 1075 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1076 | "entityStatus": "A String", # Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` |
| 1077 | "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. |
| 1078 | { # Exit event of the creative. |
| 1079 | "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` |
| 1080 | "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. |
| 1081 | "type": "A String", # Required. The type of the exit event. |
| 1082 | "reportingName": "A String", # The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. |
| 1083 | }, |
| 1084 | ], |
| 1085 | "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. |
| 1086 | { # Dimensions. |
| 1087 | "heightPixels": 42, # The height in pixels. |
| 1088 | "widthPixels": 42, # The width in pixels. |
| 1089 | }, |
| 1090 | ], |
| 1091 | "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. |
| 1092 | "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. |
| 1093 | "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` |
| 1094 | "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` |
| 1095 | "A String", |
| 1096 | ], |
| 1097 | "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` |
| 1098 | "createTime": "A String", # Output only. The timestamp when the creative was created. Assigned by the system. |
| 1099 | "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` |
| 1100 | "seconds": "A String", # The offset in seconds from the start of the audio or video. |
| 1101 | "percentage": "A String", # The offset in percentage of the audio or video duration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1102 | }, |
| 1103 | "appendedTag": "A String", # Third-party HTML tracking tag to be appended to the creative tag. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1104 | }</pre> |
| 1105 | </div> |
| 1106 | |
| 1107 | </body></html> |