File: authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html

package info (click to toggle)
python-googleapi 2.186.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 553,432 kB
  • sloc: python: 11,087; javascript: 249; sh: 114; makefile: 59
file content (1692 lines) | stat: -rw-r--r-- 174,810 bytes parent folder | download | duplicates (2)
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
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
<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_v1.html">Authorized Buyers Marketplace API</a> . <a href="authorizedbuyersmarketplace_v1.buyers.html">buyers</a> . <a href="authorizedbuyersmarketplace_v1.buyers.finalizedDeals.html">finalizedDeals</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#addCreative">addCreative(deal, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.</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 finalized deal given its name.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists finalized deals. Use the URL path "/v1/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.</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="#pause">pause(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.</p>
<p class="toc_element">
  <code><a href="#resume">resume(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.</p>
<p class="toc_element">
  <code><a href="#setReadyToServe">setReadyToServe(deal, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="addCreative">addCreative(deal, body=None, x__xgafv=None)</code>
  <pre>Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it&#x27;s recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don&#x27;t contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.

Args:
  deal: string, Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for adding creative to be used in the bidding process for the finalized deal.
  &quot;creative&quot;: &quot;A String&quot;, # Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
  &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
    &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
    &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
    &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
    &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
    &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
      &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
      &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
      &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
      &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
      &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
      &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
    },
    &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
    &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
      &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
      &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
      &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
      &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
        { # Message contains details about publisher-set frequency caps of the delivery.
          &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
          &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
          &quot;timeUnitsCount&quot;: 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.
        },
      ],
      &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
    },
    &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
    &quot;displayName&quot;: &quot;A String&quot;, # 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.
    &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
      &quot;A String&quot;,
    ],
    &quot;estimatedGrossSpend&quot;: { # 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.
      &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
      &quot;nanos&quot;: 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.
      &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
    },
    &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
    &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
    &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
      &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
    },
    &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
    &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
    },
    &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
      &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
    },
    &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
      &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
      &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
      &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
      &quot;reservationType&quot;: &quot;A String&quot;, # 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.
    },
    &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
    &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
    &quot;sellerTimeZone&quot;: { # 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.
      &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
      &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
    },
    &quot;targeting&quot;: { # 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.
      &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
        &quot;dayParts&quot;: [ # The targeted weekdays and times
          { # Defines targeting for a period of time on a specific week day.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
            &quot;endTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
            &quot;startTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
          },
        ],
        &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
      },
      &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;geoTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
        &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
        &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
      },
      &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
        &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
          &quot;A String&quot;,
        ],
      },
      &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
        &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
          &quot;firstPartyTargeting&quot;: { # 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.
            &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
          &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedUris&quot;: [ # A list of URLs to be included.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
        &quot;deviceCapabilityTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;deviceCategoryTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
          &quot;operatingSystemCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;operatingSystemVersionCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
      },
      &quot;userListTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;verticalTargeting&quot;: { # 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
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
        &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
          &quot;A String&quot;,
        ],
        &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
  },
  &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
    &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
    &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
    &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
  },
  &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
  &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
  &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
    &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
    &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
    &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
    &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
    &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
    &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
  },
}</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 finalized deal given its name.

