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