criteo-api-marketingsolutions-sdk 2025.7.0.251028__py3-none-any.whl → 2025.7.0.251030__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.251028.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251030.dist-info}/METADATA +3 -3
- {criteo_api_marketingsolutions_sdk-2025.7.0.251028.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251030.dist-info}/RECORD +16 -11
- 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 +769 -723
- criteo_api_marketingsolutions_v2025_07/api_client.py +1 -1
- criteo_api_marketingsolutions_v2025_07/configuration.py +1 -1
- criteo_api_marketingsolutions_v2025_07/model/ad_set_delivery_status.py +291 -0
- criteo_api_marketingsolutions_v2025_07/model/advertiser_adset_message.py +289 -0
- criteo_api_marketingsolutions_v2025_07/model/advertiser_campaign_message.py +287 -0
- criteo_api_marketingsolutions_v2025_07/model/advertiser_info_message.py +271 -0
- criteo_api_marketingsolutions_v2025_07/model/advertiser_quota_message.py +279 -0
- criteo_api_marketingsolutions_v2025_07/model/seller_budget_status_v2.py +4 -4
- criteo_api_marketingsolutions_v2025_07/models/__init__.py +5 -0
- {criteo_api_marketingsolutions_sdk-2025.7.0.251028.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251030.dist-info}/WHEEL +0 -0
- {criteo_api_marketingsolutions_sdk-2025.7.0.251028.dist-info → criteo_api_marketingsolutions_sdk-2025.7.0.251030.dist-info}/top_level.txt +0 -0
|
@@ -26,6 +26,10 @@ from criteo_api_marketingsolutions_v2025_07.model.ad_set_audience_link_input_ent
|
|
|
26
26
|
from criteo_api_marketingsolutions_v2025_07.model.ad_set_category_bid_list_response import AdSetCategoryBidListResponse
|
|
27
27
|
from criteo_api_marketingsolutions_v2025_07.model.ad_set_display_multiplier_list_response import AdSetDisplayMultiplierListResponse
|
|
28
28
|
from criteo_api_marketingsolutions_v2025_07.model.ad_set_search_request_v24_q3 import AdSetSearchRequestV24Q3
|
|
29
|
+
from criteo_api_marketingsolutions_v2025_07.model.advertiser_adset_message import AdvertiserAdsetMessage
|
|
30
|
+
from criteo_api_marketingsolutions_v2025_07.model.advertiser_campaign_message import AdvertiserCampaignMessage
|
|
31
|
+
from criteo_api_marketingsolutions_v2025_07.model.advertiser_info_message import AdvertiserInfoMessage
|
|
32
|
+
from criteo_api_marketingsolutions_v2025_07.model.advertiser_quota_message import AdvertiserQuotaMessage
|
|
29
33
|
from criteo_api_marketingsolutions_v2025_07.model.campaign_search_request_v23_q1 import CampaignSearchRequestV23Q1
|
|
30
34
|
from criteo_api_marketingsolutions_v2025_07.model.campaign_v23_q1_list_response import CampaignV23Q1ListResponse
|
|
31
35
|
from criteo_api_marketingsolutions_v2025_07.model.campaign_v23_q1_response import CampaignV23Q1Response
|
|
@@ -64,101 +68,6 @@ class CampaignApi(object):
|
|
|
64
68
|
if api_client is None:
|
|
65
69
|
api_client = ApiClient()
|
|
66
70
|
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
71
|
self.create_ad_set_endpoint = _Endpoint(
|
|
163
72
|
settings={
|
|
164
73
|
'response_type': (ResponseReadAdSetV24Q3,),
|
|
@@ -265,15 +174,15 @@ class CampaignApi(object):
|
|
|
265
174
|
},
|
|
266
175
|
api_client=api_client
|
|
267
176
|
)
|
|
268
|
-
self.
|
|
177
|
+
self.create_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
269
178
|
settings={
|
|
270
|
-
'response_type':
|
|
179
|
+
'response_type': ([SellerBudgetMessage],),
|
|
271
180
|
'auth': [
|
|
272
181
|
'oauth',
|
|
273
182
|
'oauth'
|
|
274
183
|
],
|
|
275
184
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
276
|
-
'operation_id': '
|
|
185
|
+
'operation_id': 'create_marketplace_seller_budgets',
|
|
277
186
|
'http_method': 'POST',
|
|
278
187
|
'servers': None,
|
|
279
188
|
},
|
|
@@ -307,22 +216,24 @@ class CampaignApi(object):
|
|
|
307
216
|
}
|
|
308
217
|
},
|
|
309
218
|
headers_map={
|
|
310
|
-
'accept': [
|
|
219
|
+
'accept': [
|
|
220
|
+
'application/json'
|
|
221
|
+
],
|
|
311
222
|
'content_type': [
|
|
312
223
|
'application/json'
|
|
313
224
|
]
|
|
314
225
|
},
|
|
315
226
|
api_client=api_client
|
|
316
227
|
)
|
|
317
|
-
self.
|
|
228
|
+
self.create_marketplace_seller_campaigns_by_seller_endpoint = _Endpoint(
|
|
318
229
|
settings={
|
|
319
|
-
'response_type':
|
|
230
|
+
'response_type': (SellerCampaignMessage,),
|
|
320
231
|
'auth': [
|
|
321
232
|
'oauth',
|
|
322
233
|
'oauth'
|
|
323
234
|
],
|
|
324
235
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns',
|
|
325
|
-
'operation_id': '
|
|
236
|
+
'operation_id': 'create_marketplace_seller_campaigns_by_seller',
|
|
326
237
|
'http_method': 'POST',
|
|
327
238
|
'servers': None,
|
|
328
239
|
},
|
|
@@ -363,33 +274,33 @@ class CampaignApi(object):
|
|
|
363
274
|
}
|
|
364
275
|
},
|
|
365
276
|
headers_map={
|
|
366
|
-
'accept': [
|
|
277
|
+
'accept': [
|
|
278
|
+
'application/json'
|
|
279
|
+
],
|
|
367
280
|
'content_type': [
|
|
368
281
|
'application/json'
|
|
369
282
|
]
|
|
370
283
|
},
|
|
371
284
|
api_client=api_client
|
|
372
285
|
)
|
|
373
|
-
self.
|
|
286
|
+
self.get_ad_set_endpoint = _Endpoint(
|
|
374
287
|
settings={
|
|
375
|
-
'response_type':
|
|
288
|
+
'response_type': (ResponseReadAdSetV24Q3,),
|
|
376
289
|
'auth': [
|
|
377
290
|
'oauth',
|
|
378
291
|
'oauth'
|
|
379
292
|
],
|
|
380
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
381
|
-
'operation_id': '
|
|
382
|
-
'http_method': '
|
|
293
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}',
|
|
294
|
+
'operation_id': 'get_ad_set',
|
|
295
|
+
'http_method': 'GET',
|
|
383
296
|
'servers': None,
|
|
384
297
|
},
|
|
385
298
|
params_map={
|
|
386
299
|
'all': [
|
|
387
|
-
'
|
|
388
|
-
'partner_id',
|
|
389
|
-
'request_body',
|
|
300
|
+
'ad_set_id',
|
|
390
301
|
],
|
|
391
302
|
'required': [
|
|
392
|
-
'
|
|
303
|
+
'ad_set_id',
|
|
393
304
|
],
|
|
394
305
|
'nullable': [
|
|
395
306
|
],
|
|
@@ -404,42 +315,35 @@ class CampaignApi(object):
|
|
|
404
315
|
'allowed_values': {
|
|
405
316
|
},
|
|
406
317
|
'openapi_types': {
|
|
407
|
-
'
|
|
408
|
-
(
|
|
409
|
-
'partner_id':
|
|
410
|
-
(int,),
|
|
411
|
-
'request_body':
|
|
412
|
-
([str],),
|
|
318
|
+
'ad_set_id':
|
|
319
|
+
(str,),
|
|
413
320
|
},
|
|
414
321
|
'attribute_map': {
|
|
415
|
-
'
|
|
416
|
-
'partner_id': 'partnerId',
|
|
322
|
+
'ad_set_id': 'ad-set-id',
|
|
417
323
|
},
|
|
418
324
|
'location_map': {
|
|
419
|
-
'
|
|
420
|
-
'partner_id': 'query',
|
|
421
|
-
'request_body': 'body',
|
|
325
|
+
'ad_set_id': 'path',
|
|
422
326
|
},
|
|
423
327
|
'collection_format_map': {
|
|
424
328
|
}
|
|
425
329
|
},
|
|
426
330
|
headers_map={
|
|
427
|
-
'accept': [
|
|
428
|
-
'content_type': [
|
|
331
|
+
'accept': [
|
|
429
332
|
'application/json'
|
|
430
|
-
]
|
|
333
|
+
],
|
|
334
|
+
'content_type': [],
|
|
431
335
|
},
|
|
432
336
|
api_client=api_client
|
|
433
337
|
)
|
|
434
|
-
self.
|
|
338
|
+
self.get_ad_set_category_bids_endpoint = _Endpoint(
|
|
435
339
|
settings={
|
|
436
|
-
'response_type': (
|
|
340
|
+
'response_type': (AdSetCategoryBidListResponse,),
|
|
437
341
|
'auth': [
|
|
438
342
|
'oauth',
|
|
439
343
|
'oauth'
|
|
440
344
|
],
|
|
441
|
-
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}',
|
|
442
|
-
'operation_id': '
|
|
345
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
|
|
346
|
+
'operation_id': 'get_ad_set_category_bids',
|
|
443
347
|
'http_method': 'GET',
|
|
444
348
|
'servers': None,
|
|
445
349
|
},
|
|
@@ -483,24 +387,24 @@ class CampaignApi(object):
|
|
|
483
387
|
},
|
|
484
388
|
api_client=api_client
|
|
485
389
|
)
|
|
486
|
-
self.
|
|
390
|
+
self.get_campaign_endpoint = _Endpoint(
|
|
487
391
|
settings={
|
|
488
|
-
'response_type': (
|
|
392
|
+
'response_type': (CampaignV23Q1Response,),
|
|
489
393
|
'auth': [
|
|
490
394
|
'oauth',
|
|
491
395
|
'oauth'
|
|
492
396
|
],
|
|
493
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
494
|
-
'operation_id': '
|
|
397
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns/{campaign-id}',
|
|
398
|
+
'operation_id': 'get_campaign',
|
|
495
399
|
'http_method': 'GET',
|
|
496
400
|
'servers': None,
|
|
497
401
|
},
|
|
498
402
|
params_map={
|
|
499
403
|
'all': [
|
|
500
|
-
'
|
|
404
|
+
'campaign_id',
|
|
501
405
|
],
|
|
502
406
|
'required': [
|
|
503
|
-
'
|
|
407
|
+
'campaign_id',
|
|
504
408
|
],
|
|
505
409
|
'nullable': [
|
|
506
410
|
],
|
|
@@ -515,14 +419,14 @@ class CampaignApi(object):
|
|
|
515
419
|
'allowed_values': {
|
|
516
420
|
},
|
|
517
421
|
'openapi_types': {
|
|
518
|
-
'
|
|
422
|
+
'campaign_id':
|
|
519
423
|
(str,),
|
|
520
424
|
},
|
|
521
425
|
'attribute_map': {
|
|
522
|
-
'
|
|
426
|
+
'campaign_id': 'campaign-id',
|
|
523
427
|
},
|
|
524
428
|
'location_map': {
|
|
525
|
-
'
|
|
429
|
+
'campaign_id': 'path',
|
|
526
430
|
},
|
|
527
431
|
'collection_format_map': {
|
|
528
432
|
}
|
|
@@ -535,24 +439,24 @@ class CampaignApi(object):
|
|
|
535
439
|
},
|
|
536
440
|
api_client=api_client
|
|
537
441
|
)
|
|
538
|
-
self.
|
|
442
|
+
self.get_display_multipliers_endpoint = _Endpoint(
|
|
539
443
|
settings={
|
|
540
|
-
'response_type':
|
|
444
|
+
'response_type': (AdSetDisplayMultiplierListResponse,),
|
|
541
445
|
'auth': [
|
|
542
446
|
'oauth',
|
|
543
447
|
'oauth'
|
|
544
448
|
],
|
|
545
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
546
|
-
'operation_id': '
|
|
449
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
|
|
450
|
+
'operation_id': 'get_display_multipliers',
|
|
547
451
|
'http_method': 'GET',
|
|
548
452
|
'servers': None,
|
|
549
453
|
},
|
|
550
454
|
params_map={
|
|
551
455
|
'all': [
|
|
552
|
-
'
|
|
456
|
+
'ad_set_id',
|
|
553
457
|
],
|
|
554
458
|
'required': [
|
|
555
|
-
'
|
|
459
|
+
'ad_set_id',
|
|
556
460
|
],
|
|
557
461
|
'nullable': [
|
|
558
462
|
],
|
|
@@ -567,33 +471,35 @@ class CampaignApi(object):
|
|
|
567
471
|
'allowed_values': {
|
|
568
472
|
},
|
|
569
473
|
'openapi_types': {
|
|
570
|
-
'
|
|
571
|
-
(
|
|
474
|
+
'ad_set_id':
|
|
475
|
+
(str,),
|
|
572
476
|
},
|
|
573
477
|
'attribute_map': {
|
|
574
|
-
'
|
|
478
|
+
'ad_set_id': 'ad-set-id',
|
|
575
479
|
},
|
|
576
480
|
'location_map': {
|
|
577
|
-
'
|
|
481
|
+
'ad_set_id': 'path',
|
|
578
482
|
},
|
|
579
483
|
'collection_format_map': {
|
|
580
484
|
}
|
|
581
485
|
},
|
|
582
486
|
headers_map={
|
|
583
|
-
'accept': [
|
|
487
|
+
'accept': [
|
|
488
|
+
'application/json'
|
|
489
|
+
],
|
|
584
490
|
'content_type': [],
|
|
585
491
|
},
|
|
586
492
|
api_client=api_client
|
|
587
493
|
)
|
|
588
|
-
self.
|
|
494
|
+
self.get_marketplace_ad_sets_by_advertiser_endpoint = _Endpoint(
|
|
589
495
|
settings={
|
|
590
|
-
'response_type':
|
|
496
|
+
'response_type': ([AdvertiserAdsetMessage],),
|
|
591
497
|
'auth': [
|
|
592
498
|
'oauth',
|
|
593
499
|
'oauth'
|
|
594
500
|
],
|
|
595
501
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/adsets',
|
|
596
|
-
'operation_id': '
|
|
502
|
+
'operation_id': 'get_marketplace_ad_sets_by_advertiser',
|
|
597
503
|
'http_method': 'GET',
|
|
598
504
|
'servers': None,
|
|
599
505
|
},
|
|
@@ -630,20 +536,22 @@ class CampaignApi(object):
|
|
|
630
536
|
}
|
|
631
537
|
},
|
|
632
538
|
headers_map={
|
|
633
|
-
'accept': [
|
|
539
|
+
'accept': [
|
|
540
|
+
'application/json'
|
|
541
|
+
],
|
|
634
542
|
'content_type': [],
|
|
635
543
|
},
|
|
636
544
|
api_client=api_client
|
|
637
545
|
)
|
|
638
|
-
self.
|
|
546
|
+
self.get_marketplace_advertiser_endpoint = _Endpoint(
|
|
639
547
|
settings={
|
|
640
|
-
'response_type':
|
|
548
|
+
'response_type': (AdvertiserInfoMessage,),
|
|
641
549
|
'auth': [
|
|
642
550
|
'oauth',
|
|
643
551
|
'oauth'
|
|
644
552
|
],
|
|
645
|
-
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}
|
|
646
|
-
'operation_id': '
|
|
553
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}',
|
|
554
|
+
'operation_id': 'get_marketplace_advertiser',
|
|
647
555
|
'http_method': 'GET',
|
|
648
556
|
'servers': None,
|
|
649
557
|
},
|
|
@@ -680,20 +588,22 @@ class CampaignApi(object):
|
|
|
680
588
|
}
|
|
681
589
|
},
|
|
682
590
|
headers_map={
|
|
683
|
-
'accept': [
|
|
591
|
+
'accept': [
|
|
592
|
+
'application/json'
|
|
593
|
+
],
|
|
684
594
|
'content_type': [],
|
|
685
595
|
},
|
|
686
596
|
api_client=api_client
|
|
687
597
|
)
|
|
688
|
-
self.
|
|
598
|
+
self.get_marketplace_advertiser_preview_limits_endpoint = _Endpoint(
|
|
689
599
|
settings={
|
|
690
|
-
'response_type':
|
|
600
|
+
'response_type': ([AdvertiserQuotaMessage],),
|
|
691
601
|
'auth': [
|
|
692
602
|
'oauth',
|
|
693
603
|
'oauth'
|
|
694
604
|
],
|
|
695
605
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/preview-limit',
|
|
696
|
-
'operation_id': '
|
|
606
|
+
'operation_id': 'get_marketplace_advertiser_preview_limits',
|
|
697
607
|
'http_method': 'GET',
|
|
698
608
|
'servers': None,
|
|
699
609
|
},
|
|
@@ -723,20 +633,22 @@ class CampaignApi(object):
|
|
|
723
633
|
}
|
|
724
634
|
},
|
|
725
635
|
headers_map={
|
|
726
|
-
'accept': [
|
|
636
|
+
'accept': [
|
|
637
|
+
'application/json'
|
|
638
|
+
],
|
|
727
639
|
'content_type': [],
|
|
728
640
|
},
|
|
729
641
|
api_client=api_client
|
|
730
642
|
)
|
|
731
|
-
self.
|
|
643
|
+
self.get_marketplace_advertisers_endpoint = _Endpoint(
|
|
732
644
|
settings={
|
|
733
|
-
'response_type':
|
|
645
|
+
'response_type': ([AdvertiserInfoMessage],),
|
|
734
646
|
'auth': [
|
|
735
647
|
'oauth',
|
|
736
648
|
'oauth'
|
|
737
649
|
],
|
|
738
650
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers',
|
|
739
|
-
'operation_id': '
|
|
651
|
+
'operation_id': 'get_marketplace_advertisers',
|
|
740
652
|
'http_method': 'GET',
|
|
741
653
|
'servers': None,
|
|
742
654
|
},
|
|
@@ -766,20 +678,22 @@ class CampaignApi(object):
|
|
|
766
678
|
}
|
|
767
679
|
},
|
|
768
680
|
headers_map={
|
|
769
|
-
'accept': [
|
|
681
|
+
'accept': [
|
|
682
|
+
'application/json'
|
|
683
|
+
],
|
|
770
684
|
'content_type': [],
|
|
771
685
|
},
|
|
772
686
|
api_client=api_client
|
|
773
687
|
)
|
|
774
|
-
self.
|
|
688
|
+
self.get_marketplace_budgets_by_advertiser_endpoint = _Endpoint(
|
|
775
689
|
settings={
|
|
776
|
-
'response_type':
|
|
690
|
+
'response_type': ([SellerBudgetMessage],),
|
|
777
691
|
'auth': [
|
|
778
692
|
'oauth',
|
|
779
693
|
'oauth'
|
|
780
694
|
],
|
|
781
695
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/budgets',
|
|
782
|
-
'operation_id': '
|
|
696
|
+
'operation_id': 'get_marketplace_budgets_by_advertiser',
|
|
783
697
|
'http_method': 'GET',
|
|
784
698
|
'servers': None,
|
|
785
699
|
},
|
|
@@ -863,12 +777,14 @@ class CampaignApi(object):
|
|
|
863
777
|
}
|
|
864
778
|
},
|
|
865
779
|
headers_map={
|
|
866
|
-
'accept': [
|
|
780
|
+
'accept': [
|
|
781
|
+
'application/json'
|
|
782
|
+
],
|
|
867
783
|
'content_type': [],
|
|
868
784
|
},
|
|
869
785
|
api_client=api_client
|
|
870
786
|
)
|
|
871
|
-
self.
|
|
787
|
+
self.get_marketplace_budgets_by_seller_endpoint = _Endpoint(
|
|
872
788
|
settings={
|
|
873
789
|
'response_type': ([SellerBudgetMessage],),
|
|
874
790
|
'auth': [
|
|
@@ -876,7 +792,7 @@ class CampaignApi(object):
|
|
|
876
792
|
'oauth'
|
|
877
793
|
],
|
|
878
794
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/budgets',
|
|
879
|
-
'operation_id': '
|
|
795
|
+
'operation_id': 'get_marketplace_budgets_by_seller',
|
|
880
796
|
'http_method': 'GET',
|
|
881
797
|
'servers': None,
|
|
882
798
|
},
|
|
@@ -962,7 +878,7 @@ class CampaignApi(object):
|
|
|
962
878
|
},
|
|
963
879
|
api_client=api_client
|
|
964
880
|
)
|
|
965
|
-
self.
|
|
881
|
+
self.get_marketplace_budgets_by_seller_campaign_endpoint = _Endpoint(
|
|
966
882
|
settings={
|
|
967
883
|
'response_type': ([SellerBudgetMessage],),
|
|
968
884
|
'auth': [
|
|
@@ -970,7 +886,7 @@ class CampaignApi(object):
|
|
|
970
886
|
'oauth'
|
|
971
887
|
],
|
|
972
888
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}/budgets',
|
|
973
|
-
'operation_id': '
|
|
889
|
+
'operation_id': 'get_marketplace_budgets_by_seller_campaign',
|
|
974
890
|
'http_method': 'GET',
|
|
975
891
|
'servers': None,
|
|
976
892
|
},
|
|
@@ -1051,24 +967,24 @@ class CampaignApi(object):
|
|
|
1051
967
|
},
|
|
1052
968
|
api_client=api_client
|
|
1053
969
|
)
|
|
1054
|
-
self.
|
|
970
|
+
self.get_marketplace_campaigns_by_advertiser_endpoint = _Endpoint(
|
|
1055
971
|
settings={
|
|
1056
|
-
'response_type': (
|
|
972
|
+
'response_type': ([AdvertiserCampaignMessage],),
|
|
1057
973
|
'auth': [
|
|
1058
974
|
'oauth',
|
|
1059
975
|
'oauth'
|
|
1060
976
|
],
|
|
1061
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1062
|
-
'operation_id': '
|
|
977
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/campaigns',
|
|
978
|
+
'operation_id': 'get_marketplace_campaigns_by_advertiser',
|
|
1063
979
|
'http_method': 'GET',
|
|
1064
980
|
'servers': None,
|
|
1065
981
|
},
|
|
1066
982
|
params_map={
|
|
1067
983
|
'all': [
|
|
1068
|
-
'
|
|
984
|
+
'advertiser_id',
|
|
1069
985
|
],
|
|
1070
986
|
'required': [
|
|
1071
|
-
'
|
|
987
|
+
'advertiser_id',
|
|
1072
988
|
],
|
|
1073
989
|
'nullable': [
|
|
1074
990
|
],
|
|
@@ -1083,14 +999,14 @@ class CampaignApi(object):
|
|
|
1083
999
|
'allowed_values': {
|
|
1084
1000
|
},
|
|
1085
1001
|
'openapi_types': {
|
|
1086
|
-
'
|
|
1087
|
-
(
|
|
1002
|
+
'advertiser_id':
|
|
1003
|
+
(int,),
|
|
1088
1004
|
},
|
|
1089
1005
|
'attribute_map': {
|
|
1090
|
-
'
|
|
1006
|
+
'advertiser_id': 'advertiserId',
|
|
1091
1007
|
},
|
|
1092
1008
|
'location_map': {
|
|
1093
|
-
'
|
|
1009
|
+
'advertiser_id': 'path',
|
|
1094
1010
|
},
|
|
1095
1011
|
'collection_format_map': {
|
|
1096
1012
|
}
|
|
@@ -1103,28 +1019,35 @@ class CampaignApi(object):
|
|
|
1103
1019
|
},
|
|
1104
1020
|
api_client=api_client
|
|
1105
1021
|
)
|
|
1106
|
-
self.
|
|
1022
|
+
self.get_marketplace_campaigns_stats_endpoint = _Endpoint(
|
|
1107
1023
|
settings={
|
|
1108
|
-
'response_type': (
|
|
1024
|
+
'response_type': (str,),
|
|
1109
1025
|
'auth': [
|
|
1110
1026
|
'oauth',
|
|
1111
1027
|
'oauth'
|
|
1112
1028
|
],
|
|
1113
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1114
|
-
'operation_id': '
|
|
1029
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/campaigns',
|
|
1030
|
+
'operation_id': 'get_marketplace_campaigns_stats',
|
|
1115
1031
|
'http_method': 'GET',
|
|
1116
1032
|
'servers': None,
|
|
1117
1033
|
},
|
|
1118
1034
|
params_map={
|
|
1119
1035
|
'all': [
|
|
1120
|
-
'
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
'
|
|
1036
|
+
'advertiser_id',
|
|
1037
|
+
'campaign_id',
|
|
1038
|
+
'click_attribution_policy',
|
|
1039
|
+
'count',
|
|
1040
|
+
'end_date',
|
|
1041
|
+
'interval_size',
|
|
1042
|
+
'start_date',
|
|
1043
|
+
'time_zone_id',
|
|
1124
1044
|
],
|
|
1045
|
+
'required': [],
|
|
1125
1046
|
'nullable': [
|
|
1126
1047
|
],
|
|
1127
1048
|
'enum': [
|
|
1049
|
+
'click_attribution_policy',
|
|
1050
|
+
'interval_size',
|
|
1128
1051
|
],
|
|
1129
1052
|
'validation': [
|
|
1130
1053
|
]
|
|
@@ -1133,16 +1056,57 @@ class CampaignApi(object):
|
|
|
1133
1056
|
'validations': {
|
|
1134
1057
|
},
|
|
1135
1058
|
'allowed_values': {
|
|
1059
|
+
('click_attribution_policy',): {
|
|
1060
|
+
|
|
1061
|
+
"BOTH": "Both",
|
|
1062
|
+
"SAMESELLER": "SameSeller",
|
|
1063
|
+
"ANYSELLER": "AnySeller"
|
|
1064
|
+
},
|
|
1065
|
+
('interval_size',): {
|
|
1066
|
+
|
|
1067
|
+
"HOUR": "Hour",
|
|
1068
|
+
"DAY": "Day",
|
|
1069
|
+
"MONTH": "Month",
|
|
1070
|
+
"YEAR": "Year"
|
|
1071
|
+
},
|
|
1136
1072
|
},
|
|
1137
1073
|
'openapi_types': {
|
|
1138
|
-
'
|
|
1074
|
+
'advertiser_id':
|
|
1075
|
+
(int,),
|
|
1076
|
+
'campaign_id':
|
|
1139
1077
|
(str,),
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
'
|
|
1143
|
-
|
|
1078
|
+
'click_attribution_policy':
|
|
1079
|
+
(str,),
|
|
1080
|
+
'count':
|
|
1081
|
+
(int,),
|
|
1082
|
+
'end_date':
|
|
1083
|
+
(datetime,),
|
|
1084
|
+
'interval_size':
|
|
1085
|
+
(str,),
|
|
1086
|
+
'start_date':
|
|
1087
|
+
(datetime,),
|
|
1088
|
+
'time_zone_id':
|
|
1089
|
+
(str,),
|
|
1090
|
+
},
|
|
1091
|
+
'attribute_map': {
|
|
1092
|
+
'advertiser_id': 'advertiserId',
|
|
1093
|
+
'campaign_id': 'campaignId',
|
|
1094
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1095
|
+
'count': 'count',
|
|
1096
|
+
'end_date': 'endDate',
|
|
1097
|
+
'interval_size': 'intervalSize',
|
|
1098
|
+
'start_date': 'startDate',
|
|
1099
|
+
'time_zone_id': 'timeZoneId',
|
|
1100
|
+
},
|
|
1144
1101
|
'location_map': {
|
|
1145
|
-
'
|
|
1102
|
+
'advertiser_id': 'query',
|
|
1103
|
+
'campaign_id': 'query',
|
|
1104
|
+
'click_attribution_policy': 'query',
|
|
1105
|
+
'count': 'query',
|
|
1106
|
+
'end_date': 'query',
|
|
1107
|
+
'interval_size': 'query',
|
|
1108
|
+
'start_date': 'query',
|
|
1109
|
+
'time_zone_id': 'query',
|
|
1146
1110
|
},
|
|
1147
1111
|
'collection_format_map': {
|
|
1148
1112
|
}
|
|
@@ -1155,7 +1119,7 @@ class CampaignApi(object):
|
|
|
1155
1119
|
},
|
|
1156
1120
|
api_client=api_client
|
|
1157
1121
|
)
|
|
1158
|
-
self.
|
|
1122
|
+
self.get_marketplace_seller_endpoint = _Endpoint(
|
|
1159
1123
|
settings={
|
|
1160
1124
|
'response_type': (SellerBase,),
|
|
1161
1125
|
'auth': [
|
|
@@ -1163,7 +1127,7 @@ class CampaignApi(object):
|
|
|
1163
1127
|
'oauth'
|
|
1164
1128
|
],
|
|
1165
1129
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}',
|
|
1166
|
-
'operation_id': '
|
|
1130
|
+
'operation_id': 'get_marketplace_seller',
|
|
1167
1131
|
'http_method': 'GET',
|
|
1168
1132
|
'servers': None,
|
|
1169
1133
|
},
|
|
@@ -1207,7 +1171,7 @@ class CampaignApi(object):
|
|
|
1207
1171
|
},
|
|
1208
1172
|
api_client=api_client
|
|
1209
1173
|
)
|
|
1210
|
-
self.
|
|
1174
|
+
self.get_marketplace_seller_ad_preview_endpoint = _Endpoint(
|
|
1211
1175
|
settings={
|
|
1212
1176
|
'response_type': (str,),
|
|
1213
1177
|
'auth': [
|
|
@@ -1215,7 +1179,7 @@ class CampaignApi(object):
|
|
|
1215
1179
|
'oauth'
|
|
1216
1180
|
],
|
|
1217
1181
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/ad-preview',
|
|
1218
|
-
'operation_id': '
|
|
1182
|
+
'operation_id': 'get_marketplace_seller_ad_preview',
|
|
1219
1183
|
'http_method': 'GET',
|
|
1220
1184
|
'servers': None,
|
|
1221
1185
|
},
|
|
@@ -1280,7 +1244,7 @@ class CampaignApi(object):
|
|
|
1280
1244
|
},
|
|
1281
1245
|
api_client=api_client
|
|
1282
1246
|
)
|
|
1283
|
-
self.
|
|
1247
|
+
self.get_marketplace_seller_budget_endpoint = _Endpoint(
|
|
1284
1248
|
settings={
|
|
1285
1249
|
'response_type': (SellerBudgetMessage,),
|
|
1286
1250
|
'auth': [
|
|
@@ -1288,7 +1252,7 @@ class CampaignApi(object):
|
|
|
1288
1252
|
'oauth'
|
|
1289
1253
|
],
|
|
1290
1254
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}',
|
|
1291
|
-
'operation_id': '
|
|
1255
|
+
'operation_id': 'get_marketplace_seller_budget',
|
|
1292
1256
|
'http_method': 'GET',
|
|
1293
1257
|
'servers': None,
|
|
1294
1258
|
},
|
|
@@ -1332,7 +1296,7 @@ class CampaignApi(object):
|
|
|
1332
1296
|
},
|
|
1333
1297
|
api_client=api_client
|
|
1334
1298
|
)
|
|
1335
|
-
self.
|
|
1299
|
+
self.get_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
1336
1300
|
settings={
|
|
1337
1301
|
'response_type': ([SellerBudgetMessage],),
|
|
1338
1302
|
'auth': [
|
|
@@ -1340,7 +1304,7 @@ class CampaignApi(object):
|
|
|
1340
1304
|
'oauth'
|
|
1341
1305
|
],
|
|
1342
1306
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
1343
|
-
'operation_id': '
|
|
1307
|
+
'operation_id': 'get_marketplace_seller_budgets',
|
|
1344
1308
|
'http_method': 'GET',
|
|
1345
1309
|
'servers': None,
|
|
1346
1310
|
},
|
|
@@ -1429,15 +1393,15 @@ class CampaignApi(object):
|
|
|
1429
1393
|
},
|
|
1430
1394
|
api_client=api_client
|
|
1431
1395
|
)
|
|
1432
|
-
self.
|
|
1396
|
+
self.get_marketplace_seller_campaign_endpoint = _Endpoint(
|
|
1433
1397
|
settings={
|
|
1434
|
-
'response_type': (SellerCampaignMessage,),
|
|
1398
|
+
'response_type': ([SellerCampaignMessage],),
|
|
1435
1399
|
'auth': [
|
|
1436
1400
|
'oauth',
|
|
1437
1401
|
'oauth'
|
|
1438
1402
|
],
|
|
1439
1403
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}',
|
|
1440
|
-
'operation_id': '
|
|
1404
|
+
'operation_id': 'get_marketplace_seller_campaign',
|
|
1441
1405
|
'http_method': 'GET',
|
|
1442
1406
|
'servers': None,
|
|
1443
1407
|
},
|
|
@@ -1481,7 +1445,7 @@ class CampaignApi(object):
|
|
|
1481
1445
|
},
|
|
1482
1446
|
api_client=api_client
|
|
1483
1447
|
)
|
|
1484
|
-
self.
|
|
1448
|
+
self.get_marketplace_seller_campaigns_endpoint = _Endpoint(
|
|
1485
1449
|
settings={
|
|
1486
1450
|
'response_type': ([SellerCampaignMessage],),
|
|
1487
1451
|
'auth': [
|
|
@@ -1489,7 +1453,7 @@ class CampaignApi(object):
|
|
|
1489
1453
|
'oauth'
|
|
1490
1454
|
],
|
|
1491
1455
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns',
|
|
1492
|
-
'operation_id': '
|
|
1456
|
+
'operation_id': 'get_marketplace_seller_campaigns',
|
|
1493
1457
|
'http_method': 'GET',
|
|
1494
1458
|
'servers': None,
|
|
1495
1459
|
},
|
|
@@ -1564,15 +1528,15 @@ class CampaignApi(object):
|
|
|
1564
1528
|
},
|
|
1565
1529
|
api_client=api_client
|
|
1566
1530
|
)
|
|
1567
|
-
self.
|
|
1531
|
+
self.get_marketplace_seller_campaigns_by_advertiser_endpoint = _Endpoint(
|
|
1568
1532
|
settings={
|
|
1569
|
-
'response_type':
|
|
1533
|
+
'response_type': ([SellerCampaignMessage],),
|
|
1570
1534
|
'auth': [
|
|
1571
1535
|
'oauth',
|
|
1572
1536
|
'oauth'
|
|
1573
1537
|
],
|
|
1574
1538
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/seller-campaigns',
|
|
1575
|
-
'operation_id': '
|
|
1539
|
+
'operation_id': 'get_marketplace_seller_campaigns_by_advertiser',
|
|
1576
1540
|
'http_method': 'GET',
|
|
1577
1541
|
'servers': None,
|
|
1578
1542
|
},
|
|
@@ -1609,12 +1573,14 @@ class CampaignApi(object):
|
|
|
1609
1573
|
}
|
|
1610
1574
|
},
|
|
1611
1575
|
headers_map={
|
|
1612
|
-
'accept': [
|
|
1576
|
+
'accept': [
|
|
1577
|
+
'application/json'
|
|
1578
|
+
],
|
|
1613
1579
|
'content_type': [],
|
|
1614
1580
|
},
|
|
1615
1581
|
api_client=api_client
|
|
1616
1582
|
)
|
|
1617
|
-
self.
|
|
1583
|
+
self.get_marketplace_seller_campaigns_by_seller_endpoint = _Endpoint(
|
|
1618
1584
|
settings={
|
|
1619
1585
|
'response_type': ([SellerCampaignMessage],),
|
|
1620
1586
|
'auth': [
|
|
@@ -1622,7 +1588,7 @@ class CampaignApi(object):
|
|
|
1622
1588
|
'oauth'
|
|
1623
1589
|
],
|
|
1624
1590
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers/{sellerId}/seller-campaigns',
|
|
1625
|
-
'operation_id': '
|
|
1591
|
+
'operation_id': 'get_marketplace_seller_campaigns_by_seller',
|
|
1626
1592
|
'http_method': 'GET',
|
|
1627
1593
|
'servers': None,
|
|
1628
1594
|
},
|
|
@@ -1694,15 +1660,120 @@ class CampaignApi(object):
|
|
|
1694
1660
|
},
|
|
1695
1661
|
api_client=api_client
|
|
1696
1662
|
)
|
|
1697
|
-
self.
|
|
1663
|
+
self.get_marketplace_seller_campaigns_stats_endpoint = _Endpoint(
|
|
1698
1664
|
settings={
|
|
1699
|
-
'response_type': (
|
|
1665
|
+
'response_type': (str,),
|
|
1666
|
+
'auth': [
|
|
1667
|
+
'oauth',
|
|
1668
|
+
'oauth'
|
|
1669
|
+
],
|
|
1670
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/seller-campaigns',
|
|
1671
|
+
'operation_id': 'get_marketplace_seller_campaigns_stats',
|
|
1672
|
+
'http_method': 'GET',
|
|
1673
|
+
'servers': None,
|
|
1674
|
+
},
|
|
1675
|
+
params_map={
|
|
1676
|
+
'all': [
|
|
1677
|
+
'advertiser_id',
|
|
1678
|
+
'campaign_id',
|
|
1679
|
+
'click_attribution_policy',
|
|
1680
|
+
'count',
|
|
1681
|
+
'end_date',
|
|
1682
|
+
'interval_size',
|
|
1683
|
+
'seller_id',
|
|
1684
|
+
'start_date',
|
|
1685
|
+
'time_zone_id',
|
|
1686
|
+
],
|
|
1687
|
+
'required': [],
|
|
1688
|
+
'nullable': [
|
|
1689
|
+
],
|
|
1690
|
+
'enum': [
|
|
1691
|
+
'click_attribution_policy',
|
|
1692
|
+
'interval_size',
|
|
1693
|
+
],
|
|
1694
|
+
'validation': [
|
|
1695
|
+
]
|
|
1696
|
+
},
|
|
1697
|
+
root_map={
|
|
1698
|
+
'validations': {
|
|
1699
|
+
},
|
|
1700
|
+
'allowed_values': {
|
|
1701
|
+
('click_attribution_policy',): {
|
|
1702
|
+
|
|
1703
|
+
"BOTH": "Both",
|
|
1704
|
+
"SAMESELLER": "SameSeller",
|
|
1705
|
+
"ANYSELLER": "AnySeller"
|
|
1706
|
+
},
|
|
1707
|
+
('interval_size',): {
|
|
1708
|
+
|
|
1709
|
+
"HOUR": "Hour",
|
|
1710
|
+
"DAY": "Day",
|
|
1711
|
+
"MONTH": "Month",
|
|
1712
|
+
"YEAR": "Year"
|
|
1713
|
+
},
|
|
1714
|
+
},
|
|
1715
|
+
'openapi_types': {
|
|
1716
|
+
'advertiser_id':
|
|
1717
|
+
(int,),
|
|
1718
|
+
'campaign_id':
|
|
1719
|
+
(str,),
|
|
1720
|
+
'click_attribution_policy':
|
|
1721
|
+
(str,),
|
|
1722
|
+
'count':
|
|
1723
|
+
(int,),
|
|
1724
|
+
'end_date':
|
|
1725
|
+
(datetime,),
|
|
1726
|
+
'interval_size':
|
|
1727
|
+
(str,),
|
|
1728
|
+
'seller_id':
|
|
1729
|
+
(str,),
|
|
1730
|
+
'start_date':
|
|
1731
|
+
(datetime,),
|
|
1732
|
+
'time_zone_id':
|
|
1733
|
+
(str,),
|
|
1734
|
+
},
|
|
1735
|
+
'attribute_map': {
|
|
1736
|
+
'advertiser_id': 'advertiserId',
|
|
1737
|
+
'campaign_id': 'campaignId',
|
|
1738
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1739
|
+
'count': 'count',
|
|
1740
|
+
'end_date': 'endDate',
|
|
1741
|
+
'interval_size': 'intervalSize',
|
|
1742
|
+
'seller_id': 'sellerId',
|
|
1743
|
+
'start_date': 'startDate',
|
|
1744
|
+
'time_zone_id': 'timeZoneId',
|
|
1745
|
+
},
|
|
1746
|
+
'location_map': {
|
|
1747
|
+
'advertiser_id': 'query',
|
|
1748
|
+
'campaign_id': 'query',
|
|
1749
|
+
'click_attribution_policy': 'query',
|
|
1750
|
+
'count': 'query',
|
|
1751
|
+
'end_date': 'query',
|
|
1752
|
+
'interval_size': 'query',
|
|
1753
|
+
'seller_id': 'query',
|
|
1754
|
+
'start_date': 'query',
|
|
1755
|
+
'time_zone_id': 'query',
|
|
1756
|
+
},
|
|
1757
|
+
'collection_format_map': {
|
|
1758
|
+
}
|
|
1759
|
+
},
|
|
1760
|
+
headers_map={
|
|
1761
|
+
'accept': [
|
|
1762
|
+
'application/json'
|
|
1763
|
+
],
|
|
1764
|
+
'content_type': [],
|
|
1765
|
+
},
|
|
1766
|
+
api_client=api_client
|
|
1767
|
+
)
|
|
1768
|
+
self.get_marketplace_sellers_endpoint = _Endpoint(
|
|
1769
|
+
settings={
|
|
1770
|
+
'response_type': ([SellerBase],),
|
|
1700
1771
|
'auth': [
|
|
1701
1772
|
'oauth',
|
|
1702
1773
|
'oauth'
|
|
1703
1774
|
],
|
|
1704
1775
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/sellers',
|
|
1705
|
-
'operation_id': '
|
|
1776
|
+
'operation_id': 'get_marketplace_sellers',
|
|
1706
1777
|
'http_method': 'GET',
|
|
1707
1778
|
'servers': None,
|
|
1708
1779
|
},
|
|
@@ -1782,25 +1853,26 @@ class CampaignApi(object):
|
|
|
1782
1853
|
},
|
|
1783
1854
|
api_client=api_client
|
|
1784
1855
|
)
|
|
1785
|
-
self.
|
|
1856
|
+
self.get_marketplace_sellers_by_advertiser_endpoint = _Endpoint(
|
|
1786
1857
|
settings={
|
|
1787
|
-
'response_type': (
|
|
1858
|
+
'response_type': ([SellerBase],),
|
|
1788
1859
|
'auth': [
|
|
1789
1860
|
'oauth',
|
|
1790
1861
|
'oauth'
|
|
1791
1862
|
],
|
|
1792
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1793
|
-
'operation_id': '
|
|
1794
|
-
'http_method': '
|
|
1863
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/advertisers/{advertiserId}/sellers',
|
|
1864
|
+
'operation_id': 'get_marketplace_sellers_by_advertiser',
|
|
1865
|
+
'http_method': 'POST',
|
|
1795
1866
|
'servers': None,
|
|
1796
1867
|
},
|
|
1797
1868
|
params_map={
|
|
1798
1869
|
'all': [
|
|
1799
|
-
'
|
|
1800
|
-
'
|
|
1870
|
+
'advertiser_id',
|
|
1871
|
+
'partner_id',
|
|
1872
|
+
'request_body',
|
|
1801
1873
|
],
|
|
1802
1874
|
'required': [
|
|
1803
|
-
'
|
|
1875
|
+
'advertiser_id',
|
|
1804
1876
|
],
|
|
1805
1877
|
'nullable': [
|
|
1806
1878
|
],
|
|
@@ -1815,17 +1887,21 @@ class CampaignApi(object):
|
|
|
1815
1887
|
'allowed_values': {
|
|
1816
1888
|
},
|
|
1817
1889
|
'openapi_types': {
|
|
1818
|
-
'
|
|
1819
|
-
(
|
|
1820
|
-
'
|
|
1821
|
-
(
|
|
1890
|
+
'advertiser_id':
|
|
1891
|
+
(int,),
|
|
1892
|
+
'partner_id':
|
|
1893
|
+
(int,),
|
|
1894
|
+
'request_body':
|
|
1895
|
+
([str],),
|
|
1822
1896
|
},
|
|
1823
1897
|
'attribute_map': {
|
|
1824
|
-
'
|
|
1898
|
+
'advertiser_id': 'advertiserId',
|
|
1899
|
+
'partner_id': 'partnerId',
|
|
1825
1900
|
},
|
|
1826
1901
|
'location_map': {
|
|
1827
|
-
'
|
|
1828
|
-
'
|
|
1902
|
+
'advertiser_id': 'path',
|
|
1903
|
+
'partner_id': 'query',
|
|
1904
|
+
'request_body': 'body',
|
|
1829
1905
|
},
|
|
1830
1906
|
'collection_format_map': {
|
|
1831
1907
|
}
|
|
@@ -1840,26 +1916,35 @@ class CampaignApi(object):
|
|
|
1840
1916
|
},
|
|
1841
1917
|
api_client=api_client
|
|
1842
1918
|
)
|
|
1843
|
-
self.
|
|
1919
|
+
self.get_marketplace_sellers_stats_endpoint = _Endpoint(
|
|
1844
1920
|
settings={
|
|
1845
|
-
'response_type': (
|
|
1921
|
+
'response_type': (str,),
|
|
1846
1922
|
'auth': [
|
|
1847
1923
|
'oauth',
|
|
1848
1924
|
'oauth'
|
|
1849
1925
|
],
|
|
1850
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1851
|
-
'operation_id': '
|
|
1852
|
-
'http_method': '
|
|
1926
|
+
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/stats/sellers',
|
|
1927
|
+
'operation_id': 'get_marketplace_sellers_stats',
|
|
1928
|
+
'http_method': 'GET',
|
|
1853
1929
|
'servers': None,
|
|
1854
1930
|
},
|
|
1855
1931
|
params_map={
|
|
1856
1932
|
'all': [
|
|
1857
|
-
'
|
|
1933
|
+
'advertiser_id',
|
|
1934
|
+
'click_attribution_policy',
|
|
1935
|
+
'count',
|
|
1936
|
+
'end_date',
|
|
1937
|
+
'interval_size',
|
|
1938
|
+
'seller_id',
|
|
1939
|
+
'start_date',
|
|
1940
|
+
'time_zone_id',
|
|
1858
1941
|
],
|
|
1859
1942
|
'required': [],
|
|
1860
1943
|
'nullable': [
|
|
1861
1944
|
],
|
|
1862
1945
|
'enum': [
|
|
1946
|
+
'click_attribution_policy',
|
|
1947
|
+
'interval_size',
|
|
1863
1948
|
],
|
|
1864
1949
|
'validation': [
|
|
1865
1950
|
]
|
|
@@ -1868,15 +1953,57 @@ class CampaignApi(object):
|
|
|
1868
1953
|
'validations': {
|
|
1869
1954
|
},
|
|
1870
1955
|
'allowed_values': {
|
|
1956
|
+
('click_attribution_policy',): {
|
|
1957
|
+
|
|
1958
|
+
"BOTH": "Both",
|
|
1959
|
+
"SAMESELLER": "SameSeller",
|
|
1960
|
+
"ANYSELLER": "AnySeller"
|
|
1961
|
+
},
|
|
1962
|
+
('interval_size',): {
|
|
1963
|
+
|
|
1964
|
+
"HOUR": "Hour",
|
|
1965
|
+
"DAY": "Day",
|
|
1966
|
+
"MONTH": "Month",
|
|
1967
|
+
"YEAR": "Year"
|
|
1968
|
+
},
|
|
1871
1969
|
},
|
|
1872
1970
|
'openapi_types': {
|
|
1873
|
-
'
|
|
1874
|
-
(
|
|
1971
|
+
'advertiser_id':
|
|
1972
|
+
(int,),
|
|
1973
|
+
'click_attribution_policy':
|
|
1974
|
+
(str,),
|
|
1975
|
+
'count':
|
|
1976
|
+
(int,),
|
|
1977
|
+
'end_date':
|
|
1978
|
+
(datetime,),
|
|
1979
|
+
'interval_size':
|
|
1980
|
+
(str,),
|
|
1981
|
+
'seller_id':
|
|
1982
|
+
(str,),
|
|
1983
|
+
'start_date':
|
|
1984
|
+
(datetime,),
|
|
1985
|
+
'time_zone_id':
|
|
1986
|
+
(str,),
|
|
1875
1987
|
},
|
|
1876
1988
|
'attribute_map': {
|
|
1989
|
+
'advertiser_id': 'advertiserId',
|
|
1990
|
+
'click_attribution_policy': 'clickAttributionPolicy',
|
|
1991
|
+
'count': 'count',
|
|
1992
|
+
'end_date': 'endDate',
|
|
1993
|
+
'interval_size': 'intervalSize',
|
|
1994
|
+
'seller_id': 'sellerId',
|
|
1995
|
+
'start_date': 'startDate',
|
|
1996
|
+
'time_zone_id': 'timeZoneId',
|
|
1877
1997
|
},
|
|
1878
1998
|
'location_map': {
|
|
1879
|
-
'
|
|
1999
|
+
'advertiser_id': 'query',
|
|
2000
|
+
'click_attribution_policy': 'query',
|
|
2001
|
+
'count': 'query',
|
|
2002
|
+
'end_date': 'query',
|
|
2003
|
+
'interval_size': 'query',
|
|
2004
|
+
'seller_id': 'query',
|
|
2005
|
+
'start_date': 'query',
|
|
2006
|
+
'time_zone_id': 'query',
|
|
1880
2007
|
},
|
|
1881
2008
|
'collection_format_map': {
|
|
1882
2009
|
}
|
|
@@ -1885,29 +2012,30 @@ class CampaignApi(object):
|
|
|
1885
2012
|
'accept': [
|
|
1886
2013
|
'application/json'
|
|
1887
2014
|
],
|
|
1888
|
-
'content_type': [
|
|
1889
|
-
'application/json'
|
|
1890
|
-
]
|
|
2015
|
+
'content_type': [],
|
|
1891
2016
|
},
|
|
1892
2017
|
api_client=api_client
|
|
1893
2018
|
)
|
|
1894
|
-
self.
|
|
2019
|
+
self.patch_ad_set_category_bids_endpoint = _Endpoint(
|
|
1895
2020
|
settings={
|
|
1896
|
-
'response_type': (
|
|
2021
|
+
'response_type': (PatchAdSetCategoryBidResultListResponse,),
|
|
1897
2022
|
'auth': [
|
|
1898
2023
|
'oauth',
|
|
1899
2024
|
'oauth'
|
|
1900
2025
|
],
|
|
1901
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
1902
|
-
'operation_id': '
|
|
2026
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/category-bids',
|
|
2027
|
+
'operation_id': 'patch_ad_set_category_bids',
|
|
1903
2028
|
'http_method': 'PATCH',
|
|
1904
2029
|
'servers': None,
|
|
1905
2030
|
},
|
|
1906
2031
|
params_map={
|
|
1907
2032
|
'all': [
|
|
1908
|
-
'
|
|
2033
|
+
'ad_set_id',
|
|
2034
|
+
'patch_ad_set_category_bid_list_request',
|
|
2035
|
+
],
|
|
2036
|
+
'required': [
|
|
2037
|
+
'ad_set_id',
|
|
1909
2038
|
],
|
|
1910
|
-
'required': [],
|
|
1911
2039
|
'nullable': [
|
|
1912
2040
|
],
|
|
1913
2041
|
'enum': [
|
|
@@ -1921,13 +2049,17 @@ class CampaignApi(object):
|
|
|
1921
2049
|
'allowed_values': {
|
|
1922
2050
|
},
|
|
1923
2051
|
'openapi_types': {
|
|
1924
|
-
'
|
|
1925
|
-
(
|
|
2052
|
+
'ad_set_id':
|
|
2053
|
+
(str,),
|
|
2054
|
+
'patch_ad_set_category_bid_list_request':
|
|
2055
|
+
(PatchAdSetCategoryBidListRequest,),
|
|
1926
2056
|
},
|
|
1927
2057
|
'attribute_map': {
|
|
2058
|
+
'ad_set_id': 'ad-set-id',
|
|
1928
2059
|
},
|
|
1929
2060
|
'location_map': {
|
|
1930
|
-
'
|
|
2061
|
+
'ad_set_id': 'path',
|
|
2062
|
+
'patch_ad_set_category_bid_list_request': 'body',
|
|
1931
2063
|
},
|
|
1932
2064
|
'collection_format_map': {
|
|
1933
2065
|
}
|
|
@@ -1942,26 +2074,23 @@ class CampaignApi(object):
|
|
|
1942
2074
|
},
|
|
1943
2075
|
api_client=api_client
|
|
1944
2076
|
)
|
|
1945
|
-
self.
|
|
2077
|
+
self.patch_ad_sets_endpoint = _Endpoint(
|
|
1946
2078
|
settings={
|
|
1947
|
-
'response_type': (
|
|
2079
|
+
'response_type': (ResponsesAdSetIdV24Q3,),
|
|
1948
2080
|
'auth': [
|
|
1949
2081
|
'oauth',
|
|
1950
2082
|
'oauth'
|
|
1951
2083
|
],
|
|
1952
|
-
'endpoint_path': '/2025-07/marketing-solutions/ad-sets
|
|
1953
|
-
'operation_id': '
|
|
2084
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets',
|
|
2085
|
+
'operation_id': 'patch_ad_sets',
|
|
1954
2086
|
'http_method': 'PATCH',
|
|
1955
2087
|
'servers': None,
|
|
1956
2088
|
},
|
|
1957
2089
|
params_map={
|
|
1958
2090
|
'all': [
|
|
1959
|
-
'
|
|
1960
|
-
'patch_ad_set_display_multiplier_list_request',
|
|
1961
|
-
],
|
|
1962
|
-
'required': [
|
|
1963
|
-
'ad_set_id',
|
|
2091
|
+
'requests_patch_ad_set_v24_q3',
|
|
1964
2092
|
],
|
|
2093
|
+
'required': [],
|
|
1965
2094
|
'nullable': [
|
|
1966
2095
|
],
|
|
1967
2096
|
'enum': [
|
|
@@ -1975,17 +2104,13 @@ class CampaignApi(object):
|
|
|
1975
2104
|
'allowed_values': {
|
|
1976
2105
|
},
|
|
1977
2106
|
'openapi_types': {
|
|
1978
|
-
'
|
|
1979
|
-
(
|
|
1980
|
-
'patch_ad_set_display_multiplier_list_request':
|
|
1981
|
-
(PatchAdSetDisplayMultiplierListRequest,),
|
|
2107
|
+
'requests_patch_ad_set_v24_q3':
|
|
2108
|
+
(RequestsPatchAdSetV24Q3,),
|
|
1982
2109
|
},
|
|
1983
2110
|
'attribute_map': {
|
|
1984
|
-
'ad_set_id': 'ad-set-id',
|
|
1985
2111
|
},
|
|
1986
2112
|
'location_map': {
|
|
1987
|
-
'
|
|
1988
|
-
'patch_ad_set_display_multiplier_list_request': 'body',
|
|
2113
|
+
'requests_patch_ad_set_v24_q3': 'body',
|
|
1989
2114
|
},
|
|
1990
2115
|
'collection_format_map': {
|
|
1991
2116
|
}
|
|
@@ -2000,21 +2125,21 @@ class CampaignApi(object):
|
|
|
2000
2125
|
},
|
|
2001
2126
|
api_client=api_client
|
|
2002
2127
|
)
|
|
2003
|
-
self.
|
|
2128
|
+
self.patch_campaigns_endpoint = _Endpoint(
|
|
2004
2129
|
settings={
|
|
2005
|
-
'response_type': (
|
|
2130
|
+
'response_type': (PatchResultCampaignListResponse,),
|
|
2006
2131
|
'auth': [
|
|
2007
2132
|
'oauth',
|
|
2008
2133
|
'oauth'
|
|
2009
2134
|
],
|
|
2010
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2011
|
-
'operation_id': '
|
|
2012
|
-
'http_method': '
|
|
2135
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns',
|
|
2136
|
+
'operation_id': 'patch_campaigns',
|
|
2137
|
+
'http_method': 'PATCH',
|
|
2013
2138
|
'servers': None,
|
|
2014
2139
|
},
|
|
2015
2140
|
params_map={
|
|
2016
2141
|
'all': [
|
|
2017
|
-
'
|
|
2142
|
+
'patch_campaign_list_request',
|
|
2018
2143
|
],
|
|
2019
2144
|
'required': [],
|
|
2020
2145
|
'nullable': [
|
|
@@ -2030,13 +2155,13 @@ class CampaignApi(object):
|
|
|
2030
2155
|
'allowed_values': {
|
|
2031
2156
|
},
|
|
2032
2157
|
'openapi_types': {
|
|
2033
|
-
'
|
|
2034
|
-
(
|
|
2158
|
+
'patch_campaign_list_request':
|
|
2159
|
+
(PatchCampaignListRequest,),
|
|
2035
2160
|
},
|
|
2036
2161
|
'attribute_map': {
|
|
2037
2162
|
},
|
|
2038
2163
|
'location_map': {
|
|
2039
|
-
'
|
|
2164
|
+
'patch_campaign_list_request': 'body',
|
|
2040
2165
|
},
|
|
2041
2166
|
'collection_format_map': {
|
|
2042
2167
|
}
|
|
@@ -2051,23 +2176,26 @@ class CampaignApi(object):
|
|
|
2051
2176
|
},
|
|
2052
2177
|
api_client=api_client
|
|
2053
2178
|
)
|
|
2054
|
-
self.
|
|
2179
|
+
self.patch_display_multipliers_endpoint = _Endpoint(
|
|
2055
2180
|
settings={
|
|
2056
|
-
'response_type': (
|
|
2181
|
+
'response_type': (PatchAdSetDisplayMultiplierResultListResponse,),
|
|
2057
2182
|
'auth': [
|
|
2058
2183
|
'oauth',
|
|
2059
2184
|
'oauth'
|
|
2060
2185
|
],
|
|
2061
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2062
|
-
'operation_id': '
|
|
2063
|
-
'http_method': '
|
|
2186
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/{ad-set-id}/display-multipliers',
|
|
2187
|
+
'operation_id': 'patch_display_multipliers',
|
|
2188
|
+
'http_method': 'PATCH',
|
|
2064
2189
|
'servers': None,
|
|
2065
2190
|
},
|
|
2066
2191
|
params_map={
|
|
2067
2192
|
'all': [
|
|
2068
|
-
'
|
|
2193
|
+
'ad_set_id',
|
|
2194
|
+
'patch_ad_set_display_multiplier_list_request',
|
|
2195
|
+
],
|
|
2196
|
+
'required': [
|
|
2197
|
+
'ad_set_id',
|
|
2069
2198
|
],
|
|
2070
|
-
'required': [],
|
|
2071
2199
|
'nullable': [
|
|
2072
2200
|
],
|
|
2073
2201
|
'enum': [
|
|
@@ -2081,13 +2209,17 @@ class CampaignApi(object):
|
|
|
2081
2209
|
'allowed_values': {
|
|
2082
2210
|
},
|
|
2083
2211
|
'openapi_types': {
|
|
2084
|
-
'
|
|
2085
|
-
(
|
|
2212
|
+
'ad_set_id':
|
|
2213
|
+
(str,),
|
|
2214
|
+
'patch_ad_set_display_multiplier_list_request':
|
|
2215
|
+
(PatchAdSetDisplayMultiplierListRequest,),
|
|
2086
2216
|
},
|
|
2087
2217
|
'attribute_map': {
|
|
2218
|
+
'ad_set_id': 'ad-set-id',
|
|
2088
2219
|
},
|
|
2089
2220
|
'location_map': {
|
|
2090
|
-
'
|
|
2221
|
+
'ad_set_id': 'path',
|
|
2222
|
+
'patch_ad_set_display_multiplier_list_request': 'body',
|
|
2091
2223
|
},
|
|
2092
2224
|
'collection_format_map': {
|
|
2093
2225
|
}
|
|
@@ -2102,35 +2234,26 @@ class CampaignApi(object):
|
|
|
2102
2234
|
},
|
|
2103
2235
|
api_client=api_client
|
|
2104
2236
|
)
|
|
2105
|
-
self.
|
|
2237
|
+
self.search_ad_sets_endpoint = _Endpoint(
|
|
2106
2238
|
settings={
|
|
2107
|
-
'response_type': (
|
|
2239
|
+
'response_type': (ResponsesReadAdSetV24Q3,),
|
|
2108
2240
|
'auth': [
|
|
2109
2241
|
'oauth',
|
|
2110
2242
|
'oauth'
|
|
2111
2243
|
],
|
|
2112
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2113
|
-
'operation_id': '
|
|
2114
|
-
'http_method': '
|
|
2244
|
+
'endpoint_path': '/2025-07/marketing-solutions/ad-sets/search',
|
|
2245
|
+
'operation_id': 'search_ad_sets',
|
|
2246
|
+
'http_method': 'POST',
|
|
2115
2247
|
'servers': None,
|
|
2116
2248
|
},
|
|
2117
2249
|
params_map={
|
|
2118
2250
|
'all': [
|
|
2119
|
-
'
|
|
2120
|
-
'campaign_id',
|
|
2121
|
-
'click_attribution_policy',
|
|
2122
|
-
'count',
|
|
2123
|
-
'end_date',
|
|
2124
|
-
'interval_size',
|
|
2125
|
-
'seller_id',
|
|
2126
|
-
'start_date',
|
|
2251
|
+
'ad_set_search_request_v24_q3',
|
|
2127
2252
|
],
|
|
2128
2253
|
'required': [],
|
|
2129
2254
|
'nullable': [
|
|
2130
2255
|
],
|
|
2131
2256
|
'enum': [
|
|
2132
|
-
'click_attribution_policy',
|
|
2133
|
-
'interval_size',
|
|
2134
2257
|
],
|
|
2135
2258
|
'validation': [
|
|
2136
2259
|
]
|
|
@@ -2139,57 +2262,15 @@ class CampaignApi(object):
|
|
|
2139
2262
|
'validations': {
|
|
2140
2263
|
},
|
|
2141
2264
|
'allowed_values': {
|
|
2142
|
-
('click_attribution_policy',): {
|
|
2143
|
-
|
|
2144
|
-
"BOTH": "Both",
|
|
2145
|
-
"SAMESELLER": "SameSeller",
|
|
2146
|
-
"ANYSELLER": "AnySeller"
|
|
2147
|
-
},
|
|
2148
|
-
('interval_size',): {
|
|
2149
|
-
|
|
2150
|
-
"HOUR": "Hour",
|
|
2151
|
-
"DAY": "Day",
|
|
2152
|
-
"MONTH": "Month",
|
|
2153
|
-
"YEAR": "Year"
|
|
2154
|
-
},
|
|
2155
2265
|
},
|
|
2156
2266
|
'openapi_types': {
|
|
2157
|
-
'
|
|
2158
|
-
(
|
|
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,),
|
|
2267
|
+
'ad_set_search_request_v24_q3':
|
|
2268
|
+
(AdSetSearchRequestV24Q3,),
|
|
2173
2269
|
},
|
|
2174
2270
|
'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
2271
|
},
|
|
2184
2272
|
'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',
|
|
2273
|
+
'ad_set_search_request_v24_q3': 'body',
|
|
2193
2274
|
},
|
|
2194
2275
|
'collection_format_map': {
|
|
2195
2276
|
}
|
|
@@ -2198,38 +2279,32 @@ class CampaignApi(object):
|
|
|
2198
2279
|
'accept': [
|
|
2199
2280
|
'application/json'
|
|
2200
2281
|
],
|
|
2201
|
-
'content_type': [
|
|
2282
|
+
'content_type': [
|
|
2283
|
+
'application/json'
|
|
2284
|
+
]
|
|
2202
2285
|
},
|
|
2203
2286
|
api_client=api_client
|
|
2204
2287
|
)
|
|
2205
|
-
self.
|
|
2288
|
+
self.search_campaigns_endpoint = _Endpoint(
|
|
2206
2289
|
settings={
|
|
2207
|
-
'response_type': (
|
|
2290
|
+
'response_type': (CampaignV23Q1ListResponse,),
|
|
2208
2291
|
'auth': [
|
|
2209
2292
|
'oauth',
|
|
2210
2293
|
'oauth'
|
|
2211
2294
|
],
|
|
2212
|
-
'endpoint_path': '/2025-07/marketing-solutions/
|
|
2213
|
-
'operation_id': '
|
|
2214
|
-
'http_method': '
|
|
2295
|
+
'endpoint_path': '/2025-07/marketing-solutions/campaigns/search',
|
|
2296
|
+
'operation_id': 'search_campaigns',
|
|
2297
|
+
'http_method': 'POST',
|
|
2215
2298
|
'servers': None,
|
|
2216
2299
|
},
|
|
2217
2300
|
params_map={
|
|
2218
2301
|
'all': [
|
|
2219
|
-
'
|
|
2220
|
-
'click_attribution_policy',
|
|
2221
|
-
'count',
|
|
2222
|
-
'end_date',
|
|
2223
|
-
'interval_size',
|
|
2224
|
-
'seller_id',
|
|
2225
|
-
'start_date',
|
|
2302
|
+
'campaign_search_request_v23_q1',
|
|
2226
2303
|
],
|
|
2227
2304
|
'required': [],
|
|
2228
2305
|
'nullable': [
|
|
2229
2306
|
],
|
|
2230
2307
|
'enum': [
|
|
2231
|
-
'click_attribution_policy',
|
|
2232
|
-
'interval_size',
|
|
2233
2308
|
],
|
|
2234
2309
|
'validation': [
|
|
2235
2310
|
]
|
|
@@ -2238,53 +2313,15 @@ class CampaignApi(object):
|
|
|
2238
2313
|
'validations': {
|
|
2239
2314
|
},
|
|
2240
2315
|
'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
2316
|
},
|
|
2255
2317
|
'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,),
|
|
2318
|
+
'campaign_search_request_v23_q1':
|
|
2319
|
+
(CampaignSearchRequestV23Q1,),
|
|
2270
2320
|
},
|
|
2271
2321
|
'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
2322
|
},
|
|
2280
2323
|
'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',
|
|
2324
|
+
'campaign_search_request_v23_q1': 'body',
|
|
2288
2325
|
},
|
|
2289
2326
|
'collection_format_map': {
|
|
2290
2327
|
}
|
|
@@ -2293,7 +2330,9 @@ class CampaignApi(object):
|
|
|
2293
2330
|
'accept': [
|
|
2294
2331
|
'application/json'
|
|
2295
2332
|
],
|
|
2296
|
-
'content_type': [
|
|
2333
|
+
'content_type': [
|
|
2334
|
+
'application/json'
|
|
2335
|
+
]
|
|
2297
2336
|
},
|
|
2298
2337
|
api_client=api_client
|
|
2299
2338
|
)
|
|
@@ -2458,15 +2497,15 @@ class CampaignApi(object):
|
|
|
2458
2497
|
},
|
|
2459
2498
|
api_client=api_client
|
|
2460
2499
|
)
|
|
2461
|
-
self.
|
|
2500
|
+
self.update_marketplace_seller_budget_endpoint = _Endpoint(
|
|
2462
2501
|
settings={
|
|
2463
|
-
'response_type':
|
|
2502
|
+
'response_type': (SellerBudgetMessage,),
|
|
2464
2503
|
'auth': [
|
|
2465
2504
|
'oauth',
|
|
2466
2505
|
'oauth'
|
|
2467
2506
|
],
|
|
2468
2507
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets/{budgetId}',
|
|
2469
|
-
'operation_id': '
|
|
2508
|
+
'operation_id': 'update_marketplace_seller_budget',
|
|
2470
2509
|
'http_method': 'PATCH',
|
|
2471
2510
|
'servers': None,
|
|
2472
2511
|
},
|
|
@@ -2507,22 +2546,24 @@ class CampaignApi(object):
|
|
|
2507
2546
|
}
|
|
2508
2547
|
},
|
|
2509
2548
|
headers_map={
|
|
2510
|
-
'accept': [
|
|
2549
|
+
'accept': [
|
|
2550
|
+
'application/json'
|
|
2551
|
+
],
|
|
2511
2552
|
'content_type': [
|
|
2512
2553
|
'application/json'
|
|
2513
2554
|
]
|
|
2514
2555
|
},
|
|
2515
2556
|
api_client=api_client
|
|
2516
2557
|
)
|
|
2517
|
-
self.
|
|
2558
|
+
self.update_marketplace_seller_budgets_endpoint = _Endpoint(
|
|
2518
2559
|
settings={
|
|
2519
|
-
'response_type':
|
|
2560
|
+
'response_type': ([SellerBudgetMessage],),
|
|
2520
2561
|
'auth': [
|
|
2521
2562
|
'oauth',
|
|
2522
2563
|
'oauth'
|
|
2523
2564
|
],
|
|
2524
2565
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/budgets',
|
|
2525
|
-
'operation_id': '
|
|
2566
|
+
'operation_id': 'update_marketplace_seller_budgets',
|
|
2526
2567
|
'http_method': 'PATCH',
|
|
2527
2568
|
'servers': None,
|
|
2528
2569
|
},
|
|
@@ -2556,14 +2597,16 @@ class CampaignApi(object):
|
|
|
2556
2597
|
}
|
|
2557
2598
|
},
|
|
2558
2599
|
headers_map={
|
|
2559
|
-
'accept': [
|
|
2600
|
+
'accept': [
|
|
2601
|
+
'application/json'
|
|
2602
|
+
],
|
|
2560
2603
|
'content_type': [
|
|
2561
2604
|
'application/json'
|
|
2562
2605
|
]
|
|
2563
2606
|
},
|
|
2564
2607
|
api_client=api_client
|
|
2565
2608
|
)
|
|
2566
|
-
self.
|
|
2609
|
+
self.update_marketplace_seller_campaign_endpoint = _Endpoint(
|
|
2567
2610
|
settings={
|
|
2568
2611
|
'response_type': (SellerCampaignMessage,),
|
|
2569
2612
|
'auth': [
|
|
@@ -2571,7 +2614,7 @@ class CampaignApi(object):
|
|
|
2571
2614
|
'oauth'
|
|
2572
2615
|
],
|
|
2573
2616
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}',
|
|
2574
|
-
'operation_id': '
|
|
2617
|
+
'operation_id': 'update_marketplace_seller_campaign',
|
|
2575
2618
|
'http_method': 'PATCH',
|
|
2576
2619
|
'servers': None,
|
|
2577
2620
|
},
|
|
@@ -2620,7 +2663,7 @@ class CampaignApi(object):
|
|
|
2620
2663
|
},
|
|
2621
2664
|
api_client=api_client
|
|
2622
2665
|
)
|
|
2623
|
-
self.
|
|
2666
|
+
self.update_marketplace_seller_campaigns_endpoint = _Endpoint(
|
|
2624
2667
|
settings={
|
|
2625
2668
|
'response_type': ([SellerCampaignMessage],),
|
|
2626
2669
|
'auth': [
|
|
@@ -2628,7 +2671,7 @@ class CampaignApi(object):
|
|
|
2628
2671
|
'oauth'
|
|
2629
2672
|
],
|
|
2630
2673
|
'endpoint_path': '/2025-07/marketing-solutions/marketplace-performance-outcomes/seller-campaigns',
|
|
2631
|
-
'operation_id': '
|
|
2674
|
+
'operation_id': 'update_marketplace_seller_campaigns',
|
|
2632
2675
|
'http_method': 'PATCH',
|
|
2633
2676
|
'servers': None,
|
|
2634
2677
|
},
|
|
@@ -2672,91 +2715,6 @@ class CampaignApi(object):
|
|
|
2672
2715
|
api_client=api_client
|
|
2673
2716
|
)
|
|
2674
2717
|
|
|
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
2718
|
def create_ad_set(
|
|
2761
2719
|
self,
|
|
2762
2720
|
create_ad_set_v24_q3_request,
|
|
@@ -2923,7 +2881,7 @@ class CampaignApi(object):
|
|
|
2923
2881
|
create_campaign_request
|
|
2924
2882
|
return self.create_campaign_endpoint.call_with_http_info(**kwargs)
|
|
2925
2883
|
|
|
2926
|
-
def
|
|
2884
|
+
def create_marketplace_seller_budgets(
|
|
2927
2885
|
self,
|
|
2928
2886
|
**kwargs
|
|
2929
2887
|
):
|
|
@@ -2933,7 +2891,7 @@ class CampaignApi(object):
|
|
|
2933
2891
|
This method makes a synchronous HTTP request by default. To make an
|
|
2934
2892
|
asynchronous HTTP request, please pass async_req=True
|
|
2935
2893
|
|
|
2936
|
-
>>> thread = api.
|
|
2894
|
+
>>> thread = api.create_marketplace_seller_budgets(async_req=True)
|
|
2937
2895
|
>>> result = thread.get()
|
|
2938
2896
|
|
|
2939
2897
|
|
|
@@ -2971,7 +2929,7 @@ class CampaignApi(object):
|
|
|
2971
2929
|
async_req (bool): execute request asynchronously
|
|
2972
2930
|
|
|
2973
2931
|
Returns:
|
|
2974
|
-
|
|
2932
|
+
[SellerBudgetMessage]
|
|
2975
2933
|
If the method is called asynchronously, returns the request
|
|
2976
2934
|
thread.
|
|
2977
2935
|
"""
|
|
@@ -3000,9 +2958,9 @@ class CampaignApi(object):
|
|
|
3000
2958
|
'_content_type')
|
|
3001
2959
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3002
2960
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3003
|
-
return self.
|
|
2961
|
+
return self.create_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
3004
2962
|
|
|
3005
|
-
def
|
|
2963
|
+
def create_marketplace_seller_campaigns_by_seller(
|
|
3006
2964
|
self,
|
|
3007
2965
|
seller_id,
|
|
3008
2966
|
**kwargs
|
|
@@ -3013,7 +2971,7 @@ class CampaignApi(object):
|
|
|
3013
2971
|
This method makes a synchronous HTTP request by default. To make an
|
|
3014
2972
|
asynchronous HTTP request, please pass async_req=True
|
|
3015
2973
|
|
|
3016
|
-
>>> thread = api.
|
|
2974
|
+
>>> thread = api.create_marketplace_seller_campaigns_by_seller(seller_id, async_req=True)
|
|
3017
2975
|
>>> result = thread.get()
|
|
3018
2976
|
|
|
3019
2977
|
Args:
|
|
@@ -3053,7 +3011,7 @@ class CampaignApi(object):
|
|
|
3053
3011
|
async_req (bool): execute request asynchronously
|
|
3054
3012
|
|
|
3055
3013
|
Returns:
|
|
3056
|
-
|
|
3014
|
+
SellerCampaignMessage
|
|
3057
3015
|
If the method is called asynchronously, returns the request
|
|
3058
3016
|
thread.
|
|
3059
3017
|
"""
|
|
@@ -3084,28 +3042,26 @@ class CampaignApi(object):
|
|
|
3084
3042
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3085
3043
|
kwargs['seller_id'] = \
|
|
3086
3044
|
seller_id
|
|
3087
|
-
return self.
|
|
3045
|
+
return self.create_marketplace_seller_campaigns_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3088
3046
|
|
|
3089
|
-
def
|
|
3047
|
+
def get_ad_set(
|
|
3090
3048
|
self,
|
|
3091
|
-
|
|
3049
|
+
ad_set_id,
|
|
3092
3050
|
**kwargs
|
|
3093
3051
|
):
|
|
3094
|
-
""" # noqa: E501
|
|
3052
|
+
"""get_ad_set # noqa: E501
|
|
3095
3053
|
|
|
3096
|
-
|
|
3054
|
+
Get the data for the specified ad set # noqa: E501
|
|
3097
3055
|
This method makes a synchronous HTTP request by default. To make an
|
|
3098
3056
|
asynchronous HTTP request, please pass async_req=True
|
|
3099
3057
|
|
|
3100
|
-
>>> thread = api.
|
|
3058
|
+
>>> thread = api.get_ad_set(ad_set_id, async_req=True)
|
|
3101
3059
|
>>> result = thread.get()
|
|
3102
3060
|
|
|
3103
3061
|
Args:
|
|
3104
|
-
|
|
3062
|
+
ad_set_id (str): Id of the ad set
|
|
3105
3063
|
|
|
3106
3064
|
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
3065
|
_return_http_data_only (bool): response data without head status
|
|
3110
3066
|
code and headers. Default is True.
|
|
3111
3067
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3138,7 +3094,7 @@ class CampaignApi(object):
|
|
|
3138
3094
|
async_req (bool): execute request asynchronously
|
|
3139
3095
|
|
|
3140
3096
|
Returns:
|
|
3141
|
-
|
|
3097
|
+
ResponseReadAdSetV24Q3
|
|
3142
3098
|
If the method is called asynchronously, returns the request
|
|
3143
3099
|
thread.
|
|
3144
3100
|
"""
|
|
@@ -3167,26 +3123,26 @@ class CampaignApi(object):
|
|
|
3167
3123
|
'_content_type')
|
|
3168
3124
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3169
3125
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3170
|
-
kwargs['
|
|
3171
|
-
|
|
3172
|
-
return self.
|
|
3126
|
+
kwargs['ad_set_id'] = \
|
|
3127
|
+
ad_set_id
|
|
3128
|
+
return self.get_ad_set_endpoint.call_with_http_info(**kwargs)
|
|
3173
3129
|
|
|
3174
|
-
def
|
|
3130
|
+
def get_ad_set_category_bids(
|
|
3175
3131
|
self,
|
|
3176
3132
|
ad_set_id,
|
|
3177
3133
|
**kwargs
|
|
3178
3134
|
):
|
|
3179
|
-
"""
|
|
3135
|
+
"""get_ad_set_category_bids # noqa: E501
|
|
3180
3136
|
|
|
3181
|
-
Get the
|
|
3137
|
+
Get the Category Bids for all valid Categories associated to an Ad Set # noqa: E501
|
|
3182
3138
|
This method makes a synchronous HTTP request by default. To make an
|
|
3183
3139
|
asynchronous HTTP request, please pass async_req=True
|
|
3184
3140
|
|
|
3185
|
-
>>> thread = api.
|
|
3141
|
+
>>> thread = api.get_ad_set_category_bids(ad_set_id, async_req=True)
|
|
3186
3142
|
>>> result = thread.get()
|
|
3187
3143
|
|
|
3188
3144
|
Args:
|
|
3189
|
-
ad_set_id (str): Id of the
|
|
3145
|
+
ad_set_id (str): Id of the Ad Set
|
|
3190
3146
|
|
|
3191
3147
|
Keyword Args:
|
|
3192
3148
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3221,7 +3177,7 @@ class CampaignApi(object):
|
|
|
3221
3177
|
async_req (bool): execute request asynchronously
|
|
3222
3178
|
|
|
3223
3179
|
Returns:
|
|
3224
|
-
|
|
3180
|
+
AdSetCategoryBidListResponse
|
|
3225
3181
|
If the method is called asynchronously, returns the request
|
|
3226
3182
|
thread.
|
|
3227
3183
|
"""
|
|
@@ -3252,24 +3208,24 @@ class CampaignApi(object):
|
|
|
3252
3208
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3253
3209
|
kwargs['ad_set_id'] = \
|
|
3254
3210
|
ad_set_id
|
|
3255
|
-
return self.
|
|
3211
|
+
return self.get_ad_set_category_bids_endpoint.call_with_http_info(**kwargs)
|
|
3256
3212
|
|
|
3257
|
-
def
|
|
3213
|
+
def get_campaign(
|
|
3258
3214
|
self,
|
|
3259
|
-
|
|
3215
|
+
campaign_id,
|
|
3260
3216
|
**kwargs
|
|
3261
3217
|
):
|
|
3262
|
-
"""
|
|
3218
|
+
"""get_campaign # noqa: E501
|
|
3263
3219
|
|
|
3264
|
-
Get the
|
|
3220
|
+
Get the data for the specified campaign # noqa: E501
|
|
3265
3221
|
This method makes a synchronous HTTP request by default. To make an
|
|
3266
3222
|
asynchronous HTTP request, please pass async_req=True
|
|
3267
3223
|
|
|
3268
|
-
>>> thread = api.
|
|
3224
|
+
>>> thread = api.get_campaign(campaign_id, async_req=True)
|
|
3269
3225
|
>>> result = thread.get()
|
|
3270
3226
|
|
|
3271
3227
|
Args:
|
|
3272
|
-
|
|
3228
|
+
campaign_id (str): Id of the campaign
|
|
3273
3229
|
|
|
3274
3230
|
Keyword Args:
|
|
3275
3231
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3304,7 +3260,7 @@ class CampaignApi(object):
|
|
|
3304
3260
|
async_req (bool): execute request asynchronously
|
|
3305
3261
|
|
|
3306
3262
|
Returns:
|
|
3307
|
-
|
|
3263
|
+
CampaignV23Q1Response
|
|
3308
3264
|
If the method is called asynchronously, returns the request
|
|
3309
3265
|
thread.
|
|
3310
3266
|
"""
|
|
@@ -3333,26 +3289,26 @@ class CampaignApi(object):
|
|
|
3333
3289
|
'_content_type')
|
|
3334
3290
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3335
3291
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3336
|
-
kwargs['
|
|
3337
|
-
|
|
3338
|
-
return self.
|
|
3292
|
+
kwargs['campaign_id'] = \
|
|
3293
|
+
campaign_id
|
|
3294
|
+
return self.get_campaign_endpoint.call_with_http_info(**kwargs)
|
|
3339
3295
|
|
|
3340
|
-
def
|
|
3296
|
+
def get_display_multipliers(
|
|
3341
3297
|
self,
|
|
3342
|
-
|
|
3298
|
+
ad_set_id,
|
|
3343
3299
|
**kwargs
|
|
3344
3300
|
):
|
|
3345
|
-
""" # noqa: E501
|
|
3301
|
+
"""get_display_multipliers # noqa: E501
|
|
3346
3302
|
|
|
3347
|
-
Get an
|
|
3303
|
+
Get the Display Multipliers for all valid Categories associated to an Ad Set # noqa: E501
|
|
3348
3304
|
This method makes a synchronous HTTP request by default. To make an
|
|
3349
3305
|
asynchronous HTTP request, please pass async_req=True
|
|
3350
3306
|
|
|
3351
|
-
>>> thread = api.
|
|
3307
|
+
>>> thread = api.get_display_multipliers(ad_set_id, async_req=True)
|
|
3352
3308
|
>>> result = thread.get()
|
|
3353
3309
|
|
|
3354
3310
|
Args:
|
|
3355
|
-
|
|
3311
|
+
ad_set_id (str): Id of the Ad Set
|
|
3356
3312
|
|
|
3357
3313
|
Keyword Args:
|
|
3358
3314
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3387,7 +3343,7 @@ class CampaignApi(object):
|
|
|
3387
3343
|
async_req (bool): execute request asynchronously
|
|
3388
3344
|
|
|
3389
3345
|
Returns:
|
|
3390
|
-
|
|
3346
|
+
AdSetDisplayMultiplierListResponse
|
|
3391
3347
|
If the method is called asynchronously, returns the request
|
|
3392
3348
|
thread.
|
|
3393
3349
|
"""
|
|
@@ -3416,11 +3372,11 @@ class CampaignApi(object):
|
|
|
3416
3372
|
'_content_type')
|
|
3417
3373
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3418
3374
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3419
|
-
kwargs['
|
|
3420
|
-
|
|
3421
|
-
return self.
|
|
3375
|
+
kwargs['ad_set_id'] = \
|
|
3376
|
+
ad_set_id
|
|
3377
|
+
return self.get_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
3422
3378
|
|
|
3423
|
-
def
|
|
3379
|
+
def get_marketplace_ad_sets_by_advertiser(
|
|
3424
3380
|
self,
|
|
3425
3381
|
advertiser_id,
|
|
3426
3382
|
**kwargs
|
|
@@ -3431,7 +3387,7 @@ class CampaignApi(object):
|
|
|
3431
3387
|
This method makes a synchronous HTTP request by default. To make an
|
|
3432
3388
|
asynchronous HTTP request, please pass async_req=True
|
|
3433
3389
|
|
|
3434
|
-
>>> thread = api.
|
|
3390
|
+
>>> thread = api.get_marketplace_ad_sets_by_advertiser(advertiser_id, async_req=True)
|
|
3435
3391
|
>>> result = thread.get()
|
|
3436
3392
|
|
|
3437
3393
|
Args:
|
|
@@ -3470,7 +3426,7 @@ class CampaignApi(object):
|
|
|
3470
3426
|
async_req (bool): execute request asynchronously
|
|
3471
3427
|
|
|
3472
3428
|
Returns:
|
|
3473
|
-
|
|
3429
|
+
[AdvertiserAdsetMessage]
|
|
3474
3430
|
If the method is called asynchronously, returns the request
|
|
3475
3431
|
thread.
|
|
3476
3432
|
"""
|
|
@@ -3501,20 +3457,20 @@ class CampaignApi(object):
|
|
|
3501
3457
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3502
3458
|
kwargs['advertiser_id'] = \
|
|
3503
3459
|
advertiser_id
|
|
3504
|
-
return self.
|
|
3460
|
+
return self.get_marketplace_ad_sets_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3505
3461
|
|
|
3506
|
-
def
|
|
3462
|
+
def get_marketplace_advertiser(
|
|
3507
3463
|
self,
|
|
3508
3464
|
advertiser_id,
|
|
3509
3465
|
**kwargs
|
|
3510
3466
|
):
|
|
3511
3467
|
""" # noqa: E501
|
|
3512
3468
|
|
|
3513
|
-
Get
|
|
3469
|
+
Get an advertiser. # noqa: E501
|
|
3514
3470
|
This method makes a synchronous HTTP request by default. To make an
|
|
3515
3471
|
asynchronous HTTP request, please pass async_req=True
|
|
3516
3472
|
|
|
3517
|
-
>>> thread = api.
|
|
3473
|
+
>>> thread = api.get_marketplace_advertiser(advertiser_id, async_req=True)
|
|
3518
3474
|
>>> result = thread.get()
|
|
3519
3475
|
|
|
3520
3476
|
Args:
|
|
@@ -3553,7 +3509,7 @@ class CampaignApi(object):
|
|
|
3553
3509
|
async_req (bool): execute request asynchronously
|
|
3554
3510
|
|
|
3555
3511
|
Returns:
|
|
3556
|
-
|
|
3512
|
+
AdvertiserInfoMessage
|
|
3557
3513
|
If the method is called asynchronously, returns the request
|
|
3558
3514
|
thread.
|
|
3559
3515
|
"""
|
|
@@ -3584,9 +3540,9 @@ class CampaignApi(object):
|
|
|
3584
3540
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3585
3541
|
kwargs['advertiser_id'] = \
|
|
3586
3542
|
advertiser_id
|
|
3587
|
-
return self.
|
|
3543
|
+
return self.get_marketplace_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3588
3544
|
|
|
3589
|
-
def
|
|
3545
|
+
def get_marketplace_advertiser_preview_limits(
|
|
3590
3546
|
self,
|
|
3591
3547
|
**kwargs
|
|
3592
3548
|
):
|
|
@@ -3596,7 +3552,7 @@ class CampaignApi(object):
|
|
|
3596
3552
|
This method makes a synchronous HTTP request by default. To make an
|
|
3597
3553
|
asynchronous HTTP request, please pass async_req=True
|
|
3598
3554
|
|
|
3599
|
-
>>> thread = api.
|
|
3555
|
+
>>> thread = api.get_marketplace_advertiser_preview_limits(async_req=True)
|
|
3600
3556
|
>>> result = thread.get()
|
|
3601
3557
|
|
|
3602
3558
|
|
|
@@ -3633,7 +3589,7 @@ class CampaignApi(object):
|
|
|
3633
3589
|
async_req (bool): execute request asynchronously
|
|
3634
3590
|
|
|
3635
3591
|
Returns:
|
|
3636
|
-
|
|
3592
|
+
[AdvertiserQuotaMessage]
|
|
3637
3593
|
If the method is called asynchronously, returns the request
|
|
3638
3594
|
thread.
|
|
3639
3595
|
"""
|
|
@@ -3662,9 +3618,9 @@ class CampaignApi(object):
|
|
|
3662
3618
|
'_content_type')
|
|
3663
3619
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3664
3620
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3665
|
-
return self.
|
|
3621
|
+
return self.get_marketplace_advertiser_preview_limits_endpoint.call_with_http_info(**kwargs)
|
|
3666
3622
|
|
|
3667
|
-
def
|
|
3623
|
+
def get_marketplace_advertisers(
|
|
3668
3624
|
self,
|
|
3669
3625
|
**kwargs
|
|
3670
3626
|
):
|
|
@@ -3674,7 +3630,7 @@ class CampaignApi(object):
|
|
|
3674
3630
|
This method makes a synchronous HTTP request by default. To make an
|
|
3675
3631
|
asynchronous HTTP request, please pass async_req=True
|
|
3676
3632
|
|
|
3677
|
-
>>> thread = api.
|
|
3633
|
+
>>> thread = api.get_marketplace_advertisers(async_req=True)
|
|
3678
3634
|
>>> result = thread.get()
|
|
3679
3635
|
|
|
3680
3636
|
|
|
@@ -3711,7 +3667,7 @@ class CampaignApi(object):
|
|
|
3711
3667
|
async_req (bool): execute request asynchronously
|
|
3712
3668
|
|
|
3713
3669
|
Returns:
|
|
3714
|
-
|
|
3670
|
+
[AdvertiserInfoMessage]
|
|
3715
3671
|
If the method is called asynchronously, returns the request
|
|
3716
3672
|
thread.
|
|
3717
3673
|
"""
|
|
@@ -3740,9 +3696,9 @@ class CampaignApi(object):
|
|
|
3740
3696
|
'_content_type')
|
|
3741
3697
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3742
3698
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3743
|
-
return self.
|
|
3699
|
+
return self.get_marketplace_advertisers_endpoint.call_with_http_info(**kwargs)
|
|
3744
3700
|
|
|
3745
|
-
def
|
|
3701
|
+
def get_marketplace_budgets_by_advertiser(
|
|
3746
3702
|
self,
|
|
3747
3703
|
advertiser_id,
|
|
3748
3704
|
**kwargs
|
|
@@ -3753,7 +3709,7 @@ class CampaignApi(object):
|
|
|
3753
3709
|
This method makes a synchronous HTTP request by default. To make an
|
|
3754
3710
|
asynchronous HTTP request, please pass async_req=True
|
|
3755
3711
|
|
|
3756
|
-
>>> thread = api.
|
|
3712
|
+
>>> thread = api.get_marketplace_budgets_by_advertiser(advertiser_id, async_req=True)
|
|
3757
3713
|
>>> result = thread.get()
|
|
3758
3714
|
|
|
3759
3715
|
Args:
|
|
@@ -3800,7 +3756,7 @@ class CampaignApi(object):
|
|
|
3800
3756
|
async_req (bool): execute request asynchronously
|
|
3801
3757
|
|
|
3802
3758
|
Returns:
|
|
3803
|
-
|
|
3759
|
+
[SellerBudgetMessage]
|
|
3804
3760
|
If the method is called asynchronously, returns the request
|
|
3805
3761
|
thread.
|
|
3806
3762
|
"""
|
|
@@ -3831,9 +3787,9 @@ class CampaignApi(object):
|
|
|
3831
3787
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3832
3788
|
kwargs['advertiser_id'] = \
|
|
3833
3789
|
advertiser_id
|
|
3834
|
-
return self.
|
|
3790
|
+
return self.get_marketplace_budgets_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
3835
3791
|
|
|
3836
|
-
def
|
|
3792
|
+
def get_marketplace_budgets_by_seller(
|
|
3837
3793
|
self,
|
|
3838
3794
|
seller_id,
|
|
3839
3795
|
**kwargs
|
|
@@ -3844,7 +3800,7 @@ class CampaignApi(object):
|
|
|
3844
3800
|
This method makes a synchronous HTTP request by default. To make an
|
|
3845
3801
|
asynchronous HTTP request, please pass async_req=True
|
|
3846
3802
|
|
|
3847
|
-
>>> thread = api.
|
|
3803
|
+
>>> thread = api.get_marketplace_budgets_by_seller(seller_id, async_req=True)
|
|
3848
3804
|
>>> result = thread.get()
|
|
3849
3805
|
|
|
3850
3806
|
Args:
|
|
@@ -3921,9 +3877,9 @@ class CampaignApi(object):
|
|
|
3921
3877
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3922
3878
|
kwargs['seller_id'] = \
|
|
3923
3879
|
seller_id
|
|
3924
|
-
return self.
|
|
3880
|
+
return self.get_marketplace_budgets_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3925
3881
|
|
|
3926
|
-
def
|
|
3882
|
+
def get_marketplace_budgets_by_seller_campaign(
|
|
3927
3883
|
self,
|
|
3928
3884
|
seller_campaign_id,
|
|
3929
3885
|
**kwargs
|
|
@@ -3934,7 +3890,7 @@ class CampaignApi(object):
|
|
|
3934
3890
|
This method makes a synchronous HTTP request by default. To make an
|
|
3935
3891
|
asynchronous HTTP request, please pass async_req=True
|
|
3936
3892
|
|
|
3937
|
-
>>> thread = api.
|
|
3893
|
+
>>> thread = api.get_marketplace_budgets_by_seller_campaign(seller_campaign_id, async_req=True)
|
|
3938
3894
|
>>> result = thread.get()
|
|
3939
3895
|
|
|
3940
3896
|
Args:
|
|
@@ -4010,24 +3966,24 @@ class CampaignApi(object):
|
|
|
4010
3966
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4011
3967
|
kwargs['seller_campaign_id'] = \
|
|
4012
3968
|
seller_campaign_id
|
|
4013
|
-
return self.
|
|
3969
|
+
return self.get_marketplace_budgets_by_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
4014
3970
|
|
|
4015
|
-
def
|
|
3971
|
+
def get_marketplace_campaigns_by_advertiser(
|
|
4016
3972
|
self,
|
|
4017
|
-
|
|
3973
|
+
advertiser_id,
|
|
4018
3974
|
**kwargs
|
|
4019
3975
|
):
|
|
4020
|
-
"""
|
|
3976
|
+
""" # noqa: E501
|
|
4021
3977
|
|
|
4022
|
-
Get the
|
|
3978
|
+
Get the collection of CRP campaigns associated with the advertiserId. # noqa: E501
|
|
4023
3979
|
This method makes a synchronous HTTP request by default. To make an
|
|
4024
3980
|
asynchronous HTTP request, please pass async_req=True
|
|
4025
3981
|
|
|
4026
|
-
>>> thread = api.
|
|
3982
|
+
>>> thread = api.get_marketplace_campaigns_by_advertiser(advertiser_id, async_req=True)
|
|
4027
3983
|
>>> result = thread.get()
|
|
4028
3984
|
|
|
4029
3985
|
Args:
|
|
4030
|
-
|
|
3986
|
+
advertiser_id (int): Id of the advertiser
|
|
4031
3987
|
|
|
4032
3988
|
Keyword Args:
|
|
4033
3989
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4062,7 +4018,7 @@ class CampaignApi(object):
|
|
|
4062
4018
|
async_req (bool): execute request asynchronously
|
|
4063
4019
|
|
|
4064
4020
|
Returns:
|
|
4065
|
-
|
|
4021
|
+
[AdvertiserCampaignMessage]
|
|
4066
4022
|
If the method is called asynchronously, returns the request
|
|
4067
4023
|
thread.
|
|
4068
4024
|
"""
|
|
@@ -4091,28 +4047,33 @@ class CampaignApi(object):
|
|
|
4091
4047
|
'_content_type')
|
|
4092
4048
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4093
4049
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4094
|
-
kwargs['
|
|
4095
|
-
|
|
4096
|
-
return self.
|
|
4050
|
+
kwargs['advertiser_id'] = \
|
|
4051
|
+
advertiser_id
|
|
4052
|
+
return self.get_marketplace_campaigns_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
4097
4053
|
|
|
4098
|
-
def
|
|
4054
|
+
def get_marketplace_campaigns_stats(
|
|
4099
4055
|
self,
|
|
4100
|
-
ad_set_id,
|
|
4101
4056
|
**kwargs
|
|
4102
4057
|
):
|
|
4103
|
-
"""
|
|
4058
|
+
""" # noqa: E501
|
|
4104
4059
|
|
|
4105
|
-
Get the
|
|
4060
|
+
## 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` aligned with the user timezone if provided. 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
4061
|
This method makes a synchronous HTTP request by default. To make an
|
|
4107
4062
|
asynchronous HTTP request, please pass async_req=True
|
|
4108
4063
|
|
|
4109
|
-
>>> thread = api.
|
|
4064
|
+
>>> thread = api.get_marketplace_campaigns_stats(async_req=True)
|
|
4110
4065
|
>>> result = thread.get()
|
|
4111
4066
|
|
|
4112
|
-
Args:
|
|
4113
|
-
ad_set_id (str): Id of the Ad Set
|
|
4114
4067
|
|
|
4115
4068
|
Keyword Args:
|
|
4069
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
4070
|
+
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
4071
|
+
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"
|
|
4072
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
4073
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
4074
|
+
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"
|
|
4075
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
4076
|
+
time_zone_id (str): Specify the timezone used in the aggregations (IANA code).. [optional]
|
|
4116
4077
|
_return_http_data_only (bool): response data without head status
|
|
4117
4078
|
code and headers. Default is True.
|
|
4118
4079
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4145,7 +4106,7 @@ class CampaignApi(object):
|
|
|
4145
4106
|
async_req (bool): execute request asynchronously
|
|
4146
4107
|
|
|
4147
4108
|
Returns:
|
|
4148
|
-
|
|
4109
|
+
str
|
|
4149
4110
|
If the method is called asynchronously, returns the request
|
|
4150
4111
|
thread.
|
|
4151
4112
|
"""
|
|
@@ -4174,11 +4135,9 @@ class CampaignApi(object):
|
|
|
4174
4135
|
'_content_type')
|
|
4175
4136
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4176
4137
|
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)
|
|
4138
|
+
return self.get_marketplace_campaigns_stats_endpoint.call_with_http_info(**kwargs)
|
|
4180
4139
|
|
|
4181
|
-
def
|
|
4140
|
+
def get_marketplace_seller(
|
|
4182
4141
|
self,
|
|
4183
4142
|
seller_id,
|
|
4184
4143
|
**kwargs
|
|
@@ -4189,7 +4148,7 @@ class CampaignApi(object):
|
|
|
4189
4148
|
This method makes a synchronous HTTP request by default. To make an
|
|
4190
4149
|
asynchronous HTTP request, please pass async_req=True
|
|
4191
4150
|
|
|
4192
|
-
>>> thread = api.
|
|
4151
|
+
>>> thread = api.get_marketplace_seller(seller_id, async_req=True)
|
|
4193
4152
|
>>> result = thread.get()
|
|
4194
4153
|
|
|
4195
4154
|
Args:
|
|
@@ -4259,9 +4218,9 @@ class CampaignApi(object):
|
|
|
4259
4218
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4260
4219
|
kwargs['seller_id'] = \
|
|
4261
4220
|
seller_id
|
|
4262
|
-
return self.
|
|
4221
|
+
return self.get_marketplace_seller_endpoint.call_with_http_info(**kwargs)
|
|
4263
4222
|
|
|
4264
|
-
def
|
|
4223
|
+
def get_marketplace_seller_ad_preview(
|
|
4265
4224
|
self,
|
|
4266
4225
|
advertiser_id,
|
|
4267
4226
|
seller_id,
|
|
@@ -4273,7 +4232,7 @@ class CampaignApi(object):
|
|
|
4273
4232
|
This method makes a synchronous HTTP request by default. To make an
|
|
4274
4233
|
asynchronous HTTP request, please pass async_req=True
|
|
4275
4234
|
|
|
4276
|
-
>>> thread = api.
|
|
4235
|
+
>>> thread = api.get_marketplace_seller_ad_preview(advertiser_id, seller_id, async_req=True)
|
|
4277
4236
|
>>> result = thread.get()
|
|
4278
4237
|
|
|
4279
4238
|
Args:
|
|
@@ -4349,9 +4308,9 @@ class CampaignApi(object):
|
|
|
4349
4308
|
advertiser_id
|
|
4350
4309
|
kwargs['seller_id'] = \
|
|
4351
4310
|
seller_id
|
|
4352
|
-
return self.
|
|
4311
|
+
return self.get_marketplace_seller_ad_preview_endpoint.call_with_http_info(**kwargs)
|
|
4353
4312
|
|
|
4354
|
-
def
|
|
4313
|
+
def get_marketplace_seller_budget(
|
|
4355
4314
|
self,
|
|
4356
4315
|
budget_id,
|
|
4357
4316
|
**kwargs
|
|
@@ -4362,7 +4321,7 @@ class CampaignApi(object):
|
|
|
4362
4321
|
This method makes a synchronous HTTP request by default. To make an
|
|
4363
4322
|
asynchronous HTTP request, please pass async_req=True
|
|
4364
4323
|
|
|
4365
|
-
>>> thread = api.
|
|
4324
|
+
>>> thread = api.get_marketplace_seller_budget(budget_id, async_req=True)
|
|
4366
4325
|
>>> result = thread.get()
|
|
4367
4326
|
|
|
4368
4327
|
Args:
|
|
@@ -4432,9 +4391,9 @@ class CampaignApi(object):
|
|
|
4432
4391
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4433
4392
|
kwargs['budget_id'] = \
|
|
4434
4393
|
budget_id
|
|
4435
|
-
return self.
|
|
4394
|
+
return self.get_marketplace_seller_budget_endpoint.call_with_http_info(**kwargs)
|
|
4436
4395
|
|
|
4437
|
-
def
|
|
4396
|
+
def get_marketplace_seller_budgets(
|
|
4438
4397
|
self,
|
|
4439
4398
|
**kwargs
|
|
4440
4399
|
):
|
|
@@ -4444,7 +4403,7 @@ class CampaignApi(object):
|
|
|
4444
4403
|
This method makes a synchronous HTTP request by default. To make an
|
|
4445
4404
|
asynchronous HTTP request, please pass async_req=True
|
|
4446
4405
|
|
|
4447
|
-
>>> thread = api.
|
|
4406
|
+
>>> thread = api.get_marketplace_seller_budgets(async_req=True)
|
|
4448
4407
|
>>> result = thread.get()
|
|
4449
4408
|
|
|
4450
4409
|
|
|
@@ -4519,9 +4478,9 @@ class CampaignApi(object):
|
|
|
4519
4478
|
'_content_type')
|
|
4520
4479
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4521
4480
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4522
|
-
return self.
|
|
4481
|
+
return self.get_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
4523
4482
|
|
|
4524
|
-
def
|
|
4483
|
+
def get_marketplace_seller_campaign(
|
|
4525
4484
|
self,
|
|
4526
4485
|
seller_campaign_id,
|
|
4527
4486
|
**kwargs
|
|
@@ -4532,7 +4491,7 @@ class CampaignApi(object):
|
|
|
4532
4491
|
This method makes a synchronous HTTP request by default. To make an
|
|
4533
4492
|
asynchronous HTTP request, please pass async_req=True
|
|
4534
4493
|
|
|
4535
|
-
>>> thread = api.
|
|
4494
|
+
>>> thread = api.get_marketplace_seller_campaign(seller_campaign_id, async_req=True)
|
|
4536
4495
|
>>> result = thread.get()
|
|
4537
4496
|
|
|
4538
4497
|
Args:
|
|
@@ -4571,7 +4530,7 @@ class CampaignApi(object):
|
|
|
4571
4530
|
async_req (bool): execute request asynchronously
|
|
4572
4531
|
|
|
4573
4532
|
Returns:
|
|
4574
|
-
SellerCampaignMessage
|
|
4533
|
+
[SellerCampaignMessage]
|
|
4575
4534
|
If the method is called asynchronously, returns the request
|
|
4576
4535
|
thread.
|
|
4577
4536
|
"""
|
|
@@ -4602,9 +4561,9 @@ class CampaignApi(object):
|
|
|
4602
4561
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4603
4562
|
kwargs['seller_campaign_id'] = \
|
|
4604
4563
|
seller_campaign_id
|
|
4605
|
-
return self.
|
|
4564
|
+
return self.get_marketplace_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
4606
4565
|
|
|
4607
|
-
def
|
|
4566
|
+
def get_marketplace_seller_campaigns(
|
|
4608
4567
|
self,
|
|
4609
4568
|
**kwargs
|
|
4610
4569
|
):
|
|
@@ -4614,7 +4573,7 @@ class CampaignApi(object):
|
|
|
4614
4573
|
This method makes a synchronous HTTP request by default. To make an
|
|
4615
4574
|
asynchronous HTTP request, please pass async_req=True
|
|
4616
4575
|
|
|
4617
|
-
>>> thread = api.
|
|
4576
|
+
>>> thread = api.get_marketplace_seller_campaigns(async_req=True)
|
|
4618
4577
|
>>> result = thread.get()
|
|
4619
4578
|
|
|
4620
4579
|
|
|
@@ -4685,9 +4644,9 @@ class CampaignApi(object):
|
|
|
4685
4644
|
'_content_type')
|
|
4686
4645
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4687
4646
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4688
|
-
return self.
|
|
4647
|
+
return self.get_marketplace_seller_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
4689
4648
|
|
|
4690
|
-
def
|
|
4649
|
+
def get_marketplace_seller_campaigns_by_advertiser(
|
|
4691
4650
|
self,
|
|
4692
4651
|
advertiser_id,
|
|
4693
4652
|
**kwargs
|
|
@@ -4698,7 +4657,7 @@ class CampaignApi(object):
|
|
|
4698
4657
|
This method makes a synchronous HTTP request by default. To make an
|
|
4699
4658
|
asynchronous HTTP request, please pass async_req=True
|
|
4700
4659
|
|
|
4701
|
-
>>> thread = api.
|
|
4660
|
+
>>> thread = api.get_marketplace_seller_campaigns_by_advertiser(advertiser_id, async_req=True)
|
|
4702
4661
|
>>> result = thread.get()
|
|
4703
4662
|
|
|
4704
4663
|
Args:
|
|
@@ -4737,7 +4696,7 @@ class CampaignApi(object):
|
|
|
4737
4696
|
async_req (bool): execute request asynchronously
|
|
4738
4697
|
|
|
4739
4698
|
Returns:
|
|
4740
|
-
|
|
4699
|
+
[SellerCampaignMessage]
|
|
4741
4700
|
If the method is called asynchronously, returns the request
|
|
4742
4701
|
thread.
|
|
4743
4702
|
"""
|
|
@@ -4768,9 +4727,9 @@ class CampaignApi(object):
|
|
|
4768
4727
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4769
4728
|
kwargs['advertiser_id'] = \
|
|
4770
4729
|
advertiser_id
|
|
4771
|
-
return self.
|
|
4730
|
+
return self.get_marketplace_seller_campaigns_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
4772
4731
|
|
|
4773
|
-
def
|
|
4732
|
+
def get_marketplace_seller_campaigns_by_seller(
|
|
4774
4733
|
self,
|
|
4775
4734
|
seller_id,
|
|
4776
4735
|
**kwargs
|
|
@@ -4781,7 +4740,7 @@ class CampaignApi(object):
|
|
|
4781
4740
|
This method makes a synchronous HTTP request by default. To make an
|
|
4782
4741
|
asynchronous HTTP request, please pass async_req=True
|
|
4783
4742
|
|
|
4784
|
-
>>> thread = api.
|
|
4743
|
+
>>> thread = api.get_marketplace_seller_campaigns_by_seller(seller_id, async_req=True)
|
|
4785
4744
|
>>> result = thread.get()
|
|
4786
4745
|
|
|
4787
4746
|
Args:
|
|
@@ -4854,9 +4813,96 @@ class CampaignApi(object):
|
|
|
4854
4813
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4855
4814
|
kwargs['seller_id'] = \
|
|
4856
4815
|
seller_id
|
|
4857
|
-
return self.
|
|
4816
|
+
return self.get_marketplace_seller_campaigns_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
4817
|
+
|
|
4818
|
+
def get_marketplace_seller_campaigns_stats(
|
|
4819
|
+
self,
|
|
4820
|
+
**kwargs
|
|
4821
|
+
):
|
|
4822
|
+
""" # noqa: E501
|
|
4823
|
+
|
|
4824
|
+
## 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` aligned with the user timezone if provided. 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
|
|
4825
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
4826
|
+
asynchronous HTTP request, please pass async_req=True
|
|
4827
|
+
|
|
4828
|
+
>>> thread = api.get_marketplace_seller_campaigns_stats(async_req=True)
|
|
4829
|
+
>>> result = thread.get()
|
|
4830
|
+
|
|
4831
|
+
|
|
4832
|
+
Keyword Args:
|
|
4833
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
4834
|
+
campaign_id (str): Show only metrics for this campaign (default all campaigns). [optional]
|
|
4835
|
+
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"
|
|
4836
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
4837
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
4838
|
+
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"
|
|
4839
|
+
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
4840
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
4841
|
+
time_zone_id (str): Specify the timezone used in the aggregations (IANA code).. [optional]
|
|
4842
|
+
_return_http_data_only (bool): response data without head status
|
|
4843
|
+
code and headers. Default is True.
|
|
4844
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4845
|
+
will be returned without reading/decoding response data.
|
|
4846
|
+
Default is True.
|
|
4847
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4848
|
+
one number provided, it will be total request timeout. It can also
|
|
4849
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
4850
|
+
Default is None.
|
|
4851
|
+
_check_input_type (bool): specifies if type checking
|
|
4852
|
+
should be done one the data sent to the server.
|
|
4853
|
+
Default is True.
|
|
4854
|
+
_check_return_type (bool): specifies if type checking
|
|
4855
|
+
should be done one the data received from the server.
|
|
4856
|
+
Default is True.
|
|
4857
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
4858
|
+
are serialized names, as specified in the OpenAPI document.
|
|
4859
|
+
False if the variable names in the input data
|
|
4860
|
+
are pythonic names, e.g. snake case (default)
|
|
4861
|
+
_content_type (str/None): force body content-type.
|
|
4862
|
+
Default is None and content-type will be predicted by allowed
|
|
4863
|
+
content-types and body.
|
|
4864
|
+
_host_index (int/None): specifies the index of the server
|
|
4865
|
+
that we want to use.
|
|
4866
|
+
Default is read from the configuration.
|
|
4867
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
4868
|
+
request; this effectively ignores the authentication
|
|
4869
|
+
in the spec for a single request.
|
|
4870
|
+
Default is None
|
|
4871
|
+
async_req (bool): execute request asynchronously
|
|
4872
|
+
|
|
4873
|
+
Returns:
|
|
4874
|
+
str
|
|
4875
|
+
If the method is called asynchronously, returns the request
|
|
4876
|
+
thread.
|
|
4877
|
+
"""
|
|
4878
|
+
kwargs['async_req'] = kwargs.get(
|
|
4879
|
+
'async_req', False
|
|
4880
|
+
)
|
|
4881
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4882
|
+
'_return_http_data_only', True
|
|
4883
|
+
)
|
|
4884
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
4885
|
+
'_preload_content', True
|
|
4886
|
+
)
|
|
4887
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
4888
|
+
'_request_timeout', None
|
|
4889
|
+
)
|
|
4890
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
4891
|
+
'_check_input_type', True
|
|
4892
|
+
)
|
|
4893
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
4894
|
+
'_check_return_type', True
|
|
4895
|
+
)
|
|
4896
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4897
|
+
'_spec_property_naming', False
|
|
4898
|
+
)
|
|
4899
|
+
kwargs['_content_type'] = kwargs.get(
|
|
4900
|
+
'_content_type')
|
|
4901
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4902
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4903
|
+
return self.get_marketplace_seller_campaigns_stats_endpoint.call_with_http_info(**kwargs)
|
|
4858
4904
|
|
|
4859
|
-
def
|
|
4905
|
+
def get_marketplace_sellers(
|
|
4860
4906
|
self,
|
|
4861
4907
|
**kwargs
|
|
4862
4908
|
):
|
|
@@ -4866,7 +4912,7 @@ class CampaignApi(object):
|
|
|
4866
4912
|
This method makes a synchronous HTTP request by default. To make an
|
|
4867
4913
|
asynchronous HTTP request, please pass async_req=True
|
|
4868
4914
|
|
|
4869
|
-
>>> thread = api.
|
|
4915
|
+
>>> thread = api.get_marketplace_sellers(async_req=True)
|
|
4870
4916
|
>>> result = thread.get()
|
|
4871
4917
|
|
|
4872
4918
|
|
|
@@ -4909,7 +4955,7 @@ class CampaignApi(object):
|
|
|
4909
4955
|
async_req (bool): execute request asynchronously
|
|
4910
4956
|
|
|
4911
4957
|
Returns:
|
|
4912
|
-
[
|
|
4958
|
+
[SellerBase]
|
|
4913
4959
|
If the method is called asynchronously, returns the request
|
|
4914
4960
|
thread.
|
|
4915
4961
|
"""
|
|
@@ -4938,27 +4984,28 @@ class CampaignApi(object):
|
|
|
4938
4984
|
'_content_type')
|
|
4939
4985
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4940
4986
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4941
|
-
return self.
|
|
4987
|
+
return self.get_marketplace_sellers_endpoint.call_with_http_info(**kwargs)
|
|
4942
4988
|
|
|
4943
|
-
def
|
|
4989
|
+
def get_marketplace_sellers_by_advertiser(
|
|
4944
4990
|
self,
|
|
4945
|
-
|
|
4991
|
+
advertiser_id,
|
|
4946
4992
|
**kwargs
|
|
4947
4993
|
):
|
|
4948
|
-
"""
|
|
4994
|
+
""" # noqa: E501
|
|
4949
4995
|
|
|
4950
|
-
|
|
4996
|
+
Create new sellers for an advertiser # noqa: E501
|
|
4951
4997
|
This method makes a synchronous HTTP request by default. To make an
|
|
4952
4998
|
asynchronous HTTP request, please pass async_req=True
|
|
4953
4999
|
|
|
4954
|
-
>>> thread = api.
|
|
5000
|
+
>>> thread = api.get_marketplace_sellers_by_advertiser(advertiser_id, async_req=True)
|
|
4955
5001
|
>>> result = thread.get()
|
|
4956
5002
|
|
|
4957
5003
|
Args:
|
|
4958
|
-
|
|
5004
|
+
advertiser_id (int): Id of the advertiser
|
|
4959
5005
|
|
|
4960
5006
|
Keyword Args:
|
|
4961
|
-
|
|
5007
|
+
partner_id (int): Id of the partner. [optional]
|
|
5008
|
+
request_body ([str]): Names of the sellers to associate with new Ids. [optional]
|
|
4962
5009
|
_return_http_data_only (bool): response data without head status
|
|
4963
5010
|
code and headers. Default is True.
|
|
4964
5011
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4991,7 +5038,7 @@ class CampaignApi(object):
|
|
|
4991
5038
|
async_req (bool): execute request asynchronously
|
|
4992
5039
|
|
|
4993
5040
|
Returns:
|
|
4994
|
-
|
|
5041
|
+
[SellerBase]
|
|
4995
5042
|
If the method is called asynchronously, returns the request
|
|
4996
5043
|
thread.
|
|
4997
5044
|
"""
|
|
@@ -5020,26 +5067,33 @@ class CampaignApi(object):
|
|
|
5020
5067
|
'_content_type')
|
|
5021
5068
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5022
5069
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5023
|
-
kwargs['
|
|
5024
|
-
|
|
5025
|
-
return self.
|
|
5070
|
+
kwargs['advertiser_id'] = \
|
|
5071
|
+
advertiser_id
|
|
5072
|
+
return self.get_marketplace_sellers_by_advertiser_endpoint.call_with_http_info(**kwargs)
|
|
5026
5073
|
|
|
5027
|
-
def
|
|
5074
|
+
def get_marketplace_sellers_stats(
|
|
5028
5075
|
self,
|
|
5029
5076
|
**kwargs
|
|
5030
5077
|
):
|
|
5031
|
-
"""
|
|
5078
|
+
""" # noqa: E501
|
|
5032
5079
|
|
|
5033
|
-
|
|
5080
|
+
## 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` aligned with the user timezone if provided. 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
5081
|
This method makes a synchronous HTTP request by default. To make an
|
|
5035
5082
|
asynchronous HTTP request, please pass async_req=True
|
|
5036
5083
|
|
|
5037
|
-
>>> thread = api.
|
|
5084
|
+
>>> thread = api.get_marketplace_sellers_stats(async_req=True)
|
|
5038
5085
|
>>> result = thread.get()
|
|
5039
5086
|
|
|
5040
5087
|
|
|
5041
5088
|
Keyword Args:
|
|
5042
|
-
|
|
5089
|
+
advertiser_id (int): Show only metrics for this advertiser.. [optional]
|
|
5090
|
+
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"
|
|
5091
|
+
count (int): Return up to the first count rows of data (default is all rows). [optional]
|
|
5092
|
+
end_date (datetime): Filter out all events that occur after date (default is today’s date). [optional]
|
|
5093
|
+
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"
|
|
5094
|
+
seller_id (str): Show only metrics for this seller (default all sellers). [optional]
|
|
5095
|
+
start_date (datetime): Filter out all events that occur before date (default is the value of `endDate`). [optional]
|
|
5096
|
+
time_zone_id (str): Specify the timezone used in the aggregations (IANA code).. [optional]
|
|
5043
5097
|
_return_http_data_only (bool): response data without head status
|
|
5044
5098
|
code and headers. Default is True.
|
|
5045
5099
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5072,7 +5126,7 @@ class CampaignApi(object):
|
|
|
5072
5126
|
async_req (bool): execute request asynchronously
|
|
5073
5127
|
|
|
5074
5128
|
Returns:
|
|
5075
|
-
|
|
5129
|
+
str
|
|
5076
5130
|
If the method is called asynchronously, returns the request
|
|
5077
5131
|
thread.
|
|
5078
5132
|
"""
|
|
@@ -5101,24 +5155,27 @@ class CampaignApi(object):
|
|
|
5101
5155
|
'_content_type')
|
|
5102
5156
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5103
5157
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5104
|
-
return self.
|
|
5158
|
+
return self.get_marketplace_sellers_stats_endpoint.call_with_http_info(**kwargs)
|
|
5105
5159
|
|
|
5106
|
-
def
|
|
5160
|
+
def patch_ad_set_category_bids(
|
|
5107
5161
|
self,
|
|
5162
|
+
ad_set_id,
|
|
5108
5163
|
**kwargs
|
|
5109
5164
|
):
|
|
5110
|
-
"""
|
|
5165
|
+
"""patch_ad_set_category_bids # noqa: E501
|
|
5111
5166
|
|
|
5112
|
-
Patch a
|
|
5167
|
+
Patch Category Bids for one or more Categories in a single request. Partial success policy is followed. # noqa: E501
|
|
5113
5168
|
This method makes a synchronous HTTP request by default. To make an
|
|
5114
5169
|
asynchronous HTTP request, please pass async_req=True
|
|
5115
5170
|
|
|
5116
|
-
>>> thread = api.
|
|
5171
|
+
>>> thread = api.patch_ad_set_category_bids(ad_set_id, async_req=True)
|
|
5117
5172
|
>>> result = thread.get()
|
|
5118
5173
|
|
|
5174
|
+
Args:
|
|
5175
|
+
ad_set_id (str): Id of the Ad Set
|
|
5119
5176
|
|
|
5120
5177
|
Keyword Args:
|
|
5121
|
-
|
|
5178
|
+
patch_ad_set_category_bid_list_request (PatchAdSetCategoryBidListRequest): [optional]
|
|
5122
5179
|
_return_http_data_only (bool): response data without head status
|
|
5123
5180
|
code and headers. Default is True.
|
|
5124
5181
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5151,7 +5208,7 @@ class CampaignApi(object):
|
|
|
5151
5208
|
async_req (bool): execute request asynchronously
|
|
5152
5209
|
|
|
5153
5210
|
Returns:
|
|
5154
|
-
|
|
5211
|
+
PatchAdSetCategoryBidResultListResponse
|
|
5155
5212
|
If the method is called asynchronously, returns the request
|
|
5156
5213
|
thread.
|
|
5157
5214
|
"""
|
|
@@ -5180,27 +5237,26 @@ class CampaignApi(object):
|
|
|
5180
5237
|
'_content_type')
|
|
5181
5238
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5182
5239
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5183
|
-
|
|
5240
|
+
kwargs['ad_set_id'] = \
|
|
5241
|
+
ad_set_id
|
|
5242
|
+
return self.patch_ad_set_category_bids_endpoint.call_with_http_info(**kwargs)
|
|
5184
5243
|
|
|
5185
|
-
def
|
|
5244
|
+
def patch_ad_sets(
|
|
5186
5245
|
self,
|
|
5187
|
-
ad_set_id,
|
|
5188
5246
|
**kwargs
|
|
5189
5247
|
):
|
|
5190
|
-
"""
|
|
5248
|
+
"""patch_ad_sets # noqa: E501
|
|
5191
5249
|
|
|
5192
|
-
Patch
|
|
5250
|
+
Patch a list of AdSets. # noqa: E501
|
|
5193
5251
|
This method makes a synchronous HTTP request by default. To make an
|
|
5194
5252
|
asynchronous HTTP request, please pass async_req=True
|
|
5195
5253
|
|
|
5196
|
-
>>> thread = api.
|
|
5254
|
+
>>> thread = api.patch_ad_sets(async_req=True)
|
|
5197
5255
|
>>> result = thread.get()
|
|
5198
5256
|
|
|
5199
|
-
Args:
|
|
5200
|
-
ad_set_id (str): Id of the Ad Set
|
|
5201
5257
|
|
|
5202
5258
|
Keyword Args:
|
|
5203
|
-
|
|
5259
|
+
requests_patch_ad_set_v24_q3 (RequestsPatchAdSetV24Q3): List of adsets to patch.. [optional]
|
|
5204
5260
|
_return_http_data_only (bool): response data without head status
|
|
5205
5261
|
code and headers. Default is True.
|
|
5206
5262
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5233,7 +5289,7 @@ class CampaignApi(object):
|
|
|
5233
5289
|
async_req (bool): execute request asynchronously
|
|
5234
5290
|
|
|
5235
5291
|
Returns:
|
|
5236
|
-
|
|
5292
|
+
ResponsesAdSetIdV24Q3
|
|
5237
5293
|
If the method is called asynchronously, returns the request
|
|
5238
5294
|
thread.
|
|
5239
5295
|
"""
|
|
@@ -5262,26 +5318,24 @@ class CampaignApi(object):
|
|
|
5262
5318
|
'_content_type')
|
|
5263
5319
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5264
5320
|
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)
|
|
5321
|
+
return self.patch_ad_sets_endpoint.call_with_http_info(**kwargs)
|
|
5268
5322
|
|
|
5269
|
-
def
|
|
5323
|
+
def patch_campaigns(
|
|
5270
5324
|
self,
|
|
5271
5325
|
**kwargs
|
|
5272
5326
|
):
|
|
5273
|
-
"""
|
|
5327
|
+
"""patch_campaigns # noqa: E501
|
|
5274
5328
|
|
|
5275
|
-
|
|
5329
|
+
Patch a list of Campaigns. # noqa: E501
|
|
5276
5330
|
This method makes a synchronous HTTP request by default. To make an
|
|
5277
5331
|
asynchronous HTTP request, please pass async_req=True
|
|
5278
5332
|
|
|
5279
|
-
>>> thread = api.
|
|
5333
|
+
>>> thread = api.patch_campaigns(async_req=True)
|
|
5280
5334
|
>>> result = thread.get()
|
|
5281
5335
|
|
|
5282
5336
|
|
|
5283
5337
|
Keyword Args:
|
|
5284
|
-
|
|
5338
|
+
patch_campaign_list_request (PatchCampaignListRequest): List of campaigns to patch.. [optional]
|
|
5285
5339
|
_return_http_data_only (bool): response data without head status
|
|
5286
5340
|
code and headers. Default is True.
|
|
5287
5341
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5314,7 +5368,7 @@ class CampaignApi(object):
|
|
|
5314
5368
|
async_req (bool): execute request asynchronously
|
|
5315
5369
|
|
|
5316
5370
|
Returns:
|
|
5317
|
-
|
|
5371
|
+
PatchResultCampaignListResponse
|
|
5318
5372
|
If the method is called asynchronously, returns the request
|
|
5319
5373
|
thread.
|
|
5320
5374
|
"""
|
|
@@ -5343,24 +5397,27 @@ class CampaignApi(object):
|
|
|
5343
5397
|
'_content_type')
|
|
5344
5398
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5345
5399
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5346
|
-
return self.
|
|
5400
|
+
return self.patch_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
5347
5401
|
|
|
5348
|
-
def
|
|
5402
|
+
def patch_display_multipliers(
|
|
5349
5403
|
self,
|
|
5404
|
+
ad_set_id,
|
|
5350
5405
|
**kwargs
|
|
5351
5406
|
):
|
|
5352
|
-
"""
|
|
5407
|
+
"""patch_display_multipliers # noqa: E501
|
|
5353
5408
|
|
|
5354
|
-
|
|
5409
|
+
Patch Display Multipliers for one or more Categories in a single request. Partial success policy is followed. # noqa: E501
|
|
5355
5410
|
This method makes a synchronous HTTP request by default. To make an
|
|
5356
5411
|
asynchronous HTTP request, please pass async_req=True
|
|
5357
5412
|
|
|
5358
|
-
>>> thread = api.
|
|
5413
|
+
>>> thread = api.patch_display_multipliers(ad_set_id, async_req=True)
|
|
5359
5414
|
>>> result = thread.get()
|
|
5360
5415
|
|
|
5416
|
+
Args:
|
|
5417
|
+
ad_set_id (str): Id of the Ad Set
|
|
5361
5418
|
|
|
5362
5419
|
Keyword Args:
|
|
5363
|
-
|
|
5420
|
+
patch_ad_set_display_multiplier_list_request (PatchAdSetDisplayMultiplierListRequest): [optional]
|
|
5364
5421
|
_return_http_data_only (bool): response data without head status
|
|
5365
5422
|
code and headers. Default is True.
|
|
5366
5423
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5393,7 +5450,7 @@ class CampaignApi(object):
|
|
|
5393
5450
|
async_req (bool): execute request asynchronously
|
|
5394
5451
|
|
|
5395
5452
|
Returns:
|
|
5396
|
-
|
|
5453
|
+
PatchAdSetDisplayMultiplierResultListResponse
|
|
5397
5454
|
If the method is called asynchronously, returns the request
|
|
5398
5455
|
thread.
|
|
5399
5456
|
"""
|
|
@@ -5422,31 +5479,26 @@ class CampaignApi(object):
|
|
|
5422
5479
|
'_content_type')
|
|
5423
5480
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5424
5481
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5425
|
-
|
|
5482
|
+
kwargs['ad_set_id'] = \
|
|
5483
|
+
ad_set_id
|
|
5484
|
+
return self.patch_display_multipliers_endpoint.call_with_http_info(**kwargs)
|
|
5426
5485
|
|
|
5427
|
-
def
|
|
5486
|
+
def search_ad_sets(
|
|
5428
5487
|
self,
|
|
5429
5488
|
**kwargs
|
|
5430
5489
|
):
|
|
5431
|
-
""" # noqa: E501
|
|
5490
|
+
"""search_ad_sets # noqa: E501
|
|
5432
5491
|
|
|
5433
|
-
|
|
5492
|
+
Search for ad sets # noqa: E501
|
|
5434
5493
|
This method makes a synchronous HTTP request by default. To make an
|
|
5435
5494
|
asynchronous HTTP request, please pass async_req=True
|
|
5436
5495
|
|
|
5437
|
-
>>> thread = api.
|
|
5496
|
+
>>> thread = api.search_ad_sets(async_req=True)
|
|
5438
5497
|
>>> result = thread.get()
|
|
5439
5498
|
|
|
5440
5499
|
|
|
5441
5500
|
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]
|
|
5501
|
+
ad_set_search_request_v24_q3 (AdSetSearchRequestV24Q3): [optional]
|
|
5450
5502
|
_return_http_data_only (bool): response data without head status
|
|
5451
5503
|
code and headers. Default is True.
|
|
5452
5504
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5479,7 +5531,7 @@ class CampaignApi(object):
|
|
|
5479
5531
|
async_req (bool): execute request asynchronously
|
|
5480
5532
|
|
|
5481
5533
|
Returns:
|
|
5482
|
-
|
|
5534
|
+
ResponsesReadAdSetV24Q3
|
|
5483
5535
|
If the method is called asynchronously, returns the request
|
|
5484
5536
|
thread.
|
|
5485
5537
|
"""
|
|
@@ -5508,30 +5560,24 @@ class CampaignApi(object):
|
|
|
5508
5560
|
'_content_type')
|
|
5509
5561
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5510
5562
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5511
|
-
return self.
|
|
5563
|
+
return self.search_ad_sets_endpoint.call_with_http_info(**kwargs)
|
|
5512
5564
|
|
|
5513
|
-
def
|
|
5565
|
+
def search_campaigns(
|
|
5514
5566
|
self,
|
|
5515
5567
|
**kwargs
|
|
5516
5568
|
):
|
|
5517
|
-
""" # noqa: E501
|
|
5569
|
+
"""search_campaigns # noqa: E501
|
|
5518
5570
|
|
|
5519
|
-
|
|
5571
|
+
Search for campaigns # noqa: E501
|
|
5520
5572
|
This method makes a synchronous HTTP request by default. To make an
|
|
5521
5573
|
asynchronous HTTP request, please pass async_req=True
|
|
5522
5574
|
|
|
5523
|
-
>>> thread = api.
|
|
5575
|
+
>>> thread = api.search_campaigns(async_req=True)
|
|
5524
5576
|
>>> result = thread.get()
|
|
5525
5577
|
|
|
5526
5578
|
|
|
5527
5579
|
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]
|
|
5580
|
+
campaign_search_request_v23_q1 (CampaignSearchRequestV23Q1): filters on campaigns. [optional]
|
|
5535
5581
|
_return_http_data_only (bool): response data without head status
|
|
5536
5582
|
code and headers. Default is True.
|
|
5537
5583
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5564,7 +5610,7 @@ class CampaignApi(object):
|
|
|
5564
5610
|
async_req (bool): execute request asynchronously
|
|
5565
5611
|
|
|
5566
5612
|
Returns:
|
|
5567
|
-
|
|
5613
|
+
CampaignV23Q1ListResponse
|
|
5568
5614
|
If the method is called asynchronously, returns the request
|
|
5569
5615
|
thread.
|
|
5570
5616
|
"""
|
|
@@ -5593,7 +5639,7 @@ class CampaignApi(object):
|
|
|
5593
5639
|
'_content_type')
|
|
5594
5640
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5595
5641
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5596
|
-
return self.
|
|
5642
|
+
return self.search_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
5597
5643
|
|
|
5598
5644
|
def start_ad_sets(
|
|
5599
5645
|
self,
|
|
@@ -5840,7 +5886,7 @@ class CampaignApi(object):
|
|
|
5840
5886
|
ad_set_audience_link_input_entity_v1
|
|
5841
5887
|
return self.update_ad_set_audience_endpoint.call_with_http_info(**kwargs)
|
|
5842
5888
|
|
|
5843
|
-
def
|
|
5889
|
+
def update_marketplace_seller_budget(
|
|
5844
5890
|
self,
|
|
5845
5891
|
budget_id,
|
|
5846
5892
|
**kwargs
|
|
@@ -5851,7 +5897,7 @@ class CampaignApi(object):
|
|
|
5851
5897
|
This method makes a synchronous HTTP request by default. To make an
|
|
5852
5898
|
asynchronous HTTP request, please pass async_req=True
|
|
5853
5899
|
|
|
5854
|
-
>>> thread = api.
|
|
5900
|
+
>>> thread = api.update_marketplace_seller_budget(budget_id, async_req=True)
|
|
5855
5901
|
>>> result = thread.get()
|
|
5856
5902
|
|
|
5857
5903
|
Args:
|
|
@@ -5891,7 +5937,7 @@ class CampaignApi(object):
|
|
|
5891
5937
|
async_req (bool): execute request asynchronously
|
|
5892
5938
|
|
|
5893
5939
|
Returns:
|
|
5894
|
-
|
|
5940
|
+
SellerBudgetMessage
|
|
5895
5941
|
If the method is called asynchronously, returns the request
|
|
5896
5942
|
thread.
|
|
5897
5943
|
"""
|
|
@@ -5922,9 +5968,9 @@ class CampaignApi(object):
|
|
|
5922
5968
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5923
5969
|
kwargs['budget_id'] = \
|
|
5924
5970
|
budget_id
|
|
5925
|
-
return self.
|
|
5971
|
+
return self.update_marketplace_seller_budget_endpoint.call_with_http_info(**kwargs)
|
|
5926
5972
|
|
|
5927
|
-
def
|
|
5973
|
+
def update_marketplace_seller_budgets(
|
|
5928
5974
|
self,
|
|
5929
5975
|
**kwargs
|
|
5930
5976
|
):
|
|
@@ -5934,7 +5980,7 @@ class CampaignApi(object):
|
|
|
5934
5980
|
This method makes a synchronous HTTP request by default. To make an
|
|
5935
5981
|
asynchronous HTTP request, please pass async_req=True
|
|
5936
5982
|
|
|
5937
|
-
>>> thread = api.
|
|
5983
|
+
>>> thread = api.update_marketplace_seller_budgets(async_req=True)
|
|
5938
5984
|
>>> result = thread.get()
|
|
5939
5985
|
|
|
5940
5986
|
|
|
@@ -5972,7 +6018,7 @@ class CampaignApi(object):
|
|
|
5972
6018
|
async_req (bool): execute request asynchronously
|
|
5973
6019
|
|
|
5974
6020
|
Returns:
|
|
5975
|
-
|
|
6021
|
+
[SellerBudgetMessage]
|
|
5976
6022
|
If the method is called asynchronously, returns the request
|
|
5977
6023
|
thread.
|
|
5978
6024
|
"""
|
|
@@ -6001,9 +6047,9 @@ class CampaignApi(object):
|
|
|
6001
6047
|
'_content_type')
|
|
6002
6048
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
6003
6049
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6004
|
-
return self.
|
|
6050
|
+
return self.update_marketplace_seller_budgets_endpoint.call_with_http_info(**kwargs)
|
|
6005
6051
|
|
|
6006
|
-
def
|
|
6052
|
+
def update_marketplace_seller_campaign(
|
|
6007
6053
|
self,
|
|
6008
6054
|
seller_campaign_id,
|
|
6009
6055
|
**kwargs
|
|
@@ -6014,7 +6060,7 @@ class CampaignApi(object):
|
|
|
6014
6060
|
This method makes a synchronous HTTP request by default. To make an
|
|
6015
6061
|
asynchronous HTTP request, please pass async_req=True
|
|
6016
6062
|
|
|
6017
|
-
>>> thread = api.
|
|
6063
|
+
>>> thread = api.update_marketplace_seller_campaign(seller_campaign_id, async_req=True)
|
|
6018
6064
|
>>> result = thread.get()
|
|
6019
6065
|
|
|
6020
6066
|
Args:
|
|
@@ -6085,9 +6131,9 @@ class CampaignApi(object):
|
|
|
6085
6131
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6086
6132
|
kwargs['seller_campaign_id'] = \
|
|
6087
6133
|
seller_campaign_id
|
|
6088
|
-
return self.
|
|
6134
|
+
return self.update_marketplace_seller_campaign_endpoint.call_with_http_info(**kwargs)
|
|
6089
6135
|
|
|
6090
|
-
def
|
|
6136
|
+
def update_marketplace_seller_campaigns(
|
|
6091
6137
|
self,
|
|
6092
6138
|
**kwargs
|
|
6093
6139
|
):
|
|
@@ -6097,7 +6143,7 @@ class CampaignApi(object):
|
|
|
6097
6143
|
This method makes a synchronous HTTP request by default. To make an
|
|
6098
6144
|
asynchronous HTTP request, please pass async_req=True
|
|
6099
6145
|
|
|
6100
|
-
>>> thread = api.
|
|
6146
|
+
>>> thread = api.update_marketplace_seller_campaigns(async_req=True)
|
|
6101
6147
|
>>> result = thread.get()
|
|
6102
6148
|
|
|
6103
6149
|
|
|
@@ -6164,5 +6210,5 @@ class CampaignApi(object):
|
|
|
6164
6210
|
'_content_type')
|
|
6165
6211
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
6166
6212
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
6167
|
-
return self.
|
|
6213
|
+
return self.update_marketplace_seller_campaigns_endpoint.call_with_http_info(**kwargs)
|
|
6168
6214
|
|