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 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538
|
<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="authorizedbuyersmarketplace_v1alpha.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1alpha.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1alpha.buyers.proposals.html">proposals</a> . <a href="authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html">deals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Batch updates multiple deals in the same proposal.</p>
<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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a deal given its name. The deal is returned at its head revision.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.</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(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
<pre>Batch updates multiple deals in the same proposal.
Args:
parent: string, Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} (required)
body: object, The request body.
The object takes the form of:
{ # Request message for batch updating deals.
"requests": [ # Required. List of request messages to update deals.
{ # Request message for updating the deal at the given revision number.
"deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
},
"updateMask": "A String", # List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for batch updating deals.
"deals": [ # Deals updated.
{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a deal given its name. The deal is returned at its head revision.
Args:
name: string, Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
Args:
parent: string, Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} (required)
pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
pageToken: string, The page token as returned from ListDealsResponse.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing deals in a proposal.
"deals": [ # The list of deals.
{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
},
],
"nextPageToken": "A String", # Token to fetch the next page of results.
}</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(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
Args:
name: string, Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
body: object, The request body.
The object takes the form of:
{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
}
updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
"billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
"buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
"buyerPermissionType": "A String", # Output only. The buyer permission type of the deal.
"client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
"createTime": "A String", # Output only. The time of the deal creation.
"creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
"creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
"creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
"creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
"maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
"programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
"skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
},
"dealType": "A String", # Output only. Type of deal.
"deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
"companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
"creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
"deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
"frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
{ # Message contains details about publisher-set frequency caps of the delivery.
"maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
"timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
"timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
},
],
"roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
},
"description": "A String", # Output only. Free text description for the deal terms.
"displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
"eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
"A String",
],
"estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
"flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
"mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
"accountId": "A String", # Output only. Account ID of the media planner.
},
"name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
"preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
},
"privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
"floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
},
"programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
"fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
"amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
"currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
"nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
"units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
},
"type": "A String", # The pricing type for the deal.
},
"guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
"impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
"minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
"percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
"reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
},
"proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
"publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
"sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
"targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
"daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
"dayParts": [ # The targeted weekdays and times
{ # Defines targeting for a period of time on a specific week day.
"dayOfWeek": "A String", # Day of week for the period.
"endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"timeZoneType": "A String", # The time zone type of the day parts
},
"excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
"A String",
],
"geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
"excludedInventorySizes": [ # A list of inventory sizes to be excluded.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
"targetedInventorySizes": [ # A list of inventory sizes to be included.
{ # Represents size of a single ad slot, or a creative.
"height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
"type": "A String", # The type of the ad slot size.
"width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
},
],
},
"inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
"inventoryTypes": [ # The list of targeted inventory types for the bid request.
"A String",
],
},
"placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
"mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
"firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
"excludedAppIds": [ # A list of application IDs to be excluded.
"A String",
],
"targetedAppIds": [ # A list of application IDs to be included.
"A String",
],
},
},
"uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
"excludedUris": [ # A list of URLs to be excluded.
"A String",
],
"targetedUris": [ # A list of URLs to be included.
"A String",
],
},
},
"technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
"deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
"operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
},
},
"userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
"excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
"A String",
],
"targetedCriteriaIds": [ # A list of numeric IDs to be included.
"A String",
],
},
"videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
"excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
"A String",
],
"targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time when the deal was last updated.
}</pre>
</div>
</body></html>
|