criteo-api-marketingsolutions-sdk 2025.7.0.251021__py3-none-any.whl → 2025.7.0.251029__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of criteo-api-marketingsolutions-sdk might be problematic. Click here for more details.
- {criteo_api_marketingsolutions_sdk-2025.7.0.251021.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251029.dist-info}/METADATA +3 -3
- {criteo_api_marketingsolutions_sdk-2025.7.0.251021.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251029.dist-info}/RECORD +9 -9
- criteo_api_marketingsolutions_v2025_07/__init__.py +1 -1
- criteo_api_marketingsolutions_v2025_07/api/audience_api.py +526 -526
- criteo_api_marketingsolutions_v2025_07/api/campaign_api.py +697 -697
- criteo_api_marketingsolutions_v2025_07/api_client.py +1 -1
- criteo_api_marketingsolutions_v2025_07/configuration.py +1 -1
- {criteo_api_marketingsolutions_sdk-2025.7.0.251021.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251029.dist-info}/WHEEL +0 -0
- {criteo_api_marketingsolutions_sdk-2025.7.0.251021.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251029.dist-info}/top_level.txt +0 -0
|
@@ -64,101 +64,6 @@ class CampaignApi(object):
|
|
|
64
64
|
if api_client is None:
|
|
65
65
|
api_client = ApiClient()
|
|
66
66
|
self.api_client = api_client
|
|
67
|
-
self.campaigns_endpoint = _Endpoint(
|
|
68
|
-
settings={
|
|
69
|
-
'response_type': (str,),
|
|
70
|
-
'auth': [
|
|
71
|
-
'oauth',
|
|
72
|
-
'oauth'
|
|
73
|
-
],
|
|
74
|
-
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns',
|
|
75
|
-
'operation_id': 'campaigns',
|
|
76
|
-
'http_method': 'GET',
|
|
77
|
-
'servers': None,
|
|
78
|
-
},
|
|
79
|
-
params_map={
|
|
80
|
-
'all': [
|
|
81
|
-
'advertiser_id',
|
|
82
|
-
'campaign_id',
|
|
83
|
-
'click_attribution_policy',
|
|
84
|
-
'count',
|
|
85
|
-
'end_date',
|
|
86
|
-
'interval_size',
|
|
87
|
-
'start_date',
|
|
88
|
-
],
|
|
89
|
-
'required': [],
|
|
90
|
-
'nullable': [
|
|
91
|
-
],
|
|
92
|
-
'enum': [
|
|
93
|
-
'click_attribution_policy',
|
|
94
|
-
'interval_size',
|
|
95
|
-
],
|
|
96
|
-
'validation': [
|
|
97
|
-
]
|
|
98
|
-
},
|
|
99
|
-
root_map={
|
|
100
|
-
'validations': {
|
|
101
|
-
},
|
|
102
|
-
'allowed_values': {
|
|
103
|
-
('click_attribution_policy',): {
|
|
104
|
-
|
|
105
|
-
"BOTH": "Both",
|
|
106
|
-
"SAMESELLER": "SameSeller",
|
|
107
|
-
"ANYSELLER": "AnySeller"
|
|
108
|
-
},
|
|
109
|
-
('interval_size',): {
|
|
110
|
-
|
|
111
|
-
"HOUR": "Hour",
|
|
112
|
-
"DAY": "Day",
|
|
113
|
-
"MONTH": "Month",
|
|
114
|
-
"YEAR": "Year"
|
|
115
|
-
},
|
|
116
|
-
},
|
|
117
|
-
'openapi_types': {
|
|
118
|
-
'advertiser_id':
|
|
119
|
-
(int,),
|
|
120
|
-
'campaign_id':
|
|
121
|
-
(str,),
|
|
122
|
-
'click_attribution_policy':
|
|
123
|
-
(str,),
|
|
124
|
-
'count':
|
|
125
|
-
(int,),
|
|
126
|
-
'end_date':
|
|
127
|
-
(datetime,),
|
|
128
|
-
'interval_size':
|
|
129
|
-
(str,),
|
|
130
|
-
'start_date':
|
|
131
|
-
(datetime,),
|
|
132
|
-
},
|
|
133
|
-
'attribute_map': {
|
|
134
|
-
'advertiser_id': 'advertiserId',
|
|
135
|
-
'campaign_id': 'campaignId',
|
|
136
|
-
'click_attribution_policy': 'clickAttributionPolicy',
|
|
137
|
-
'count': 'count',
|
|
138
|
-
'end_date': 'endDate',
|
|
139
|
-
'interval_size': 'intervalSize',
|
|
140
|
-
'start_date': 'startDate',
|
|
141
|
-
},
|
|
142
|
-
'location_map': {
|
|
143
|
-
'advertiser_id': 'query',
|
|
144
|
-
'campaign_id': 'query',
|
|
145
|
-
'click_attribution_policy': 'query',
|
|
146
|
-
'count': 'query',
|
|
147
|
-
'end_date': 'query',
|
|
148
|
-
'interval_size': 'query',
|
|
149
|
-
'start_date': 'query',
|
|
150
|
-
},
|
|
151
|
-
'collection_format_map': {
|
|
152
|
-
}
|
|
153
|
-
},
|
|
154
|
-
headers_map={
|
|
155
|
-
'accept': [
|
|
156
|
-
'application/json'
|
|
157
|
-
],
|
|
158
|
-
'content_type': [],
|
|
159
|
-
},
|
|
160
|
-
api_client=api_client
|
|
161
|
-
)
|
|
162
67
|
self.create_ad_set_endpoint = _Endpoint(
|
|
163
68
|
settings={
|
|
164
69
|
'response_type': (ResponseReadAdSetV24Q3,),
|
|
@@ -265,7 +170,7 @@ class CampaignApi(object):
|
|
|
265
170
|
},
|
|
266
171
|
api_client=api_client
|
|
267
172
|
)
|
|
268
|
-
self.
|
|
173
|
+
self.create_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
269
174
|
settings={
|
|
270
175
|
'response_type': None,
|
|
271
176
|
'auth': [
|
|
@@ -273,7 +178,7 @@ class CampaignApi(object):
|
|
|
273
178
|
'oauth'
|
|
274
179
|
],
|
|
275
180
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
276
|
-
'operation_id': '
|
|
181
|
+
'operation_id': 'create_marketplace_seller_budgets',
|
|
277
182
|
'http_method': 'POST',
|
|
278
183
|
'servers': None,
|
|
279
184
|
},
|
|
@@ -314,7 +219,7 @@ class CampaignApi(object):
|
|
|
314
219
|
},
|
|
315
220
|
api_client=api_client
|
|
316
221
|
)
|
|
317
|
-
self.
|
|
222
|
+
self.create_marketplace_seller_campaigns_by_seller_endpoint = _Endpoint(
|
|
318
223
|
settings={
|
|
319
224
|
'response_type': None,
|
|
320
225
|
'auth': [
|
|
@@ -322,7 +227,7 @@ class CampaignApi(object):
|
|
|
322
227
|
'oauth'
|
|
323
228
|
],
|
|
324
229
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns',
|
|
325
|
-
'operation_id': '
|
|
230
|
+
'operation_id': 'create_marketplace_seller_campaigns_by_seller',
|
|
326
231
|
'http_method': 'POST',
|
|
327
232
|
'servers': None,
|
|
328
233
|
},
|
|
@@ -370,26 +275,24 @@ class CampaignApi(object):
|
|
|
370
275
|
},
|
|
371
276
|
api_client=api_client
|
|
372
277
|
)
|
|
373
|
-
self.
|
|
278
|
+
self.get_ad_set_endpoint = _Endpoint(
|
|
374
279
|
settings={
|
|
375
|
-
'response_type':
|
|
280
|
+
'response_type': (ResponseReadAdSetV24Q3,),
|
|
376
281
|
'auth': [
|
|
377
282
|
'oauth',
|
|
378
283
|
'oauth'
|
|
379
284
|
],
|
|
380
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
381
|
-
'operation_id': '
|
|
382
|
-
'http_method': '
|
|
285
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}',
|
|
286
|
+
'operation_id': 'get_ad_set',
|
|
287
|
+
'http_method': 'GET',
|
|
383
288
|
'servers': None,
|
|
384
289
|
},
|
|
385
290
|
params_map={
|
|
386
291
|
'all': [
|
|
387
|
-
'
|
|
388
|
-
'partner_id',
|
|
389
|
-
'request_body',
|
|
292
|
+
'ad_set_id',
|
|
390
293
|
],
|
|
391
294
|
'required': [
|
|
392
|
-
'
|
|
295
|
+
'ad_set_id',
|
|
393
296
|
],
|
|
394
297
|
'nullable': [
|
|
395
298
|
],
|
|
@@ -404,42 +307,35 @@ class CampaignApi(object):
|
|
|
404
307
|
'allowed_values': {
|
|
405
308
|
},
|
|
406
309
|
'openapi_types': {
|
|
407
|
-
'
|
|
408
|
-
(
|
|
409
|
-
'partner_id':
|
|
410
|
-
(int,),
|
|
411
|
-
'request_body':
|
|
412
|
-
([str],),
|
|
310
|
+
'ad_set_id':
|
|
311
|
+
(str,),
|
|
413
312
|
},
|
|
414
313
|
'attribute_map': {
|
|
415
|
-
'
|
|
416
|
-
'partner_id': 'partnerId',
|
|
314
|
+
'ad_set_id': 'ad-set-id',
|
|
417
315
|
},
|
|
418
316
|
'location_map': {
|
|
419
|
-
'
|
|
420
|
-
'partner_id': 'query',
|
|
421
|
-
'request_body': 'body',
|
|
317
|
+
'ad_set_id': 'path',
|
|
422
318
|
},
|
|
423
319
|
'collection_format_map': {
|
|
424
320
|
}
|
|
425
321
|
},
|
|
426
322
|
headers_map={
|
|
427
|
-
'accept': [
|
|
428
|
-
'content_type': [
|
|
323
|
+
'accept': [
|
|
429
324
|
'application/json'
|
|
430
|
-
]
|
|
325
|
+
],
|
|
326
|
+
'content_type': [],
|
|
431
327
|
},
|
|
432
328
|
api_client=api_client
|
|
433
329
|
)
|
|
434
|
-
self.
|
|
330
|
+
self.get_ad_set_category_bids_endpoint = _Endpoint(
|
|
435
331
|
settings={
|
|
436
|
-
'response_type': (
|
|
332
|
+
'response_type': (AdSetCategoryBidListResponse,),
|
|
437
333
|
'auth': [
|
|
438
334
|
'oauth',
|
|
439
335
|
'oauth'
|
|
440
336
|
],
|
|
441
|
-
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}',
|
|
442
|
-
'operation_id': '
|
|
337
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
|
|
338
|
+
'operation_id': 'get_ad_set_category_bids',
|
|
443
339
|
'http_method': 'GET',
|
|
444
340
|
'servers': None,
|
|
445
341
|
},
|
|
@@ -483,24 +379,24 @@ class CampaignApi(object):
|
|
|
483
379
|
},
|
|
484
380
|
api_client=api_client
|
|
485
381
|
)
|
|
486
|
-
self.
|
|
382
|
+
self.get_campaign_endpoint = _Endpoint(
|
|
487
383
|
settings={
|
|
488
|
-
'response_type': (
|
|
384
|
+
'response_type': (CampaignV23Q1Response,),
|
|
489
385
|
'auth': [
|
|
490
386
|
'oauth',
|
|
491
387
|
'oauth'
|
|
492
388
|
],
|
|
493
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
494
|
-
'operation_id': '
|
|
389
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns/{campaign-id}',
|
|
390
|
+
'operation_id': 'get_campaign',
|
|
495
391
|
'http_method': 'GET',
|
|
496
392
|
'servers': None,
|
|
497
393
|
},
|
|
498
394
|
params_map={
|
|
499
395
|
'all': [
|
|
500
|
-
'
|
|
396
|
+
'campaign_id',
|
|
501
397
|
],
|
|
502
398
|
'required': [
|
|
503
|
-
'
|
|
399
|
+
'campaign_id',
|
|
504
400
|
],
|
|
505
401
|
'nullable': [
|
|
506
402
|
],
|
|
@@ -515,14 +411,14 @@ class CampaignApi(object):
|
|
|
515
411
|
'allowed_values': {
|
|
516
412
|
},
|
|
517
413
|
'openapi_types': {
|
|
518
|
-
'
|
|
414
|
+
'campaign_id':
|
|
519
415
|
(str,),
|
|
520
416
|
},
|
|
521
417
|
'attribute_map': {
|
|
522
|
-
'
|
|
418
|
+
'campaign_id': 'campaign-id',
|
|
523
419
|
},
|
|
524
420
|
'location_map': {
|
|
525
|
-
'
|
|
421
|
+
'campaign_id': 'path',
|
|
526
422
|
},
|
|
527
423
|
'collection_format_map': {
|
|
528
424
|
}
|
|
@@ -535,24 +431,24 @@ class CampaignApi(object):
|
|
|
535
431
|
},
|
|
536
432
|
api_client=api_client
|
|
537
433
|
)
|
|
538
|
-
self.
|
|
434
|
+
self.get_display_multipliers_endpoint = _Endpoint(
|
|
539
435
|
settings={
|
|
540
|
-
'response_type':
|
|
436
|
+
'response_type': (AdSetDisplayMultiplierListResponse,),
|
|
541
437
|
'auth': [
|
|
542
438
|
'oauth',
|
|
543
439
|
'oauth'
|
|
544
440
|
],
|
|
545
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
546
|
-
'operation_id': '
|
|
441
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
|
|
442
|
+
'operation_id': 'get_display_multipliers',
|
|
547
443
|
'http_method': 'GET',
|
|
548
444
|
'servers': None,
|
|
549
445
|
},
|
|
550
446
|
params_map={
|
|
551
447
|
'all': [
|
|
552
|
-
'
|
|
448
|
+
'ad_set_id',
|
|
553
449
|
],
|
|
554
450
|
'required': [
|
|
555
|
-
'
|
|
451
|
+
'ad_set_id',
|
|
556
452
|
],
|
|
557
453
|
'nullable': [
|
|
558
454
|
],
|
|
@@ -567,25 +463,27 @@ class CampaignApi(object):
|
|
|
567
463
|
'allowed_values': {
|
|
568
464
|
},
|
|
569
465
|
'openapi_types': {
|
|
570
|
-
'
|
|
571
|
-
(
|
|
466
|
+
'ad_set_id':
|
|
467
|
+
(str,),
|
|
572
468
|
},
|
|
573
469
|
'attribute_map': {
|
|
574
|
-
'
|
|
470
|
+
'ad_set_id': 'ad-set-id',
|
|
575
471
|
},
|
|
576
472
|
'location_map': {
|
|
577
|
-
'
|
|
473
|
+
'ad_set_id': 'path',
|
|
578
474
|
},
|
|
579
475
|
'collection_format_map': {
|
|
580
476
|
}
|
|
581
477
|
},
|
|
582
478
|
headers_map={
|
|
583
|
-
'accept': [
|
|
479
|
+
'accept': [
|
|
480
|
+
'application/json'
|
|
481
|
+
],
|
|
584
482
|
'content_type': [],
|
|
585
483
|
},
|
|
586
484
|
api_client=api_client
|
|
587
485
|
)
|
|
588
|
-
self.
|
|
486
|
+
self.get_marketplace_ad_sets_by_advertiser_endpoint = _Endpoint(
|
|
589
487
|
settings={
|
|
590
488
|
'response_type': None,
|
|
591
489
|
'auth': [
|
|
@@ -593,7 +491,7 @@ class CampaignApi(object):
|
|
|
593
491
|
'oauth'
|
|
594
492
|
],
|
|
595
493
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/adsets',
|
|
596
|
-
'operation_id': '
|
|
494
|
+
'operation_id': 'get_marketplace_ad_sets_by_advertiser',
|
|
597
495
|
'http_method': 'GET',
|
|
598
496
|
'servers': None,
|
|
599
497
|
},
|
|
@@ -635,15 +533,15 @@ class CampaignApi(object):
|
|
|
635
533
|
},
|
|
636
534
|
api_client=api_client
|
|
637
535
|
)
|
|
638
|
-
self.
|
|
536
|
+
self.get_marketplace_advertiser_endpoint = _Endpoint(
|
|
639
537
|
settings={
|
|
640
538
|
'response_type': None,
|
|
641
539
|
'auth': [
|
|
642
540
|
'oauth',
|
|
643
541
|
'oauth'
|
|
644
542
|
],
|
|
645
|
-
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}
|
|
646
|
-
'operation_id': '
|
|
543
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}',
|
|
544
|
+
'operation_id': 'get_marketplace_advertiser',
|
|
647
545
|
'http_method': 'GET',
|
|
648
546
|
'servers': None,
|
|
649
547
|
},
|
|
@@ -685,7 +583,7 @@ class CampaignApi(object):
|
|
|
685
583
|
},
|
|
686
584
|
api_client=api_client
|
|
687
585
|
)
|
|
688
|
-
self.
|
|
586
|
+
self.get_marketplace_advertiser_preview_limits_endpoint = _Endpoint(
|
|
689
587
|
settings={
|
|
690
588
|
'response_type': None,
|
|
691
589
|
'auth': [
|
|
@@ -693,7 +591,7 @@ class CampaignApi(object):
|
|
|
693
591
|
'oauth'
|
|
694
592
|
],
|
|
695
593
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/preview-limit',
|
|
696
|
-
'operation_id': '
|
|
594
|
+
'operation_id': 'get_marketplace_advertiser_preview_limits',
|
|
697
595
|
'http_method': 'GET',
|
|
698
596
|
'servers': None,
|
|
699
597
|
},
|
|
@@ -728,7 +626,7 @@ class CampaignApi(object):
|
|
|
728
626
|
},
|
|
729
627
|
api_client=api_client
|
|
730
628
|
)
|
|
731
|
-
self.
|
|
629
|
+
self.get_marketplace_advertisers_endpoint = _Endpoint(
|
|
732
630
|
settings={
|
|
733
631
|
'response_type': None,
|
|
734
632
|
'auth': [
|
|
@@ -736,7 +634,7 @@ class CampaignApi(object):
|
|
|
736
634
|
'oauth'
|
|
737
635
|
],
|
|
738
636
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers',
|
|
739
|
-
'operation_id': '
|
|
637
|
+
'operation_id': 'get_marketplace_advertisers',
|
|
740
638
|
'http_method': 'GET',
|
|
741
639
|
'servers': None,
|
|
742
640
|
},
|
|
@@ -771,7 +669,7 @@ class CampaignApi(object):
|
|
|
771
669
|
},
|
|
772
670
|
api_client=api_client
|
|
773
671
|
)
|
|
774
|
-
self.
|
|
672
|
+
self.get_marketplace_budgets_by_advertiser_endpoint = _Endpoint(
|
|
775
673
|
settings={
|
|
776
674
|
'response_type': None,
|
|
777
675
|
'auth': [
|
|
@@ -779,7 +677,7 @@ class CampaignApi(object):
|
|
|
779
677
|
'oauth'
|
|
780
678
|
],
|
|
781
679
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/budgets',
|
|
782
|
-
'operation_id': '
|
|
680
|
+
'operation_id': 'get_marketplace_budgets_by_advertiser',
|
|
783
681
|
'http_method': 'GET',
|
|
784
682
|
'servers': None,
|
|
785
683
|
},
|
|
@@ -868,7 +766,7 @@ class CampaignApi(object):
|
|
|
868
766
|
},
|
|
869
767
|
api_client=api_client
|
|
870
768
|
)
|
|
871
|
-
self.
|
|
769
|
+
self.get_marketplace_budgets_by_seller_endpoint = _Endpoint(
|
|
872
770
|
settings={
|
|
873
771
|
'response_type': ([SellerBudgetMessage],),
|
|
874
772
|
'auth': [
|
|
@@ -876,7 +774,7 @@ class CampaignApi(object):
|
|
|
876
774
|
'oauth'
|
|
877
775
|
],
|
|
878
776
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/budgets',
|
|
879
|
-
'operation_id': '
|
|
777
|
+
'operation_id': 'get_marketplace_budgets_by_seller',
|
|
880
778
|
'http_method': 'GET',
|
|
881
779
|
'servers': None,
|
|
882
780
|
},
|
|
@@ -962,7 +860,7 @@ class CampaignApi(object):
|
|
|
962
860
|
},
|
|
963
861
|
api_client=api_client
|
|
964
862
|
)
|
|
965
|
-
self.
|
|
863
|
+
self.get_marketplace_budgets_by_seller_campaign_endpoint = _Endpoint(
|
|
966
864
|
settings={
|
|
967
865
|
'response_type': ([SellerBudgetMessage],),
|
|
968
866
|
'auth': [
|
|
@@ -970,7 +868,7 @@ class CampaignApi(object):
|
|
|
970
868
|
'oauth'
|
|
971
869
|
],
|
|
972
870
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}/budgets',
|
|
973
|
-
'operation_id': '
|
|
871
|
+
'operation_id': 'get_marketplace_budgets_by_seller_campaign',
|
|
974
872
|
'http_method': 'GET',
|
|
975
873
|
'servers': None,
|
|
976
874
|
},
|
|
@@ -1051,24 +949,24 @@ class CampaignApi(object):
|
|
|
1051
949
|
},
|
|
1052
950
|
api_client=api_client
|
|
1053
951
|
)
|
|
1054
|
-
self.
|
|
952
|
+
self.get_marketplace_campaigns_by_advertiser_endpoint = _Endpoint(
|
|
1055
953
|
settings={
|
|
1056
|
-
'response_type':
|
|
954
|
+
'response_type': None,
|
|
1057
955
|
'auth': [
|
|
1058
956
|
'oauth',
|
|
1059
957
|
'oauth'
|
|
1060
958
|
],
|
|
1061
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1062
|
-
'operation_id': '
|
|
959
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/campaigns',
|
|
960
|
+
'operation_id': 'get_marketplace_campaigns_by_advertiser',
|
|
1063
961
|
'http_method': 'GET',
|
|
1064
962
|
'servers': None,
|
|
1065
963
|
},
|
|
1066
964
|
params_map={
|
|
1067
965
|
'all': [
|
|
1068
|
-
'
|
|
966
|
+
'advertiser_id',
|
|
1069
967
|
],
|
|
1070
968
|
'required': [
|
|
1071
|
-
'
|
|
969
|
+
'advertiser_id',
|
|
1072
970
|
],
|
|
1073
971
|
'nullable': [
|
|
1074
972
|
],
|
|
@@ -1083,48 +981,52 @@ class CampaignApi(object):
|
|
|
1083
981
|
'allowed_values': {
|
|
1084
982
|
},
|
|
1085
983
|
'openapi_types': {
|
|
1086
|
-
'
|
|
1087
|
-
(
|
|
984
|
+
'advertiser_id':
|
|
985
|
+
(int,),
|
|
1088
986
|
},
|
|
1089
987
|
'attribute_map': {
|
|
1090
|
-
'
|
|
988
|
+
'advertiser_id': 'advertiserId',
|
|
1091
989
|
},
|
|
1092
990
|
'location_map': {
|
|
1093
|
-
'
|
|
991
|
+
'advertiser_id': 'path',
|
|
1094
992
|
},
|
|
1095
993
|
'collection_format_map': {
|
|
1096
994
|
}
|
|
1097
995
|
},
|
|
1098
996
|
headers_map={
|
|
1099
|
-
'accept': [
|
|
1100
|
-
'application/json'
|
|
1101
|
-
],
|
|
997
|
+
'accept': [],
|
|
1102
998
|
'content_type': [],
|
|
1103
999
|
},
|
|
1104
1000
|
api_client=api_client
|
|
1105
1001
|
)
|
|
1106
|
-
self.
|
|
1002
|
+
self.get_marketplace_campaigns_stats_endpoint = _Endpoint(
|
|
1107
1003
|
settings={
|
|
1108
|
-
'response_type': (
|
|
1004
|
+
'response_type': (str,),
|
|
1109
1005
|
'auth': [
|
|
1110
1006
|
'oauth',
|
|
1111
1007
|
'oauth'
|
|
1112
1008
|
],
|
|
1113
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1114
|
-
'operation_id': '
|
|
1009
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns',
|
|
1010
|
+
'operation_id': 'get_marketplace_campaigns_stats',
|
|
1115
1011
|
'http_method': 'GET',
|
|
1116
1012
|
'servers': None,
|
|
1117
1013
|
},
|
|
1118
1014
|
params_map={
|
|
1119
1015
|
'all': [
|
|
1120
|
-
'
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
'
|
|
1016
|
+
'advertiser_id',
|
|
1017
|
+
'campaign_id',
|
|
1018
|
+
'click_attribution_policy',
|
|
1019
|
+
'count',
|
|
1020
|
+
'end_date',
|
|
1021
|
+
'interval_size',
|
|
1022
|
+
'start_date',
|
|
1124
1023
|
],
|
|
1024
|
+
'required': [],
|
|
1125
1025
|
'nullable': [
|
|
1126
1026
|
],
|
|
1127
1027
|
'enum': [
|
|
1028
|
+
'click_attribution_policy',
|
|
1029
|
+
'interval_size',
|
|
1128
1030
|
],
|
|
1129
1031
|
'validation': [
|
|
1130
1032
|
]
|
|
@@ -1133,16 +1035,53 @@ class CampaignApi(object):
|
|
|
1133
1035
|
'validations': {
|
|
1134
1036
|
},
|
|
1135
1037
|
'allowed_values': {
|
|
1038
|
+
('click_attribution_policy',): {
|
|
1039
|
+
|
|
1040
|
+
"BOTH": "Both",
|
|
1041
|
+
"SAMESELLER": "SameSeller",
|
|
1042
|
+
"ANYSELLER": "AnySeller"
|
|
1043
|
+
},
|
|
1044
|
+
('interval_size',): {
|
|
1045
|
+
|
|
1046
|
+
"HOUR": "Hour",
|
|
1047
|
+
"DAY": "Day",
|
|
1048
|
+
"MONTH": "Month",
|
|
1049
|
+
"YEAR": "Year"
|
|
1050
|
+
},
|
|
1136
1051
|
},
|
|
1137
1052
|
'openapi_types': {
|
|
1138
|
-
'
|
|
1053
|
+
'advertiser_id':
|
|
1054
|
+
(int,),
|
|
1055
|
+
'campaign_id':
|
|
1056
|
+
(str,),
|
|
1057
|
+
'click_attribution_policy':
|
|
1058
|
+
(str,),
|
|
1059
|
+
'count':
|
|
1060
|
+
(int,),
|
|
1061
|
+
'end_date':
|
|
1062
|
+
(datetime,),
|
|
1063
|
+
'interval_size':
|
|
1139
1064
|
(str,),
|
|
1065
|
+
'start_date':
|
|
1066
|
+
(datetime,),
|
|
1140
1067
|
},
|
|
1141
1068
|
'attribute_map': {
|
|
1142
|
-
'
|
|
1069
|
+
'advertiser_id': 'advertiserId',
|
|
1070
|
+
'campaign_id': 'campaignId',
|
|
1071
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1072
|
+
'count': 'count',
|
|
1073
|
+
'end_date': 'endDate',
|
|
1074
|
+
'interval_size': 'intervalSize',
|
|
1075
|
+
'start_date': 'startDate',
|
|
1143
1076
|
},
|
|
1144
1077
|
'location_map': {
|
|
1145
|
-
'
|
|
1078
|
+
'advertiser_id': 'query',
|
|
1079
|
+
'campaign_id': 'query',
|
|
1080
|
+
'click_attribution_policy': 'query',
|
|
1081
|
+
'count': 'query',
|
|
1082
|
+
'end_date': 'query',
|
|
1083
|
+
'interval_size': 'query',
|
|
1084
|
+
'start_date': 'query',
|
|
1146
1085
|
},
|
|
1147
1086
|
'collection_format_map': {
|
|
1148
1087
|
}
|
|
@@ -1155,7 +1094,7 @@ class CampaignApi(object):
|
|
|
1155
1094
|
},
|
|
1156
1095
|
api_client=api_client
|
|
1157
1096
|
)
|
|
1158
|
-
self.
|
|
1097
|
+
self.get_marketplace_seller_endpoint = _Endpoint(
|
|
1159
1098
|
settings={
|
|
1160
1099
|
'response_type': (SellerBase,),
|
|
1161
1100
|
'auth': [
|
|
@@ -1163,7 +1102,7 @@ class CampaignApi(object):
|
|
|
1163
1102
|
'oauth'
|
|
1164
1103
|
],
|
|
1165
1104
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}',
|
|
1166
|
-
'operation_id': '
|
|
1105
|
+
'operation_id': 'get_marketplace_seller',
|
|
1167
1106
|
'http_method': 'GET',
|
|
1168
1107
|
'servers': None,
|
|
1169
1108
|
},
|
|
@@ -1207,7 +1146,7 @@ class CampaignApi(object):
|
|
|
1207
1146
|
},
|
|
1208
1147
|
api_client=api_client
|
|
1209
1148
|
)
|
|
1210
|
-
self.
|
|
1149
|
+
self.get_marketplace_seller_ad_preview_endpoint = _Endpoint(
|
|
1211
1150
|
settings={
|
|
1212
1151
|
'response_type': (str,),
|
|
1213
1152
|
'auth': [
|
|
@@ -1215,7 +1154,7 @@ class CampaignApi(object):
|
|
|
1215
1154
|
'oauth'
|
|
1216
1155
|
],
|
|
1217
1156
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/ad-preview',
|
|
1218
|
-
'operation_id': '
|
|
1157
|
+
'operation_id': 'get_marketplace_seller_ad_preview',
|
|
1219
1158
|
'http_method': 'GET',
|
|
1220
1159
|
'servers': None,
|
|
1221
1160
|
},
|
|
@@ -1280,7 +1219,7 @@ class CampaignApi(object):
|
|
|
1280
1219
|
},
|
|
1281
1220
|
api_client=api_client
|
|
1282
1221
|
)
|
|
1283
|
-
self.
|
|
1222
|
+
self.get_marketplace_seller_budget_endpoint = _Endpoint(
|
|
1284
1223
|
settings={
|
|
1285
1224
|
'response_type': (SellerBudgetMessage,),
|
|
1286
1225
|
'auth': [
|
|
@@ -1288,7 +1227,7 @@ class CampaignApi(object):
|
|
|
1288
1227
|
'oauth'
|
|
1289
1228
|
],
|
|
1290
1229
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}',
|
|
1291
|
-
'operation_id': '
|
|
1230
|
+
'operation_id': 'get_marketplace_seller_budget',
|
|
1292
1231
|
'http_method': 'GET',
|
|
1293
1232
|
'servers': None,
|
|
1294
1233
|
},
|
|
@@ -1332,7 +1271,7 @@ class CampaignApi(object):
|
|
|
1332
1271
|
},
|
|
1333
1272
|
api_client=api_client
|
|
1334
1273
|
)
|
|
1335
|
-
self.
|
|
1274
|
+
self.get_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
1336
1275
|
settings={
|
|
1337
1276
|
'response_type': ([SellerBudgetMessage],),
|
|
1338
1277
|
'auth': [
|
|
@@ -1340,7 +1279,7 @@ class CampaignApi(object):
|
|
|
1340
1279
|
'oauth'
|
|
1341
1280
|
],
|
|
1342
1281
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
1343
|
-
'operation_id': '
|
|
1282
|
+
'operation_id': 'get_marketplace_seller_budgets',
|
|
1344
1283
|
'http_method': 'GET',
|
|
1345
1284
|
'servers': None,
|
|
1346
1285
|
},
|
|
@@ -1429,7 +1368,7 @@ class CampaignApi(object):
|
|
|
1429
1368
|
},
|
|
1430
1369
|
api_client=api_client
|
|
1431
1370
|
)
|
|
1432
|
-
self.
|
|
1371
|
+
self.get_marketplace_seller_campaign_endpoint = _Endpoint(
|
|
1433
1372
|
settings={
|
|
1434
1373
|
'response_type': (SellerCampaignMessage,),
|
|
1435
1374
|
'auth': [
|
|
@@ -1437,7 +1376,7 @@ class CampaignApi(object):
|
|
|
1437
1376
|
'oauth'
|
|
1438
1377
|
],
|
|
1439
1378
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}',
|
|
1440
|
-
'operation_id': '
|
|
1379
|
+
'operation_id': 'get_marketplace_seller_campaign',
|
|
1441
1380
|
'http_method': 'GET',
|
|
1442
1381
|
'servers': None,
|
|
1443
1382
|
},
|
|
@@ -1481,7 +1420,7 @@ class CampaignApi(object):
|
|
|
1481
1420
|
},
|
|
1482
1421
|
api_client=api_client
|
|
1483
1422
|
)
|
|
1484
|
-
self.
|
|
1423
|
+
self.get_marketplace_seller_campaigns_endpoint = _Endpoint(
|
|
1485
1424
|
settings={
|
|
1486
1425
|
'response_type': ([SellerCampaignMessage],),
|
|
1487
1426
|
'auth': [
|
|
@@ -1489,7 +1428,7 @@ class CampaignApi(object):
|
|
|
1489
1428
|
'oauth'
|
|
1490
1429
|
],
|
|
1491
1430
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns',
|
|
1492
|
-
'operation_id': '
|
|
1431
|
+
'operation_id': 'get_marketplace_seller_campaigns',
|
|
1493
1432
|
'http_method': 'GET',
|
|
1494
1433
|
'servers': None,
|
|
1495
1434
|
},
|
|
@@ -1564,7 +1503,7 @@ class CampaignApi(object):
|
|
|
1564
1503
|
},
|
|
1565
1504
|
api_client=api_client
|
|
1566
1505
|
)
|
|
1567
|
-
self.
|
|
1506
|
+
self.get_marketplace_seller_campaigns_by_advertiser_endpoint = _Endpoint(
|
|
1568
1507
|
settings={
|
|
1569
1508
|
'response_type': None,
|
|
1570
1509
|
'auth': [
|
|
@@ -1572,7 +1511,7 @@ class CampaignApi(object):
|
|
|
1572
1511
|
'oauth'
|
|
1573
1512
|
],
|
|
1574
1513
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/seller-campaigns',
|
|
1575
|
-
'operation_id': '
|
|
1514
|
+
'operation_id': 'get_marketplace_seller_campaigns_by_advertiser',
|
|
1576
1515
|
'http_method': 'GET',
|
|
1577
1516
|
'servers': None,
|
|
1578
1517
|
},
|
|
@@ -1614,7 +1553,7 @@ class CampaignApi(object):
|
|
|
1614
1553
|
},
|
|
1615
1554
|
api_client=api_client
|
|
1616
1555
|
)
|
|
1617
|
-
self.
|
|
1556
|
+
self.get_marketplace_seller_campaigns_by_seller_endpoint = _Endpoint(
|
|
1618
1557
|
settings={
|
|
1619
1558
|
'response_type': ([SellerCampaignMessage],),
|
|
1620
1559
|
'auth': [
|
|
@@ -1622,7 +1561,7 @@ class CampaignApi(object):
|
|
|
1622
1561
|
'oauth'
|
|
1623
1562
|
],
|
|
1624
1563
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns',
|
|
1625
|
-
'operation_id': '
|
|
1564
|
+
'operation_id': 'get_marketplace_seller_campaigns_by_seller',
|
|
1626
1565
|
'http_method': 'GET',
|
|
1627
1566
|
'servers': None,
|
|
1628
1567
|
},
|
|
@@ -1694,7 +1633,107 @@ class CampaignApi(object):
|
|
|
1694
1633
|
},
|
|
1695
1634
|
api_client=api_client
|
|
1696
1635
|
)
|
|
1697
|
-
self.
|
|
1636
|
+
self.get_marketplace_seller_campaigns_stats_endpoint = _Endpoint(
|
|
1637
|
+
settings={
|
|
1638
|
+
'response_type': (str,),
|
|
1639
|
+
'auth': [
|
|
1640
|
+
'oauth',
|
|
1641
|
+
'oauth'
|
|
1642
|
+
],
|
|
1643
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns',
|
|
1644
|
+
'operation_id': 'get_marketplace_seller_campaigns_stats',
|
|
1645
|
+
'http_method': 'GET',
|
|
1646
|
+
'servers': None,
|
|
1647
|
+
},
|
|
1648
|
+
params_map={
|
|
1649
|
+
'all': [
|
|
1650
|
+
'advertiser_id',
|
|
1651
|
+
'campaign_id',
|
|
1652
|
+
'click_attribution_policy',
|
|
1653
|
+
'count',
|
|
1654
|
+
'end_date',
|
|
1655
|
+
'interval_size',
|
|
1656
|
+
'seller_id',
|
|
1657
|
+
'start_date',
|
|
1658
|
+
],
|
|
1659
|
+
'required': [],
|
|
1660
|
+
'nullable': [
|
|
1661
|
+
],
|
|
1662
|
+
'enum': [
|
|
1663
|
+
'click_attribution_policy',
|
|
1664
|
+
'interval_size',
|
|
1665
|
+
],
|
|
1666
|
+
'validation': [
|
|
1667
|
+
]
|
|
1668
|
+
},
|
|
1669
|
+
root_map={
|
|
1670
|
+
'validations': {
|
|
1671
|
+
},
|
|
1672
|
+
'allowed_values': {
|
|
1673
|
+
('click_attribution_policy',): {
|
|
1674
|
+
|
|
1675
|
+
"BOTH": "Both",
|
|
1676
|
+
"SAMESELLER": "SameSeller",
|
|
1677
|
+
"ANYSELLER": "AnySeller"
|
|
1678
|
+
},
|
|
1679
|
+
('interval_size',): {
|
|
1680
|
+
|
|
1681
|
+
"HOUR": "Hour",
|
|
1682
|
+
"DAY": "Day",
|
|
1683
|
+
"MONTH": "Month",
|
|
1684
|
+
"YEAR": "Year"
|
|
1685
|
+
},
|
|
1686
|
+
},
|
|
1687
|
+
'openapi_types': {
|
|
1688
|
+
'advertiser_id':
|
|
1689
|
+
(int,),
|
|
1690
|
+
'campaign_id':
|
|
1691
|
+
(str,),
|
|
1692
|
+
'click_attribution_policy':
|
|
1693
|
+
(str,),
|
|
1694
|
+
'count':
|
|
1695
|
+
(int,),
|
|
1696
|
+
'end_date':
|
|
1697
|
+
(datetime,),
|
|
1698
|
+
'interval_size':
|
|
1699
|
+
(str,),
|
|
1700
|
+
'seller_id':
|
|
1701
|
+
(str,),
|
|
1702
|
+
'start_date':
|
|
1703
|
+
(datetime,),
|
|
1704
|
+
},
|
|
1705
|
+
'attribute_map': {
|
|
1706
|
+
'advertiser_id': 'advertiserId',
|
|
1707
|
+
'campaign_id': 'campaignId',
|
|
1708
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1709
|
+
'count': 'count',
|
|
1710
|
+
'end_date': 'endDate',
|
|
1711
|
+
'interval_size': 'intervalSize',
|
|
1712
|
+
'seller_id': 'sellerId',
|
|
1713
|
+
'start_date': 'startDate',
|
|
1714
|
+
},
|
|
1715
|
+
'location_map': {
|
|
1716
|
+
'advertiser_id': 'query',
|
|
1717
|
+
'campaign_id': 'query',
|
|
1718
|
+
'click_attribution_policy': 'query',
|
|
1719
|
+
'count': 'query',
|
|
1720
|
+
'end_date': 'query',
|
|
1721
|
+
'interval_size': 'query',
|
|
1722
|
+
'seller_id': 'query',
|
|
1723
|
+
'start_date': 'query',
|
|
1724
|
+
},
|
|
1725
|
+
'collection_format_map': {
|
|
1726
|
+
}
|
|
1727
|
+
},
|
|
1728
|
+
headers_map={
|
|
1729
|
+
'accept': [
|
|
1730
|
+
'application/json'
|
|
1731
|
+
],
|
|
1732
|
+
'content_type': [],
|
|
1733
|
+
},
|
|
1734
|
+
api_client=api_client
|
|
1735
|
+
)
|
|
1736
|
+
self.get_marketplace_sellers_endpoint = _Endpoint(
|
|
1698
1737
|
settings={
|
|
1699
1738
|
'response_type': ([SellerBudgetMessage],),
|
|
1700
1739
|
'auth': [
|
|
@@ -1702,7 +1741,7 @@ class CampaignApi(object):
|
|
|
1702
1741
|
'oauth'
|
|
1703
1742
|
],
|
|
1704
1743
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers',
|
|
1705
|
-
'operation_id': '
|
|
1744
|
+
'operation_id': 'get_marketplace_sellers',
|
|
1706
1745
|
'http_method': 'GET',
|
|
1707
1746
|
'servers': None,
|
|
1708
1747
|
},
|
|
@@ -1782,25 +1821,26 @@ class CampaignApi(object):
|
|
|
1782
1821
|
},
|
|
1783
1822
|
api_client=api_client
|
|
1784
1823
|
)
|
|
1785
|
-
self.
|
|
1824
|
+
self.get_marketplace_sellers_by_advertiser_endpoint = _Endpoint(
|
|
1786
1825
|
settings={
|
|
1787
|
-
'response_type':
|
|
1826
|
+
'response_type': None,
|
|
1788
1827
|
'auth': [
|
|
1789
1828
|
'oauth',
|
|
1790
1829
|
'oauth'
|
|
1791
1830
|
],
|
|
1792
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1793
|
-
'operation_id': '
|
|
1794
|
-
'http_method': '
|
|
1831
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/sellers',
|
|
1832
|
+
'operation_id': 'get_marketplace_sellers_by_advertiser',
|
|
1833
|
+
'http_method': 'POST',
|
|
1795
1834
|
'servers': None,
|
|
1796
1835
|
},
|
|
1797
1836
|
params_map={
|
|
1798
1837
|
'all': [
|
|
1799
|
-
'
|
|
1800
|
-
'
|
|
1838
|
+
'advertiser_id',
|
|
1839
|
+
'partner_id',
|
|
1840
|
+
'request_body',
|
|
1801
1841
|
],
|
|
1802
1842
|
'required': [
|
|
1803
|
-
'
|
|
1843
|
+
'advertiser_id',
|
|
1804
1844
|
],
|
|
1805
1845
|
'nullable': [
|
|
1806
1846
|
],
|
|
@@ -1815,51 +1855,61 @@ class CampaignApi(object):
|
|
|
1815
1855
|
'allowed_values': {
|
|
1816
1856
|
},
|
|
1817
1857
|
'openapi_types': {
|
|
1818
|
-
'
|
|
1819
|
-
(
|
|
1820
|
-
'
|
|
1821
|
-
(
|
|
1858
|
+
'advertiser_id':
|
|
1859
|
+
(int,),
|
|
1860
|
+
'partner_id':
|
|
1861
|
+
(int,),
|
|
1862
|
+
'request_body':
|
|
1863
|
+
([str],),
|
|
1822
1864
|
},
|
|
1823
1865
|
'attribute_map': {
|
|
1824
|
-
'
|
|
1866
|
+
'advertiser_id': 'advertiserId',
|
|
1867
|
+
'partner_id': 'partnerId',
|
|
1825
1868
|
},
|
|
1826
1869
|
'location_map': {
|
|
1827
|
-
'
|
|
1828
|
-
'
|
|
1870
|
+
'advertiser_id': 'path',
|
|
1871
|
+
'partner_id': 'query',
|
|
1872
|
+
'request_body': 'body',
|
|
1829
1873
|
},
|
|
1830
1874
|
'collection_format_map': {
|
|
1831
1875
|
}
|
|
1832
1876
|
},
|
|
1833
1877
|
headers_map={
|
|
1834
|
-
'accept': [
|
|
1835
|
-
'application/json'
|
|
1836
|
-
],
|
|
1878
|
+
'accept': [],
|
|
1837
1879
|
'content_type': [
|
|
1838
1880
|
'application/json'
|
|
1839
1881
|
]
|
|
1840
1882
|
},
|
|
1841
1883
|
api_client=api_client
|
|
1842
1884
|
)
|
|
1843
|
-
self.
|
|
1885
|
+
self.get_marketplace_sellers_stats_endpoint = _Endpoint(
|
|
1844
1886
|
settings={
|
|
1845
|
-
'response_type': (
|
|
1887
|
+
'response_type': (str,),
|
|
1846
1888
|
'auth': [
|
|
1847
1889
|
'oauth',
|
|
1848
1890
|
'oauth'
|
|
1849
1891
|
],
|
|
1850
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1851
|
-
'operation_id': '
|
|
1852
|
-
'http_method': '
|
|
1892
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers',
|
|
1893
|
+
'operation_id': 'get_marketplace_sellers_stats',
|
|
1894
|
+
'http_method': 'GET',
|
|
1853
1895
|
'servers': None,
|
|
1854
1896
|
},
|
|
1855
1897
|
params_map={
|
|
1856
1898
|
'all': [
|
|
1857
|
-
'
|
|
1899
|
+
'advertiser_id',
|
|
1900
|
+
'click_attribution_policy',
|
|
1901
|
+
'count',
|
|
1902
|
+
'end_date',
|
|
1903
|
+
'interval_size',
|
|
1904
|
+
'seller_id',
|
|
1905
|
+
'start_date',
|
|
1858
1906
|
],
|
|
1859
1907
|
'required': [],
|
|
1860
1908
|
'nullable': [
|
|
1861
1909
|
],
|
|
1862
1910
|
'enum': [
|
|
1911
|
+
'click_attribution_policy',
|
|
1912
|
+
'interval_size',
|
|
1863
1913
|
],
|
|
1864
1914
|
'validation': [
|
|
1865
1915
|
]
|
|
@@ -1868,15 +1918,53 @@ class CampaignApi(object):
|
|
|
1868
1918
|
'validations': {
|
|
1869
1919
|
},
|
|
1870
1920
|
'allowed_values': {
|
|
1921
|
+
('click_attribution_policy',): {
|
|
1922
|
+
|
|
1923
|
+
"BOTH": "Both",
|
|
1924
|
+
"SAMESELLER": "SameSeller",
|
|
1925
|
+
"ANYSELLER": "AnySeller"
|
|
1926
|
+
},
|
|
1927
|
+
('interval_size',): {
|
|
1928
|
+
|
|
1929
|
+
"HOUR": "Hour",
|
|
1930
|
+
"DAY": "Day",
|
|
1931
|
+
"MONTH": "Month",
|
|
1932
|
+
"YEAR": "Year"
|
|
1933
|
+
},
|
|
1871
1934
|
},
|
|
1872
1935
|
'openapi_types': {
|
|
1873
|
-
'
|
|
1874
|
-
(
|
|
1936
|
+
'advertiser_id':
|
|
1937
|
+
(int,),
|
|
1938
|
+
'click_attribution_policy':
|
|
1939
|
+
(str,),
|
|
1940
|
+
'count':
|
|
1941
|
+
(int,),
|
|
1942
|
+
'end_date':
|
|
1943
|
+
(datetime,),
|
|
1944
|
+
'interval_size':
|
|
1945
|
+
(str,),
|
|
1946
|
+
'seller_id':
|
|
1947
|
+
(str,),
|
|
1948
|
+
'start_date':
|
|
1949
|
+
(datetime,),
|
|
1875
1950
|
},
|
|
1876
1951
|
'attribute_map': {
|
|
1952
|
+
'advertiser_id': 'advertiserId',
|
|
1953
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1954
|
+
'count': 'count',
|
|
1955
|
+
'end_date': 'endDate',
|
|
1956
|
+
'interval_size': 'intervalSize',
|
|
1957
|
+
'seller_id': 'sellerId',
|
|
1958
|
+
'start_date': 'startDate',
|
|
1877
1959
|
},
|
|
1878
1960
|
'location_map': {
|
|
1879
|
-
'
|
|
1961
|
+
'advertiser_id': 'query',
|
|
1962
|
+
'click_attribution_policy': 'query',
|
|
1963
|
+
'count': 'query',
|
|
1964
|
+
'end_date': 'query',
|
|
1965
|
+
'interval_size': 'query',
|
|
1966
|
+
'seller_id': 'query',
|
|
1967
|
+
'start_date': 'query',
|
|
1880
1968
|
},
|
|
1881
1969
|
'collection_format_map': {
|
|
1882
1970
|
}
|
|
@@ -1885,29 +1973,30 @@ class CampaignApi(object):
|
|
|
1885
1973
|
'accept': [
|
|
1886
1974
|
'application/json'
|
|
1887
1975
|
],
|
|
1888
|
-
'content_type': [
|
|
1889
|
-
'application/json'
|
|
1890
|
-
]
|
|
1976
|
+
'content_type': [],
|
|
1891
1977
|
},
|
|
1892
1978
|
api_client=api_client
|
|
1893
1979
|
)
|
|
1894
|
-
self.
|
|
1980
|
+
self.patch_ad_set_category_bids_endpoint = _Endpoint(
|
|
1895
1981
|
settings={
|
|
1896
|
-
'response_type': (
|
|
1982
|
+
'response_type': (PatchAdSetCategoryBidResultListResponse,),
|
|
1897
1983
|
'auth': [
|
|
1898
1984
|
'oauth',
|
|
1899
1985
|
'oauth'
|
|
1900
1986
|
],
|
|
1901
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1902
|
-
'operation_id': '
|
|
1987
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
|
|
1988
|
+
'operation_id': 'patch_ad_set_category_bids',
|
|
1903
1989
|
'http_method': 'PATCH',
|
|
1904
1990
|
'servers': None,
|
|
1905
1991
|
},
|
|
1906
1992
|
params_map={
|
|
1907
1993
|
'all': [
|
|
1908
|
-
'
|
|
1994
|
+
'ad_set_id',
|
|
1995
|
+
'patch_ad_set_category_bid_list_request',
|
|
1996
|
+
],
|
|
1997
|
+
'required': [
|
|
1998
|
+
'ad_set_id',
|
|
1909
1999
|
],
|
|
1910
|
-
'required': [],
|
|
1911
2000
|
'nullable': [
|
|
1912
2001
|
],
|
|
1913
2002
|
'enum': [
|
|
@@ -1921,13 +2010,17 @@ class CampaignApi(object):
|
|
|
1921
2010
|
'allowed_values': {
|
|
1922
2011
|
},
|
|
1923
2012
|
'openapi_types': {
|
|
1924
|
-
'
|
|
1925
|
-
(
|
|
2013
|
+
'ad_set_id':
|
|
2014
|
+
(str,),
|
|
2015
|
+
'patch_ad_set_category_bid_list_request':
|
|
2016
|
+
(PatchAdSetCategoryBidListRequest,),
|
|
1926
2017
|
},
|
|
1927
2018
|
'attribute_map': {
|
|
2019
|
+
'ad_set_id': 'ad-set-id',
|
|
1928
2020
|
},
|
|
1929
2021
|
'location_map': {
|
|
1930
|
-
'
|
|
2022
|
+
'ad_set_id': 'path',
|
|
2023
|
+
'patch_ad_set_category_bid_list_request': 'body',
|
|
1931
2024
|
},
|
|
1932
2025
|
'collection_format_map': {
|
|
1933
2026
|
}
|
|
@@ -1942,26 +2035,23 @@ class CampaignApi(object):
|
|
|
1942
2035
|
},
|
|
1943
2036
|
api_client=api_client
|
|
1944
2037
|
)
|
|
1945
|
-
self.
|
|
2038
|
+
self.patch_ad_sets_endpoint = _Endpoint(
|
|
1946
2039
|
settings={
|
|
1947
|
-
'response_type': (
|
|
2040
|
+
'response_type': (ResponsesAdSetIdV24Q3,),
|
|
1948
2041
|
'auth': [
|
|
1949
2042
|
'oauth',
|
|
1950
2043
|
'oauth'
|
|
1951
2044
|
],
|
|
1952
|
-
'endpoint_path': '/2025-07/marketing-solutions/ad-sets
|
|
1953
|
-
'operation_id': '
|
|
2045
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets',
|
|
2046
|
+
'operation_id': 'patch_ad_sets',
|
|
1954
2047
|
'http_method': 'PATCH',
|
|
1955
2048
|
'servers': None,
|
|
1956
2049
|
},
|
|
1957
2050
|
params_map={
|
|
1958
2051
|
'all': [
|
|
1959
|
-
'
|
|
1960
|
-
'patch_ad_set_display_multiplier_list_request',
|
|
1961
|
-
],
|
|
1962
|
-
'required': [
|
|
1963
|
-
'ad_set_id',
|
|
2052
|
+
'requests_patch_ad_set_v24_q3',
|
|
1964
2053
|
],
|
|
2054
|
+
'required': [],
|
|
1965
2055
|
'nullable': [
|
|
1966
2056
|
],
|
|
1967
2057
|
'enum': [
|
|
@@ -1975,17 +2065,13 @@ class CampaignApi(object):
|
|
|
1975
2065
|
'allowed_values': {
|
|
1976
2066
|
},
|
|
1977
2067
|
'openapi_types': {
|
|
1978
|
-
'
|
|
1979
|
-
(
|
|
1980
|
-
'patch_ad_set_display_multiplier_list_request':
|
|
1981
|
-
(PatchAdSetDisplayMultiplierListRequest,),
|
|
2068
|
+
'requests_patch_ad_set_v24_q3':
|
|
2069
|
+
(RequestsPatchAdSetV24Q3,),
|
|
1982
2070
|
},
|
|
1983
2071
|
'attribute_map': {
|
|
1984
|
-
'ad_set_id': 'ad-set-id',
|
|
1985
2072
|
},
|
|
1986
2073
|
'location_map': {
|
|
1987
|
-
'
|
|
1988
|
-
'patch_ad_set_display_multiplier_list_request': 'body',
|
|
2074
|
+
'requests_patch_ad_set_v24_q3': 'body',
|
|
1989
2075
|
},
|
|
1990
2076
|
'collection_format_map': {
|
|
1991
2077
|
}
|
|
@@ -2000,21 +2086,21 @@ class CampaignApi(object):
|
|
|
2000
2086
|
},
|
|
2001
2087
|
api_client=api_client
|
|
2002
2088
|
)
|
|
2003
|
-
self.
|
|
2089
|
+
self.patch_campaigns_endpoint = _Endpoint(
|
|
2004
2090
|
settings={
|
|
2005
|
-
'response_type': (
|
|
2091
|
+
'response_type': (PatchResultCampaignListResponse,),
|
|
2006
2092
|
'auth': [
|
|
2007
2093
|
'oauth',
|
|
2008
2094
|
'oauth'
|
|
2009
2095
|
],
|
|
2010
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2011
|
-
'operation_id': '
|
|
2012
|
-
'http_method': '
|
|
2096
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns',
|
|
2097
|
+
'operation_id': 'patch_campaigns',
|
|
2098
|
+
'http_method': 'PATCH',
|
|
2013
2099
|
'servers': None,
|
|
2014
2100
|
},
|
|
2015
2101
|
params_map={
|
|
2016
2102
|
'all': [
|
|
2017
|
-
'
|
|
2103
|
+
'patch_campaign_list_request',
|
|
2018
2104
|
],
|
|
2019
2105
|
'required': [],
|
|
2020
2106
|
'nullable': [
|
|
@@ -2030,13 +2116,13 @@ class CampaignApi(object):
|
|
|
2030
2116
|
'allowed_values': {
|
|
2031
2117
|
},
|
|
2032
2118
|
'openapi_types': {
|
|
2033
|
-
'
|
|
2034
|
-
(
|
|
2119
|
+
'patch_campaign_list_request':
|
|
2120
|
+
(PatchCampaignListRequest,),
|
|
2035
2121
|
},
|
|
2036
2122
|
'attribute_map': {
|
|
2037
2123
|
},
|
|
2038
2124
|
'location_map': {
|
|
2039
|
-
'
|
|
2125
|
+
'patch_campaign_list_request': 'body',
|
|
2040
2126
|
},
|
|
2041
2127
|
'collection_format_map': {
|
|
2042
2128
|
}
|
|
@@ -2051,23 +2137,26 @@ class CampaignApi(object):
|
|
|
2051
2137
|
},
|
|
2052
2138
|
api_client=api_client
|
|
2053
2139
|
)
|
|
2054
|
-
self.
|
|
2140
|
+
self.patch_display_multipliers_endpoint = _Endpoint(
|
|
2055
2141
|
settings={
|
|
2056
|
-
'response_type': (
|
|
2142
|
+
'response_type': (PatchAdSetDisplayMultiplierResultListResponse,),
|
|
2057
2143
|
'auth': [
|
|
2058
2144
|
'oauth',
|
|
2059
2145
|
'oauth'
|
|
2060
2146
|
],
|
|
2061
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2062
|
-
'operation_id': '
|
|
2063
|
-
'http_method': '
|
|
2147
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
|
|
2148
|
+
'operation_id': 'patch_display_multipliers',
|
|
2149
|
+
'http_method': 'PATCH',
|
|
2064
2150
|
'servers': None,
|
|
2065
2151
|
},
|
|
2066
2152
|
params_map={
|
|
2067
2153
|
'all': [
|
|
2068
|
-
'
|
|
2154
|
+
'ad_set_id',
|
|
2155
|
+
'patch_ad_set_display_multiplier_list_request',
|
|
2156
|
+
],
|
|
2157
|
+
'required': [
|
|
2158
|
+
'ad_set_id',
|
|
2069
2159
|
],
|
|
2070
|
-
'required': [],
|
|
2071
2160
|
'nullable': [
|
|
2072
2161
|
],
|
|
2073
2162
|
'enum': [
|
|
@@ -2081,13 +2170,17 @@ class CampaignApi(object):
|
|
|
2081
2170
|
'allowed_values': {
|
|
2082
2171
|
},
|
|
2083
2172
|
'openapi_types': {
|
|
2084
|
-
'
|
|
2085
|
-
(
|
|
2173
|
+
'ad_set_id':
|
|
2174
|
+
(str,),
|
|
2175
|
+
'patch_ad_set_display_multiplier_list_request':
|
|
2176
|
+
(PatchAdSetDisplayMultiplierListRequest,),
|
|
2086
2177
|
},
|
|
2087
2178
|
'attribute_map': {
|
|
2179
|
+
'ad_set_id': 'ad-set-id',
|
|
2088
2180
|
},
|
|
2089
2181
|
'location_map': {
|
|
2090
|
-
'
|
|
2182
|
+
'ad_set_id': 'path',
|
|
2183
|
+
'patch_ad_set_display_multiplier_list_request': 'body',
|
|
2091
2184
|
},
|
|
2092
2185
|
'collection_format_map': {
|
|
2093
2186
|
}
|
|
@@ -2102,94 +2195,43 @@ class CampaignApi(object):
|
|
|
2102
2195
|
},
|
|
2103
2196
|
api_client=api_client
|
|
2104
2197
|
)
|
|
2105
|
-
self.
|
|
2198
|
+
self.search_ad_sets_endpoint = _Endpoint(
|
|
2106
2199
|
settings={
|
|
2107
|
-
'response_type': (
|
|
2200
|
+
'response_type': (ResponsesReadAdSetV24Q3,),
|
|
2108
2201
|
'auth': [
|
|
2109
2202
|
'oauth',
|
|
2110
2203
|
'oauth'
|
|
2111
2204
|
],
|
|
2112
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2113
|
-
'operation_id': '
|
|
2114
|
-
'http_method': '
|
|
2205
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/search',
|
|
2206
|
+
'operation_id': 'search_ad_sets',
|
|
2207
|
+
'http_method': 'POST',
|
|
2115
2208
|
'servers': None,
|
|
2116
2209
|
},
|
|
2117
2210
|
params_map={
|
|
2118
2211
|
'all': [
|
|
2119
|
-
'
|
|
2120
|
-
'campaign_id',
|
|
2121
|
-
'click_attribution_policy',
|
|
2122
|
-
'count',
|
|
2123
|
-
'end_date',
|
|
2124
|
-
'interval_size',
|
|
2125
|
-
'seller_id',
|
|
2126
|
-
'start_date',
|
|
2212
|
+
'ad_set_search_request_v24_q3',
|
|
2127
2213
|
],
|
|
2128
2214
|
'required': [],
|
|
2129
2215
|
'nullable': [
|
|
2130
2216
|
],
|
|
2131
2217
|
'enum': [
|
|
2132
|
-
'click_attribution_policy',
|
|
2133
|
-
'interval_size',
|
|
2134
2218
|
],
|
|
2135
2219
|
'validation': [
|
|
2136
2220
|
]
|
|
2137
2221
|
},
|
|
2138
2222
|
root_map={
|
|
2139
|
-
'validations': {
|
|
2140
|
-
},
|
|
2141
|
-
'allowed_values': {
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
|
|
2145
|
-
|
|
2146
|
-
"ANYSELLER": "AnySeller"
|
|
2147
|
-
},
|
|
2148
|
-
('interval_size',): {
|
|
2149
|
-
|
|
2150
|
-
"HOUR": "Hour",
|
|
2151
|
-
"DAY": "Day",
|
|
2152
|
-
"MONTH": "Month",
|
|
2153
|
-
"YEAR": "Year"
|
|
2154
|
-
},
|
|
2155
|
-
},
|
|
2156
|
-
'openapi_types': {
|
|
2157
|
-
'advertiser_id':
|
|
2158
|
-
(int,),
|
|
2159
|
-
'campaign_id':
|
|
2160
|
-
(str,),
|
|
2161
|
-
'click_attribution_policy':
|
|
2162
|
-
(str,),
|
|
2163
|
-
'count':
|
|
2164
|
-
(int,),
|
|
2165
|
-
'end_date':
|
|
2166
|
-
(datetime,),
|
|
2167
|
-
'interval_size':
|
|
2168
|
-
(str,),
|
|
2169
|
-
'seller_id':
|
|
2170
|
-
(str,),
|
|
2171
|
-
'start_date':
|
|
2172
|
-
(datetime,),
|
|
2223
|
+
'validations': {
|
|
2224
|
+
},
|
|
2225
|
+
'allowed_values': {
|
|
2226
|
+
},
|
|
2227
|
+
'openapi_types': {
|
|
2228
|
+
'ad_set_search_request_v24_q3':
|
|
2229
|
+
(AdSetSearchRequestV24Q3,),
|
|
2173
2230
|
},
|
|
2174
2231
|
'attribute_map': {
|
|
2175
|
-
'advertiser_id': 'advertiserId',
|
|
2176
|
-
'campaign_id': 'campaignId',
|
|
2177
|
-
'click_attribution_policy': 'clickAttributionPolicy',
|
|
2178
|
-
'count': 'count',
|
|
2179
|
-
'end_date': 'endDate',
|
|
2180
|
-
'interval_size': 'intervalSize',
|
|
2181
|
-
'seller_id': 'sellerId',
|
|
2182
|
-
'start_date': 'startDate',
|
|
2183
2232
|
},
|
|
2184
2233
|
'location_map': {
|
|
2185
|
-
'
|
|
2186
|
-
'campaign_id': 'query',
|
|
2187
|
-
'click_attribution_policy': 'query',
|
|
2188
|
-
'count': 'query',
|
|
2189
|
-
'end_date': 'query',
|
|
2190
|
-
'interval_size': 'query',
|
|
2191
|
-
'seller_id': 'query',
|
|
2192
|
-
'start_date': 'query',
|
|
2234
|
+
'ad_set_search_request_v24_q3': 'body',
|
|
2193
2235
|
},
|
|
2194
2236
|
'collection_format_map': {
|
|
2195
2237
|
}
|
|
@@ -2198,38 +2240,32 @@ class CampaignApi(object):
|
|
|
2198
2240
|
'accept': [
|
|
2199
2241
|
'application/json'
|
|
2200
2242
|
],
|
|
2201
|
-
'content_type': [
|
|
2243
|
+
'content_type': [
|
|
2244
|
+
'application/json'
|
|
2245
|
+
]
|
|
2202
2246
|
},
|
|
2203
2247
|
api_client=api_client
|
|
2204
2248
|
)
|
|
2205
|
-
self.
|
|
2249
|
+
self.search_campaigns_endpoint = _Endpoint(
|
|
2206
2250
|
settings={
|
|
2207
|
-
'response_type': (
|
|
2251
|
+
'response_type': (CampaignV23Q1ListResponse,),
|
|
2208
2252
|
'auth': [
|
|
2209
2253
|
'oauth',
|
|
2210
2254
|
'oauth'
|
|
2211
2255
|
],
|
|
2212
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2213
|
-
'operation_id': '
|
|
2214
|
-
'http_method': '
|
|
2256
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns/search',
|
|
2257
|
+
'operation_id': 'search_campaigns',
|
|
2258
|
+
'http_method': 'POST',
|
|
2215
2259
|
'servers': None,
|
|
2216
2260
|
},
|
|
2217
2261
|
params_map={
|
|
2218
2262
|
'all': [
|
|
2219
|
-
'
|
|
2220
|
-
'click_attribution_policy',
|
|
2221
|
-
'count',
|
|
2222
|
-
'end_date',
|
|
2223
|
-
'interval_size',
|
|
2224
|
-
'seller_id',
|
|
2225
|
-
'start_date',
|
|
2263
|
+
'campaign_search_request_v23_q1',
|
|
2226
2264
|
],
|
|
2227
2265
|
'required': [],
|
|
2228
2266
|
'nullable': [
|
|
2229
2267
|
],
|
|
2230
2268
|
'enum': [
|
|
2231
|
-
'click_attribution_policy',
|
|
2232
|
-
'interval_size',
|
|
2233
2269
|
],
|
|
2234
2270
|
'validation': [
|
|
2235
2271
|
]
|
|
@@ -2238,53 +2274,15 @@ class CampaignApi(object):
|
|
|
2238
2274
|
'validations': {
|
|
2239
2275
|
},
|
|
2240
2276
|
'allowed_values': {
|
|
2241
|
-
('click_attribution_policy',): {
|
|
2242
|
-
|
|
2243
|
-
"BOTH": "Both",
|
|
2244
|
-
"SAMESELLER": "SameSeller",
|
|
2245
|
-
"ANYSELLER": "AnySeller"
|
|
2246
|
-
},
|
|
2247
|
-
('interval_size',): {
|
|
2248
|
-
|
|
2249
|
-
"HOUR": "Hour",
|
|
2250
|
-
"DAY": "Day",
|
|
2251
|
-
"MONTH": "Month",
|
|
2252
|
-
"YEAR": "Year"
|
|
2253
|
-
},
|
|
2254
2277
|
},
|
|
2255
2278
|
'openapi_types': {
|
|
2256
|
-
'
|
|
2257
|
-
(
|
|
2258
|
-
'click_attribution_policy':
|
|
2259
|
-
(str,),
|
|
2260
|
-
'count':
|
|
2261
|
-
(int,),
|
|
2262
|
-
'end_date':
|
|
2263
|
-
(datetime,),
|
|
2264
|
-
'interval_size':
|
|
2265
|
-
(str,),
|
|
2266
|
-
'seller_id':
|
|
2267
|
-
(str,),
|
|
2268
|
-
'start_date':
|
|
2269
|
-
(datetime,),
|
|
2279
|
+
'campaign_search_request_v23_q1':
|
|
2280
|
+
(CampaignSearchRequestV23Q1,),
|
|
2270
2281
|
},
|
|
2271
2282
|
'attribute_map': {
|
|
2272
|
-
'advertiser_id': 'advertiserId',
|
|
2273
|
-
'click_attribution_policy': 'clickAttributionPolicy',
|
|
2274
|
-
'count': 'count',
|
|
2275
|
-
'end_date': 'endDate',
|
|
2276
|
-
'interval_size': 'intervalSize',
|
|
2277
|
-
'seller_id': 'sellerId',
|
|
2278
|
-
'start_date': 'startDate',
|
|
2279
2283
|
},
|
|
2280
2284
|
'location_map': {
|
|
2281
|
-
'
|
|
2282
|
-
'click_attribution_policy': 'query',
|
|
2283
|
-
'count': 'query',
|
|
2284
|
-
'end_date': 'query',
|
|
2285
|
-
'interval_size': 'query',
|
|
2286
|
-
'seller_id': 'query',
|
|
2287
|
-
'start_date': 'query',
|
|
2285
|
+
'campaign_search_request_v23_q1': 'body',
|
|
2288
2286
|
},
|
|
2289
2287
|
'collection_format_map': {
|
|
2290
2288
|
}
|
|
@@ -2293,7 +2291,9 @@ class CampaignApi(object):
|
|
|
2293
2291
|
'accept': [
|
|
2294
2292
|
'application/json'
|
|
2295
2293
|
],
|
|
2296
|
-
'content_type': [
|
|
2294
|
+
'content_type': [
|
|
2295
|
+
'application/json'
|
|
2296
|
+
]
|
|
2297
2297
|
},
|
|
2298
2298
|
api_client=api_client
|
|
2299
2299
|
)
|
|
@@ -2458,7 +2458,7 @@ class CampaignApi(object):
|
|
|
2458
2458
|
},
|
|
2459
2459
|
api_client=api_client
|
|
2460
2460
|
)
|
|
2461
|
-
self.
|
|
2461
|
+
self.update_marketplace_seller_budget_endpoint = _Endpoint(
|
|
2462
2462
|
settings={
|
|
2463
2463
|
'response_type': None,
|
|
2464
2464
|
'auth': [
|
|
@@ -2466,7 +2466,7 @@ class CampaignApi(object):
|
|
|
2466
2466
|
'oauth'
|
|
2467
2467
|
],
|
|
2468
2468
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}',
|
|
2469
|
-
'operation_id': '
|
|
2469
|
+
'operation_id': 'update_marketplace_seller_budget',
|
|
2470
2470
|
'http_method': 'PATCH',
|
|
2471
2471
|
'servers': None,
|
|
2472
2472
|
},
|
|
@@ -2514,7 +2514,7 @@ class CampaignApi(object):
|
|
|
2514
2514
|
},
|
|
2515
2515
|
api_client=api_client
|
|
2516
2516
|
)
|
|
2517
|
-
self.
|
|
2517
|
+
self.update_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
2518
2518
|
settings={
|
|
2519
2519
|
'response_type': None,
|
|
2520
2520
|
'auth': [
|
|
@@ -2522,7 +2522,7 @@ class CampaignApi(object):
|
|
|
2522
2522
|
'oauth'
|
|
2523
2523
|
],
|
|
2524
2524
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
2525
|
-
'operation_id': '
|
|
2525
|
+
'operation_id': 'update_marketplace_seller_budgets',
|
|
2526
2526
|
'http_method': 'PATCH',
|
|
2527
2527
|
'servers': None,
|
|
2528
2528
|
},
|
|
@@ -2563,7 +2563,7 @@ class CampaignApi(object):
|
|
|
2563
2563
|
},
|
|
2564
2564
|
api_client=api_client
|
|
2565
2565
|
)
|
|
2566
|
-
self.
|
|
2566
|
+
self.update_marketplace_seller_campaign_endpoint = _Endpoint(
|
|
2567
2567
|
settings={
|
|
2568
2568
|
'response_type': (SellerCampaignMessage,),
|
|
2569
2569
|
'auth': [
|
|
@@ -2571,7 +2571,7 @@ class CampaignApi(object):
|
|
|
2571
2571
|
'oauth'
|
|
2572
2572
|
],
|
|
2573
2573
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}',
|
|
2574
|
-
'operation_id': '
|
|
2574
|
+
'operation_id': 'update_marketplace_seller_campaign',
|
|
2575
2575
|
'http_method': 'PATCH',
|
|
2576
2576
|
'servers': None,
|
|
2577
2577
|
},
|
|
@@ -2620,7 +2620,7 @@ class CampaignApi(object):
|
|
|
2620
2620
|
},
|
|
2621
2621
|
api_client=api_client
|
|
2622
2622
|
)
|
|
2623
|
-
self.
|
|
2623
|
+
self.update_marketplace_seller_campaigns_endpoint = _Endpoint(
|
|
2624
2624
|
settings={
|
|
2625
2625
|
'response_type': ([SellerCampaignMessage],),
|
|
2626
2626
|
'auth': [
|
|
@@ -2628,7 +2628,7 @@ class CampaignApi(object):
|
|
|
2628
2628
|
'oauth'
|
|
2629
2629
|
],
|
|
2630
2630
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns',
|
|
2631
|
-
'operation_id': '
|
|
2631
|
+
'operation_id': 'update_marketplace_seller_campaigns',
|
|
2632
2632
|
'http_method': 'PATCH',
|
|
2633
2633
|
'servers': None,
|
|
2634
2634
|
},
|
|
@@ -2672,91 +2672,6 @@ class CampaignApi(object):
|
|
|
2672
2672
|
api_client=api_client
|
|
2673
2673
|
)
|
|
2674
2674
|
|
|
2675
|
-
def campaigns(
|
|
2676
|
-
self,
|
|
2677
|
-
**kwargs
|
|
2678
|
-
):
|
|
2679
|
-
""" # noqa: E501
|
|
2680
|
-
|
|
2681
|
-
## Dimensions Get performance statistics aggregated for _campaigns_. The campaign id appears in the output as the first column. Aggregation can be done by `hour`, `day`, `month`, or `year`. The aggregation interval size is controlled by `intervalSize`. The time interval appears in the output as the second column. ## Metrics The metrics reported by this endpoint are . | Metric Group | Description ---|--------------|------------ A | impressions | Number of times product is shown in a banner B | clicks | Number of clicks on product C | cost | Amount spent for clicks on products D | saleUnits | Number of products sold attributed to clicks E | revenue | Revenue generated by sales F | CR = Conversion Rate | salesUnits / clicks G | CPO = Cost Per Order | cost / salesUnits H | COS = Cost of Sale | cost / revenue I | ROAS = Return On Add Spend | revenue / cost The last six metrics can be computed in two ways depending on the policy to count only the sales that result from clicks on the same sellers product in a banner (same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`. The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns. ## Filtering The results can be filtered by campaign, date or count. Filtering the results to events associated with a specific campaign is done by setting the `campaignId` filter parameter to the desired value. Filtering the results to events that happened in a time interval is done by setting the `startDate` and `endDate` filter parameters using the `yyyy-MM-DD` format. The start date includes all events timestamped since the beginning of that day while the end date includes events until the end of day. The maximum duration of the date range is 1 year. If the aggregation interval is `hour`, then the maximum duration of the date range is 31 days. Note that month and year aggregate values may contain partial data for the interval if filtering by date. Filtering the results to a maximum number of data rows is done by setting the `count` filter parameter. When combined with startDate this can be used to perform simple pagination. ## Response Format The representation format can be specified by MIME values in the Accept header. For now the only supported values for the accept header is `application/json` and `text/csv`. ```json { \"columns\": [ \"campaignId\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\" ], \"data\": [ [168423, \"2019-05-01\", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ], [168423, \"2019-06-01\", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ] ], \"rows\": 2 } ``` The JSON result is an object with three fields (`columns`, `data`, and `rows`). The “columns” array acts as the header for the data rows. The categorical dimension column comes first and consists of the campaign id. The interval column comes next and defines the aggregation period. The interval size is determined by the `intervalSize` parameter. This is followed by either nine or fifteen metrics columns. The first three metrics (impressions, clicks, and cost) always appear. The remaining depend on the `clickAttributionPolicy` parameter. The “data” array contains data rows whose values match the entries in the “columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects whose type is number. Some of these are natural numbers (e.g. clicks and impressions) whereas others are decimal values. A divide by zero yields null. The currency is assumed to be the local currency established by the advertiser. The “row” value is a count of the number of rows in the data array, and can be used to check the integrity of the data. Further information on the campaign or seller (e.g. the seller name) can be obtained from the existing V1 or V2 endpoints using the campaign and/or seller ID values. # noqa: E501
|
|
2682
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
2683
|
-
asynchronous HTTP request, please pass async_req=True
|
|
2684
|
-
|
|
2685
|
-
>>> thread = api.campaigns(async_req=True)
|
|
2686
|
-
>>> result = thread.get()
|
|
2687
|
-
|
|
2688
|
-
|
|
2689
|
-
Keyword Args:
|
|
2690
|
-
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
2691
|
-
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
2692
|
-
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
2693
|
-
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
2694
|
-
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
2695
|
-
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
2696
|
-
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
2697
|
-
_return_http_data_only (bool): response data without head status
|
|
2698
|
-
code and headers. Default is True.
|
|
2699
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2700
|
-
will be returned without reading/decoding response data.
|
|
2701
|
-
Default is True.
|
|
2702
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2703
|
-
one number provided, it will be total request timeout. It can also
|
|
2704
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
2705
|
-
Default is None.
|
|
2706
|
-
_check_input_type (bool): specifies if type checking
|
|
2707
|
-
should be done one the data sent to the server.
|
|
2708
|
-
Default is True.
|
|
2709
|
-
_check_return_type (bool): specifies if type checking
|
|
2710
|
-
should be done one the data received from the server.
|
|
2711
|
-
Default is True.
|
|
2712
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
2713
|
-
are serialized names, as specified in the OpenAPI document.
|
|
2714
|
-
False if the variable names in the input data
|
|
2715
|
-
are pythonic names, e.g. snake case (default)
|
|
2716
|
-
_content_type (str/None): force body content-type.
|
|
2717
|
-
Default is None and content-type will be predicted by allowed
|
|
2718
|
-
content-types and body.
|
|
2719
|
-
_host_index (int/None): specifies the index of the server
|
|
2720
|
-
that we want to use.
|
|
2721
|
-
Default is read from the configuration.
|
|
2722
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
2723
|
-
request; this effectively ignores the authentication
|
|
2724
|
-
in the spec for a single request.
|
|
2725
|
-
Default is None
|
|
2726
|
-
async_req (bool): execute request asynchronously
|
|
2727
|
-
|
|
2728
|
-
Returns:
|
|
2729
|
-
str
|
|
2730
|
-
If the method is called asynchronously, returns the request
|
|
2731
|
-
thread.
|
|
2732
|
-
"""
|
|
2733
|
-
kwargs['async_req'] = kwargs.get(
|
|
2734
|
-
'async_req', False
|
|
2735
|
-
)
|
|
2736
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2737
|
-
'_return_http_data_only', True
|
|
2738
|
-
)
|
|
2739
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
2740
|
-
'_preload_content', True
|
|
2741
|
-
)
|
|
2742
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
2743
|
-
'_request_timeout', None
|
|
2744
|
-
)
|
|
2745
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
2746
|
-
'_check_input_type', True
|
|
2747
|
-
)
|
|
2748
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
2749
|
-
'_check_return_type', True
|
|
2750
|
-
)
|
|
2751
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2752
|
-
'_spec_property_naming', False
|
|
2753
|
-
)
|
|
2754
|
-
kwargs['_content_type'] = kwargs.get(
|
|
2755
|
-
'_content_type')
|
|
2756
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2757
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2758
|
-
return self.campaigns_endpoint.call_with_http_info(**kwargs)
|
|
2759
|
-
|
|
2760
2675
|
def create_ad_set(
|
|
2761
2676
|
self,
|
|
2762
2677
|
create_ad_set_v24_q3_request,
|
|
@@ -2923,7 +2838,7 @@ class CampaignApi(object):
|
|
|
2923
2838
|
create_campaign_request
|
|
2924
2839
|
return self.create_campaign_endpoint.call_with_http_info(**kwargs)
|
|
2925
2840
|
|
|
2926
|
-
def
|
|
2841
|
+
def create_marketplace_seller_budgets(
|
|
2927
2842
|
self,
|
|
2928
2843
|
**kwargs
|
|
2929
2844
|
):
|
|
@@ -2933,7 +2848,7 @@ class CampaignApi(object):
|
|
|
2933
2848
|
This method makes a synchronous HTTP request by default. To make an
|
|
2934
2849
|
asynchronous HTTP request, please pass async_req=True
|
|
2935
2850
|
|
|
2936
|
-
>>> thread = api.
|
|
2851
|
+
>>> thread = api.create_marketplace_seller_budgets(async_req=True)
|
|
2937
2852
|
>>> result = thread.get()
|
|
2938
2853
|
|
|
2939
2854
|
|
|
@@ -3000,9 +2915,9 @@ class CampaignApi(object):
|
|
|
3000
2915
|
'_content_type')
|
|
3001
2916
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3002
2917
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3003
|
-
return self.
|
|
2918
|
+
return self.create_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
3004
2919
|
|
|
3005
|
-
def
|
|
2920
|
+
def create_marketplace_seller_campaigns_by_seller(
|
|
3006
2921
|
self,
|
|
3007
2922
|
seller_id,
|
|
3008
2923
|
**kwargs
|
|
@@ -3013,7 +2928,7 @@ class CampaignApi(object):
|
|
|
3013
2928
|
This method makes a synchronous HTTP request by default. To make an
|
|
3014
2929
|
asynchronous HTTP request, please pass async_req=True
|
|
3015
2930
|
|
|
3016
|
-
>>> thread = api.
|
|
2931
|
+
>>> thread = api.create_marketplace_seller_campaigns_by_seller(seller_id, async_req=True)
|
|
3017
2932
|
>>> result = thread.get()
|
|
3018
2933
|
|
|
3019
2934
|
Args:
|
|
@@ -3084,28 +2999,26 @@ class CampaignApi(object):
|
|
|
3084
2999
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3085
3000
|
kwargs['seller_id'] = \
|
|
3086
3001
|
seller_id
|
|
3087
|
-
return self.
|
|
3002
|
+
return self.create_marketplace_seller_campaigns_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3088
3003
|
|
|
3089
|
-
def
|
|
3004
|
+
def get_ad_set(
|
|
3090
3005
|
self,
|
|
3091
|
-
|
|
3006
|
+
ad_set_id,
|
|
3092
3007
|
**kwargs
|
|
3093
3008
|
):
|
|
3094
|
-
""" # noqa: E501
|
|
3009
|
+
"""get_ad_set # noqa: E501
|
|
3095
3010
|
|
|
3096
|
-
|
|
3011
|
+
Get the data for the specified ad set # noqa: E501
|
|
3097
3012
|
This method makes a synchronous HTTP request by default. To make an
|
|
3098
3013
|
asynchronous HTTP request, please pass async_req=True
|
|
3099
3014
|
|
|
3100
|
-
>>> thread = api.
|
|
3015
|
+
>>> thread = api.get_ad_set(ad_set_id, async_req=True)
|
|
3101
3016
|
>>> result = thread.get()
|
|
3102
3017
|
|
|
3103
3018
|
Args:
|
|
3104
|
-
|
|
3019
|
+
ad_set_id (str): Id of the ad set
|
|
3105
3020
|
|
|
3106
3021
|
Keyword Args:
|
|
3107
|
-
partner_id (int): Id of the partner. [optional]
|
|
3108
|
-
request_body ([str]): Names of the sellers to associate with new Ids. [optional]
|
|
3109
3022
|
_return_http_data_only (bool): response data without head status
|
|
3110
3023
|
code and headers. Default is True.
|
|
3111
3024
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3138,7 +3051,7 @@ class CampaignApi(object):
|
|
|
3138
3051
|
async_req (bool): execute request asynchronously
|
|
3139
3052
|
|
|
3140
3053
|
Returns:
|
|
3141
|
-
|
|
3054
|
+
ResponseReadAdSetV24Q3
|
|
3142
3055
|
If the method is called asynchronously, returns the request
|
|
3143
3056
|
thread.
|
|
3144
3057
|
"""
|
|
@@ -3167,26 +3080,26 @@ class CampaignApi(object):
|
|
|
3167
3080
|
'_content_type')
|
|
3168
3081
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3169
3082
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3170
|
-
kwargs['
|
|
3171
|
-
|
|
3172
|
-
return self.
|
|
3083
|
+
kwargs['ad_set_id'] = \
|
|
3084
|
+
ad_set_id
|
|
3085
|
+
return self.get_ad_set_endpoint.call_with_http_info(**kwargs)
|
|
3173
3086
|
|
|
3174
|
-
def
|
|
3087
|
+
def get_ad_set_category_bids(
|
|
3175
3088
|
self,
|
|
3176
3089
|
ad_set_id,
|
|
3177
3090
|
**kwargs
|
|
3178
3091
|
):
|
|
3179
|
-
"""
|
|
3092
|
+
"""get_ad_set_category_bids # noqa: E501
|
|
3180
3093
|
|
|
3181
|
-
Get the
|
|
3094
|
+
Get the Category Bids for all valid Categories associated to an Ad Set # noqa: E501
|
|
3182
3095
|
This method makes a synchronous HTTP request by default. To make an
|
|
3183
3096
|
asynchronous HTTP request, please pass async_req=True
|
|
3184
3097
|
|
|
3185
|
-
>>> thread = api.
|
|
3098
|
+
>>> thread = api.get_ad_set_category_bids(ad_set_id, async_req=True)
|
|
3186
3099
|
>>> result = thread.get()
|
|
3187
3100
|
|
|
3188
3101
|
Args:
|
|
3189
|
-
ad_set_id (str): Id of the
|
|
3102
|
+
ad_set_id (str): Id of the Ad Set
|
|
3190
3103
|
|
|
3191
3104
|
Keyword Args:
|
|
3192
3105
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3221,7 +3134,7 @@ class CampaignApi(object):
|
|
|
3221
3134
|
async_req (bool): execute request asynchronously
|
|
3222
3135
|
|
|
3223
3136
|
Returns:
|
|
3224
|
-
|
|
3137
|
+
AdSetCategoryBidListResponse
|
|
3225
3138
|
If the method is called asynchronously, returns the request
|
|
3226
3139
|
thread.
|
|
3227
3140
|
"""
|
|
@@ -3252,24 +3165,24 @@ class CampaignApi(object):
|
|
|
3252
3165
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3253
3166
|
kwargs['ad_set_id'] = \
|
|
3254
3167
|
ad_set_id
|
|
3255
|
-
return self.
|
|
3168
|
+
return self.get_ad_set_category_bids_endpoint.call_with_http_info(**kwargs)
|
|
3256
3169
|
|
|
3257
|
-
def
|
|
3170
|
+
def get_campaign(
|
|
3258
3171
|
self,
|
|
3259
|
-
|
|
3172
|
+
campaign_id,
|
|
3260
3173
|
**kwargs
|
|
3261
3174
|
):
|
|
3262
|
-
"""
|
|
3175
|
+
"""get_campaign # noqa: E501
|
|
3263
3176
|
|
|
3264
|
-
Get the
|
|
3177
|
+
Get the data for the specified campaign # noqa: E501
|
|
3265
3178
|
This method makes a synchronous HTTP request by default. To make an
|
|
3266
3179
|
asynchronous HTTP request, please pass async_req=True
|
|
3267
3180
|
|
|
3268
|
-
>>> thread = api.
|
|
3181
|
+
>>> thread = api.get_campaign(campaign_id, async_req=True)
|
|
3269
3182
|
>>> result = thread.get()
|
|
3270
3183
|
|
|
3271
3184
|
Args:
|
|
3272
|
-
|
|
3185
|
+
campaign_id (str): Id of the campaign
|
|
3273
3186
|
|
|
3274
3187
|
Keyword Args:
|
|
3275
3188
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3304,7 +3217,7 @@ class CampaignApi(object):
|
|
|
3304
3217
|
async_req (bool): execute request asynchronously
|
|
3305
3218
|
|
|
3306
3219
|
Returns:
|
|
3307
|
-
|
|
3220
|
+
CampaignV23Q1Response
|
|
3308
3221
|
If the method is called asynchronously, returns the request
|
|
3309
3222
|
thread.
|
|
3310
3223
|
"""
|
|
@@ -3333,26 +3246,26 @@ class CampaignApi(object):
|
|
|
3333
3246
|
'_content_type')
|
|
3334
3247
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3335
3248
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3336
|
-
kwargs['
|
|
3337
|
-
|
|
3338
|
-
return self.
|
|
3249
|
+
kwargs['campaign_id'] = \
|
|
3250
|
+
campaign_id
|
|
3251
|
+
return self.get_campaign_endpoint.call_with_http_info(**kwargs)
|
|
3339
3252
|
|
|
3340
|
-
def
|
|
3253
|
+
def get_display_multipliers(
|
|
3341
3254
|
self,
|
|
3342
|
-
|
|
3255
|
+
ad_set_id,
|
|
3343
3256
|
**kwargs
|
|
3344
3257
|
):
|
|
3345
|
-
""" # noqa: E501
|
|
3258
|
+
"""get_display_multipliers # noqa: E501
|
|
3346
3259
|
|
|
3347
|
-
Get an
|
|
3260
|
+
Get the Display Multipliers for all valid Categories associated to an Ad Set # noqa: E501
|
|
3348
3261
|
This method makes a synchronous HTTP request by default. To make an
|
|
3349
3262
|
asynchronous HTTP request, please pass async_req=True
|
|
3350
3263
|
|
|
3351
|
-
>>> thread = api.
|
|
3264
|
+
>>> thread = api.get_display_multipliers(ad_set_id, async_req=True)
|
|
3352
3265
|
>>> result = thread.get()
|
|
3353
3266
|
|
|
3354
3267
|
Args:
|
|
3355
|
-
|
|
3268
|
+
ad_set_id (str): Id of the Ad Set
|
|
3356
3269
|
|
|
3357
3270
|
Keyword Args:
|
|
3358
3271
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3387,7 +3300,7 @@ class CampaignApi(object):
|
|
|
3387
3300
|
async_req (bool): execute request asynchronously
|
|
3388
3301
|
|
|
3389
3302
|
Returns:
|
|
3390
|
-
|
|
3303
|
+
AdSetDisplayMultiplierListResponse
|
|
3391
3304
|
If the method is called asynchronously, returns the request
|
|
3392
3305
|
thread.
|
|
3393
3306
|
"""
|
|
@@ -3416,11 +3329,11 @@ class CampaignApi(object):
|
|
|
3416
3329
|
'_content_type')
|
|
3417
3330
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3418
3331
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3419
|
-
kwargs['
|
|
3420
|
-
|
|
3421
|
-
return self.
|
|
3332
|
+
kwargs['ad_set_id'] = \
|
|
3333
|
+
ad_set_id
|
|
3334
|
+
return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
3422
3335
|
|
|
3423
|
-
def
|
|
3336
|
+
def get_marketplace_ad_sets_by_advertiser(
|
|
3424
3337
|
self,
|
|
3425
3338
|
advertiser_id,
|
|
3426
3339
|
**kwargs
|
|
@@ -3431,7 +3344,7 @@ class CampaignApi(object):
|
|
|
3431
3344
|
This method makes a synchronous HTTP request by default. To make an
|
|
3432
3345
|
asynchronous HTTP request, please pass async_req=True
|
|
3433
3346
|
|
|
3434
|
-
>>> thread = api.
|
|
3347
|
+
>>> thread = api.get_marketplace_ad_sets_by_advertiser(advertiser_id, async_req=True)
|
|
3435
3348
|
>>> result = thread.get()
|
|
3436
3349
|
|
|
3437
3350
|
Args:
|
|
@@ -3501,20 +3414,20 @@ class CampaignApi(object):
|
|
|
3501
3414
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3502
3415
|
kwargs['advertiser_id'] = \
|
|
3503
3416
|
advertiser_id
|
|
3504
|
-
return self.
|
|
3417
|
+
return self.get_marketplace_ad_sets_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3505
3418
|
|
|
3506
|
-
def
|
|
3419
|
+
def get_marketplace_advertiser(
|
|
3507
3420
|
self,
|
|
3508
3421
|
advertiser_id,
|
|
3509
3422
|
**kwargs
|
|
3510
3423
|
):
|
|
3511
3424
|
""" # noqa: E501
|
|
3512
3425
|
|
|
3513
|
-
Get
|
|
3426
|
+
Get an advertiser. # noqa: E501
|
|
3514
3427
|
This method makes a synchronous HTTP request by default. To make an
|
|
3515
3428
|
asynchronous HTTP request, please pass async_req=True
|
|
3516
3429
|
|
|
3517
|
-
>>> thread = api.
|
|
3430
|
+
>>> thread = api.get_marketplace_advertiser(advertiser_id, async_req=True)
|
|
3518
3431
|
>>> result = thread.get()
|
|
3519
3432
|
|
|
3520
3433
|
Args:
|
|
@@ -3584,9 +3497,9 @@ class CampaignApi(object):
|
|
|
3584
3497
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3585
3498
|
kwargs['advertiser_id'] = \
|
|
3586
3499
|
advertiser_id
|
|
3587
|
-
return self.
|
|
3500
|
+
return self.get_marketplace_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3588
3501
|
|
|
3589
|
-
def
|
|
3502
|
+
def get_marketplace_advertiser_preview_limits(
|
|
3590
3503
|
self,
|
|
3591
3504
|
**kwargs
|
|
3592
3505
|
):
|
|
@@ -3596,7 +3509,7 @@ class CampaignApi(object):
|
|
|
3596
3509
|
This method makes a synchronous HTTP request by default. To make an
|
|
3597
3510
|
asynchronous HTTP request, please pass async_req=True
|
|
3598
3511
|
|
|
3599
|
-
>>> thread = api.
|
|
3512
|
+
>>> thread = api.get_marketplace_advertiser_preview_limits(async_req=True)
|
|
3600
3513
|
>>> result = thread.get()
|
|
3601
3514
|
|
|
3602
3515
|
|
|
@@ -3662,9 +3575,9 @@ class CampaignApi(object):
|
|
|
3662
3575
|
'_content_type')
|
|
3663
3576
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3664
3577
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3665
|
-
return self.
|
|
3578
|
+
return self.get_marketplace_advertiser_preview_limits_endpoint.call_with_http_info(**kwargs)
|
|
3666
3579
|
|
|
3667
|
-
def
|
|
3580
|
+
def get_marketplace_advertisers(
|
|
3668
3581
|
self,
|
|
3669
3582
|
**kwargs
|
|
3670
3583
|
):
|
|
@@ -3674,7 +3587,7 @@ class CampaignApi(object):
|
|
|
3674
3587
|
This method makes a synchronous HTTP request by default. To make an
|
|
3675
3588
|
asynchronous HTTP request, please pass async_req=True
|
|
3676
3589
|
|
|
3677
|
-
>>> thread = api.
|
|
3590
|
+
>>> thread = api.get_marketplace_advertisers(async_req=True)
|
|
3678
3591
|
>>> result = thread.get()
|
|
3679
3592
|
|
|
3680
3593
|
|
|
@@ -3740,9 +3653,9 @@ class CampaignApi(object):
|
|
|
3740
3653
|
'_content_type')
|
|
3741
3654
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3742
3655
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3743
|
-
return self.
|
|
3656
|
+
return self.get_marketplace_advertisers_endpoint.call_with_http_info(**kwargs)
|
|
3744
3657
|
|
|
3745
|
-
def
|
|
3658
|
+
def get_marketplace_budgets_by_advertiser(
|
|
3746
3659
|
self,
|
|
3747
3660
|
advertiser_id,
|
|
3748
3661
|
**kwargs
|
|
@@ -3753,7 +3666,7 @@ class CampaignApi(object):
|
|
|
3753
3666
|
This method makes a synchronous HTTP request by default. To make an
|
|
3754
3667
|
asynchronous HTTP request, please pass async_req=True
|
|
3755
3668
|
|
|
3756
|
-
>>> thread = api.
|
|
3669
|
+
>>> thread = api.get_marketplace_budgets_by_advertiser(advertiser_id, async_req=True)
|
|
3757
3670
|
>>> result = thread.get()
|
|
3758
3671
|
|
|
3759
3672
|
Args:
|
|
@@ -3831,9 +3744,9 @@ class CampaignApi(object):
|
|
|
3831
3744
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3832
3745
|
kwargs['advertiser_id'] = \
|
|
3833
3746
|
advertiser_id
|
|
3834
|
-
return self.
|
|
3747
|
+
return self.get_marketplace_budgets_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3835
3748
|
|
|
3836
|
-
def
|
|
3749
|
+
def get_marketplace_budgets_by_seller(
|
|
3837
3750
|
self,
|
|
3838
3751
|
seller_id,
|
|
3839
3752
|
**kwargs
|
|
@@ -3844,7 +3757,7 @@ class CampaignApi(object):
|
|
|
3844
3757
|
This method makes a synchronous HTTP request by default. To make an
|
|
3845
3758
|
asynchronous HTTP request, please pass async_req=True
|
|
3846
3759
|
|
|
3847
|
-
>>> thread = api.
|
|
3760
|
+
>>> thread = api.get_marketplace_budgets_by_seller(seller_id, async_req=True)
|
|
3848
3761
|
>>> result = thread.get()
|
|
3849
3762
|
|
|
3850
3763
|
Args:
|
|
@@ -3921,9 +3834,9 @@ class CampaignApi(object):
|
|
|
3921
3834
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3922
3835
|
kwargs['seller_id'] = \
|
|
3923
3836
|
seller_id
|
|
3924
|
-
return self.
|
|
3837
|
+
return self.get_marketplace_budgets_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3925
3838
|
|
|
3926
|
-
def
|
|
3839
|
+
def get_marketplace_budgets_by_seller_campaign(
|
|
3927
3840
|
self,
|
|
3928
3841
|
seller_campaign_id,
|
|
3929
3842
|
**kwargs
|
|
@@ -3934,7 +3847,7 @@ class CampaignApi(object):
|
|
|
3934
3847
|
This method makes a synchronous HTTP request by default. To make an
|
|
3935
3848
|
asynchronous HTTP request, please pass async_req=True
|
|
3936
3849
|
|
|
3937
|
-
>>> thread = api.
|
|
3850
|
+
>>> thread = api.get_marketplace_budgets_by_seller_campaign(seller_campaign_id, async_req=True)
|
|
3938
3851
|
>>> result = thread.get()
|
|
3939
3852
|
|
|
3940
3853
|
Args:
|
|
@@ -4010,24 +3923,24 @@ class CampaignApi(object):
|
|
|
4010
3923
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4011
3924
|
kwargs['seller_campaign_id'] = \
|
|
4012
3925
|
seller_campaign_id
|
|
4013
|
-
return self.
|
|
3926
|
+
return self.get_marketplace_budgets_by_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
4014
3927
|
|
|
4015
|
-
def
|
|
3928
|
+
def get_marketplace_campaigns_by_advertiser(
|
|
4016
3929
|
self,
|
|
4017
|
-
|
|
3930
|
+
advertiser_id,
|
|
4018
3931
|
**kwargs
|
|
4019
3932
|
):
|
|
4020
|
-
"""
|
|
3933
|
+
""" # noqa: E501
|
|
4021
3934
|
|
|
4022
|
-
Get the
|
|
3935
|
+
Get the collection of CRP campaigns associated with the advertiserId. # noqa: E501
|
|
4023
3936
|
This method makes a synchronous HTTP request by default. To make an
|
|
4024
3937
|
asynchronous HTTP request, please pass async_req=True
|
|
4025
3938
|
|
|
4026
|
-
>>> thread = api.
|
|
3939
|
+
>>> thread = api.get_marketplace_campaigns_by_advertiser(advertiser_id, async_req=True)
|
|
4027
3940
|
>>> result = thread.get()
|
|
4028
3941
|
|
|
4029
3942
|
Args:
|
|
4030
|
-
|
|
3943
|
+
advertiser_id (int): Id of the advertiser
|
|
4031
3944
|
|
|
4032
3945
|
Keyword Args:
|
|
4033
3946
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4062,7 +3975,7 @@ class CampaignApi(object):
|
|
|
4062
3975
|
async_req (bool): execute request asynchronously
|
|
4063
3976
|
|
|
4064
3977
|
Returns:
|
|
4065
|
-
|
|
3978
|
+
None
|
|
4066
3979
|
If the method is called asynchronously, returns the request
|
|
4067
3980
|
thread.
|
|
4068
3981
|
"""
|
|
@@ -4091,28 +4004,32 @@ class CampaignApi(object):
|
|
|
4091
4004
|
'_content_type')
|
|
4092
4005
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4093
4006
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4094
|
-
kwargs['
|
|
4095
|
-
|
|
4096
|
-
return self.
|
|
4007
|
+
kwargs['advertiser_id'] = \
|
|
4008
|
+
advertiser_id
|
|
4009
|
+
return self.get_marketplace_campaigns_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
4097
4010
|
|
|
4098
|
-
def
|
|
4011
|
+
def get_marketplace_campaigns_stats(
|
|
4099
4012
|
self,
|
|
4100
|
-
ad_set_id,
|
|
4101
4013
|
**kwargs
|
|
4102
4014
|
):
|
|
4103
|
-
"""
|
|
4015
|
+
""" # noqa: E501
|
|
4104
4016
|
|
|
4105
|
-
Get the
|
|
4017
|
+
## Dimensions Get performance statistics aggregated for _campaigns_. The campaign id appears in the output as the first column. Aggregation can be done by `hour`, `day`, `month`, or `year`. The aggregation interval size is controlled by `intervalSize`. The time interval appears in the output as the second column. ## Metrics The metrics reported by this endpoint are . | Metric Group | Description ---|--------------|------------ A | impressions | Number of times product is shown in a banner B | clicks | Number of clicks on product C | cost | Amount spent for clicks on products D | saleUnits | Number of products sold attributed to clicks E | revenue | Revenue generated by sales F | CR = Conversion Rate | salesUnits / clicks G | CPO = Cost Per Order | cost / salesUnits H | COS = Cost of Sale | cost / revenue I | ROAS = Return On Add Spend | revenue / cost The last six metrics can be computed in two ways depending on the policy to count only the sales that result from clicks on the same sellers product in a banner (same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`. The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns. ## Filtering The results can be filtered by campaign, date or count. Filtering the results to events associated with a specific campaign is done by setting the `campaignId` filter parameter to the desired value. Filtering the results to events that happened in a time interval is done by setting the `startDate` and `endDate` filter parameters using the `yyyy-MM-DD` format. The start date includes all events timestamped since the beginning of that day while the end date includes events until the end of day. The maximum duration of the date range is 1 year. If the aggregation interval is `hour`, then the maximum duration of the date range is 31 days. Note that month and year aggregate values may contain partial data for the interval if filtering by date. Filtering the results to a maximum number of data rows is done by setting the `count` filter parameter. When combined with startDate this can be used to perform simple pagination. ## Response Format The representation format can be specified by MIME values in the Accept header. For now the only supported values for the accept header is `application/json` and `text/csv`. ```json { \"columns\": [ \"campaignId\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\" ], \"data\": [ [168423, \"2019-05-01\", 3969032, 13410, 1111.295, 985, 190758099, 0.073, 1.128, 0.000, 171653.880 ], [168423, \"2019-06-01\", 8479603, 25619, 2190.705, 740, 152783656, 0.028, 2.960, 0.000, 69741.775 ] ], \"rows\": 2 } ``` The JSON result is an object with three fields (`columns`, `data`, and `rows`). The “columns” array acts as the header for the data rows. The categorical dimension column comes first and consists of the campaign id. The interval column comes next and defines the aggregation period. The interval size is determined by the `intervalSize` parameter. This is followed by either nine or fifteen metrics columns. The first three metrics (impressions, clicks, and cost) always appear. The remaining depend on the `clickAttributionPolicy` parameter. The “data” array contains data rows whose values match the entries in the “columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects whose type is number. Some of these are natural numbers (e.g. clicks and impressions) whereas others are decimal values. A divide by zero yields null. The currency is assumed to be the local currency established by the advertiser. The “row” value is a count of the number of rows in the data array, and can be used to check the integrity of the data. Further information on the campaign or seller (e.g. the seller name) can be obtained from the existing V1 or V2 endpoints using the campaign and/or seller ID values. # noqa: E501
|
|
4106
4018
|
This method makes a synchronous HTTP request by default. To make an
|
|
4107
4019
|
asynchronous HTTP request, please pass async_req=True
|
|
4108
4020
|
|
|
4109
|
-
>>> thread = api.
|
|
4021
|
+
>>> thread = api.get_marketplace_campaigns_stats(async_req=True)
|
|
4110
4022
|
>>> result = thread.get()
|
|
4111
4023
|
|
|
4112
|
-
Args:
|
|
4113
|
-
ad_set_id (str): Id of the Ad Set
|
|
4114
4024
|
|
|
4115
4025
|
Keyword Args:
|
|
4026
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
4027
|
+
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
4028
|
+
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
4029
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
4030
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
4031
|
+
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
4032
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
4116
4033
|
_return_http_data_only (bool): response data without head status
|
|
4117
4034
|
code and headers. Default is True.
|
|
4118
4035
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4145,7 +4062,7 @@ class CampaignApi(object):
|
|
|
4145
4062
|
async_req (bool): execute request asynchronously
|
|
4146
4063
|
|
|
4147
4064
|
Returns:
|
|
4148
|
-
|
|
4065
|
+
str
|
|
4149
4066
|
If the method is called asynchronously, returns the request
|
|
4150
4067
|
thread.
|
|
4151
4068
|
"""
|
|
@@ -4174,11 +4091,9 @@ class CampaignApi(object):
|
|
|
4174
4091
|
'_content_type')
|
|
4175
4092
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4176
4093
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4177
|
-
kwargs
|
|
4178
|
-
ad_set_id
|
|
4179
|
-
return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
4094
|
+
return self.get_marketplace_campaigns_stats_endpoint.call_with_http_info(**kwargs)
|
|
4180
4095
|
|
|
4181
|
-
def
|
|
4096
|
+
def get_marketplace_seller(
|
|
4182
4097
|
self,
|
|
4183
4098
|
seller_id,
|
|
4184
4099
|
**kwargs
|
|
@@ -4189,7 +4104,7 @@ class CampaignApi(object):
|
|
|
4189
4104
|
This method makes a synchronous HTTP request by default. To make an
|
|
4190
4105
|
asynchronous HTTP request, please pass async_req=True
|
|
4191
4106
|
|
|
4192
|
-
>>> thread = api.
|
|
4107
|
+
>>> thread = api.get_marketplace_seller(seller_id, async_req=True)
|
|
4193
4108
|
>>> result = thread.get()
|
|
4194
4109
|
|
|
4195
4110
|
Args:
|
|
@@ -4259,9 +4174,9 @@ class CampaignApi(object):
|
|
|
4259
4174
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4260
4175
|
kwargs['seller_id'] = \
|
|
4261
4176
|
seller_id
|
|
4262
|
-
return self.
|
|
4177
|
+
return self.get_marketplace_seller_endpoint.call_with_http_info(**kwargs)
|
|
4263
4178
|
|
|
4264
|
-
def
|
|
4179
|
+
def get_marketplace_seller_ad_preview(
|
|
4265
4180
|
self,
|
|
4266
4181
|
advertiser_id,
|
|
4267
4182
|
seller_id,
|
|
@@ -4273,7 +4188,7 @@ class CampaignApi(object):
|
|
|
4273
4188
|
This method makes a synchronous HTTP request by default. To make an
|
|
4274
4189
|
asynchronous HTTP request, please pass async_req=True
|
|
4275
4190
|
|
|
4276
|
-
>>> thread = api.
|
|
4191
|
+
>>> thread = api.get_marketplace_seller_ad_preview(advertiser_id, seller_id, async_req=True)
|
|
4277
4192
|
>>> result = thread.get()
|
|
4278
4193
|
|
|
4279
4194
|
Args:
|
|
@@ -4349,9 +4264,9 @@ class CampaignApi(object):
|
|
|
4349
4264
|
advertiser_id
|
|
4350
4265
|
kwargs['seller_id'] = \
|
|
4351
4266
|
seller_id
|
|
4352
|
-
return self.
|
|
4267
|
+
return self.get_marketplace_seller_ad_preview_endpoint.call_with_http_info(**kwargs)
|
|
4353
4268
|
|
|
4354
|
-
def
|
|
4269
|
+
def get_marketplace_seller_budget(
|
|
4355
4270
|
self,
|
|
4356
4271
|
budget_id,
|
|
4357
4272
|
**kwargs
|
|
@@ -4362,7 +4277,7 @@ class CampaignApi(object):
|
|
|
4362
4277
|
This method makes a synchronous HTTP request by default. To make an
|
|
4363
4278
|
asynchronous HTTP request, please pass async_req=True
|
|
4364
4279
|
|
|
4365
|
-
>>> thread = api.
|
|
4280
|
+
>>> thread = api.get_marketplace_seller_budget(budget_id, async_req=True)
|
|
4366
4281
|
>>> result = thread.get()
|
|
4367
4282
|
|
|
4368
4283
|
Args:
|
|
@@ -4432,9 +4347,9 @@ class CampaignApi(object):
|
|
|
4432
4347
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4433
4348
|
kwargs['budget_id'] = \
|
|
4434
4349
|
budget_id
|
|
4435
|
-
return self.
|
|
4350
|
+
return self.get_marketplace_seller_budget_endpoint.call_with_http_info(**kwargs)
|
|
4436
4351
|
|
|
4437
|
-
def
|
|
4352
|
+
def get_marketplace_seller_budgets(
|
|
4438
4353
|
self,
|
|
4439
4354
|
**kwargs
|
|
4440
4355
|
):
|
|
@@ -4444,7 +4359,7 @@ class CampaignApi(object):
|
|
|
4444
4359
|
This method makes a synchronous HTTP request by default. To make an
|
|
4445
4360
|
asynchronous HTTP request, please pass async_req=True
|
|
4446
4361
|
|
|
4447
|
-
>>> thread = api.
|
|
4362
|
+
>>> thread = api.get_marketplace_seller_budgets(async_req=True)
|
|
4448
4363
|
>>> result = thread.get()
|
|
4449
4364
|
|
|
4450
4365
|
|
|
@@ -4519,9 +4434,9 @@ class CampaignApi(object):
|
|
|
4519
4434
|
'_content_type')
|
|
4520
4435
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4521
4436
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4522
|
-
return self.
|
|
4437
|
+
return self.get_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
4523
4438
|
|
|
4524
|
-
def
|
|
4439
|
+
def get_marketplace_seller_campaign(
|
|
4525
4440
|
self,
|
|
4526
4441
|
seller_campaign_id,
|
|
4527
4442
|
**kwargs
|
|
@@ -4532,7 +4447,7 @@ class CampaignApi(object):
|
|
|
4532
4447
|
This method makes a synchronous HTTP request by default. To make an
|
|
4533
4448
|
asynchronous HTTP request, please pass async_req=True
|
|
4534
4449
|
|
|
4535
|
-
>>> thread = api.
|
|
4450
|
+
>>> thread = api.get_marketplace_seller_campaign(seller_campaign_id, async_req=True)
|
|
4536
4451
|
>>> result = thread.get()
|
|
4537
4452
|
|
|
4538
4453
|
Args:
|
|
@@ -4602,9 +4517,9 @@ class CampaignApi(object):
|
|
|
4602
4517
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4603
4518
|
kwargs['seller_campaign_id'] = \
|
|
4604
4519
|
seller_campaign_id
|
|
4605
|
-
return self.
|
|
4520
|
+
return self.get_marketplace_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
4606
4521
|
|
|
4607
|
-
def
|
|
4522
|
+
def get_marketplace_seller_campaigns(
|
|
4608
4523
|
self,
|
|
4609
4524
|
**kwargs
|
|
4610
4525
|
):
|
|
@@ -4614,7 +4529,7 @@ class CampaignApi(object):
|
|
|
4614
4529
|
This method makes a synchronous HTTP request by default. To make an
|
|
4615
4530
|
asynchronous HTTP request, please pass async_req=True
|
|
4616
4531
|
|
|
4617
|
-
>>> thread = api.
|
|
4532
|
+
>>> thread = api.get_marketplace_seller_campaigns(async_req=True)
|
|
4618
4533
|
>>> result = thread.get()
|
|
4619
4534
|
|
|
4620
4535
|
|
|
@@ -4685,9 +4600,9 @@ class CampaignApi(object):
|
|
|
4685
4600
|
'_content_type')
|
|
4686
4601
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4687
4602
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4688
|
-
return self.
|
|
4603
|
+
return self.get_marketplace_seller_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
4689
4604
|
|
|
4690
|
-
def
|
|
4605
|
+
def get_marketplace_seller_campaigns_by_advertiser(
|
|
4691
4606
|
self,
|
|
4692
4607
|
advertiser_id,
|
|
4693
4608
|
**kwargs
|
|
@@ -4698,7 +4613,7 @@ class CampaignApi(object):
|
|
|
4698
4613
|
This method makes a synchronous HTTP request by default. To make an
|
|
4699
4614
|
asynchronous HTTP request, please pass async_req=True
|
|
4700
4615
|
|
|
4701
|
-
>>> thread = api.
|
|
4616
|
+
>>> thread = api.get_marketplace_seller_campaigns_by_advertiser(advertiser_id, async_req=True)
|
|
4702
4617
|
>>> result = thread.get()
|
|
4703
4618
|
|
|
4704
4619
|
Args:
|
|
@@ -4768,9 +4683,9 @@ class CampaignApi(object):
|
|
|
4768
4683
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4769
4684
|
kwargs['advertiser_id'] = \
|
|
4770
4685
|
advertiser_id
|
|
4771
|
-
return self.
|
|
4686
|
+
return self.get_marketplace_seller_campaigns_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
4772
4687
|
|
|
4773
|
-
def
|
|
4688
|
+
def get_marketplace_seller_campaigns_by_seller(
|
|
4774
4689
|
self,
|
|
4775
4690
|
seller_id,
|
|
4776
4691
|
**kwargs
|
|
@@ -4781,7 +4696,7 @@ class CampaignApi(object):
|
|
|
4781
4696
|
This method makes a synchronous HTTP request by default. To make an
|
|
4782
4697
|
asynchronous HTTP request, please pass async_req=True
|
|
4783
4698
|
|
|
4784
|
-
>>> thread = api.
|
|
4699
|
+
>>> thread = api.get_marketplace_seller_campaigns_by_seller(seller_id, async_req=True)
|
|
4785
4700
|
>>> result = thread.get()
|
|
4786
4701
|
|
|
4787
4702
|
Args:
|
|
@@ -4854,9 +4769,95 @@ class CampaignApi(object):
|
|
|
4854
4769
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4855
4770
|
kwargs['seller_id'] = \
|
|
4856
4771
|
seller_id
|
|
4857
|
-
return self.
|
|
4772
|
+
return self.get_marketplace_seller_campaigns_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
4773
|
+
|
|
4774
|
+
def get_marketplace_seller_campaigns_stats(
|
|
4775
|
+
self,
|
|
4776
|
+
**kwargs
|
|
4777
|
+
):
|
|
4778
|
+
""" # noqa: E501
|
|
4779
|
+
|
|
4780
|
+
## Dimensions Get performance statistics aggregated for _seller campaigns_.The campaign id, seller id, and seller name appear in the first three columns of the output. These are followed by the interval size column. Aggregation can be done by `hour`, `day`, `month`, or `year`. The aggregation interval size is controlled by `intervalSize`. The remaining columns are metrics. ## Metrics The metrics reported by this endpoint are . | Metric Group | Description ---|--------------|------------ A | impressions | Number of times product is shown in a banner B | clicks | Number of clicks on product C | cost | Amount spent for clicks on products D | saleUnits | Number of products sold attributed to clicks E | revenue | Revenue generated by sales F | CR = Conversion Rate | salesUnits / clicks G | CPO = Cost Per Order | cost / salesUnits H | COS = Cost of Sale | cost / revenue I | ROAS = Return On Add Spend | revenue / cost The last six metrics can be computed in two ways depending on the policy to count only the sales that result from clicks on the same sellers product in a banner (same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`. The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns. ## Filtering The results can be filtered by date or count. Filtering the results to events associated with a specific campaign is done by setting the `campaignId` filter parameter to the desired value. Filtering the results to events associated with a specific seller is done by setting the `sellerId` filter parameter to the desired value. Filtering the results to events that happened in a time interval is done by setting the `startDate` and `endDate` filter parameters using the `yyyy-MM-DD` format. The start date includes all events timestamped since the beginning of that day while the end date includes events until the end of day. The maximum duration of the date range is 1 year. If the aggregation interval is `hour`, then the maximum duration of the date range is 31 days. Note that month and year aggregate values may contain partial data for the interval if filtering by date. Filtering the results to a maximum number of data rows is done by setting the `count` filter parameter. When combined with startDate this can be used to perform simple pagination. ## Response Format The representation format can be specified by MIME values in the Accept header. For now the only supported values for the accept header is `application/json` and `text/csv`. ```json { \"columns\": [ \"campaignId\", \"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\" ], \"data\": [ [168423, 1110222, \"118883955\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0], [168423, 1110222, \"118883955\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0], [168423, 1110225, \"117980027\", \"2019-05-01\", 12502, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0], [168423, 1110225, \"117980027\", \"2019-06-01\", 20266, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0] ], \"rows\": 4 } ``` The JSON result is an object with three fields (`columns`, `data`, and `rows`). The “columns” array acts as the header for the data rows. The categorical dimension columns come first and include the campaign id, seller id, and seller name. The interval column comes next and defines the aggregation period. The interval size is determined by the `intervalSize` parameter. This is followed by either nine or fifteen metrics columns. The first three metrics (impressions, clicks, and cost) always appear. The remaining depend on the `clickAttributionPolicy` parameter. The “data” array contains data rows whose values match the entries in the “columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects whose type is number. Some of these are natural numbers (e.g. clicks and impressions) whereas others are decimal values. A divide by zero yields null. The currency is assumed to be the local currency established by the advertiser. The “row” value is a count of the number of rows in the data array, and can be used to check the integrity of the data. Further information on the campaign or seller (e.g. the seller name) can be obtained from the existing V1 or V2 endpoints using the campaign and/or seller ID values. # noqa: E501
|
|
4781
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4782
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4783
|
+
|
|
4784
|
+
>>> thread = api.get_marketplace_seller_campaigns_stats(async_req=True)
|
|
4785
|
+
>>> result = thread.get()
|
|
4786
|
+
|
|
4787
|
+
|
|
4788
|
+
Keyword Args:
|
|
4789
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
4790
|
+
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
4791
|
+
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
4792
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
4793
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
4794
|
+
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
4795
|
+
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
4796
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
4797
|
+
_return_http_data_only (bool): response data without head status
|
|
4798
|
+
code and headers. Default is True.
|
|
4799
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4800
|
+
will be returned without reading/decoding response data.
|
|
4801
|
+
Default is True.
|
|
4802
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4803
|
+
one number provided, it will be total request timeout. It can also
|
|
4804
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4805
|
+
Default is None.
|
|
4806
|
+
_check_input_type (bool): specifies if type checking
|
|
4807
|
+
should be done one the data sent to the server.
|
|
4808
|
+
Default is True.
|
|
4809
|
+
_check_return_type (bool): specifies if type checking
|
|
4810
|
+
should be done one the data received from the server.
|
|
4811
|
+
Default is True.
|
|
4812
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4813
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4814
|
+
False if the variable names in the input data
|
|
4815
|
+
are pythonic names, e.g. snake case (default)
|
|
4816
|
+
_content_type (str/None): force body content-type.
|
|
4817
|
+
Default is None and content-type will be predicted by allowed
|
|
4818
|
+
content-types and body.
|
|
4819
|
+
_host_index (int/None): specifies the index of the server
|
|
4820
|
+
that we want to use.
|
|
4821
|
+
Default is read from the configuration.
|
|
4822
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4823
|
+
request; this effectively ignores the authentication
|
|
4824
|
+
in the spec for a single request.
|
|
4825
|
+
Default is None
|
|
4826
|
+
async_req (bool): execute request asynchronously
|
|
4827
|
+
|
|
4828
|
+
Returns:
|
|
4829
|
+
str
|
|
4830
|
+
If the method is called asynchronously, returns the request
|
|
4831
|
+
thread.
|
|
4832
|
+
"""
|
|
4833
|
+
kwargs['async_req'] = kwargs.get(
|
|
4834
|
+
'async_req', False
|
|
4835
|
+
)
|
|
4836
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4837
|
+
'_return_http_data_only', True
|
|
4838
|
+
)
|
|
4839
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4840
|
+
'_preload_content', True
|
|
4841
|
+
)
|
|
4842
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4843
|
+
'_request_timeout', None
|
|
4844
|
+
)
|
|
4845
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4846
|
+
'_check_input_type', True
|
|
4847
|
+
)
|
|
4848
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4849
|
+
'_check_return_type', True
|
|
4850
|
+
)
|
|
4851
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4852
|
+
'_spec_property_naming', False
|
|
4853
|
+
)
|
|
4854
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4855
|
+
'_content_type')
|
|
4856
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4857
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4858
|
+
return self.get_marketplace_seller_campaigns_stats_endpoint.call_with_http_info(**kwargs)
|
|
4858
4859
|
|
|
4859
|
-
def
|
|
4860
|
+
def get_marketplace_sellers(
|
|
4860
4861
|
self,
|
|
4861
4862
|
**kwargs
|
|
4862
4863
|
):
|
|
@@ -4866,7 +4867,7 @@ class CampaignApi(object):
|
|
|
4866
4867
|
This method makes a synchronous HTTP request by default. To make an
|
|
4867
4868
|
asynchronous HTTP request, please pass async_req=True
|
|
4868
4869
|
|
|
4869
|
-
>>> thread = api.
|
|
4870
|
+
>>> thread = api.get_marketplace_sellers(async_req=True)
|
|
4870
4871
|
>>> result = thread.get()
|
|
4871
4872
|
|
|
4872
4873
|
|
|
@@ -4938,27 +4939,28 @@ class CampaignApi(object):
|
|
|
4938
4939
|
'_content_type')
|
|
4939
4940
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4940
4941
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4941
|
-
return self.
|
|
4942
|
+
return self.get_marketplace_sellers_endpoint.call_with_http_info(**kwargs)
|
|
4942
4943
|
|
|
4943
|
-
def
|
|
4944
|
+
def get_marketplace_sellers_by_advertiser(
|
|
4944
4945
|
self,
|
|
4945
|
-
|
|
4946
|
+
advertiser_id,
|
|
4946
4947
|
**kwargs
|
|
4947
4948
|
):
|
|
4948
|
-
"""
|
|
4949
|
+
""" # noqa: E501
|
|
4949
4950
|
|
|
4950
|
-
|
|
4951
|
+
Create new sellers for an advertiser # noqa: E501
|
|
4951
4952
|
This method makes a synchronous HTTP request by default. To make an
|
|
4952
4953
|
asynchronous HTTP request, please pass async_req=True
|
|
4953
4954
|
|
|
4954
|
-
>>> thread = api.
|
|
4955
|
+
>>> thread = api.get_marketplace_sellers_by_advertiser(advertiser_id, async_req=True)
|
|
4955
4956
|
>>> result = thread.get()
|
|
4956
4957
|
|
|
4957
4958
|
Args:
|
|
4958
|
-
|
|
4959
|
+
advertiser_id (int): Id of the advertiser
|
|
4959
4960
|
|
|
4960
4961
|
Keyword Args:
|
|
4961
|
-
|
|
4962
|
+
partner_id (int): Id of the partner. [optional]
|
|
4963
|
+
request_body ([str]): Names of the sellers to associate with new Ids. [optional]
|
|
4962
4964
|
_return_http_data_only (bool): response data without head status
|
|
4963
4965
|
code and headers. Default is True.
|
|
4964
4966
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4991,7 +4993,7 @@ class CampaignApi(object):
|
|
|
4991
4993
|
async_req (bool): execute request asynchronously
|
|
4992
4994
|
|
|
4993
4995
|
Returns:
|
|
4994
|
-
|
|
4996
|
+
None
|
|
4995
4997
|
If the method is called asynchronously, returns the request
|
|
4996
4998
|
thread.
|
|
4997
4999
|
"""
|
|
@@ -5020,26 +5022,32 @@ class CampaignApi(object):
|
|
|
5020
5022
|
'_content_type')
|
|
5021
5023
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5022
5024
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5023
|
-
kwargs['
|
|
5024
|
-
|
|
5025
|
-
return self.
|
|
5025
|
+
kwargs['advertiser_id'] = \
|
|
5026
|
+
advertiser_id
|
|
5027
|
+
return self.get_marketplace_sellers_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
5026
5028
|
|
|
5027
|
-
def
|
|
5029
|
+
def get_marketplace_sellers_stats(
|
|
5028
5030
|
self,
|
|
5029
5031
|
**kwargs
|
|
5030
5032
|
):
|
|
5031
|
-
"""
|
|
5033
|
+
""" # noqa: E501
|
|
5032
5034
|
|
|
5033
|
-
|
|
5035
|
+
## Dimensions Get performance statistics aggregated for _sellers_. The seller id appears in the output in the first column and the seller name appears in the second. Aggregation can be done by `hour`, `day`, `month`, or `year`. The aggregation interval size is controlled by `intervalSize`. The time interval appears in the output as the second column. ## Metrics The metrics reported by this endpoint are . | Metric Group | Description ---|--------------|------------ A | impressions | Number of times product is shown in a banner B | clicks | Number of clicks on product C | cost | Amount spent for clicks on products D | saleUnits | Number of products sold attributed to clicks E | revenue | Revenue generated by sales F | CR = Conversion Rate | salesUnits / clicks G | CPO = Cost Per Order | cost / salesUnits H | COS = Cost of Sale | cost / revenue I | ROAS = Return On Add Spend | revenue / cost The last six metrics can be computed in two ways depending on the policy to count only the sales that result from clicks on the same sellers product in a banner (same-seller) or not (any-seller). Reporting can be controlled by `clickAttributionPolicy`. The 9 (or 15) metric values appear in the output as the final 9 (or 15) columns. ## Filtering The results can be filtered by seller id, date or count. Filtering the results to events associated with a specific seller is done by setting the `sellerId` filter parameter to the desired value. Filtering the results to events that happened in a time interval is done by setting the `startDate` and `endDate` filter parameters using the `yyyy-MM-DD` format. The start date includes all events timestamped since the beginning of that day while the end date includes events until the end of day. The maximum duration of the date range is 1 year. If the aggregation interval is `hour`, then the maximum duration of the date range is 31 days. Note that month and year aggregate values may contain partial data for the interval if filtering by date. Filtering the results to a maximum number of data rows is done by setting the `count` filter parameter. When combined with startDate this can be used to perform simple pagination. ## Response Format The representation format can be specified by MIME values in the Accept header. For now the only supported values for the accept header is `application/json` and `text/csv`. ```json { \"columns\": [\"sellerId\", \"sellerName\", \"month\", \"impressions\", \"clicks\", \"cost\", \"saleUnits\", \"revenue\", \"cr\", \"cpo\", \"cos\", \"roas\"], \"data\": [ [1200972, \"sellerA\", \"2019-05-01\", 14542, 48, 3.36, 0, 0.0, 0.0, null, null, 0.0], [1200972, \"sellerA\", \"2019-06-01\", 16619, 53, 3.71, 0, 0.0, 0.0, null, null, 0.0], [1200974, \"sellerB\", \"2019-05-01\", 10102, 47, 3.29, 3, 396000.0, 0.063, 1.096, 8.308E-6, 120364.741], [1200974, \"sellerB\", \"2019-06-01\", 11576, 54, 3.78, 1, 132000.0, 0.018, 3.78, 2.863E-5, 34920.634] ], \"rows\": 4 } ``` The JSON result is an object with three fields (`columns`, `data`, and `rows`). The “columns” array acts as the header for the data rows. The categorical dimension columns come first and include the seller id and seller name. The interval column comes next and defines the aggregation period. The interval size is determined by the `intervalSize` parameter. This is followed by either nine or fifteen metrics columns. The first three metrics (impressions, clicks, and cost) always appear. The remaining metrics depend on the `clickAttributionPolicy` parameter. The “data” array contains data rows whose values match the entries in the “columns” array. Id dimensions are numbers while name and date dimensions are strings. The metrics are JSON objects whose type is number. Some of these are natural numbers (e.g. clicks and impressions) whereas others are decimal values. A divide by zero yields null. The currency is assumed to be the local currency established by the advertiser. The “row” value is a count of the number of rows in the data array, and can be used to check the integrity of the data. Further information on the campaign or seller (e.g. the seller name) can be obtained from the existing V1 or V2 endpoints using the campaign and/or seller ID values. # noqa: E501
|
|
5034
5036
|
This method makes a synchronous HTTP request by default. To make an
|
|
5035
5037
|
asynchronous HTTP request, please pass async_req=True
|
|
5036
5038
|
|
|
5037
|
-
>>> thread = api.
|
|
5039
|
+
>>> thread = api.get_marketplace_sellers_stats(async_req=True)
|
|
5038
5040
|
>>> result = thread.get()
|
|
5039
5041
|
|
|
5040
5042
|
|
|
5041
5043
|
Keyword Args:
|
|
5042
|
-
|
|
5044
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
5045
|
+
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
5046
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
5047
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
5048
|
+
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
5049
|
+
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
5050
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
5043
5051
|
_return_http_data_only (bool): response data without head status
|
|
5044
5052
|
code and headers. Default is True.
|
|
5045
5053
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5072,7 +5080,7 @@ class CampaignApi(object):
|
|
|
5072
5080
|
async_req (bool): execute request asynchronously
|
|
5073
5081
|
|
|
5074
5082
|
Returns:
|
|
5075
|
-
|
|
5083
|
+
str
|
|
5076
5084
|
If the method is called asynchronously, returns the request
|
|
5077
5085
|
thread.
|
|
5078
5086
|
"""
|
|
@@ -5101,24 +5109,27 @@ class CampaignApi(object):
|
|
|
5101
5109
|
'_content_type')
|
|
5102
5110
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5103
5111
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5104
|
-
return self.
|
|
5112
|
+
return self.get_marketplace_sellers_stats_endpoint.call_with_http_info(**kwargs)
|
|
5105
5113
|
|
|
5106
|
-
def
|
|
5114
|
+
def patch_ad_set_category_bids(
|
|
5107
5115
|
self,
|
|
5116
|
+
ad_set_id,
|
|
5108
5117
|
**kwargs
|
|
5109
5118
|
):
|
|
5110
|
-
"""
|
|
5119
|
+
"""patch_ad_set_category_bids # noqa: E501
|
|
5111
5120
|
|
|
5112
|
-
Patch a
|
|
5121
|
+
Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. # noqa: E501
|
|
5113
5122
|
This method makes a synchronous HTTP request by default. To make an
|
|
5114
5123
|
asynchronous HTTP request, please pass async_req=True
|
|
5115
5124
|
|
|
5116
|
-
>>> thread = api.
|
|
5125
|
+
>>> thread = api.patch_ad_set_category_bids(ad_set_id, async_req=True)
|
|
5117
5126
|
>>> result = thread.get()
|
|
5118
5127
|
|
|
5128
|
+
Args:
|
|
5129
|
+
ad_set_id (str): Id of the Ad Set
|
|
5119
5130
|
|
|
5120
5131
|
Keyword Args:
|
|
5121
|
-
|
|
5132
|
+
patch_ad_set_category_bid_list_request (PatchAdSetCategoryBidListRequest): [optional]
|
|
5122
5133
|
_return_http_data_only (bool): response data without head status
|
|
5123
5134
|
code and headers. Default is True.
|
|
5124
5135
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5151,7 +5162,7 @@ class CampaignApi(object):
|
|
|
5151
5162
|
async_req (bool): execute request asynchronously
|
|
5152
5163
|
|
|
5153
5164
|
Returns:
|
|
5154
|
-
|
|
5165
|
+
PatchAdSetCategoryBidResultListResponse
|
|
5155
5166
|
If the method is called asynchronously, returns the request
|
|
5156
5167
|
thread.
|
|
5157
5168
|
"""
|
|
@@ -5180,27 +5191,26 @@ class CampaignApi(object):
|
|
|
5180
5191
|
'_content_type')
|
|
5181
5192
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5182
5193
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5183
|
-
|
|
5194
|
+
kwargs['ad_set_id'] = \
|
|
5195
|
+
ad_set_id
|
|
5196
|
+
return self.patch_ad_set_category_bids_endpoint.call_with_http_info(**kwargs)
|
|
5184
5197
|
|
|
5185
|
-
def
|
|
5198
|
+
def patch_ad_sets(
|
|
5186
5199
|
self,
|
|
5187
|
-
ad_set_id,
|
|
5188
5200
|
**kwargs
|
|
5189
5201
|
):
|
|
5190
|
-
"""
|
|
5202
|
+
"""patch_ad_sets # noqa: E501
|
|
5191
5203
|
|
|
5192
|
-
Patch
|
|
5204
|
+
Patch a list of AdSets. # noqa: E501
|
|
5193
5205
|
This method makes a synchronous HTTP request by default. To make an
|
|
5194
5206
|
asynchronous HTTP request, please pass async_req=True
|
|
5195
5207
|
|
|
5196
|
-
>>> thread = api.
|
|
5208
|
+
>>> thread = api.patch_ad_sets(async_req=True)
|
|
5197
5209
|
>>> result = thread.get()
|
|
5198
5210
|
|
|
5199
|
-
Args:
|
|
5200
|
-
ad_set_id (str): Id of the Ad Set
|
|
5201
5211
|
|
|
5202
5212
|
Keyword Args:
|
|
5203
|
-
|
|
5213
|
+
requests_patch_ad_set_v24_q3 (RequestsPatchAdSetV24Q3): List of adsets to patch.. [optional]
|
|
5204
5214
|
_return_http_data_only (bool): response data without head status
|
|
5205
5215
|
code and headers. Default is True.
|
|
5206
5216
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5233,7 +5243,7 @@ class CampaignApi(object):
|
|
|
5233
5243
|
async_req (bool): execute request asynchronously
|
|
5234
5244
|
|
|
5235
5245
|
Returns:
|
|
5236
|
-
|
|
5246
|
+
ResponsesAdSetIdV24Q3
|
|
5237
5247
|
If the method is called asynchronously, returns the request
|
|
5238
5248
|
thread.
|
|
5239
5249
|
"""
|
|
@@ -5262,26 +5272,24 @@ class CampaignApi(object):
|
|
|
5262
5272
|
'_content_type')
|
|
5263
5273
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5264
5274
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5265
|
-
kwargs
|
|
5266
|
-
ad_set_id
|
|
5267
|
-
return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
5275
|
+
return self.patch_ad_sets_endpoint.call_with_http_info(**kwargs)
|
|
5268
5276
|
|
|
5269
|
-
def
|
|
5277
|
+
def patch_campaigns(
|
|
5270
5278
|
self,
|
|
5271
5279
|
**kwargs
|
|
5272
5280
|
):
|
|
5273
|
-
"""
|
|
5281
|
+
"""patch_campaigns # noqa: E501
|
|
5274
5282
|
|
|
5275
|
-
|
|
5283
|
+
Patch a list of Campaigns. # noqa: E501
|
|
5276
5284
|
This method makes a synchronous HTTP request by default. To make an
|
|
5277
5285
|
asynchronous HTTP request, please pass async_req=True
|
|
5278
5286
|
|
|
5279
|
-
>>> thread = api.
|
|
5287
|
+
>>> thread = api.patch_campaigns(async_req=True)
|
|
5280
5288
|
>>> result = thread.get()
|
|
5281
5289
|
|
|
5282
5290
|
|
|
5283
5291
|
Keyword Args:
|
|
5284
|
-
|
|
5292
|
+
patch_campaign_list_request (PatchCampaignListRequest): List of campaigns to patch.. [optional]
|
|
5285
5293
|
_return_http_data_only (bool): response data without head status
|
|
5286
5294
|
code and headers. Default is True.
|
|
5287
5295
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5314,7 +5322,7 @@ class CampaignApi(object):
|
|
|
5314
5322
|
async_req (bool): execute request asynchronously
|
|
5315
5323
|
|
|
5316
5324
|
Returns:
|
|
5317
|
-
|
|
5325
|
+
PatchResultCampaignListResponse
|
|
5318
5326
|
If the method is called asynchronously, returns the request
|
|
5319
5327
|
thread.
|
|
5320
5328
|
"""
|
|
@@ -5343,24 +5351,27 @@ class CampaignApi(object):
|
|
|
5343
5351
|
'_content_type')
|
|
5344
5352
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5345
5353
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5346
|
-
return self.
|
|
5354
|
+
return self.patch_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
5347
5355
|
|
|
5348
|
-
def
|
|
5356
|
+
def patch_display_multipliers(
|
|
5349
5357
|
self,
|
|
5358
|
+
ad_set_id,
|
|
5350
5359
|
**kwargs
|
|
5351
5360
|
):
|
|
5352
|
-
"""
|
|
5361
|
+
"""patch_display_multipliers # noqa: E501
|
|
5353
5362
|
|
|
5354
|
-
|
|
5363
|
+
Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. # noqa: E501
|
|
5355
5364
|
This method makes a synchronous HTTP request by default. To make an
|
|
5356
5365
|
asynchronous HTTP request, please pass async_req=True
|
|
5357
5366
|
|
|
5358
|
-
>>> thread = api.
|
|
5367
|
+
>>> thread = api.patch_display_multipliers(ad_set_id, async_req=True)
|
|
5359
5368
|
>>> result = thread.get()
|
|
5360
5369
|
|
|
5370
|
+
Args:
|
|
5371
|
+
ad_set_id (str): Id of the Ad Set
|
|
5361
5372
|
|
|
5362
5373
|
Keyword Args:
|
|
5363
|
-
|
|
5374
|
+
patch_ad_set_display_multiplier_list_request (PatchAdSetDisplayMultiplierListRequest): [optional]
|
|
5364
5375
|
_return_http_data_only (bool): response data without head status
|
|
5365
5376
|
code and headers. Default is True.
|
|
5366
5377
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5393,7 +5404,7 @@ class CampaignApi(object):
|
|
|
5393
5404
|
async_req (bool): execute request asynchronously
|
|
5394
5405
|
|
|
5395
5406
|
Returns:
|
|
5396
|
-
|
|
5407
|
+
PatchAdSetDisplayMultiplierResultListResponse
|
|
5397
5408
|
If the method is called asynchronously, returns the request
|
|
5398
5409
|
thread.
|
|
5399
5410
|
"""
|
|
@@ -5422,31 +5433,26 @@ class CampaignApi(object):
|
|
|
5422
5433
|
'_content_type')
|
|
5423
5434
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5424
5435
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5425
|
-
|
|
5436
|
+
kwargs['ad_set_id'] = \
|
|
5437
|
+
ad_set_id
|
|
5438
|
+
return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
5426
5439
|
|
|
5427
|
-
def
|
|
5440
|
+
def search_ad_sets(
|
|
5428
5441
|
self,
|
|
5429
5442
|
**kwargs
|
|
5430
5443
|
):
|
|
5431
|
-
""" # noqa: E501
|
|
5444
|
+
"""search_ad_sets # noqa: E501
|
|
5432
5445
|
|
|
5433
|
-
|
|
5446
|
+
Search for ad sets # noqa: E501
|
|
5434
5447
|
This method makes a synchronous HTTP request by default. To make an
|
|
5435
5448
|
asynchronous HTTP request, please pass async_req=True
|
|
5436
5449
|
|
|
5437
|
-
>>> thread = api.
|
|
5450
|
+
>>> thread = api.search_ad_sets(async_req=True)
|
|
5438
5451
|
>>> result = thread.get()
|
|
5439
5452
|
|
|
5440
5453
|
|
|
5441
5454
|
Keyword Args:
|
|
5442
|
-
|
|
5443
|
-
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
5444
|
-
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
5445
|
-
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
5446
|
-
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
5447
|
-
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
5448
|
-
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
5449
|
-
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
5455
|
+
ad_set_search_request_v24_q3 (AdSetSearchRequestV24Q3): [optional]
|
|
5450
5456
|
_return_http_data_only (bool): response data without head status
|
|
5451
5457
|
code and headers. Default is True.
|
|
5452
5458
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5479,7 +5485,7 @@ class CampaignApi(object):
|
|
|
5479
5485
|
async_req (bool): execute request asynchronously
|
|
5480
5486
|
|
|
5481
5487
|
Returns:
|
|
5482
|
-
|
|
5488
|
+
ResponsesReadAdSetV24Q3
|
|
5483
5489
|
If the method is called asynchronously, returns the request
|
|
5484
5490
|
thread.
|
|
5485
5491
|
"""
|
|
@@ -5508,30 +5514,24 @@ class CampaignApi(object):
|
|
|
5508
5514
|
'_content_type')
|
|
5509
5515
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5510
5516
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5511
|
-
return self.
|
|
5517
|
+
return self.search_ad_sets_endpoint.call_with_http_info(**kwargs)
|
|
5512
5518
|
|
|
5513
|
-
def
|
|
5519
|
+
def search_campaigns(
|
|
5514
5520
|
self,
|
|
5515
5521
|
**kwargs
|
|
5516
5522
|
):
|
|
5517
|
-
""" # noqa: E501
|
|
5523
|
+
"""search_campaigns # noqa: E501
|
|
5518
5524
|
|
|
5519
|
-
|
|
5525
|
+
Search for campaigns # noqa: E501
|
|
5520
5526
|
This method makes a synchronous HTTP request by default. To make an
|
|
5521
5527
|
asynchronous HTTP request, please pass async_req=True
|
|
5522
5528
|
|
|
5523
|
-
>>> thread = api.
|
|
5529
|
+
>>> thread = api.search_campaigns(async_req=True)
|
|
5524
5530
|
>>> result = thread.get()
|
|
5525
5531
|
|
|
5526
5532
|
|
|
5527
5533
|
Keyword Args:
|
|
5528
|
-
|
|
5529
|
-
click_attribution_policy (str): Specify the click attribution policy for salesUnits, revenue, CR, CPO, COS, and ROAS. [optional] if omitted the server will use the default value of "AnySeller"
|
|
5530
|
-
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
5531
|
-
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
5532
|
-
interval_size (str): Specify the aggregation interval for events used to compute stats (default is \"day\"). [optional] if omitted the server will use the default value of "Day"
|
|
5533
|
-
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
5534
|
-
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
5534
|
+
campaign_search_request_v23_q1 (CampaignSearchRequestV23Q1): filters on campaigns. [optional]
|
|
5535
5535
|
_return_http_data_only (bool): response data without head status
|
|
5536
5536
|
code and headers. Default is True.
|
|
5537
5537
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5564,7 +5564,7 @@ class CampaignApi(object):
|
|
|
5564
5564
|
async_req (bool): execute request asynchronously
|
|
5565
5565
|
|
|
5566
5566
|
Returns:
|
|
5567
|
-
|
|
5567
|
+
CampaignV23Q1ListResponse
|
|
5568
5568
|
If the method is called asynchronously, returns the request
|
|
5569
5569
|
thread.
|
|
5570
5570
|
"""
|
|
@@ -5593,7 +5593,7 @@ class CampaignApi(object):
|
|
|
5593
5593
|
'_content_type')
|
|
5594
5594
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5595
5595
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5596
|
-
return self.
|
|
5596
|
+
return self.search_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
5597
5597
|
|
|
5598
5598
|
def start_ad_sets(
|
|
5599
5599
|
self,
|
|
@@ -5840,7 +5840,7 @@ class CampaignApi(object):
|
|
|
5840
5840
|
ad_set_audience_link_input_entity_v1
|
|
5841
5841
|
return self.update_ad_set_audience_endpoint.call_with_http_info(**kwargs)
|
|
5842
5842
|
|
|
5843
|
-
def
|
|
5843
|
+
def update_marketplace_seller_budget(
|
|
5844
5844
|
self,
|
|
5845
5845
|
budget_id,
|
|
5846
5846
|
**kwargs
|
|
@@ -5851,7 +5851,7 @@ class CampaignApi(object):
|
|
|
5851
5851
|
This method makes a synchronous HTTP request by default. To make an
|
|
5852
5852
|
asynchronous HTTP request, please pass async_req=True
|
|
5853
5853
|
|
|
5854
|
-
>>> thread = api.
|
|
5854
|
+
>>> thread = api.update_marketplace_seller_budget(budget_id, async_req=True)
|
|
5855
5855
|
>>> result = thread.get()
|
|
5856
5856
|
|
|
5857
5857
|
Args:
|
|
@@ -5922,9 +5922,9 @@ class CampaignApi(object):
|
|
|
5922
5922
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5923
5923
|
kwargs['budget_id'] = \
|
|
5924
5924
|
budget_id
|
|
5925
|
-
return self.
|
|
5925
|
+
return self.update_marketplace_seller_budget_endpoint.call_with_http_info(**kwargs)
|
|
5926
5926
|
|
|
5927
|
-
def
|
|
5927
|
+
def update_marketplace_seller_budgets(
|
|
5928
5928
|
self,
|
|
5929
5929
|
**kwargs
|
|
5930
5930
|
):
|
|
@@ -5934,7 +5934,7 @@ class CampaignApi(object):
|
|
|
5934
5934
|
This method makes a synchronous HTTP request by default. To make an
|
|
5935
5935
|
asynchronous HTTP request, please pass async_req=True
|
|
5936
5936
|
|
|
5937
|
-
>>> thread = api.
|
|
5937
|
+
>>> thread = api.update_marketplace_seller_budgets(async_req=True)
|
|
5938
5938
|
>>> result = thread.get()
|
|
5939
5939
|
|
|
5940
5940
|
|
|
@@ -6001,9 +6001,9 @@ class CampaignApi(object):
|
|
|
6001
6001
|
'_content_type')
|
|
6002
6002
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
6003
6003
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6004
|
-
return self.
|
|
6004
|
+
return self.update_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
6005
6005
|
|
|
6006
|
-
def
|
|
6006
|
+
def update_marketplace_seller_campaign(
|
|
6007
6007
|
self,
|
|
6008
6008
|
seller_campaign_id,
|
|
6009
6009
|
**kwargs
|
|
@@ -6014,7 +6014,7 @@ class CampaignApi(object):
|
|
|
6014
6014
|
This method makes a synchronous HTTP request by default. To make an
|
|
6015
6015
|
asynchronous HTTP request, please pass async_req=True
|
|
6016
6016
|
|
|
6017
|
-
>>> thread = api.
|
|
6017
|
+
>>> thread = api.update_marketplace_seller_campaign(seller_campaign_id, async_req=True)
|
|
6018
6018
|
>>> result = thread.get()
|
|
6019
6019
|
|
|
6020
6020
|
Args:
|
|
@@ -6085,9 +6085,9 @@ class CampaignApi(object):
|
|
|
6085
6085
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6086
6086
|
kwargs['seller_campaign_id'] = \
|
|
6087
6087
|
seller_campaign_id
|
|
6088
|
-
return self.
|
|
6088
|
+
return self.update_marketplace_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
6089
6089
|
|
|
6090
|
-
def
|
|
6090
|
+
def update_marketplace_seller_campaigns(
|
|
6091
6091
|
self,
|
|
6092
6092
|
**kwargs
|
|
6093
6093
|
):
|
|
@@ -6097,7 +6097,7 @@ class CampaignApi(object):
|
|
|
6097
6097
|
This method makes a synchronous HTTP request by default. To make an
|
|
6098
6098
|
asynchronous HTTP request, please pass async_req=True
|
|
6099
6099
|
|
|
6100
|
-
>>> thread = api.
|
|
6100
|
+
>>> thread = api.update_marketplace_seller_campaigns(async_req=True)
|
|
6101
6101
|
>>> result = thread.get()
|
|
6102
6102
|
|
|
6103
6103
|
|
|
@@ -6164,5 +6164,5 @@ class CampaignApi(object):
|
|
|
6164
6164
|
'_content_type')
|
|
6165
6165
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
6166
6166
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6167
|
-
return self.
|
|
6167
|
+
return self.update_marketplace_seller_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
6168
6168
|
|