Args:
  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{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 finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
  &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
    &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
    &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
    &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
    &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
    &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
      &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
      &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
      &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
      &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
      &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
      &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
    },
    &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
    &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
      &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
      &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
      &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
      &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
        { # Message contains details about publisher-set frequency caps of the delivery.
          &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
          &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
          &quot;timeUnitsCount&quot;: 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.
        },
      ],
      &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
    },
    &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
    &quot;displayName&quot;: &quot;A String&quot;, # 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.
    &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
      &quot;A String&quot;,
    ],
    &quot;estimatedGrossSpend&quot;: { # 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.
      &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
      &quot;nanos&quot;: 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.
      &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
    },
    &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
    &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
    &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
      &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
    },
    &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
    &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
    },
    &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
      &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
    },
    &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
      &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
      &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
      &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
      &quot;reservationType&quot;: &quot;A String&quot;, # 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.
    },
    &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
    &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
    &quot;sellerTimeZone&quot;: { # 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.
      &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
      &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
    },
    &quot;targeting&quot;: { # 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.
      &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
        &quot;dayParts&quot;: [ # The targeted weekdays and times
          { # Defines targeting for a period of time on a specific week day.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
            &quot;endTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
            &quot;startTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
          },
        ],
        &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
      },
      &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;geoTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
        &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
        &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
      },
      &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
        &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
          &quot;A String&quot;,
        ],
      },
      &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
        &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
          &quot;firstPartyTargeting&quot;: { # 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.
            &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
          &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedUris&quot;: [ # A list of URLs to be included.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
        &quot;deviceCapabilityTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;deviceCategoryTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
          &quot;operatingSystemCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;operatingSystemVersionCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
      },
      &quot;userListTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;verticalTargeting&quot;: { # 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
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
        &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
          &quot;A String&quot;,
        ],
        &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
  },
  &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
    &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
    &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
    &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
  },
  &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
  &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
  &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
    &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
    &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
    &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
    &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
    &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
    &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists finalized deals. Use the URL path &quot;/v1/buyers/{accountId}/finalizedDeals&quot; to list finalized deals for the current buyer and its clients. Bidders can use the URL path &quot;/v1/bidders/{accountId}/finalizedDeals&quot; to list finalized deals for the bidder, its buyers and all their clients.

Args:
  parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
  orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
  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 ListFinalizedDealsResponse.
  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 finalized deals.
  &quot;finalizedDeals&quot;: [ # The list of finalized deals.
    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
      &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
        &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
        &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
        &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
        &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
        &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
        &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
          &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
          &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
          &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
          &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
          &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
          &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
        },
        &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
        &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
          &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
          &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
          &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
          &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
            { # Message contains details about publisher-set frequency caps of the delivery.
              &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
              &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
              &quot;timeUnitsCount&quot;: 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.
            },
          ],
          &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
        },
        &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
        &quot;displayName&quot;: &quot;A String&quot;, # 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.
        &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
          &quot;A String&quot;,
        ],
        &quot;estimatedGrossSpend&quot;: { # 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.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
        &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
        &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
          &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
        },
        &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
        &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
          &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
            &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
              &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
              &quot;nanos&quot;: 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.
              &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
            },
            &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
          },
        },
        &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
          &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
            &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
              &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
              &quot;nanos&quot;: 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.
              &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
            },
            &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
          },
          &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
        },
        &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
          &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
            &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
              &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
              &quot;nanos&quot;: 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.
              &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
            },
            &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
          },
          &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
          &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
          &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
          &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
          &quot;reservationType&quot;: &quot;A String&quot;, # 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.
        },
        &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
        &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
        &quot;sellerTimeZone&quot;: { # 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.
          &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
          &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
        },
        &quot;targeting&quot;: { # 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.
          &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
            &quot;dayParts&quot;: [ # The targeted weekdays and times
              { # Defines targeting for a period of time on a specific week day.
                &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
                &quot;endTime&quot;: { # 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.
                  &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
                  &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
                  &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
                  &quot;seconds&quot;: 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.
                },
                &quot;startTime&quot;: { # 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.
                  &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
                  &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
                  &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
                  &quot;seconds&quot;: 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.
                },
              },
            ],
            &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
          },
          &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
            &quot;A String&quot;,
          ],
          &quot;geoTargeting&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
            &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
              { # Represents size of a single ad slot, or a creative.
                &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
                &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
                &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
              },
            ],
            &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
              { # Represents size of a single ad slot, or a creative.
                &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
                &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
                &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
              },
            ],
          },
          &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
            &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
              &quot;A String&quot;,
            ],
          },
          &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
            &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
              &quot;firstPartyTargeting&quot;: { # 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.
                &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
                  &quot;A String&quot;,
                ],
                &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
                  &quot;A String&quot;,
                ],
              },
            },
            &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
              &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
                &quot;A String&quot;,
              ],
              &quot;targetedUris&quot;: [ # A list of URLs to be included.
                &quot;A String&quot;,
              ],
            },
          },
          &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
            &quot;deviceCapabilityTargeting&quot;: { # 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.
              &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
                &quot;A String&quot;,
              ],
              &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
                &quot;A String&quot;,
              ],
            },
            &quot;deviceCategoryTargeting&quot;: { # 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.
              &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
                &quot;A String&quot;,
              ],
              &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
                &quot;A String&quot;,
              ],
            },
            &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
              &quot;operatingSystemCriteria&quot;: { # 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.
                &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
                  &quot;A String&quot;,
                ],
                &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
                  &quot;A String&quot;,
                ],
              },
              &quot;operatingSystemVersionCriteria&quot;: { # 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.
                &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
                  &quot;A String&quot;,
                ],
                &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
                  &quot;A String&quot;,
                ],
              },
            },
          },
          &quot;userListTargeting&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;verticalTargeting&quot;: { # 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
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
            &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
              &quot;A String&quot;,
            ],
            &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
      },
      &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
        &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
        &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
        &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
      },
      &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
      &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
      &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
      &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
        &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
        &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
        &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
        &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
        &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
        &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
      },
    },
  ],
  &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 &#x27;execute()&#x27; 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="pause">pause(name, body=None, x__xgafv=None)</code>
  <pre>Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

