/
authorizedbuyersmarketplace-api.json
3131 lines (3131 loc) · 136 KB
/
authorizedbuyersmarketplace-api.json
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
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/authorized-buyers-marketplace": {
"description": "See, create, edit, and delete your Authorized Buyers Marketplace entities."
}
}
}
},
"basePath": "",
"baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Authorized Buyers Marketplace",
"description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "authorizedbuyersmarketplace:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/",
"name": "authorizedbuyersmarketplace",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"bidders": {
"resources": {
"finalizedDeals": {
"methods": {
"list": {
"description": "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.",
"flatPath": "v1/bidders/{biddersId}/finalizedDeals",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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 Example: 'deal.displayName, deal.updateTime desc'",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token as returned from ListFinalizedDealsResponse.",
"location": "query",
"type": "string"
},
"parent": {
"description": "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}`.",
"location": "path",
"pattern": "^bidders/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/finalizedDeals",
"response": {
"$ref": "ListFinalizedDealsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
}
}
}
}
},
"buyers": {
"resources": {
"auctionPackages": {
"methods": {
"get": {
"description": "Gets an auction package given its name.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`",
"location": "path",
"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AuctionPackage"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"list": {
"description": "List the auction packages subscribed by a buyer and its clients.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/auctionPackages",
"response": {
"$ref": "ListAuctionPackagesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"subscribe": {
"description": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`",
"location": "path",
"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:subscribe",
"request": {
"$ref": "SubscribeAuctionPackageRequest"
},
"response": {
"$ref": "AuctionPackage"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"subscribeClients": {
"description": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients",
"parameterOrder": [
"auctionPackage"
],
"parameters": {
"auctionPackage": {
"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`",
"location": "path",
"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+auctionPackage}:subscribeClients",
"request": {
"$ref": "SubscribeClientsRequest"
},
"response": {
"$ref": "AuctionPackage"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"unsubscribe": {
"description": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`",
"location": "path",
"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:unsubscribe",
"request": {
"$ref": "UnsubscribeAuctionPackageRequest"
},
"response": {
"$ref": "AuctionPackage"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"unsubscribeClients": {
"description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.",
"flatPath": "v1/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients",
"parameterOrder": [
"auctionPackage"
],
"parameters": {
"auctionPackage": {
"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`",
"location": "path",
"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+auctionPackage}:unsubscribeClients",
"request": {
"$ref": "UnsubscribeClientsRequest"
},
"response": {
"$ref": "AuctionPackage"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
}
}
},
"clients": {
"methods": {
"activate": {
"description": "Activates an existing client. The state of the client will be updated to \"ACTIVE\". This method has no effect if the client is already in \"ACTIVE\" state.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}:activate",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.activate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:activate",
"request": {
"$ref": "ActivateClientRequest"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"create": {
"description": "Creates a new client.",
"flatPath": "v1/buyers/{buyersId}/clients",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the buyer. Format: `buyers/{accountId}`",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/clients",
"request": {
"$ref": "Client"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"deactivate": {
"description": "Deactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}:deactivate",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.deactivate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:deactivate",
"request": {
"$ref": "DeactivateClientRequest"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"get": {
"description": "Gets a client with a given resource name.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.clients.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"list": {
"description": "Lists all the clients for the current buyer.",
"flatPath": "v1/buyers/{buyersId}/clients",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.clients.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. If left blank, a default page size of 500 will be applied.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the buyer. Format: `buyers/{accountId}`",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/clients",
"response": {
"$ref": "ListClientsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"patch": {
"description": "Updates an existing client.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}",
"httpMethod": "PATCH",
"id": "authorizedbuyersmarketplace.buyers.clients.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "Client"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
}
},
"resources": {
"users": {
"methods": {
"activate": {
"description": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.users.activate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:activate",
"request": {
"$ref": "ActivateClientUserRequest"
},
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"create": {
"description": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.users.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/users",
"request": {
"$ref": "ClientUser"
},
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"deactivate": {
"description": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:deactivate",
"request": {
"$ref": "DeactivateClientUserRequest"
},
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"delete": {
"description": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}",
"httpMethod": "DELETE",
"id": "authorizedbuyersmarketplace.buyers.clients.users.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"get": {
"description": "Retrieves an existing client user.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users/{usersId}",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.clients.users.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"list": {
"description": "Lists all client users for a specified client.",
"flatPath": "v1/buyers/{buyersId}/clients/{clientsId}/users",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.clients.users.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Requested page size. If left blank, a default page size of 500 will be applied.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`",
"location": "path",
"pattern": "^buyers/[^/]+/clients/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/users",
"response": {
"$ref": "ListClientUsersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
}
}
}
}
},
"finalizedDeals": {
"methods": {
"addCreative": {
"description": "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.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative",
"parameterOrder": [
"deal"
],
"parameters": {
"deal": {
"description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`",
"location": "path",
"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+deal}:addCreative",
"request": {
"$ref": "AddCreativeRequest"
},
"response": {
"$ref": "FinalizedDeal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"get": {
"description": "Gets a finalized deal given its name.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
"location": "path",
"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "FinalizedDeal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"list": {
"description": "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.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "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 Example: 'deal.displayName, deal.updateTime desc'",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "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.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token as returned from ListFinalizedDealsResponse.",
"location": "query",
"type": "string"
},
"parent": {
"description": "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}`.",
"location": "path",
"pattern": "^buyers/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/finalizedDeals",
"response": {
"$ref": "ListFinalizedDealsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"pause": {
"description": "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.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
"location": "path",
"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:pause",
"request": {
"$ref": "PauseFinalizedDealRequest"
},
"response": {
"$ref": "FinalizedDeal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"resume": {
"description": "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.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
"location": "path",
"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:resume",
"request": {
"$ref": "ResumeFinalizedDealRequest"
},
"response": {
"$ref": "FinalizedDeal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"setReadyToServe": {
"description": "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.",
"flatPath": "v1/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe",
"parameterOrder": [
"deal"
],
"parameters": {
"deal": {
"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`",
"location": "path",
"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+deal}:setReadyToServe",
"request": {
"$ref": "SetReadyToServeRequest"
},
"response": {
"$ref": "FinalizedDeal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
}
}
},
"proposals": {
"methods": {
"accept": {
"description": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.",
"flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:accept",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.proposals.accept",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`",
"location": "path",
"pattern": "^buyers/[^/]+/proposals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:accept",
"request": {
"$ref": "AcceptProposalRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"addNote": {
"description": "Creates a note for this proposal and sends to the seller.",
"flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:addNote",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.proposals.addNote",
"parameterOrder": [
"proposal"
],
"parameters": {
"proposal": {
"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`",
"location": "path",
"pattern": "^buyers/[^/]+/proposals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+proposal}:addNote",
"request": {
"$ref": "AddNoteRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"cancelNegotiation": {
"description": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.",
"flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation",
"httpMethod": "POST",
"id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation",
"parameterOrder": [
"proposal"
],
"parameters": {
"proposal": {
"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`",
"location": "path",
"pattern": "^buyers/[^/]+/proposals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+proposal}:cancelNegotiation",
"request": {
"$ref": "CancelNegotiationRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"
]
},
"get": {
"description": "Gets a proposal using its name. The proposal is returned at most recent revision. revision.",
"flatPath": "v1/buyers/{buyersId}/proposals/{proposalsId}",
"httpMethod": "GET",
"id": "authorizedbuyersmarketplace.buyers.proposals.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`",
"location": "path",
"pattern": "^buyers/[^/]+/proposals/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/authorized-buyers-marketplace"