/
adexchangebuyer2-api.json
6133 lines (6133 loc) · 281 KB
/
adexchangebuyer2-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/adexchange.buyer": {
"description": "Manage your Ad Exchange buyer account configuration"
}
}
}
},
"basePath": "",
"baseUrl": "https://adexchangebuyer.googleapis.com/",
"batchPath": "batch",
"canonicalName": "AdExchangeBuyerII",
"description": "Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.",
"discoveryVersion": "v1",
"documentationLink": "https://developers.google.com/authorized-buyers/apis/reference/rest/",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "adexchangebuyer2:v2beta1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://adexchangebuyer.mtls.googleapis.com/",
"name": "adexchangebuyer2",
"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": {
"accounts": {
"resources": {
"clients": {
"methods": {
"create": {
"description": "Creates a new client buyer.",
"flatPath": "v2beta1/accounts/{accountId}/clients",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.clients.create",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients",
"request": {
"$ref": "Client"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"get": {
"description": "Gets a client buyer with a given client account ID.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.get",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "Lists all the clients for the current sponsor buyer.",
"flatPath": "v2beta1/accounts/{accountId}/clients",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Unique numerical account ID of the sponsor buyer to list the clients for.",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.",
"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 accounts.clients.list method.",
"location": "query",
"type": "string"
},
"partnerClientId": {
"description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients",
"response": {
"$ref": "ListClientsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"update": {
"description": "Updates an existing client buyer.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"httpMethod": "PUT",
"id": "adexchangebuyer2.accounts.clients.update",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"parameters": {
"accountId": {
"description": "Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Unique numerical account ID of the client to update. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}",
"request": {
"$ref": "Client"
},
"response": {
"$ref": "Client"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
},
"resources": {
"invitations": {
"methods": {
"create": {
"description": "Creates and sends out an email invitation to access an Ad Exchange client buyer account.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.clients.invitations.create",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer that the user should be associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"request": {
"$ref": "ClientUserInvitation"
},
"response": {
"$ref": "ClientUserInvitation"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"get": {
"description": "Retrieves an existing client user invitation.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.invitations.get",
"parameterOrder": [
"accountId",
"clientAccountId",
"invitationId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"invitationId": {
"description": "Numerical identifier of the user invitation to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}",
"response": {
"$ref": "ClientUserInvitation"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "Lists all the client users invitations for a client with a given account ID.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.invitations.list",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the `-` character to list all the invitations for all the clients of a given sponsor buyer.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.",
"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 ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations",
"response": {
"$ref": "ListClientUserInvitationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"users": {
"methods": {
"get": {
"description": "Retrieves an existing client user.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.users.get",
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "Numerical identifier of the user to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "Lists all the known client users for a specified sponsor buyer account ID.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.clients.users.list",
"parameterOrder": [
"accountId",
"clientAccountId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the sponsor buyer of the client to list users for. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the `-` character to list all the client users for all the clients of a given sponsor buyer.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.",
"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 accounts.clients.users.list method.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users",
"response": {
"$ref": "ListClientUsersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"update": {
"description": "Updates an existing client user. Only the user status can be changed on update.",
"flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"httpMethod": "PUT",
"id": "adexchangebuyer2.accounts.clients.users.update",
"parameterOrder": [
"accountId",
"clientAccountId",
"userId"
],
"parameters": {
"accountId": {
"description": "Numerical account ID of the client's sponsor buyer. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"clientAccountId": {
"description": "Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
},
"userId": {
"description": "Numerical identifier of the user to retrieve. (required)",
"format": "int64",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}",
"request": {
"$ref": "ClientUser"
},
"response": {
"$ref": "ClientUser"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
}
}
},
"creatives": {
"methods": {
"create": {
"description": "Creates a creative.",
"flatPath": "v2beta1/accounts/{accountId}/creatives",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.creatives.create",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.",
"location": "path",
"required": true,
"type": "string"
},
"duplicateIdMode": {
"description": "Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).",
"enum": [
"NO_DUPLICATES",
"FORCE_ENABLE_DUPLICATE_IDS"
],
"enumDescriptions": [
"Recommended. This means that an ID will be unique to a single creative. Multiple creatives will not share an ID.",
"Not recommended. Using this option will allow multiple creatives to share the same ID. Get and Update requests will not be possible for any ID that has more than one creative associated. (List will still function.) This is only intended for backwards compatibility in cases where a single ID is already shared by multiple creatives from previous APIs."
],
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives",
"request": {
"$ref": "Creative"
},
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"get": {
"description": "Gets a creative.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.creatives.get",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The ID of the creative to retrieve.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "Lists creatives.",
"flatPath": "v2beta1/accounts/{accountId}/creatives",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.creatives.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "The account to list the creatives from. Specify \"-\" to list all creatives the current user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.",
"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 ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method.",
"location": "query",
"type": "string"
},
"query": {
"description": "An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives",
"response": {
"$ref": "ListCreativesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"stopWatching": {
"description": "Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.creatives.stopWatching",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account of the creative to stop notifications for.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The creative ID of the creative to stop notifications for. Specify \"-\" to specify stopping account level notifications.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching",
"request": {
"$ref": "StopWatchingCreativeRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"update": {
"description": "Updates a creative.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"httpMethod": "PUT",
"id": "adexchangebuyer2.accounts.creatives.update",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account that this creative belongs to. Can be used to filter the response of the creatives.list method.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}",
"request": {
"$ref": "Creative"
},
"response": {
"$ref": "Creative"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"watch": {
"description": "Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.creatives.watch",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account of the creative to watch.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The creative ID to watch for status changes. Specify \"-\" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch",
"request": {
"$ref": "WatchCreativeRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
},
"resources": {
"dealAssociations": {
"methods": {
"add": {
"description": "Associate an existing deal with a creative.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.add",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The ID of the creative associated with the deal.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add",
"request": {
"$ref": "AddDealAssociationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"list": {
"description": "List all creative-deal associations.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.list",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account to list the associations from. Specify \"-\" to list all creatives the current user has access to.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The creative ID to list the associations from. Specify \"-\" to list all creatives under the above account.",
"location": "path",
"required": true,
"type": "string"
},
"pageSize": {
"description": "Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.",
"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 ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.",
"location": "query",
"type": "string"
},
"query": {
"description": "An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsId=*deals_id_string* - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations",
"response": {
"$ref": "ListDealAssociationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"remove": {
"description": "Remove the association between a deal and a creative.",
"flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove",
"parameterOrder": [
"accountId",
"creativeId"
],
"parameters": {
"accountId": {
"description": "The account the creative belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"creativeId": {
"description": "The ID of the creative associated with the deal.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove",
"request": {
"$ref": "RemoveDealAssociationRequest"
},
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
}
}
},
"finalizedProposals": {
"methods": {
"list": {
"description": "List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.",
"flatPath": "v2beta1/accounts/{accountId}/finalizedProposals",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.finalizedProposals.list",
"parameterOrder": [
"accountId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"filter": {
"description": "An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.",
"location": "query",
"type": "string"
},
"filterSyntax": {
"description": "Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.",
"enum": [
"FILTER_SYNTAX_UNSPECIFIED",
"PQL",
"LIST_FILTER"
],
"enumDescriptions": [
"A placeholder for an undefined filter syntax.",
"PQL query syntax. Visit https://developers.google.com/ad-manager/api/pqlreference for PQL documentation and examples.",
"API list filtering syntax. Read about syntax and usage at https://developers.google.com/authorized-buyers/apis/guides/v2/list-filters."
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The page token as returned from ListProposalsResponse.",
"location": "query",
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/finalizedProposals",
"response": {
"$ref": "ListProposalsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"pause": {
"description": "Update given deals to pause serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.",
"flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.finalizedProposals.pause",
"parameterOrder": [
"accountId",
"proposalId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"proposalId": {
"description": "The proposal_id of the proposal containing the deals.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:pause",
"request": {
"$ref": "PauseProposalDealsRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
},
"resume": {
"description": "Update given deals to resume serving. This method will set the `DealServingMetadata.DealPauseStatus.has_buyer_paused` bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.",
"flatPath": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume",
"httpMethod": "POST",
"id": "adexchangebuyer2.accounts.finalizedProposals.resume",
"parameterOrder": [
"accountId",
"proposalId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"proposalId": {
"description": "The proposal_id of the proposal containing the deals.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/finalizedProposals/{proposalId}:resume",
"request": {
"$ref": "ResumeProposalDealsRequest"
},
"response": {
"$ref": "Proposal"
},
"scopes": [
"https://www.googleapis.com/auth/adexchange.buyer"
]
}
}
},
"products": {
"methods": {
"get": {
"description": "Gets the requested product by ID.",
"flatPath": "v2beta1/accounts/{accountId}/products/{productId}",
"httpMethod": "GET",
"id": "adexchangebuyer2.accounts.products.get",
"parameterOrder": [
"accountId",
"productId"
],
"parameters": {
"accountId": {
"description": "Account ID of the buyer.",
"location": "path",
"required": true,
"type": "string"
},
"productId": {
"description": "The ID for the product to get the head revision for.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v2beta1/accounts/{accountId}/products/{productId}",
"response": {