Args:
  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for pausing a finalized deal.
  &quot;reason&quot;: &quot;A String&quot;, # The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
  &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
    &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
    &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
    &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
    &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
    &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
      &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
      &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
      &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
      &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
      &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
      &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
    },
    &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
    &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
      &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
      &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
      &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
      &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
        { # Message contains details about publisher-set frequency caps of the delivery.
          &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
          &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
          &quot;timeUnitsCount&quot;: 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.
        },
      ],
      &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
    },
    &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
    &quot;displayName&quot;: &quot;A String&quot;, # 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.
    &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
      &quot;A String&quot;,
    ],
    &quot;estimatedGrossSpend&quot;: { # 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.
      &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
      &quot;nanos&quot;: 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.
      &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
    },
    &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
    &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
    &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
      &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
    },
    &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
    &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
    },
    &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
      &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
    },
    &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
      &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
      &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
      &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
      &quot;reservationType&quot;: &quot;A String&quot;, # 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.
    },
    &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
    &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
    &quot;sellerTimeZone&quot;: { # 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.
      &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
      &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
    },
    &quot;targeting&quot;: { # 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.
      &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
        &quot;dayParts&quot;: [ # The targeted weekdays and times
          { # Defines targeting for a period of time on a specific week day.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
            &quot;endTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
            &quot;startTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
          },
        ],
        &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
      },
      &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;geoTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
        &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
        &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
      },
      &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
        &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
          &quot;A String&quot;,
        ],
      },
      &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
        &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
          &quot;firstPartyTargeting&quot;: { # 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.
            &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
          &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedUris&quot;: [ # A list of URLs to be included.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
        &quot;deviceCapabilityTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;deviceCategoryTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
          &quot;operatingSystemCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;operatingSystemVersionCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
      },
      &quot;userListTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;verticalTargeting&quot;: { # 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
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
        &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
          &quot;A String&quot;,
        ],
        &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
  },
  &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
    &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
    &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
    &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
  },
  &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
  &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
  &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
    &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
    &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
    &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
    &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
    &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
    &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code>
  <pre>Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

Args:
  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for resuming a finalized deal.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
  &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
    &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
    &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
    &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
    &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
    &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
      &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
      &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
      &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
      &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
      &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
      &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
    },
    &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
    &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
      &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
      &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
      &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
      &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
        { # Message contains details about publisher-set frequency caps of the delivery.
          &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
          &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
          &quot;timeUnitsCount&quot;: 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.
        },
      ],
      &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
    },
    &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
    &quot;displayName&quot;: &quot;A String&quot;, # 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.
    &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
      &quot;A String&quot;,
    ],
    &quot;estimatedGrossSpend&quot;: { # 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.
      &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
      &quot;nanos&quot;: 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.
      &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
    },
    &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
    &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
    &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
      &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
    },
    &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
    &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
    },
    &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
      &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
    },
    &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
      &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
      &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
      &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
      &quot;reservationType&quot;: &quot;A String&quot;, # 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.
    },
    &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
    &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
    &quot;sellerTimeZone&quot;: { # 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.
      &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
      &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
    },
    &quot;targeting&quot;: { # 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.
      &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
        &quot;dayParts&quot;: [ # The targeted weekdays and times
          { # Defines targeting for a period of time on a specific week day.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
            &quot;endTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
            &quot;startTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
          },
        ],
        &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
      },
      &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;geoTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
        &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
        &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
      },
      &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
        &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
          &quot;A String&quot;,
        ],
      },
      &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
        &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
          &quot;firstPartyTargeting&quot;: { # 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.
            &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
          &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedUris&quot;: [ # A list of URLs to be included.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
        &quot;deviceCapabilityTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;deviceCategoryTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
          &quot;operatingSystemCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;operatingSystemVersionCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
      },
      &quot;userListTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;verticalTargeting&quot;: { # 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
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
        &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
          &quot;A String&quot;,
        ],
        &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
  },
  &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
    &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
    &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
    &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
  },
  &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
  &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
  &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
    &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
    &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
    &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
    &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
    &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
    &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="setReadyToServe">setReadyToServe(deal, body=None, x__xgafv=None)</code>
  <pre>Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they&#x27;re finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don&#x27;t start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

Args:
  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
  body: object, The request body.
    The object takes the form of:

{ # Request message for setting ready to serve for a finalized deal.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it&#x27;s been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
  &quot;deal&quot;: { # 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. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
    &quot;billedBuyer&quot;: &quot;A String&quot;, # 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}`
    &quot;buyer&quot;: &quot;A String&quot;, # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. Format: `buyers/{buyerAccountId}`
    &quot;buyerPermissionType&quot;: &quot;A String&quot;, # Output only. The buyer permission type of the deal.
    &quot;client&quot;: &quot;A String&quot;, # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
    &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time of the deal creation.
    &quot;creativeRequirements&quot;: { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
      &quot;creativeFormat&quot;: &quot;A String&quot;, # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
      &quot;creativePreApprovalPolicy&quot;: &quot;A String&quot;, # Output only. Specifies the creative pre-approval policy.
      &quot;creativeSafeFrameCompatibility&quot;: &quot;A String&quot;, # Output only. Specifies whether the creative is safeFrame compatible.
      &quot;maxAdDurationMs&quot;: &quot;A String&quot;, # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
      &quot;programmaticCreativeSource&quot;: &quot;A String&quot;, # 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.
      &quot;skippableAdType&quot;: &quot;A String&quot;, # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
    },
    &quot;dealType&quot;: &quot;A String&quot;, # Output only. Type of deal.
    &quot;deliveryControl&quot;: { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
      &quot;companionDeliveryType&quot;: &quot;A String&quot;, # Output only. Specifies roadblocking in a main companion lineitem.
      &quot;creativeRotationType&quot;: &quot;A String&quot;, # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
      &quot;deliveryRateType&quot;: &quot;A String&quot;, # Output only. Specifies how the impression delivery will be paced.
      &quot;frequencyCap&quot;: [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
        { # Message contains details about publisher-set frequency caps of the delivery.
          &quot;maxImpressions&quot;: 42, # The maximum number of impressions that can be served to a user within the specified time period.
          &quot;timeUnitType&quot;: &quot;A String&quot;, # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
          &quot;timeUnitsCount&quot;: 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.
        },
      ],
      &quot;roadblockingType&quot;: &quot;A String&quot;, # Output only. Specifies the roadblocking type in display creatives.
    },
    &quot;description&quot;: &quot;A String&quot;, # Output only. Free text description for the deal terms.
    &quot;displayName&quot;: &quot;A String&quot;, # 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.
    &quot;eligibleSeatIds&quot;: [ # 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&#x27;s namespace.
      &quot;A String&quot;,
    ],
    &quot;estimatedGrossSpend&quot;: { # 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.
      &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
      &quot;nanos&quot;: 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.
      &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
    },
    &quot;flightEndTime&quot;: &quot;A String&quot;, # 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.
    &quot;flightStartTime&quot;: &quot;A String&quot;, # 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.
    &quot;mediaPlanner&quot;: { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API&#x27;s Buyer resource. This field represents a media planner (For example, agency or big advertiser).
      &quot;accountId&quot;: &quot;A String&quot;, # Output only. Account ID of the media planner.
    },
    &quot;name&quot;: &quot;A String&quot;, # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
    &quot;preferredDealTerms&quot;: { # Pricing terms for Preferred Deals. # The terms for preferred deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
    },
    &quot;privateAuctionTerms&quot;: { # Pricing terms for Private Auctions. # The terms for private auction deals.
      &quot;floorPrice&quot;: { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;openAuctionAllowed&quot;: True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
    },
    &quot;programmaticGuaranteedTerms&quot;: { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
      &quot;fixedPrice&quot;: { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
        &quot;amount&quot;: { # Represents an amount of money with its currency type. # The actual price with currency specified.
          &quot;currencyCode&quot;: &quot;A String&quot;, # The three-letter currency code defined in ISO 4217.
          &quot;nanos&quot;: 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.
          &quot;units&quot;: &quot;A String&quot;, # The whole units of the amount. For example if `currencyCode` is `&quot;USD&quot;`, then 1 unit is one US dollar.
        },
        &quot;type&quot;: &quot;A String&quot;, # The pricing type for the deal.
      },
      &quot;guaranteedLooks&quot;: &quot;A String&quot;, # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
      &quot;impressionCap&quot;: &quot;A String&quot;, # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
      &quot;minimumDailyLooks&quot;: &quot;A String&quot;, # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
      &quot;percentShareOfVoice&quot;: &quot;A String&quot;, # For sponsorship deals, this is the percentage of the seller&#x27;s eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
      &quot;reservationType&quot;: &quot;A String&quot;, # 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.
    },
    &quot;proposalRevision&quot;: &quot;A String&quot;, # 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.
    &quot;publisherProfile&quot;: &quot;A String&quot;, # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
    &quot;sellerTimeZone&quot;: { # 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.
      &quot;id&quot;: &quot;A String&quot;, # IANA Time Zone Database time zone. For example &quot;America/New_York&quot;.
      &quot;version&quot;: &quot;A String&quot;, # Optional. IANA Time Zone Database version number. For example &quot;2019a&quot;.
    },
    &quot;targeting&quot;: { # 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.
      &quot;daypartTargeting&quot;: { # Represents Daypart targeting. # Daypart targeting information.
        &quot;dayParts&quot;: [ # The targeted weekdays and times
          { # Defines targeting for a period of time on a specific week day.
            &quot;dayOfWeek&quot;: &quot;A String&quot;, # Day of week for the period.
            &quot;endTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
            &quot;startTime&quot;: { # 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.
              &quot;hours&quot;: 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 &quot;24:00:00&quot; for scenarios like business closing time.
              &quot;minutes&quot;: 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
              &quot;nanos&quot;: 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
              &quot;seconds&quot;: 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.
            },
          },
        ],
        &quot;timeZoneType&quot;: &quot;A String&quot;, # The time zone type of the day parts
      },
      &quot;excludedSensitiveCategoryIds&quot;: [ # 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.
        &quot;A String&quot;,
      ],
      &quot;geoTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;inventorySizeTargeting&quot;: { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
        &quot;excludedInventorySizes&quot;: [ # A list of inventory sizes to be excluded.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
        &quot;targetedInventorySizes&quot;: [ # A list of inventory sizes to be included.
          { # Represents size of a single ad slot, or a creative.
            &quot;height&quot;: &quot;A String&quot;, # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
            &quot;type&quot;: &quot;A String&quot;, # The type of the ad slot size.
            &quot;width&quot;: &quot;A String&quot;, # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
          },
        ],
      },
      &quot;inventoryTypeTargeting&quot;: { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
        &quot;inventoryTypes&quot;: [ # The list of targeted inventory types for the bid request.
          &quot;A String&quot;,
        ],
      },
      &quot;placementTargeting&quot;: { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR&#x27;ed. # Output only. Placement targeting information, for example, URL, mobile applications.
        &quot;mobileApplicationTargeting&quot;: { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn&#x27;t apply to Auction Packages.
          &quot;firstPartyTargeting&quot;: { # 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.
            &quot;excludedAppIds&quot;: [ # A list of application IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedAppIds&quot;: [ # A list of application IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
        &quot;uriTargeting&quot;: { # 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&#x27;t apply. # URLs to be included/excluded.
          &quot;excludedUris&quot;: [ # A list of URLs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedUris&quot;: [ # A list of URLs to be included.
            &quot;A String&quot;,
          ],
        },
      },
      &quot;technologyTargeting&quot;: { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
        &quot;deviceCapabilityTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;deviceCategoryTargeting&quot;: { # 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.
          &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
            &quot;A String&quot;,
          ],
          &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
            &quot;A String&quot;,
          ],
        },
        &quot;operatingSystemTargeting&quot;: { # Represents targeting information for operating systems. # Operating system related targeting information.
          &quot;operatingSystemCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
          &quot;operatingSystemVersionCriteria&quot;: { # 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.
            &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
              &quot;A String&quot;,
            ],
            &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
              &quot;A String&quot;,
            ],
          },
        },
      },
      &quot;userListTargeting&quot;: { # 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.
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;verticalTargeting&quot;: { # 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
        &quot;excludedCriteriaIds&quot;: [ # A list of numeric IDs to be excluded.
          &quot;A String&quot;,
        ],
        &quot;targetedCriteriaIds&quot;: [ # A list of numeric IDs to be included.
          &quot;A String&quot;,
        ],
      },
      &quot;videoTargeting&quot;: { # Represents targeting information about video. # Output only. Video targeting information.
        &quot;excludedPositionTypes&quot;: [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
          &quot;A String&quot;,
        ],
        &quot;targetedPositionTypes&quot;: [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
          &quot;A String&quot;,
        ],
      },
    },
    &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The time when the deal was last updated.
  },
  &quot;dealPausingInfo&quot;: { # Information related to deal pausing. # Information related to deal pausing for the deal.
    &quot;pauseReason&quot;: &quot;A String&quot;, # The reason for the pausing of the deal; empty for active deals.
    &quot;pauseRole&quot;: &quot;A String&quot;, # The party that first paused the deal; unspecified for active deals.
    &quot;pausingConsented&quot;: True or False, # Whether pausing is consented between buyer and seller for the deal.
  },
  &quot;dealServingStatus&quot;: &quot;A String&quot;, # Serving status of the deal.
  &quot;name&quot;: &quot;A String&quot;, # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
  &quot;readyToServe&quot;: True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
  &quot;rtbMetrics&quot;: { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
    &quot;adImpressions7Days&quot;: &quot;A String&quot;, # Ad impressions in last 7 days.
    &quot;bidRate7Days&quot;: 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
    &quot;bidRequests7Days&quot;: &quot;A String&quot;, # Bid requests in last 7 days.
    &quot;bids7Days&quot;: &quot;A String&quot;, # Bids in last 7 days.
    &quot;filteredBidRate7Days&quot;: 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
    &quot;mustBidRateCurrentMonth&quot;: 3.14, # Must bid rate for current month.
  },
}</pre>
</div>

</body></html>