criteo-api-retailmedia-sdk 0.0.250911__py3-none-any.whl → 0.0.250915__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-retailmedia-sdk might be problematic. Click here for more details.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +3 -12
- criteo_api_retailmedia_preview/api/analytics_api.py +18 -63
- criteo_api_retailmedia_preview/api/audience_api.py +25 -88
- criteo_api_retailmedia_preview/api/balance_api.py +176 -186
- criteo_api_retailmedia_preview/api/billing_api.py +2 -7
- criteo_api_retailmedia_preview/api/campaign_api.py +913 -974
- criteo_api_retailmedia_preview/api/catalog_api.py +6 -22
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/models/__init__.py +0 -6
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/RECORD +15 -21
- criteo_api_retailmedia_preview/model/error_code_response.py +0 -281
- criteo_api_retailmedia_preview/model/fail_response.py +0 -283
- criteo_api_retailmedia_preview/model/outcome.py +0 -268
- criteo_api_retailmedia_preview/model/product_importer_error.py +0 -299
- criteo_api_retailmedia_preview/model/product_importer_warning.py +0 -299
- criteo_api_retailmedia_preview/model/report_outcome.py +0 -275
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.250915.dist-info}/top_level.txt +0 -0
|
@@ -36,7 +36,6 @@ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_
|
|
|
36
36
|
from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_catalog_status_v2 import EntityResourceOutcomeOfCatalogStatusV2
|
|
37
37
|
from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_sponsored_products_line_item import EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
38
38
|
from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse
|
|
39
|
-
from criteo_api_retailmedia_preview.model.outcome import Outcome
|
|
40
39
|
from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse
|
|
41
40
|
from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request
|
|
42
41
|
from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request
|
|
@@ -135,27 +134,28 @@ class CampaignApi(object):
|
|
|
135
134
|
},
|
|
136
135
|
api_client=api_client
|
|
137
136
|
)
|
|
138
|
-
self.
|
|
137
|
+
self.append_product_button_by_line_item_id_endpoint = _Endpoint(
|
|
139
138
|
settings={
|
|
140
|
-
'response_type': (
|
|
139
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
141
140
|
'auth': [
|
|
142
141
|
'oauth',
|
|
143
142
|
'oauth'
|
|
144
143
|
],
|
|
145
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
146
|
-
'operation_id': '
|
|
144
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create',
|
|
145
|
+
'operation_id': 'append_product_button_by_line_item_id',
|
|
147
146
|
'http_method': 'POST',
|
|
148
147
|
'servers': None,
|
|
149
148
|
},
|
|
150
149
|
params_map={
|
|
151
150
|
'all': [
|
|
152
151
|
'line_item_id',
|
|
153
|
-
'
|
|
152
|
+
'product_button_request_list_request',
|
|
154
153
|
],
|
|
155
154
|
'required': [
|
|
156
155
|
'line_item_id',
|
|
157
156
|
],
|
|
158
157
|
'nullable': [
|
|
158
|
+
'product_button_request_list_request',
|
|
159
159
|
],
|
|
160
160
|
'enum': [
|
|
161
161
|
],
|
|
@@ -170,15 +170,15 @@ class CampaignApi(object):
|
|
|
170
170
|
'openapi_types': {
|
|
171
171
|
'line_item_id':
|
|
172
172
|
(str,),
|
|
173
|
-
'
|
|
174
|
-
(
|
|
173
|
+
'product_button_request_list_request':
|
|
174
|
+
(ProductButtonRequestListRequest,),
|
|
175
175
|
},
|
|
176
176
|
'attribute_map': {
|
|
177
177
|
'line_item_id': 'line-item-id',
|
|
178
178
|
},
|
|
179
179
|
'location_map': {
|
|
180
180
|
'line_item_id': 'path',
|
|
181
|
-
'
|
|
181
|
+
'product_button_request_list_request': 'body',
|
|
182
182
|
},
|
|
183
183
|
'collection_format_map': {
|
|
184
184
|
}
|
|
@@ -193,72 +193,50 @@ class CampaignApi(object):
|
|
|
193
193
|
},
|
|
194
194
|
api_client=api_client
|
|
195
195
|
)
|
|
196
|
-
self.
|
|
196
|
+
self.append_promoted_products_endpoint = _Endpoint(
|
|
197
197
|
settings={
|
|
198
|
-
'response_type': (
|
|
198
|
+
'response_type': (ProductResourceOutcome,),
|
|
199
199
|
'auth': [
|
|
200
200
|
'oauth',
|
|
201
201
|
'oauth'
|
|
202
202
|
],
|
|
203
|
-
'endpoint_path': '/preview/retail-media/
|
|
204
|
-
'operation_id': '
|
|
203
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/products/append',
|
|
204
|
+
'operation_id': 'append_promoted_products',
|
|
205
205
|
'http_method': 'POST',
|
|
206
206
|
'servers': None,
|
|
207
207
|
},
|
|
208
208
|
params_map={
|
|
209
209
|
'all': [
|
|
210
|
-
'
|
|
211
|
-
'
|
|
212
|
-
'offset',
|
|
213
|
-
'value_resource_input_categories_search_request_v1',
|
|
210
|
+
'line_item_id',
|
|
211
|
+
'promoted_product_resource_collection_input',
|
|
214
212
|
],
|
|
215
213
|
'required': [
|
|
216
|
-
'
|
|
214
|
+
'line_item_id',
|
|
217
215
|
],
|
|
218
216
|
'nullable': [
|
|
219
217
|
],
|
|
220
218
|
'enum': [
|
|
221
219
|
],
|
|
222
220
|
'validation': [
|
|
223
|
-
'limit',
|
|
224
|
-
'offset',
|
|
225
221
|
]
|
|
226
222
|
},
|
|
227
223
|
root_map={
|
|
228
224
|
'validations': {
|
|
229
|
-
('limit',): {
|
|
230
|
-
|
|
231
|
-
'inclusive_maximum': 500,
|
|
232
|
-
'inclusive_minimum': 1,
|
|
233
|
-
},
|
|
234
|
-
('offset',): {
|
|
235
|
-
|
|
236
|
-
'inclusive_maximum': 2147483647,
|
|
237
|
-
'inclusive_minimum': 0,
|
|
238
|
-
},
|
|
239
225
|
},
|
|
240
226
|
'allowed_values': {
|
|
241
227
|
},
|
|
242
228
|
'openapi_types': {
|
|
243
|
-
'
|
|
244
|
-
(
|
|
245
|
-
'
|
|
246
|
-
(
|
|
247
|
-
'offset':
|
|
248
|
-
(int,),
|
|
249
|
-
'value_resource_input_categories_search_request_v1':
|
|
250
|
-
(ValueResourceInputCategoriesSearchRequestV1,),
|
|
229
|
+
'line_item_id':
|
|
230
|
+
(str,),
|
|
231
|
+
'promoted_product_resource_collection_input':
|
|
232
|
+
(PromotedProductResourceCollectionInput,),
|
|
251
233
|
},
|
|
252
234
|
'attribute_map': {
|
|
253
|
-
'
|
|
254
|
-
'limit': 'limit',
|
|
255
|
-
'offset': 'offset',
|
|
235
|
+
'line_item_id': 'line-item-id',
|
|
256
236
|
},
|
|
257
237
|
'location_map': {
|
|
258
|
-
'
|
|
259
|
-
'
|
|
260
|
-
'offset': 'query',
|
|
261
|
-
'value_resource_input_categories_search_request_v1': 'body',
|
|
238
|
+
'line_item_id': 'path',
|
|
239
|
+
'promoted_product_resource_collection_input': 'body',
|
|
262
240
|
},
|
|
263
241
|
'collection_format_map': {
|
|
264
242
|
}
|
|
@@ -268,10 +246,7 @@ class CampaignApi(object):
|
|
|
268
246
|
'application/json'
|
|
269
247
|
],
|
|
270
248
|
'content_type': [
|
|
271
|
-
'application/json
|
|
272
|
-
'application/json',
|
|
273
|
-
'text/json',
|
|
274
|
-
'application/*+json'
|
|
249
|
+
'application/json'
|
|
275
250
|
]
|
|
276
251
|
},
|
|
277
252
|
api_client=api_client
|
|
@@ -329,14 +304,70 @@ class CampaignApi(object):
|
|
|
329
304
|
'application/json'
|
|
330
305
|
],
|
|
331
306
|
'content_type': [
|
|
332
|
-
'application/json'
|
|
333
|
-
|
|
334
|
-
|
|
307
|
+
'application/json'
|
|
308
|
+
]
|
|
309
|
+
},
|
|
310
|
+
api_client=api_client
|
|
311
|
+
)
|
|
312
|
+
self.create_preferred_line_item_by_campaign_id_endpoint = _Endpoint(
|
|
313
|
+
settings={
|
|
314
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
315
|
+
'auth': [
|
|
316
|
+
'oauth',
|
|
317
|
+
'oauth'
|
|
318
|
+
],
|
|
319
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
320
|
+
'operation_id': 'create_preferred_line_item_by_campaign_id',
|
|
321
|
+
'http_method': 'POST',
|
|
322
|
+
'servers': None,
|
|
323
|
+
},
|
|
324
|
+
params_map={
|
|
325
|
+
'all': [
|
|
326
|
+
'campaign_id',
|
|
327
|
+
'preferred_line_item_create_model_v2_request',
|
|
328
|
+
],
|
|
329
|
+
'required': [
|
|
330
|
+
'campaign_id',
|
|
331
|
+
],
|
|
332
|
+
'nullable': [
|
|
333
|
+
],
|
|
334
|
+
'enum': [
|
|
335
|
+
],
|
|
336
|
+
'validation': [
|
|
337
|
+
]
|
|
338
|
+
},
|
|
339
|
+
root_map={
|
|
340
|
+
'validations': {
|
|
341
|
+
},
|
|
342
|
+
'allowed_values': {
|
|
343
|
+
},
|
|
344
|
+
'openapi_types': {
|
|
345
|
+
'campaign_id':
|
|
346
|
+
(str,),
|
|
347
|
+
'preferred_line_item_create_model_v2_request':
|
|
348
|
+
(PreferredLineItemCreateModelV2Request,),
|
|
349
|
+
},
|
|
350
|
+
'attribute_map': {
|
|
351
|
+
'campaign_id': 'campaign-id',
|
|
352
|
+
},
|
|
353
|
+
'location_map': {
|
|
354
|
+
'campaign_id': 'path',
|
|
355
|
+
'preferred_line_item_create_model_v2_request': 'body',
|
|
356
|
+
},
|
|
357
|
+
'collection_format_map': {
|
|
358
|
+
}
|
|
359
|
+
},
|
|
360
|
+
headers_map={
|
|
361
|
+
'accept': [
|
|
362
|
+
'application/json'
|
|
363
|
+
],
|
|
364
|
+
'content_type': [
|
|
365
|
+
'application/json'
|
|
335
366
|
]
|
|
336
367
|
},
|
|
337
368
|
api_client=api_client
|
|
338
369
|
)
|
|
339
|
-
self.
|
|
370
|
+
self.delete_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
340
371
|
settings={
|
|
341
372
|
'response_type': (ProductButtonResponseListResponse,),
|
|
342
373
|
'auth': [
|
|
@@ -344,7 +375,7 @@ class CampaignApi(object):
|
|
|
344
375
|
'oauth'
|
|
345
376
|
],
|
|
346
377
|
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
347
|
-
'operation_id': '
|
|
378
|
+
'operation_id': 'delete_product_button_by_line_item_and_product_button_id',
|
|
348
379
|
'http_method': 'DELETE',
|
|
349
380
|
'servers': None,
|
|
350
381
|
},
|
|
@@ -388,9 +419,7 @@ class CampaignApi(object):
|
|
|
388
419
|
},
|
|
389
420
|
headers_map={
|
|
390
421
|
'accept': [
|
|
391
|
-
'
|
|
392
|
-
'application/json',
|
|
393
|
-
'text/json'
|
|
422
|
+
'application/json'
|
|
394
423
|
],
|
|
395
424
|
'content_type': [],
|
|
396
425
|
},
|
|
@@ -445,9 +474,7 @@ class CampaignApi(object):
|
|
|
445
474
|
}
|
|
446
475
|
},
|
|
447
476
|
headers_map={
|
|
448
|
-
'accept': [
|
|
449
|
-
'application/json'
|
|
450
|
-
],
|
|
477
|
+
'accept': [],
|
|
451
478
|
'content_type': [
|
|
452
479
|
'application/json'
|
|
453
480
|
]
|
|
@@ -573,26 +600,24 @@ class CampaignApi(object):
|
|
|
573
600
|
},
|
|
574
601
|
api_client=api_client
|
|
575
602
|
)
|
|
576
|
-
self.
|
|
603
|
+
self.get_api_external_v2_catalog_status_by_catalog_id_endpoint = _Endpoint(
|
|
577
604
|
settings={
|
|
578
|
-
'response_type': (
|
|
605
|
+
'response_type': (EntityResourceOutcomeOfCatalogStatusV2,),
|
|
579
606
|
'auth': [
|
|
580
607
|
'oauth',
|
|
581
608
|
'oauth'
|
|
582
609
|
],
|
|
583
|
-
'endpoint_path': '/preview/retail-media/
|
|
584
|
-
'operation_id': '
|
|
610
|
+
'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/status',
|
|
611
|
+
'operation_id': 'get_api_external_v2_catalog_status_by_catalog_id',
|
|
585
612
|
'http_method': 'GET',
|
|
586
613
|
'servers': None,
|
|
587
614
|
},
|
|
588
615
|
params_map={
|
|
589
616
|
'all': [
|
|
590
|
-
'
|
|
591
|
-
'product_button_id',
|
|
617
|
+
'catalog_id',
|
|
592
618
|
],
|
|
593
619
|
'required': [
|
|
594
|
-
'
|
|
595
|
-
'product_button_id',
|
|
620
|
+
'catalog_id',
|
|
596
621
|
],
|
|
597
622
|
'nullable': [
|
|
598
623
|
],
|
|
@@ -607,54 +632,52 @@ class CampaignApi(object):
|
|
|
607
632
|
'allowed_values': {
|
|
608
633
|
},
|
|
609
634
|
'openapi_types': {
|
|
610
|
-
'
|
|
611
|
-
(str,),
|
|
612
|
-
'product_button_id':
|
|
635
|
+
'catalog_id':
|
|
613
636
|
(str,),
|
|
614
637
|
},
|
|
615
638
|
'attribute_map': {
|
|
616
|
-
'
|
|
617
|
-
'product_button_id': 'product-button-id',
|
|
639
|
+
'catalog_id': 'catalogId',
|
|
618
640
|
},
|
|
619
641
|
'location_map': {
|
|
620
|
-
'
|
|
621
|
-
'product_button_id': 'path',
|
|
642
|
+
'catalog_id': 'path',
|
|
622
643
|
},
|
|
623
644
|
'collection_format_map': {
|
|
624
645
|
}
|
|
625
646
|
},
|
|
626
647
|
headers_map={
|
|
627
648
|
'accept': [
|
|
628
|
-
'
|
|
629
|
-
'application/json',
|
|
630
|
-
'text/json'
|
|
649
|
+
'application/json'
|
|
631
650
|
],
|
|
632
651
|
'content_type': [],
|
|
633
652
|
},
|
|
634
653
|
api_client=api_client
|
|
635
654
|
)
|
|
636
|
-
self.
|
|
655
|
+
self.get_api_v1_external_retailer_brands_by_retailer_id_endpoint = _Endpoint(
|
|
637
656
|
settings={
|
|
638
|
-
'response_type': (
|
|
657
|
+
'response_type': (BrandPreviewListResponse,),
|
|
639
658
|
'auth': [
|
|
640
659
|
'oauth',
|
|
641
660
|
'oauth'
|
|
642
661
|
],
|
|
643
|
-
'endpoint_path': '/preview/retail-media/
|
|
644
|
-
'operation_id': '
|
|
662
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/brands',
|
|
663
|
+
'operation_id': 'get_api_v1_external_retailer_brands_by_retailer_id',
|
|
645
664
|
'http_method': 'GET',
|
|
646
665
|
'servers': None,
|
|
647
666
|
},
|
|
648
667
|
params_map={
|
|
649
668
|
'all': [
|
|
650
|
-
'
|
|
669
|
+
'retailer_id',
|
|
670
|
+
'brand_type',
|
|
671
|
+
'sku_stock_type_filter',
|
|
651
672
|
],
|
|
652
673
|
'required': [
|
|
653
|
-
'
|
|
674
|
+
'retailer_id',
|
|
654
675
|
],
|
|
655
676
|
'nullable': [
|
|
656
677
|
],
|
|
657
678
|
'enum': [
|
|
679
|
+
'brand_type',
|
|
680
|
+
'sku_stock_type_filter',
|
|
658
681
|
],
|
|
659
682
|
'validation': [
|
|
660
683
|
]
|
|
@@ -663,130 +686,125 @@ class CampaignApi(object):
|
|
|
663
686
|
'validations': {
|
|
664
687
|
},
|
|
665
688
|
'allowed_values': {
|
|
689
|
+
('brand_type',): {
|
|
690
|
+
|
|
691
|
+
"ALL": "all",
|
|
692
|
+
"UC": "uc",
|
|
693
|
+
"RETAILER": "retailer"
|
|
694
|
+
},
|
|
695
|
+
('sku_stock_type_filter',): {
|
|
696
|
+
|
|
697
|
+
"FIRST-PARTY": "first-party",
|
|
698
|
+
"THIRD-PARTY": "third-party",
|
|
699
|
+
"FIRST-AND-THIRD-PARTY": "first-and-third-party"
|
|
700
|
+
},
|
|
666
701
|
},
|
|
667
702
|
'openapi_types': {
|
|
668
|
-
'
|
|
703
|
+
'retailer_id':
|
|
704
|
+
(int,),
|
|
705
|
+
'brand_type':
|
|
706
|
+
(str,),
|
|
707
|
+
'sku_stock_type_filter':
|
|
669
708
|
(str,),
|
|
670
709
|
},
|
|
671
710
|
'attribute_map': {
|
|
672
|
-
'
|
|
711
|
+
'retailer_id': 'retailerId',
|
|
712
|
+
'brand_type': 'brand-type',
|
|
713
|
+
'sku_stock_type_filter': 'sku-stock-type-filter',
|
|
673
714
|
},
|
|
674
715
|
'location_map': {
|
|
675
|
-
'
|
|
716
|
+
'retailer_id': 'path',
|
|
717
|
+
'brand_type': 'query',
|
|
718
|
+
'sku_stock_type_filter': 'query',
|
|
676
719
|
},
|
|
677
720
|
'collection_format_map': {
|
|
678
721
|
}
|
|
679
722
|
},
|
|
680
723
|
headers_map={
|
|
681
724
|
'accept': [
|
|
682
|
-
'
|
|
683
|
-
'application/json',
|
|
684
|
-
'text/json'
|
|
725
|
+
'application/json'
|
|
685
726
|
],
|
|
686
727
|
'content_type': [],
|
|
687
728
|
},
|
|
688
729
|
api_client=api_client
|
|
689
730
|
)
|
|
690
|
-
self.
|
|
731
|
+
self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint = _Endpoint(
|
|
691
732
|
settings={
|
|
692
|
-
'response_type': (
|
|
733
|
+
'response_type': (SellerPreviewResponse,),
|
|
693
734
|
'auth': [
|
|
694
735
|
'oauth',
|
|
695
736
|
'oauth'
|
|
696
737
|
],
|
|
697
|
-
'endpoint_path': '/preview/retail-media/
|
|
698
|
-
'operation_id': '
|
|
738
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/sellers/{seller}',
|
|
739
|
+
'operation_id': 'get_api_v1_external_retailer_by_retailer_id_seller_by_seller',
|
|
699
740
|
'http_method': 'GET',
|
|
700
741
|
'servers': None,
|
|
701
742
|
},
|
|
702
743
|
params_map={
|
|
703
744
|
'all': [
|
|
704
|
-
'
|
|
705
|
-
'
|
|
706
|
-
'page_index',
|
|
707
|
-
'page_size',
|
|
745
|
+
'retailer_id',
|
|
746
|
+
'seller',
|
|
708
747
|
],
|
|
709
748
|
'required': [
|
|
710
|
-
'
|
|
749
|
+
'retailer_id',
|
|
750
|
+
'seller',
|
|
711
751
|
],
|
|
712
752
|
'nullable': [
|
|
713
753
|
],
|
|
714
754
|
'enum': [
|
|
715
755
|
],
|
|
716
756
|
'validation': [
|
|
717
|
-
'page_index',
|
|
718
|
-
'page_size',
|
|
719
757
|
]
|
|
720
758
|
},
|
|
721
759
|
root_map={
|
|
722
760
|
'validations': {
|
|
723
|
-
('page_index',): {
|
|
724
|
-
|
|
725
|
-
'inclusive_maximum': 2147483647,
|
|
726
|
-
'inclusive_minimum': 0,
|
|
727
|
-
},
|
|
728
|
-
('page_size',): {
|
|
729
|
-
|
|
730
|
-
'inclusive_maximum': 2147483647,
|
|
731
|
-
'inclusive_minimum': 1,
|
|
732
|
-
},
|
|
733
761
|
},
|
|
734
762
|
'allowed_values': {
|
|
735
763
|
},
|
|
736
764
|
'openapi_types': {
|
|
737
|
-
'
|
|
738
|
-
(str,),
|
|
739
|
-
'limit_to_id':
|
|
740
|
-
([str],),
|
|
741
|
-
'page_index':
|
|
742
|
-
(int,),
|
|
743
|
-
'page_size':
|
|
765
|
+
'retailer_id':
|
|
744
766
|
(int,),
|
|
767
|
+
'seller':
|
|
768
|
+
(str,),
|
|
745
769
|
},
|
|
746
770
|
'attribute_map': {
|
|
747
|
-
'
|
|
748
|
-
'
|
|
749
|
-
'page_index': 'pageIndex',
|
|
750
|
-
'page_size': 'pageSize',
|
|
771
|
+
'retailer_id': 'retailerId',
|
|
772
|
+
'seller': 'seller',
|
|
751
773
|
},
|
|
752
774
|
'location_map': {
|
|
753
|
-
'
|
|
754
|
-
'
|
|
755
|
-
'page_index': 'query',
|
|
756
|
-
'page_size': 'query',
|
|
775
|
+
'retailer_id': 'path',
|
|
776
|
+
'seller': 'path',
|
|
757
777
|
},
|
|
758
778
|
'collection_format_map': {
|
|
759
|
-
'limit_to_id': 'multi',
|
|
760
779
|
}
|
|
761
780
|
},
|
|
762
781
|
headers_map={
|
|
763
782
|
'accept': [
|
|
764
|
-
'
|
|
765
|
-
'application/json',
|
|
766
|
-
'text/json'
|
|
783
|
+
'application/json'
|
|
767
784
|
],
|
|
768
785
|
'content_type': [],
|
|
769
786
|
},
|
|
770
787
|
api_client=api_client
|
|
771
788
|
)
|
|
772
|
-
self.
|
|
789
|
+
self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint = _Endpoint(
|
|
773
790
|
settings={
|
|
774
|
-
'response_type': (
|
|
791
|
+
'response_type': (CpcRateCardPreviewResponse,),
|
|
775
792
|
'auth': [
|
|
776
793
|
'oauth',
|
|
777
794
|
'oauth'
|
|
778
795
|
],
|
|
779
|
-
'endpoint_path': '/preview/retail-media/
|
|
780
|
-
'operation_id': '
|
|
796
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/cpc-rates',
|
|
797
|
+
'operation_id': 'get_api_v1_external_retailer_category_cpc_rates_by_retailer_id',
|
|
781
798
|
'http_method': 'GET',
|
|
782
799
|
'servers': None,
|
|
783
800
|
},
|
|
784
801
|
params_map={
|
|
785
802
|
'all': [
|
|
786
|
-
'
|
|
803
|
+
'retailer_id',
|
|
804
|
+
'fields',
|
|
787
805
|
],
|
|
788
806
|
'required': [
|
|
789
|
-
'
|
|
807
|
+
'retailer_id',
|
|
790
808
|
],
|
|
791
809
|
'nullable': [
|
|
792
810
|
],
|
|
@@ -801,46 +819,49 @@ class CampaignApi(object):
|
|
|
801
819
|
'allowed_values': {
|
|
802
820
|
},
|
|
803
821
|
'openapi_types': {
|
|
804
|
-
'
|
|
822
|
+
'retailer_id':
|
|
805
823
|
(str,),
|
|
806
|
-
|
|
824
|
+
'fields':
|
|
825
|
+
([str],),
|
|
826
|
+
},
|
|
807
827
|
'attribute_map': {
|
|
808
|
-
'
|
|
828
|
+
'retailer_id': 'retailer-id',
|
|
829
|
+
'fields': 'fields',
|
|
809
830
|
},
|
|
810
831
|
'location_map': {
|
|
811
|
-
'
|
|
832
|
+
'retailer_id': 'path',
|
|
833
|
+
'fields': 'query',
|
|
812
834
|
},
|
|
813
835
|
'collection_format_map': {
|
|
836
|
+
'fields': 'multi',
|
|
814
837
|
}
|
|
815
838
|
},
|
|
816
839
|
headers_map={
|
|
817
840
|
'accept': [
|
|
818
|
-
'
|
|
819
|
-
'application/json',
|
|
820
|
-
'text/json'
|
|
841
|
+
'application/json'
|
|
821
842
|
],
|
|
822
843
|
'content_type': [],
|
|
823
844
|
},
|
|
824
845
|
api_client=api_client
|
|
825
846
|
)
|
|
826
|
-
self.
|
|
847
|
+
self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint = _Endpoint(
|
|
827
848
|
settings={
|
|
828
|
-
'response_type': (
|
|
849
|
+
'response_type': (PlacementPreviewListResponse,),
|
|
829
850
|
'auth': [
|
|
830
851
|
'oauth',
|
|
831
852
|
'oauth'
|
|
832
853
|
],
|
|
833
|
-
'endpoint_path': '/preview/retail-media/
|
|
834
|
-
'operation_id': '
|
|
854
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/placements',
|
|
855
|
+
'operation_id': 'get_api_v1_external_retailer_placements_by_retailer_id',
|
|
835
856
|
'http_method': 'GET',
|
|
836
857
|
'servers': None,
|
|
837
858
|
},
|
|
838
859
|
params_map={
|
|
839
860
|
'all': [
|
|
840
|
-
'
|
|
861
|
+
'retailer_id',
|
|
841
862
|
],
|
|
842
863
|
'required': [
|
|
843
|
-
'
|
|
864
|
+
'retailer_id',
|
|
844
865
|
],
|
|
845
866
|
'nullable': [
|
|
846
867
|
],
|
|
@@ -855,54 +876,50 @@ class CampaignApi(object):
|
|
|
855
876
|
'allowed_values': {
|
|
856
877
|
},
|
|
857
878
|
'openapi_types': {
|
|
858
|
-
'
|
|
879
|
+
'retailer_id':
|
|
859
880
|
(str,),
|
|
860
881
|
},
|
|
861
882
|
'attribute_map': {
|
|
862
|
-
'
|
|
883
|
+
'retailer_id': 'retailer-id',
|
|
863
884
|
},
|
|
864
885
|
'location_map': {
|
|
865
|
-
'
|
|
886
|
+
'retailer_id': 'path',
|
|
866
887
|
},
|
|
867
888
|
'collection_format_map': {
|
|
868
889
|
}
|
|
869
890
|
},
|
|
870
891
|
headers_map={
|
|
871
892
|
'accept': [
|
|
872
|
-
'
|
|
873
|
-
'application/json',
|
|
874
|
-
'text/json'
|
|
893
|
+
'application/json'
|
|
875
894
|
],
|
|
876
895
|
'content_type': [],
|
|
877
896
|
},
|
|
878
897
|
api_client=api_client
|
|
879
898
|
)
|
|
880
|
-
self.
|
|
899
|
+
self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
|
|
881
900
|
settings={
|
|
882
|
-
'response_type': (
|
|
901
|
+
'response_type': (Creative2Response,),
|
|
883
902
|
'auth': [
|
|
884
903
|
'oauth',
|
|
885
904
|
'oauth'
|
|
886
905
|
],
|
|
887
|
-
'endpoint_path': '/preview/retail-media/
|
|
888
|
-
'operation_id': '
|
|
906
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
907
|
+
'operation_id': 'get_api_v2_external_account_by_account_id_creativescreative_id',
|
|
889
908
|
'http_method': 'GET',
|
|
890
909
|
'servers': None,
|
|
891
910
|
},
|
|
892
911
|
params_map={
|
|
893
912
|
'all': [
|
|
894
|
-
'
|
|
895
|
-
'
|
|
896
|
-
'sku_stock_type_filter',
|
|
913
|
+
'account_id',
|
|
914
|
+
'creative_id',
|
|
897
915
|
],
|
|
898
916
|
'required': [
|
|
899
|
-
'
|
|
917
|
+
'account_id',
|
|
918
|
+
'creative_id',
|
|
900
919
|
],
|
|
901
920
|
'nullable': [
|
|
902
921
|
],
|
|
903
922
|
'enum': [
|
|
904
|
-
'brand_type',
|
|
905
|
-
'sku_stock_type_filter',
|
|
906
923
|
],
|
|
907
924
|
'validation': [
|
|
908
925
|
]
|
|
@@ -911,36 +928,20 @@ class CampaignApi(object):
|
|
|
911
928
|
'validations': {
|
|
912
929
|
},
|
|
913
930
|
'allowed_values': {
|
|
914
|
-
('brand_type',): {
|
|
915
|
-
|
|
916
|
-
"ALL": "all",
|
|
917
|
-
"UC": "uc",
|
|
918
|
-
"RETAILER": "retailer"
|
|
919
|
-
},
|
|
920
|
-
('sku_stock_type_filter',): {
|
|
921
|
-
|
|
922
|
-
"FIRST-PARTY": "first-party",
|
|
923
|
-
"THIRD-PARTY": "third-party",
|
|
924
|
-
"FIRST-AND-THIRD-PARTY": "first-and-third-party"
|
|
925
|
-
},
|
|
926
931
|
},
|
|
927
932
|
'openapi_types': {
|
|
928
|
-
'
|
|
929
|
-
(int,),
|
|
930
|
-
'brand_type':
|
|
933
|
+
'account_id':
|
|
931
934
|
(str,),
|
|
932
|
-
'
|
|
935
|
+
'creative_id':
|
|
933
936
|
(str,),
|
|
934
937
|
},
|
|
935
938
|
'attribute_map': {
|
|
936
|
-
'
|
|
937
|
-
'
|
|
938
|
-
'sku_stock_type_filter': 'sku-stock-type-filter',
|
|
939
|
+
'account_id': 'account-id',
|
|
940
|
+
'creative_id': 'creative-id',
|
|
939
941
|
},
|
|
940
942
|
'location_map': {
|
|
941
|
-
'
|
|
942
|
-
'
|
|
943
|
-
'sku_stock_type_filter': 'query',
|
|
943
|
+
'account_id': 'path',
|
|
944
|
+
'creative_id': 'path',
|
|
944
945
|
},
|
|
945
946
|
'collection_format_map': {
|
|
946
947
|
}
|
|
@@ -953,26 +954,24 @@ class CampaignApi(object):
|
|
|
953
954
|
},
|
|
954
955
|
api_client=api_client
|
|
955
956
|
)
|
|
956
|
-
self.
|
|
957
|
+
self.get_auction_line_item_v2_endpoint = _Endpoint(
|
|
957
958
|
settings={
|
|
958
|
-
'response_type': (
|
|
959
|
+
'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
|
|
959
960
|
'auth': [
|
|
960
961
|
'oauth',
|
|
961
962
|
'oauth'
|
|
962
963
|
],
|
|
963
|
-
'endpoint_path': '/preview/retail-media/
|
|
964
|
-
'operation_id': '
|
|
964
|
+
'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
|
|
965
|
+
'operation_id': 'get_auction_line_item_v2',
|
|
965
966
|
'http_method': 'GET',
|
|
966
967
|
'servers': None,
|
|
967
968
|
},
|
|
968
969
|
params_map={
|
|
969
970
|
'all': [
|
|
970
|
-
'
|
|
971
|
-
'seller',
|
|
971
|
+
'line_item_id',
|
|
972
972
|
],
|
|
973
973
|
'required': [
|
|
974
|
-
'
|
|
975
|
-
'seller',
|
|
974
|
+
'line_item_id',
|
|
976
975
|
],
|
|
977
976
|
'nullable': [
|
|
978
977
|
],
|
|
@@ -987,18 +986,14 @@ class CampaignApi(object):
|
|
|
987
986
|
'allowed_values': {
|
|
988
987
|
},
|
|
989
988
|
'openapi_types': {
|
|
990
|
-
'
|
|
989
|
+
'line_item_id':
|
|
991
990
|
(int,),
|
|
992
|
-
'seller':
|
|
993
|
-
(str,),
|
|
994
991
|
},
|
|
995
992
|
'attribute_map': {
|
|
996
|
-
'
|
|
997
|
-
'seller': 'seller',
|
|
993
|
+
'line_item_id': 'lineItemId',
|
|
998
994
|
},
|
|
999
995
|
'location_map': {
|
|
1000
|
-
'
|
|
1001
|
-
'seller': 'path',
|
|
996
|
+
'line_item_id': 'path',
|
|
1002
997
|
},
|
|
1003
998
|
'collection_format_map': {
|
|
1004
999
|
}
|
|
@@ -1011,54 +1006,76 @@ class CampaignApi(object):
|
|
|
1011
1006
|
},
|
|
1012
1007
|
api_client=api_client
|
|
1013
1008
|
)
|
|
1014
|
-
self.
|
|
1009
|
+
self.get_auction_line_items_by_campaign_id_v2_endpoint = _Endpoint(
|
|
1015
1010
|
settings={
|
|
1016
|
-
'response_type': (
|
|
1011
|
+
'response_type': (EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata,),
|
|
1017
1012
|
'auth': [
|
|
1018
1013
|
'oauth',
|
|
1019
1014
|
'oauth'
|
|
1020
1015
|
],
|
|
1021
|
-
'endpoint_path': '/preview/retail-media/
|
|
1022
|
-
'operation_id': '
|
|
1016
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/auction-line-items',
|
|
1017
|
+
'operation_id': 'get_auction_line_items_by_campaign_id_v2',
|
|
1023
1018
|
'http_method': 'GET',
|
|
1024
1019
|
'servers': None,
|
|
1025
1020
|
},
|
|
1026
1021
|
params_map={
|
|
1027
1022
|
'all': [
|
|
1028
|
-
'
|
|
1029
|
-
'
|
|
1023
|
+
'campaign_id',
|
|
1024
|
+
'limit_to_id',
|
|
1025
|
+
'page_index',
|
|
1026
|
+
'page_size',
|
|
1030
1027
|
],
|
|
1031
1028
|
'required': [
|
|
1032
|
-
'
|
|
1029
|
+
'campaign_id',
|
|
1033
1030
|
],
|
|
1034
1031
|
'nullable': [
|
|
1035
1032
|
],
|
|
1036
1033
|
'enum': [
|
|
1037
1034
|
],
|
|
1038
1035
|
'validation': [
|
|
1036
|
+
'page_index',
|
|
1037
|
+
'page_size',
|
|
1039
1038
|
]
|
|
1040
1039
|
},
|
|
1041
1040
|
root_map={
|
|
1042
1041
|
'validations': {
|
|
1042
|
+
('page_index',): {
|
|
1043
|
+
|
|
1044
|
+
'inclusive_maximum': 2147483647,
|
|
1045
|
+
'inclusive_minimum': 0,
|
|
1046
|
+
},
|
|
1047
|
+
('page_size',): {
|
|
1048
|
+
|
|
1049
|
+
'inclusive_maximum': 2147483647,
|
|
1050
|
+
'inclusive_minimum': 1,
|
|
1051
|
+
},
|
|
1043
1052
|
},
|
|
1044
1053
|
'allowed_values': {
|
|
1045
1054
|
},
|
|
1046
1055
|
'openapi_types': {
|
|
1047
|
-
'
|
|
1056
|
+
'campaign_id':
|
|
1048
1057
|
(str,),
|
|
1049
|
-
'
|
|
1058
|
+
'limit_to_id':
|
|
1050
1059
|
([str],),
|
|
1060
|
+
'page_index':
|
|
1061
|
+
(int,),
|
|
1062
|
+
'page_size':
|
|
1063
|
+
(int,),
|
|
1051
1064
|
},
|
|
1052
1065
|
'attribute_map': {
|
|
1053
|
-
'
|
|
1054
|
-
'
|
|
1066
|
+
'campaign_id': 'campaignId',
|
|
1067
|
+
'limit_to_id': 'limitToId',
|
|
1068
|
+
'page_index': 'pageIndex',
|
|
1069
|
+
'page_size': 'pageSize',
|
|
1055
1070
|
},
|
|
1056
1071
|
'location_map': {
|
|
1057
|
-
'
|
|
1058
|
-
'
|
|
1072
|
+
'campaign_id': 'path',
|
|
1073
|
+
'limit_to_id': 'query',
|
|
1074
|
+
'page_index': 'query',
|
|
1075
|
+
'page_size': 'query',
|
|
1059
1076
|
},
|
|
1060
1077
|
'collection_format_map': {
|
|
1061
|
-
'
|
|
1078
|
+
'limit_to_id': 'multi',
|
|
1062
1079
|
}
|
|
1063
1080
|
},
|
|
1064
1081
|
headers_map={
|
|
@@ -1069,48 +1086,76 @@ class CampaignApi(object):
|
|
|
1069
1086
|
},
|
|
1070
1087
|
api_client=api_client
|
|
1071
1088
|
)
|
|
1072
|
-
self.
|
|
1089
|
+
self.get_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1073
1090
|
settings={
|
|
1074
|
-
'response_type': (
|
|
1091
|
+
'response_type': (PreferredLineItemV2PagedListResponse,),
|
|
1075
1092
|
'auth': [
|
|
1076
1093
|
'oauth',
|
|
1077
1094
|
'oauth'
|
|
1078
1095
|
],
|
|
1079
|
-
'endpoint_path': '/preview/retail-media/
|
|
1080
|
-
'operation_id': '
|
|
1096
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
1097
|
+
'operation_id': 'get_preferred_line_items_by_campaign_id',
|
|
1081
1098
|
'http_method': 'GET',
|
|
1082
1099
|
'servers': None,
|
|
1083
1100
|
},
|
|
1084
1101
|
params_map={
|
|
1085
1102
|
'all': [
|
|
1086
|
-
'
|
|
1103
|
+
'campaign_id',
|
|
1104
|
+
'limit_to_id',
|
|
1105
|
+
'page_index',
|
|
1106
|
+
'page_size',
|
|
1087
1107
|
],
|
|
1088
1108
|
'required': [
|
|
1089
|
-
'
|
|
1109
|
+
'campaign_id',
|
|
1090
1110
|
],
|
|
1091
1111
|
'nullable': [
|
|
1092
1112
|
],
|
|
1093
1113
|
'enum': [
|
|
1094
1114
|
],
|
|
1095
1115
|
'validation': [
|
|
1116
|
+
'page_index',
|
|
1117
|
+
'page_size',
|
|
1096
1118
|
]
|
|
1097
1119
|
},
|
|
1098
1120
|
root_map={
|
|
1099
1121
|
'validations': {
|
|
1122
|
+
('page_index',): {
|
|
1123
|
+
|
|
1124
|
+
'inclusive_maximum': 2147483647,
|
|
1125
|
+
'inclusive_minimum': 0,
|
|
1126
|
+
},
|
|
1127
|
+
('page_size',): {
|
|
1128
|
+
|
|
1129
|
+
'inclusive_maximum': 2147483647,
|
|
1130
|
+
'inclusive_minimum': 1,
|
|
1131
|
+
},
|
|
1100
1132
|
},
|
|
1101
1133
|
'allowed_values': {
|
|
1102
1134
|
},
|
|
1103
1135
|
'openapi_types': {
|
|
1104
|
-
'
|
|
1136
|
+
'campaign_id':
|
|
1105
1137
|
(str,),
|
|
1138
|
+
'limit_to_id':
|
|
1139
|
+
([str],),
|
|
1140
|
+
'page_index':
|
|
1141
|
+
(int,),
|
|
1142
|
+
'page_size':
|
|
1143
|
+
(int,),
|
|
1106
1144
|
},
|
|
1107
1145
|
'attribute_map': {
|
|
1108
|
-
'
|
|
1146
|
+
'campaign_id': 'campaign-id',
|
|
1147
|
+
'limit_to_id': 'limitToId',
|
|
1148
|
+
'page_index': 'pageIndex',
|
|
1149
|
+
'page_size': 'pageSize',
|
|
1109
1150
|
},
|
|
1110
1151
|
'location_map': {
|
|
1111
|
-
'
|
|
1152
|
+
'campaign_id': 'path',
|
|
1153
|
+
'limit_to_id': 'query',
|
|
1154
|
+
'page_index': 'query',
|
|
1155
|
+
'page_size': 'query',
|
|
1112
1156
|
},
|
|
1113
1157
|
'collection_format_map': {
|
|
1158
|
+
'limit_to_id': 'multi',
|
|
1114
1159
|
}
|
|
1115
1160
|
},
|
|
1116
1161
|
headers_map={
|
|
@@ -1121,26 +1166,24 @@ class CampaignApi(object):
|
|
|
1121
1166
|
},
|
|
1122
1167
|
api_client=api_client
|
|
1123
1168
|
)
|
|
1124
|
-
self.
|
|
1169
|
+
self.get_preferred_line_items_by_line_item_id_endpoint = _Endpoint(
|
|
1125
1170
|
settings={
|
|
1126
|
-
'response_type': (
|
|
1171
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1127
1172
|
'auth': [
|
|
1128
1173
|
'oauth',
|
|
1129
1174
|
'oauth'
|
|
1130
1175
|
],
|
|
1131
|
-
'endpoint_path': '/preview/retail-media/
|
|
1132
|
-
'operation_id': '
|
|
1176
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
1177
|
+
'operation_id': 'get_preferred_line_items_by_line_item_id',
|
|
1133
1178
|
'http_method': 'GET',
|
|
1134
1179
|
'servers': None,
|
|
1135
1180
|
},
|
|
1136
1181
|
params_map={
|
|
1137
1182
|
'all': [
|
|
1138
|
-
'
|
|
1139
|
-
'creative_id',
|
|
1183
|
+
'line_item_id',
|
|
1140
1184
|
],
|
|
1141
1185
|
'required': [
|
|
1142
|
-
'
|
|
1143
|
-
'creative_id',
|
|
1186
|
+
'line_item_id',
|
|
1144
1187
|
],
|
|
1145
1188
|
'nullable': [
|
|
1146
1189
|
],
|
|
@@ -1155,50 +1198,46 @@ class CampaignApi(object):
|
|
|
1155
1198
|
'allowed_values': {
|
|
1156
1199
|
},
|
|
1157
1200
|
'openapi_types': {
|
|
1158
|
-
'
|
|
1159
|
-
(str,),
|
|
1160
|
-
'creative_id':
|
|
1201
|
+
'line_item_id':
|
|
1161
1202
|
(str,),
|
|
1162
1203
|
},
|
|
1163
1204
|
'attribute_map': {
|
|
1164
|
-
'
|
|
1165
|
-
'creative_id': 'creative-id',
|
|
1205
|
+
'line_item_id': 'line-item-id',
|
|
1166
1206
|
},
|
|
1167
1207
|
'location_map': {
|
|
1168
|
-
'
|
|
1169
|
-
'creative_id': 'path',
|
|
1208
|
+
'line_item_id': 'path',
|
|
1170
1209
|
},
|
|
1171
1210
|
'collection_format_map': {
|
|
1172
1211
|
}
|
|
1173
1212
|
},
|
|
1174
1213
|
headers_map={
|
|
1175
1214
|
'accept': [
|
|
1176
|
-
'
|
|
1177
|
-
'application/json',
|
|
1178
|
-
'text/json'
|
|
1215
|
+
'application/json'
|
|
1179
1216
|
],
|
|
1180
1217
|
'content_type': [],
|
|
1181
1218
|
},
|
|
1182
1219
|
api_client=api_client
|
|
1183
1220
|
)
|
|
1184
|
-
self.
|
|
1221
|
+
self.get_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
1185
1222
|
settings={
|
|
1186
|
-
'response_type': (
|
|
1223
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
1187
1224
|
'auth': [
|
|
1188
1225
|
'oauth',
|
|
1189
1226
|
'oauth'
|
|
1190
1227
|
],
|
|
1191
|
-
'endpoint_path': '/preview/retail-media/
|
|
1192
|
-
'operation_id': '
|
|
1228
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
1229
|
+
'operation_id': 'get_product_button_by_line_item_and_product_button_id',
|
|
1193
1230
|
'http_method': 'GET',
|
|
1194
1231
|
'servers': None,
|
|
1195
1232
|
},
|
|
1196
1233
|
params_map={
|
|
1197
1234
|
'all': [
|
|
1198
1235
|
'line_item_id',
|
|
1236
|
+
'product_button_id',
|
|
1199
1237
|
],
|
|
1200
1238
|
'required': [
|
|
1201
1239
|
'line_item_id',
|
|
1240
|
+
'product_button_id',
|
|
1202
1241
|
],
|
|
1203
1242
|
'nullable': [
|
|
1204
1243
|
],
|
|
@@ -1214,13 +1253,17 @@ class CampaignApi(object):
|
|
|
1214
1253
|
},
|
|
1215
1254
|
'openapi_types': {
|
|
1216
1255
|
'line_item_id':
|
|
1217
|
-
(
|
|
1256
|
+
(str,),
|
|
1257
|
+
'product_button_id':
|
|
1258
|
+
(str,),
|
|
1218
1259
|
},
|
|
1219
1260
|
'attribute_map': {
|
|
1220
|
-
'line_item_id': '
|
|
1261
|
+
'line_item_id': 'line-item-id',
|
|
1262
|
+
'product_button_id': 'product-button-id',
|
|
1221
1263
|
},
|
|
1222
1264
|
'location_map': {
|
|
1223
1265
|
'line_item_id': 'path',
|
|
1266
|
+
'product_button_id': 'path',
|
|
1224
1267
|
},
|
|
1225
1268
|
'collection_format_map': {
|
|
1226
1269
|
}
|
|
@@ -1233,76 +1276,48 @@ class CampaignApi(object):
|
|
|
1233
1276
|
},
|
|
1234
1277
|
api_client=api_client
|
|
1235
1278
|
)
|
|
1236
|
-
self.
|
|
1279
|
+
self.get_product_buttons_by_line_item_id_endpoint = _Endpoint(
|
|
1237
1280
|
settings={
|
|
1238
|
-
'response_type': (
|
|
1281
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
1239
1282
|
'auth': [
|
|
1240
1283
|
'oauth',
|
|
1241
1284
|
'oauth'
|
|
1242
1285
|
],
|
|
1243
|
-
'endpoint_path': '/preview/retail-media/
|
|
1244
|
-
'operation_id': '
|
|
1286
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons',
|
|
1287
|
+
'operation_id': 'get_product_buttons_by_line_item_id',
|
|
1245
1288
|
'http_method': 'GET',
|
|
1246
1289
|
'servers': None,
|
|
1247
1290
|
},
|
|
1248
1291
|
params_map={
|
|
1249
1292
|
'all': [
|
|
1250
|
-
'
|
|
1251
|
-
'limit_to_id',
|
|
1252
|
-
'page_index',
|
|
1253
|
-
'page_size',
|
|
1293
|
+
'line_item_id',
|
|
1254
1294
|
],
|
|
1255
1295
|
'required': [
|
|
1256
|
-
'
|
|
1296
|
+
'line_item_id',
|
|
1257
1297
|
],
|
|
1258
1298
|
'nullable': [
|
|
1259
1299
|
],
|
|
1260
1300
|
'enum': [
|
|
1261
1301
|
],
|
|
1262
1302
|
'validation': [
|
|
1263
|
-
'page_index',
|
|
1264
|
-
'page_size',
|
|
1265
1303
|
]
|
|
1266
1304
|
},
|
|
1267
1305
|
root_map={
|
|
1268
1306
|
'validations': {
|
|
1269
|
-
('page_index',): {
|
|
1270
|
-
|
|
1271
|
-
'inclusive_maximum': 2147483647,
|
|
1272
|
-
'inclusive_minimum': 0,
|
|
1273
|
-
},
|
|
1274
|
-
('page_size',): {
|
|
1275
|
-
|
|
1276
|
-
'inclusive_maximum': 2147483647,
|
|
1277
|
-
'inclusive_minimum': 1,
|
|
1278
|
-
},
|
|
1279
1307
|
},
|
|
1280
1308
|
'allowed_values': {
|
|
1281
1309
|
},
|
|
1282
1310
|
'openapi_types': {
|
|
1283
|
-
'
|
|
1311
|
+
'line_item_id':
|
|
1284
1312
|
(str,),
|
|
1285
|
-
'limit_to_id':
|
|
1286
|
-
([str],),
|
|
1287
|
-
'page_index':
|
|
1288
|
-
(int,),
|
|
1289
|
-
'page_size':
|
|
1290
|
-
(int,),
|
|
1291
1313
|
},
|
|
1292
1314
|
'attribute_map': {
|
|
1293
|
-
'
|
|
1294
|
-
'limit_to_id': 'limitToId',
|
|
1295
|
-
'page_index': 'pageIndex',
|
|
1296
|
-
'page_size': 'pageSize',
|
|
1315
|
+
'line_item_id': 'line-item-id',
|
|
1297
1316
|
},
|
|
1298
1317
|
'location_map': {
|
|
1299
|
-
'
|
|
1300
|
-
'limit_to_id': 'query',
|
|
1301
|
-
'page_index': 'query',
|
|
1302
|
-
'page_size': 'query',
|
|
1318
|
+
'line_item_id': 'path',
|
|
1303
1319
|
},
|
|
1304
1320
|
'collection_format_map': {
|
|
1305
|
-
'limit_to_id': 'multi',
|
|
1306
1321
|
}
|
|
1307
1322
|
},
|
|
1308
1323
|
headers_map={
|
|
@@ -1366,10 +1381,7 @@ class CampaignApi(object):
|
|
|
1366
1381
|
'application/json'
|
|
1367
1382
|
],
|
|
1368
1383
|
'content_type': [
|
|
1369
|
-
'application/json
|
|
1370
|
-
'application/json',
|
|
1371
|
-
'text/json',
|
|
1372
|
-
'application/*+json'
|
|
1384
|
+
'application/json'
|
|
1373
1385
|
]
|
|
1374
1386
|
},
|
|
1375
1387
|
api_client=api_client
|
|
@@ -1442,9 +1454,7 @@ class CampaignApi(object):
|
|
|
1442
1454
|
},
|
|
1443
1455
|
headers_map={
|
|
1444
1456
|
'accept': [
|
|
1445
|
-
'
|
|
1446
|
-
'application/json',
|
|
1447
|
-
'text/json'
|
|
1457
|
+
'application/json'
|
|
1448
1458
|
],
|
|
1449
1459
|
'content_type': [],
|
|
1450
1460
|
},
|
|
@@ -1499,70 +1509,7 @@ class CampaignApi(object):
|
|
|
1499
1509
|
}
|
|
1500
1510
|
},
|
|
1501
1511
|
headers_map={
|
|
1502
|
-
'accept': [
|
|
1503
|
-
'application/json'
|
|
1504
|
-
],
|
|
1505
|
-
'content_type': [
|
|
1506
|
-
'application/json'
|
|
1507
|
-
]
|
|
1508
|
-
},
|
|
1509
|
-
api_client=api_client
|
|
1510
|
-
)
|
|
1511
|
-
self.post_api_external_v1_line_item_product_buttons_create_by_line_item_id_endpoint = _Endpoint(
|
|
1512
|
-
settings={
|
|
1513
|
-
'response_type': (ProductButtonResponseListResponse,),
|
|
1514
|
-
'auth': [
|
|
1515
|
-
'oauth',
|
|
1516
|
-
'oauth'
|
|
1517
|
-
],
|
|
1518
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create',
|
|
1519
|
-
'operation_id': 'post_api_external_v1_line_item_product_buttons_create_by_line_item_id',
|
|
1520
|
-
'http_method': 'POST',
|
|
1521
|
-
'servers': None,
|
|
1522
|
-
},
|
|
1523
|
-
params_map={
|
|
1524
|
-
'all': [
|
|
1525
|
-
'line_item_id',
|
|
1526
|
-
'product_button_request_list_request',
|
|
1527
|
-
],
|
|
1528
|
-
'required': [
|
|
1529
|
-
'line_item_id',
|
|
1530
|
-
],
|
|
1531
|
-
'nullable': [
|
|
1532
|
-
'product_button_request_list_request',
|
|
1533
|
-
],
|
|
1534
|
-
'enum': [
|
|
1535
|
-
],
|
|
1536
|
-
'validation': [
|
|
1537
|
-
]
|
|
1538
|
-
},
|
|
1539
|
-
root_map={
|
|
1540
|
-
'validations': {
|
|
1541
|
-
},
|
|
1542
|
-
'allowed_values': {
|
|
1543
|
-
},
|
|
1544
|
-
'openapi_types': {
|
|
1545
|
-
'line_item_id':
|
|
1546
|
-
(str,),
|
|
1547
|
-
'product_button_request_list_request':
|
|
1548
|
-
(ProductButtonRequestListRequest,),
|
|
1549
|
-
},
|
|
1550
|
-
'attribute_map': {
|
|
1551
|
-
'line_item_id': 'line-item-id',
|
|
1552
|
-
},
|
|
1553
|
-
'location_map': {
|
|
1554
|
-
'line_item_id': 'path',
|
|
1555
|
-
'product_button_request_list_request': 'body',
|
|
1556
|
-
},
|
|
1557
|
-
'collection_format_map': {
|
|
1558
|
-
}
|
|
1559
|
-
},
|
|
1560
|
-
headers_map={
|
|
1561
|
-
'accept': [
|
|
1562
|
-
'text/plain',
|
|
1563
|
-
'application/json',
|
|
1564
|
-
'text/json'
|
|
1565
|
-
],
|
|
1512
|
+
'accept': [],
|
|
1566
1513
|
'content_type': [
|
|
1567
1514
|
'application/json'
|
|
1568
1515
|
]
|
|
@@ -1620,9 +1567,7 @@ class CampaignApi(object):
|
|
|
1620
1567
|
},
|
|
1621
1568
|
headers_map={
|
|
1622
1569
|
'accept': [
|
|
1623
|
-
'
|
|
1624
|
-
'application/json',
|
|
1625
|
-
'text/json'
|
|
1570
|
+
'application/json'
|
|
1626
1571
|
],
|
|
1627
1572
|
'content_type': [
|
|
1628
1573
|
'application/json'
|
|
@@ -1681,69 +1626,7 @@ class CampaignApi(object):
|
|
|
1681
1626
|
},
|
|
1682
1627
|
headers_map={
|
|
1683
1628
|
'accept': [
|
|
1684
|
-
'text/plain',
|
|
1685
|
-
'application/json',
|
|
1686
|
-
'text/json'
|
|
1687
|
-
],
|
|
1688
|
-
'content_type': [
|
|
1689
1629
|
'application/json'
|
|
1690
|
-
]
|
|
1691
|
-
},
|
|
1692
|
-
api_client=api_client
|
|
1693
|
-
)
|
|
1694
|
-
self.post_api_external_v2_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1695
|
-
settings={
|
|
1696
|
-
'response_type': (PreferredLineItemV2Response,),
|
|
1697
|
-
'auth': [
|
|
1698
|
-
'oauth',
|
|
1699
|
-
'oauth'
|
|
1700
|
-
],
|
|
1701
|
-
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
1702
|
-
'operation_id': 'post_api_external_v2_campaign_preferred_line_items_by_campaign_id',
|
|
1703
|
-
'http_method': 'POST',
|
|
1704
|
-
'servers': None,
|
|
1705
|
-
},
|
|
1706
|
-
params_map={
|
|
1707
|
-
'all': [
|
|
1708
|
-
'campaign_id',
|
|
1709
|
-
'preferred_line_item_create_model_v2_request',
|
|
1710
|
-
],
|
|
1711
|
-
'required': [
|
|
1712
|
-
'campaign_id',
|
|
1713
|
-
],
|
|
1714
|
-
'nullable': [
|
|
1715
|
-
],
|
|
1716
|
-
'enum': [
|
|
1717
|
-
],
|
|
1718
|
-
'validation': [
|
|
1719
|
-
]
|
|
1720
|
-
},
|
|
1721
|
-
root_map={
|
|
1722
|
-
'validations': {
|
|
1723
|
-
},
|
|
1724
|
-
'allowed_values': {
|
|
1725
|
-
},
|
|
1726
|
-
'openapi_types': {
|
|
1727
|
-
'campaign_id':
|
|
1728
|
-
(str,),
|
|
1729
|
-
'preferred_line_item_create_model_v2_request':
|
|
1730
|
-
(PreferredLineItemCreateModelV2Request,),
|
|
1731
|
-
},
|
|
1732
|
-
'attribute_map': {
|
|
1733
|
-
'campaign_id': 'campaign-id',
|
|
1734
|
-
},
|
|
1735
|
-
'location_map': {
|
|
1736
|
-
'campaign_id': 'path',
|
|
1737
|
-
'preferred_line_item_create_model_v2_request': 'body',
|
|
1738
|
-
},
|
|
1739
|
-
'collection_format_map': {
|
|
1740
|
-
}
|
|
1741
|
-
},
|
|
1742
|
-
headers_map={
|
|
1743
|
-
'accept': [
|
|
1744
|
-
'text/plain',
|
|
1745
|
-
'application/json',
|
|
1746
|
-
'text/json'
|
|
1747
1630
|
],
|
|
1748
1631
|
'content_type': [
|
|
1749
1632
|
'application/json'
|
|
@@ -1951,9 +1834,7 @@ class CampaignApi(object):
|
|
|
1951
1834
|
},
|
|
1952
1835
|
headers_map={
|
|
1953
1836
|
'accept': [
|
|
1954
|
-
'
|
|
1955
|
-
'application/json',
|
|
1956
|
-
'text/json'
|
|
1837
|
+
'application/json'
|
|
1957
1838
|
],
|
|
1958
1839
|
'content_type': [
|
|
1959
1840
|
'application/json'
|
|
@@ -2013,38 +1894,35 @@ class CampaignApi(object):
|
|
|
2013
1894
|
},
|
|
2014
1895
|
headers_map={
|
|
2015
1896
|
'accept': [
|
|
2016
|
-
'
|
|
2017
|
-
'application/json',
|
|
2018
|
-
'text/json'
|
|
1897
|
+
'application/json'
|
|
2019
1898
|
],
|
|
2020
1899
|
'content_type': [],
|
|
2021
1900
|
},
|
|
2022
1901
|
api_client=api_client
|
|
2023
1902
|
)
|
|
2024
|
-
self.
|
|
1903
|
+
self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
|
|
2025
1904
|
settings={
|
|
2026
|
-
'response_type': (
|
|
1905
|
+
'response_type': (Creative2Response,),
|
|
2027
1906
|
'auth': [
|
|
2028
1907
|
'oauth',
|
|
2029
1908
|
'oauth'
|
|
2030
1909
|
],
|
|
2031
|
-
'endpoint_path': '/preview/retail-media/
|
|
2032
|
-
'operation_id': '
|
|
1910
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
1911
|
+
'operation_id': 'put_api_v2_external_account_by_account_id_creativescreative_id',
|
|
2033
1912
|
'http_method': 'PUT',
|
|
2034
1913
|
'servers': None,
|
|
2035
1914
|
},
|
|
2036
1915
|
params_map={
|
|
2037
1916
|
'all': [
|
|
2038
|
-
'
|
|
2039
|
-
'
|
|
2040
|
-
'
|
|
1917
|
+
'account_id',
|
|
1918
|
+
'creative_id',
|
|
1919
|
+
'creative_update_model2',
|
|
2041
1920
|
],
|
|
2042
1921
|
'required': [
|
|
2043
|
-
'
|
|
2044
|
-
'
|
|
1922
|
+
'account_id',
|
|
1923
|
+
'creative_id',
|
|
2045
1924
|
],
|
|
2046
1925
|
'nullable': [
|
|
2047
|
-
'product_button_request_request',
|
|
2048
1926
|
],
|
|
2049
1927
|
'enum': [
|
|
2050
1928
|
],
|
|
@@ -2057,30 +1935,28 @@ class CampaignApi(object):
|
|
|
2057
1935
|
'allowed_values': {
|
|
2058
1936
|
},
|
|
2059
1937
|
'openapi_types': {
|
|
2060
|
-
'
|
|
1938
|
+
'account_id':
|
|
2061
1939
|
(str,),
|
|
2062
|
-
'
|
|
1940
|
+
'creative_id':
|
|
2063
1941
|
(str,),
|
|
2064
|
-
'
|
|
2065
|
-
(
|
|
1942
|
+
'creative_update_model2':
|
|
1943
|
+
(CreativeUpdateModel2,),
|
|
2066
1944
|
},
|
|
2067
1945
|
'attribute_map': {
|
|
2068
|
-
'
|
|
2069
|
-
'
|
|
1946
|
+
'account_id': 'account-id',
|
|
1947
|
+
'creative_id': 'creative-id',
|
|
2070
1948
|
},
|
|
2071
1949
|
'location_map': {
|
|
2072
|
-
'
|
|
2073
|
-
'
|
|
2074
|
-
'
|
|
1950
|
+
'account_id': 'path',
|
|
1951
|
+
'creative_id': 'path',
|
|
1952
|
+
'creative_update_model2': 'body',
|
|
2075
1953
|
},
|
|
2076
1954
|
'collection_format_map': {
|
|
2077
1955
|
}
|
|
2078
1956
|
},
|
|
2079
1957
|
headers_map={
|
|
2080
1958
|
'accept': [
|
|
2081
|
-
'
|
|
2082
|
-
'application/json',
|
|
2083
|
-
'text/json'
|
|
1959
|
+
'application/json'
|
|
2084
1960
|
],
|
|
2085
1961
|
'content_type': [
|
|
2086
1962
|
'application/json'
|
|
@@ -2088,25 +1964,25 @@ class CampaignApi(object):
|
|
|
2088
1964
|
},
|
|
2089
1965
|
api_client=api_client
|
|
2090
1966
|
)
|
|
2091
|
-
self.
|
|
1967
|
+
self.recommended_keywords_endpoint = _Endpoint(
|
|
2092
1968
|
settings={
|
|
2093
|
-
'response_type': (
|
|
1969
|
+
'response_type': (ValueResourceOutcomeRecommendedKeywordsResponseV1,),
|
|
2094
1970
|
'auth': [
|
|
2095
1971
|
'oauth',
|
|
2096
1972
|
'oauth'
|
|
2097
1973
|
],
|
|
2098
|
-
'endpoint_path': '/preview/retail-media/
|
|
2099
|
-
'operation_id': '
|
|
2100
|
-
'http_method': '
|
|
1974
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-keywords',
|
|
1975
|
+
'operation_id': 'recommended_keywords',
|
|
1976
|
+
'http_method': 'POST',
|
|
2101
1977
|
'servers': None,
|
|
2102
1978
|
},
|
|
2103
1979
|
params_map={
|
|
2104
1980
|
'all': [
|
|
2105
|
-
'
|
|
2106
|
-
'
|
|
1981
|
+
'retailer_id',
|
|
1982
|
+
'value_resource_input_recommended_keywords_request_v1',
|
|
2107
1983
|
],
|
|
2108
1984
|
'required': [
|
|
2109
|
-
'
|
|
1985
|
+
'retailer_id',
|
|
2110
1986
|
],
|
|
2111
1987
|
'nullable': [
|
|
2112
1988
|
],
|
|
@@ -2121,26 +1997,24 @@ class CampaignApi(object):
|
|
|
2121
1997
|
'allowed_values': {
|
|
2122
1998
|
},
|
|
2123
1999
|
'openapi_types': {
|
|
2124
|
-
'
|
|
2000
|
+
'retailer_id':
|
|
2125
2001
|
(str,),
|
|
2126
|
-
'
|
|
2127
|
-
(
|
|
2002
|
+
'value_resource_input_recommended_keywords_request_v1':
|
|
2003
|
+
(ValueResourceInputRecommendedKeywordsRequestV1,),
|
|
2128
2004
|
},
|
|
2129
2005
|
'attribute_map': {
|
|
2130
|
-
'
|
|
2006
|
+
'retailer_id': 'retailerId',
|
|
2131
2007
|
},
|
|
2132
2008
|
'location_map': {
|
|
2133
|
-
'
|
|
2134
|
-
'
|
|
2009
|
+
'retailer_id': 'path',
|
|
2010
|
+
'value_resource_input_recommended_keywords_request_v1': 'body',
|
|
2135
2011
|
},
|
|
2136
2012
|
'collection_format_map': {
|
|
2137
2013
|
}
|
|
2138
2014
|
},
|
|
2139
2015
|
headers_map={
|
|
2140
2016
|
'accept': [
|
|
2141
|
-
'
|
|
2142
|
-
'application/json',
|
|
2143
|
-
'text/json'
|
|
2017
|
+
'application/json'
|
|
2144
2018
|
],
|
|
2145
2019
|
'content_type': [
|
|
2146
2020
|
'application/json'
|
|
@@ -2148,65 +2022,72 @@ class CampaignApi(object):
|
|
|
2148
2022
|
},
|
|
2149
2023
|
api_client=api_client
|
|
2150
2024
|
)
|
|
2151
|
-
self.
|
|
2025
|
+
self.search_brands_endpoint = _Endpoint(
|
|
2152
2026
|
settings={
|
|
2153
|
-
'response_type': (
|
|
2027
|
+
'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata,),
|
|
2154
2028
|
'auth': [
|
|
2155
2029
|
'oauth',
|
|
2156
2030
|
'oauth'
|
|
2157
2031
|
],
|
|
2158
|
-
'endpoint_path': '/preview/retail-media/
|
|
2159
|
-
'operation_id': '
|
|
2160
|
-
'http_method': '
|
|
2032
|
+
'endpoint_path': '/preview/retail-media/brands/search',
|
|
2033
|
+
'operation_id': 'search_brands',
|
|
2034
|
+
'http_method': 'POST',
|
|
2161
2035
|
'servers': None,
|
|
2162
2036
|
},
|
|
2163
2037
|
params_map={
|
|
2164
2038
|
'all': [
|
|
2165
|
-
'
|
|
2166
|
-
'
|
|
2167
|
-
'
|
|
2168
|
-
],
|
|
2169
|
-
'required': [
|
|
2170
|
-
'account_id',
|
|
2171
|
-
'creative_id',
|
|
2039
|
+
'limit',
|
|
2040
|
+
'offset',
|
|
2041
|
+
'value_resource_input_brand_id_search_request',
|
|
2172
2042
|
],
|
|
2043
|
+
'required': [],
|
|
2173
2044
|
'nullable': [
|
|
2174
2045
|
],
|
|
2175
2046
|
'enum': [
|
|
2176
2047
|
],
|
|
2177
2048
|
'validation': [
|
|
2049
|
+
'limit',
|
|
2050
|
+
'offset',
|
|
2178
2051
|
]
|
|
2179
2052
|
},
|
|
2180
2053
|
root_map={
|
|
2181
2054
|
'validations': {
|
|
2055
|
+
('limit',): {
|
|
2056
|
+
|
|
2057
|
+
'inclusive_maximum': 100,
|
|
2058
|
+
'inclusive_minimum': 1,
|
|
2059
|
+
},
|
|
2060
|
+
('offset',): {
|
|
2061
|
+
|
|
2062
|
+
'inclusive_maximum': 2147483647,
|
|
2063
|
+
'inclusive_minimum': 0,
|
|
2064
|
+
},
|
|
2182
2065
|
},
|
|
2183
2066
|
'allowed_values': {
|
|
2184
2067
|
},
|
|
2185
2068
|
'openapi_types': {
|
|
2186
|
-
'
|
|
2187
|
-
(
|
|
2188
|
-
'
|
|
2189
|
-
(
|
|
2190
|
-
'
|
|
2191
|
-
(
|
|
2069
|
+
'limit':
|
|
2070
|
+
(int,),
|
|
2071
|
+
'offset':
|
|
2072
|
+
(int,),
|
|
2073
|
+
'value_resource_input_brand_id_search_request':
|
|
2074
|
+
(ValueResourceInputBrandIdSearchRequest,),
|
|
2192
2075
|
},
|
|
2193
2076
|
'attribute_map': {
|
|
2194
|
-
'
|
|
2195
|
-
'
|
|
2077
|
+
'limit': 'limit',
|
|
2078
|
+
'offset': 'offset',
|
|
2196
2079
|
},
|
|
2197
2080
|
'location_map': {
|
|
2198
|
-
'
|
|
2199
|
-
'
|
|
2200
|
-
'
|
|
2081
|
+
'limit': 'query',
|
|
2082
|
+
'offset': 'query',
|
|
2083
|
+
'value_resource_input_brand_id_search_request': 'body',
|
|
2201
2084
|
},
|
|
2202
2085
|
'collection_format_map': {
|
|
2203
2086
|
}
|
|
2204
2087
|
},
|
|
2205
2088
|
headers_map={
|
|
2206
2089
|
'accept': [
|
|
2207
|
-
'
|
|
2208
|
-
'application/json',
|
|
2209
|
-
'text/json'
|
|
2090
|
+
'application/json'
|
|
2210
2091
|
],
|
|
2211
2092
|
'content_type': [
|
|
2212
2093
|
'application/json'
|
|
@@ -2214,22 +2095,24 @@ class CampaignApi(object):
|
|
|
2214
2095
|
},
|
|
2215
2096
|
api_client=api_client
|
|
2216
2097
|
)
|
|
2217
|
-
self.
|
|
2098
|
+
self.search_category_endpoint = _Endpoint(
|
|
2218
2099
|
settings={
|
|
2219
|
-
'response_type': (
|
|
2100
|
+
'response_type': (EntityResourceCollectionOutcomeCategory202204Metadata,),
|
|
2220
2101
|
'auth': [
|
|
2221
2102
|
'oauth',
|
|
2222
2103
|
'oauth'
|
|
2223
2104
|
],
|
|
2224
|
-
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/
|
|
2225
|
-
'operation_id': '
|
|
2105
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/categories/search',
|
|
2106
|
+
'operation_id': 'search_category',
|
|
2226
2107
|
'http_method': 'POST',
|
|
2227
2108
|
'servers': None,
|
|
2228
2109
|
},
|
|
2229
2110
|
params_map={
|
|
2230
2111
|
'all': [
|
|
2231
2112
|
'retailer_id',
|
|
2232
|
-
'
|
|
2113
|
+
'limit',
|
|
2114
|
+
'offset',
|
|
2115
|
+
'value_resource_input_categories_search_request_v1',
|
|
2233
2116
|
],
|
|
2234
2117
|
'required': [
|
|
2235
2118
|
'retailer_id',
|
|
@@ -2239,25 +2122,45 @@ class CampaignApi(object):
|
|
|
2239
2122
|
'enum': [
|
|
2240
2123
|
],
|
|
2241
2124
|
'validation': [
|
|
2125
|
+
'limit',
|
|
2126
|
+
'offset',
|
|
2242
2127
|
]
|
|
2243
2128
|
},
|
|
2244
2129
|
root_map={
|
|
2245
2130
|
'validations': {
|
|
2131
|
+
('limit',): {
|
|
2132
|
+
|
|
2133
|
+
'inclusive_maximum': 500,
|
|
2134
|
+
'inclusive_minimum': 1,
|
|
2135
|
+
},
|
|
2136
|
+
('offset',): {
|
|
2137
|
+
|
|
2138
|
+
'inclusive_maximum': 2147483647,
|
|
2139
|
+
'inclusive_minimum': 0,
|
|
2140
|
+
},
|
|
2246
2141
|
},
|
|
2247
2142
|
'allowed_values': {
|
|
2248
2143
|
},
|
|
2249
2144
|
'openapi_types': {
|
|
2250
2145
|
'retailer_id':
|
|
2251
|
-
(
|
|
2252
|
-
'
|
|
2253
|
-
(
|
|
2146
|
+
(int,),
|
|
2147
|
+
'limit':
|
|
2148
|
+
(int,),
|
|
2149
|
+
'offset':
|
|
2150
|
+
(int,),
|
|
2151
|
+
'value_resource_input_categories_search_request_v1':
|
|
2152
|
+
(ValueResourceInputCategoriesSearchRequestV1,),
|
|
2254
2153
|
},
|
|
2255
2154
|
'attribute_map': {
|
|
2256
2155
|
'retailer_id': 'retailerId',
|
|
2156
|
+
'limit': 'limit',
|
|
2157
|
+
'offset': 'offset',
|
|
2257
2158
|
},
|
|
2258
2159
|
'location_map': {
|
|
2259
2160
|
'retailer_id': 'path',
|
|
2260
|
-
'
|
|
2161
|
+
'limit': 'query',
|
|
2162
|
+
'offset': 'query',
|
|
2163
|
+
'value_resource_input_categories_search_request_v1': 'body',
|
|
2261
2164
|
},
|
|
2262
2165
|
'collection_format_map': {
|
|
2263
2166
|
}
|
|
@@ -2272,103 +2175,139 @@ class CampaignApi(object):
|
|
|
2272
2175
|
},
|
|
2273
2176
|
api_client=api_client
|
|
2274
2177
|
)
|
|
2275
|
-
self.
|
|
2178
|
+
self.set_keyword_bids_endpoint = _Endpoint(
|
|
2276
2179
|
settings={
|
|
2277
|
-
'response_type': (
|
|
2180
|
+
'response_type': (ResourceOutcome,),
|
|
2278
2181
|
'auth': [
|
|
2279
2182
|
'oauth',
|
|
2280
2183
|
'oauth'
|
|
2281
2184
|
],
|
|
2282
|
-
'endpoint_path': '/preview/retail-media/
|
|
2283
|
-
'operation_id': '
|
|
2185
|
+
'endpoint_path': '/preview/retail-media/line-items/{id}/keywords/set-bid',
|
|
2186
|
+
'operation_id': 'set_keyword_bids',
|
|
2284
2187
|
'http_method': 'POST',
|
|
2285
2188
|
'servers': None,
|
|
2286
2189
|
},
|
|
2287
2190
|
params_map={
|
|
2288
2191
|
'all': [
|
|
2289
|
-
'
|
|
2290
|
-
'
|
|
2291
|
-
|
|
2192
|
+
'id',
|
|
2193
|
+
'set_bids_model_request',
|
|
2194
|
+
],
|
|
2195
|
+
'required': [
|
|
2196
|
+
'id',
|
|
2292
2197
|
],
|
|
2293
|
-
'required': [],
|
|
2294
2198
|
'nullable': [
|
|
2295
2199
|
],
|
|
2296
2200
|
'enum': [
|
|
2297
2201
|
],
|
|
2298
2202
|
'validation': [
|
|
2299
|
-
'limit',
|
|
2300
|
-
'offset',
|
|
2301
2203
|
]
|
|
2302
2204
|
},
|
|
2303
2205
|
root_map={
|
|
2304
2206
|
'validations': {
|
|
2305
|
-
('limit',): {
|
|
2306
|
-
|
|
2307
|
-
'inclusive_maximum': 100,
|
|
2308
|
-
'inclusive_minimum': 1,
|
|
2309
|
-
},
|
|
2310
|
-
('offset',): {
|
|
2311
|
-
|
|
2312
|
-
'inclusive_maximum': 2147483647,
|
|
2313
|
-
'inclusive_minimum': 0,
|
|
2314
|
-
},
|
|
2315
2207
|
},
|
|
2316
2208
|
'allowed_values': {
|
|
2317
2209
|
},
|
|
2318
2210
|
'openapi_types': {
|
|
2319
|
-
'
|
|
2320
|
-
(
|
|
2321
|
-
'
|
|
2322
|
-
(
|
|
2323
|
-
'value_resource_input_brand_id_search_request':
|
|
2324
|
-
(ValueResourceInputBrandIdSearchRequest,),
|
|
2211
|
+
'id':
|
|
2212
|
+
(str,),
|
|
2213
|
+
'set_bids_model_request':
|
|
2214
|
+
(SetBidsModelRequest,),
|
|
2325
2215
|
},
|
|
2326
2216
|
'attribute_map': {
|
|
2327
|
-
'
|
|
2328
|
-
'offset': 'offset',
|
|
2217
|
+
'id': 'id',
|
|
2329
2218
|
},
|
|
2330
2219
|
'location_map': {
|
|
2331
|
-
'
|
|
2332
|
-
'
|
|
2333
|
-
'value_resource_input_brand_id_search_request': 'body',
|
|
2220
|
+
'id': 'path',
|
|
2221
|
+
'set_bids_model_request': 'body',
|
|
2334
2222
|
},
|
|
2335
2223
|
'collection_format_map': {
|
|
2336
2224
|
}
|
|
2337
2225
|
},
|
|
2338
2226
|
headers_map={
|
|
2339
2227
|
'accept': [
|
|
2340
|
-
'
|
|
2341
|
-
|
|
2342
|
-
|
|
2228
|
+
'application/json'
|
|
2229
|
+
],
|
|
2230
|
+
'content_type': [
|
|
2231
|
+
'application/json'
|
|
2232
|
+
]
|
|
2233
|
+
},
|
|
2234
|
+
api_client=api_client
|
|
2235
|
+
)
|
|
2236
|
+
self.unpause_promoted_products_endpoint = _Endpoint(
|
|
2237
|
+
settings={
|
|
2238
|
+
'response_type': None,
|
|
2239
|
+
'auth': [
|
|
2240
|
+
'oauth',
|
|
2241
|
+
'oauth'
|
|
2242
|
+
],
|
|
2243
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/products/unpause',
|
|
2244
|
+
'operation_id': 'unpause_promoted_products',
|
|
2245
|
+
'http_method': 'POST',
|
|
2246
|
+
'servers': None,
|
|
2247
|
+
},
|
|
2248
|
+
params_map={
|
|
2249
|
+
'all': [
|
|
2250
|
+
'line_item_id',
|
|
2251
|
+
'promoted_product_resource_collection_input',
|
|
2252
|
+
],
|
|
2253
|
+
'required': [
|
|
2254
|
+
'line_item_id',
|
|
2255
|
+
],
|
|
2256
|
+
'nullable': [
|
|
2257
|
+
],
|
|
2258
|
+
'enum': [
|
|
2343
2259
|
],
|
|
2260
|
+
'validation': [
|
|
2261
|
+
]
|
|
2262
|
+
},
|
|
2263
|
+
root_map={
|
|
2264
|
+
'validations': {
|
|
2265
|
+
},
|
|
2266
|
+
'allowed_values': {
|
|
2267
|
+
},
|
|
2268
|
+
'openapi_types': {
|
|
2269
|
+
'line_item_id':
|
|
2270
|
+
(str,),
|
|
2271
|
+
'promoted_product_resource_collection_input':
|
|
2272
|
+
(PromotedProductResourceCollectionInput,),
|
|
2273
|
+
},
|
|
2274
|
+
'attribute_map': {
|
|
2275
|
+
'line_item_id': 'line-item-id',
|
|
2276
|
+
},
|
|
2277
|
+
'location_map': {
|
|
2278
|
+
'line_item_id': 'path',
|
|
2279
|
+
'promoted_product_resource_collection_input': 'body',
|
|
2280
|
+
},
|
|
2281
|
+
'collection_format_map': {
|
|
2282
|
+
}
|
|
2283
|
+
},
|
|
2284
|
+
headers_map={
|
|
2285
|
+
'accept': [],
|
|
2344
2286
|
'content_type': [
|
|
2345
|
-
'application/json
|
|
2346
|
-
'application/json',
|
|
2347
|
-
'text/json',
|
|
2348
|
-
'application/*+json'
|
|
2287
|
+
'application/json'
|
|
2349
2288
|
]
|
|
2350
2289
|
},
|
|
2351
2290
|
api_client=api_client
|
|
2352
2291
|
)
|
|
2353
|
-
self.
|
|
2292
|
+
self.update_auction_line_item_v2_endpoint = _Endpoint(
|
|
2354
2293
|
settings={
|
|
2355
|
-
'response_type': (
|
|
2294
|
+
'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
|
|
2356
2295
|
'auth': [
|
|
2357
2296
|
'oauth',
|
|
2358
2297
|
'oauth'
|
|
2359
2298
|
],
|
|
2360
|
-
'endpoint_path': '/preview/retail-media/line-items/{
|
|
2361
|
-
'operation_id': '
|
|
2362
|
-
'http_method': '
|
|
2299
|
+
'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
|
|
2300
|
+
'operation_id': 'update_auction_line_item_v2',
|
|
2301
|
+
'http_method': 'PUT',
|
|
2363
2302
|
'servers': None,
|
|
2364
2303
|
},
|
|
2365
2304
|
params_map={
|
|
2366
2305
|
'all': [
|
|
2367
|
-
'
|
|
2368
|
-
'
|
|
2306
|
+
'line_item_id',
|
|
2307
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model',
|
|
2369
2308
|
],
|
|
2370
2309
|
'required': [
|
|
2371
|
-
'
|
|
2310
|
+
'line_item_id',
|
|
2372
2311
|
],
|
|
2373
2312
|
'nullable': [
|
|
2374
2313
|
],
|
|
@@ -2383,17 +2322,17 @@ class CampaignApi(object):
|
|
|
2383
2322
|
'allowed_values': {
|
|
2384
2323
|
},
|
|
2385
2324
|
'openapi_types': {
|
|
2386
|
-
'
|
|
2387
|
-
(
|
|
2388
|
-
'
|
|
2389
|
-
(
|
|
2325
|
+
'line_item_id':
|
|
2326
|
+
(int,),
|
|
2327
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model':
|
|
2328
|
+
(ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel,),
|
|
2390
2329
|
},
|
|
2391
2330
|
'attribute_map': {
|
|
2392
|
-
'
|
|
2331
|
+
'line_item_id': 'lineItemId',
|
|
2393
2332
|
},
|
|
2394
2333
|
'location_map': {
|
|
2395
|
-
'
|
|
2396
|
-
'
|
|
2334
|
+
'line_item_id': 'path',
|
|
2335
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model': 'body',
|
|
2397
2336
|
},
|
|
2398
2337
|
'collection_format_map': {
|
|
2399
2338
|
}
|
|
@@ -2408,22 +2347,22 @@ class CampaignApi(object):
|
|
|
2408
2347
|
},
|
|
2409
2348
|
api_client=api_client
|
|
2410
2349
|
)
|
|
2411
|
-
self.
|
|
2350
|
+
self.update_keyword_reviews_v1_endpoint = _Endpoint(
|
|
2412
2351
|
settings={
|
|
2413
|
-
'response_type':
|
|
2352
|
+
'response_type': (ValueResourceOutcomeRetailMediaKeywordsReviewResult,),
|
|
2414
2353
|
'auth': [
|
|
2415
2354
|
'oauth',
|
|
2416
2355
|
'oauth'
|
|
2417
2356
|
],
|
|
2418
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
2419
|
-
'operation_id': '
|
|
2357
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/keywords/review',
|
|
2358
|
+
'operation_id': 'update_keyword_reviews_v1',
|
|
2420
2359
|
'http_method': 'POST',
|
|
2421
2360
|
'servers': None,
|
|
2422
2361
|
},
|
|
2423
2362
|
params_map={
|
|
2424
2363
|
'all': [
|
|
2425
2364
|
'line_item_id',
|
|
2426
|
-
'
|
|
2365
|
+
'value_resource_input_retail_media_keywords_review',
|
|
2427
2366
|
],
|
|
2428
2367
|
'required': [
|
|
2429
2368
|
'line_item_id',
|
|
@@ -2442,16 +2381,16 @@ class CampaignApi(object):
|
|
|
2442
2381
|
},
|
|
2443
2382
|
'openapi_types': {
|
|
2444
2383
|
'line_item_id':
|
|
2445
|
-
(
|
|
2446
|
-
'
|
|
2447
|
-
(
|
|
2384
|
+
(int,),
|
|
2385
|
+
'value_resource_input_retail_media_keywords_review':
|
|
2386
|
+
(ValueResourceInputRetailMediaKeywordsReview,),
|
|
2448
2387
|
},
|
|
2449
2388
|
'attribute_map': {
|
|
2450
2389
|
'line_item_id': 'line-item-id',
|
|
2451
2390
|
},
|
|
2452
2391
|
'location_map': {
|
|
2453
2392
|
'line_item_id': 'path',
|
|
2454
|
-
'
|
|
2393
|
+
'value_resource_input_retail_media_keywords_review': 'body',
|
|
2455
2394
|
},
|
|
2456
2395
|
'collection_format_map': {
|
|
2457
2396
|
}
|
|
@@ -2466,22 +2405,22 @@ class CampaignApi(object):
|
|
|
2466
2405
|
},
|
|
2467
2406
|
api_client=api_client
|
|
2468
2407
|
)
|
|
2469
|
-
self.
|
|
2408
|
+
self.update_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
2470
2409
|
settings={
|
|
2471
|
-
'response_type': (
|
|
2410
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
2472
2411
|
'auth': [
|
|
2473
2412
|
'oauth',
|
|
2474
2413
|
'oauth'
|
|
2475
2414
|
],
|
|
2476
|
-
'endpoint_path': '/preview/retail-media/
|
|
2477
|
-
'operation_id': '
|
|
2415
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
2416
|
+
'operation_id': 'update_preferred_line_item_by_line_item_id',
|
|
2478
2417
|
'http_method': 'PUT',
|
|
2479
2418
|
'servers': None,
|
|
2480
2419
|
},
|
|
2481
2420
|
params_map={
|
|
2482
2421
|
'all': [
|
|
2483
2422
|
'line_item_id',
|
|
2484
|
-
'
|
|
2423
|
+
'preferred_line_item_update_model_v2_request',
|
|
2485
2424
|
],
|
|
2486
2425
|
'required': [
|
|
2487
2426
|
'line_item_id',
|
|
@@ -2500,16 +2439,16 @@ class CampaignApi(object):
|
|
|
2500
2439
|
},
|
|
2501
2440
|
'openapi_types': {
|
|
2502
2441
|
'line_item_id':
|
|
2503
|
-
(
|
|
2504
|
-
'
|
|
2505
|
-
(
|
|
2442
|
+
(str,),
|
|
2443
|
+
'preferred_line_item_update_model_v2_request':
|
|
2444
|
+
(PreferredLineItemUpdateModelV2Request,),
|
|
2506
2445
|
},
|
|
2507
2446
|
'attribute_map': {
|
|
2508
|
-
'line_item_id': '
|
|
2447
|
+
'line_item_id': 'line-item-id',
|
|
2509
2448
|
},
|
|
2510
2449
|
'location_map': {
|
|
2511
2450
|
'line_item_id': 'path',
|
|
2512
|
-
'
|
|
2451
|
+
'preferred_line_item_update_model_v2_request': 'body',
|
|
2513
2452
|
},
|
|
2514
2453
|
'collection_format_map': {
|
|
2515
2454
|
}
|
|
@@ -2519,34 +2458,35 @@ class CampaignApi(object):
|
|
|
2519
2458
|
'application/json'
|
|
2520
2459
|
],
|
|
2521
2460
|
'content_type': [
|
|
2522
|
-
'application/json'
|
|
2523
|
-
'text/json',
|
|
2524
|
-
'application/*+json'
|
|
2461
|
+
'application/json'
|
|
2525
2462
|
]
|
|
2526
2463
|
},
|
|
2527
2464
|
api_client=api_client
|
|
2528
2465
|
)
|
|
2529
|
-
self.
|
|
2466
|
+
self.update_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
2530
2467
|
settings={
|
|
2531
|
-
'response_type': (
|
|
2468
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
2532
2469
|
'auth': [
|
|
2533
2470
|
'oauth',
|
|
2534
2471
|
'oauth'
|
|
2535
2472
|
],
|
|
2536
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
2537
|
-
'operation_id': '
|
|
2538
|
-
'http_method': '
|
|
2473
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
2474
|
+
'operation_id': 'update_product_button_by_line_item_and_product_button_id',
|
|
2475
|
+
'http_method': 'PUT',
|
|
2539
2476
|
'servers': None,
|
|
2540
2477
|
},
|
|
2541
2478
|
params_map={
|
|
2542
2479
|
'all': [
|
|
2543
2480
|
'line_item_id',
|
|
2544
|
-
'
|
|
2481
|
+
'product_button_id',
|
|
2482
|
+
'product_button_request_request',
|
|
2545
2483
|
],
|
|
2546
2484
|
'required': [
|
|
2547
2485
|
'line_item_id',
|
|
2486
|
+
'product_button_id',
|
|
2548
2487
|
],
|
|
2549
2488
|
'nullable': [
|
|
2489
|
+
'product_button_request_request',
|
|
2550
2490
|
],
|
|
2551
2491
|
'enum': [
|
|
2552
2492
|
],
|
|
@@ -2560,31 +2500,30 @@ class CampaignApi(object):
|
|
|
2560
2500
|
},
|
|
2561
2501
|
'openapi_types': {
|
|
2562
2502
|
'line_item_id':
|
|
2563
|
-
(
|
|
2564
|
-
'
|
|
2565
|
-
(
|
|
2503
|
+
(str,),
|
|
2504
|
+
'product_button_id':
|
|
2505
|
+
(str,),
|
|
2506
|
+
'product_button_request_request':
|
|
2507
|
+
(ProductButtonRequestRequest,),
|
|
2566
2508
|
},
|
|
2567
2509
|
'attribute_map': {
|
|
2568
2510
|
'line_item_id': 'line-item-id',
|
|
2511
|
+
'product_button_id': 'product-button-id',
|
|
2569
2512
|
},
|
|
2570
2513
|
'location_map': {
|
|
2571
2514
|
'line_item_id': 'path',
|
|
2572
|
-
'
|
|
2515
|
+
'product_button_id': 'path',
|
|
2516
|
+
'product_button_request_request': 'body',
|
|
2573
2517
|
},
|
|
2574
2518
|
'collection_format_map': {
|
|
2575
2519
|
}
|
|
2576
2520
|
},
|
|
2577
2521
|
headers_map={
|
|
2578
2522
|
'accept': [
|
|
2579
|
-
'
|
|
2580
|
-
'application/json',
|
|
2581
|
-
'text/json'
|
|
2523
|
+
'application/json'
|
|
2582
2524
|
],
|
|
2583
2525
|
'content_type': [
|
|
2584
|
-
'application/json
|
|
2585
|
-
'application/json',
|
|
2586
|
-
'text/json',
|
|
2587
|
-
'application/*+json'
|
|
2526
|
+
'application/json'
|
|
2588
2527
|
]
|
|
2589
2528
|
},
|
|
2590
2529
|
api_client=api_client
|
|
@@ -2674,25 +2613,25 @@ class CampaignApi(object):
|
|
|
2674
2613
|
id
|
|
2675
2614
|
return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs)
|
|
2676
2615
|
|
|
2677
|
-
def
|
|
2616
|
+
def append_product_button_by_line_item_id(
|
|
2678
2617
|
self,
|
|
2679
2618
|
line_item_id,
|
|
2680
2619
|
**kwargs
|
|
2681
2620
|
):
|
|
2682
|
-
"""
|
|
2621
|
+
"""append_product_button_by_line_item_id # noqa: E501
|
|
2683
2622
|
|
|
2684
|
-
|
|
2623
|
+
Add Specific Product Buttons # noqa: E501
|
|
2685
2624
|
This method makes a synchronous HTTP request by default. To make an
|
|
2686
2625
|
asynchronous HTTP request, please pass async_req=True
|
|
2687
2626
|
|
|
2688
|
-
>>> thread = api.
|
|
2627
|
+
>>> thread = api.append_product_button_by_line_item_id(line_item_id, async_req=True)
|
|
2689
2628
|
>>> result = thread.get()
|
|
2690
2629
|
|
|
2691
2630
|
Args:
|
|
2692
|
-
line_item_id (str):
|
|
2631
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
2693
2632
|
|
|
2694
2633
|
Keyword Args:
|
|
2695
|
-
|
|
2634
|
+
product_button_request_list_request (ProductButtonRequestListRequest): List of Product Buttons to append. [optional]
|
|
2696
2635
|
_return_http_data_only (bool): response data without head status
|
|
2697
2636
|
code and headers. Default is True.
|
|
2698
2637
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2725,7 +2664,7 @@ class CampaignApi(object):
|
|
|
2725
2664
|
async_req (bool): execute request asynchronously
|
|
2726
2665
|
|
|
2727
2666
|
Returns:
|
|
2728
|
-
|
|
2667
|
+
ProductButtonResponseListResponse
|
|
2729
2668
|
If the method is called asynchronously, returns the request
|
|
2730
2669
|
thread.
|
|
2731
2670
|
"""
|
|
@@ -2756,29 +2695,27 @@ class CampaignApi(object):
|
|
|
2756
2695
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2757
2696
|
kwargs['line_item_id'] = \
|
|
2758
2697
|
line_item_id
|
|
2759
|
-
return self.
|
|
2698
|
+
return self.append_product_button_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
2760
2699
|
|
|
2761
|
-
def
|
|
2700
|
+
def append_promoted_products(
|
|
2762
2701
|
self,
|
|
2763
|
-
|
|
2702
|
+
line_item_id,
|
|
2764
2703
|
**kwargs
|
|
2765
2704
|
):
|
|
2766
|
-
"""
|
|
2705
|
+
"""append_promoted_products # noqa: E501
|
|
2767
2706
|
|
|
2768
|
-
|
|
2707
|
+
Append a collection of promoted products to a line item # noqa: E501
|
|
2769
2708
|
This method makes a synchronous HTTP request by default. To make an
|
|
2770
2709
|
asynchronous HTTP request, please pass async_req=True
|
|
2771
2710
|
|
|
2772
|
-
>>> thread = api.
|
|
2711
|
+
>>> thread = api.append_promoted_products(line_item_id, async_req=True)
|
|
2773
2712
|
>>> result = thread.get()
|
|
2774
2713
|
|
|
2775
2714
|
Args:
|
|
2776
|
-
|
|
2715
|
+
line_item_id (str): ID of the line item
|
|
2777
2716
|
|
|
2778
2717
|
Keyword Args:
|
|
2779
|
-
|
|
2780
|
-
offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
|
|
2781
|
-
value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
|
|
2718
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
2782
2719
|
_return_http_data_only (bool): response data without head status
|
|
2783
2720
|
code and headers. Default is True.
|
|
2784
2721
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2811,7 +2748,7 @@ class CampaignApi(object):
|
|
|
2811
2748
|
async_req (bool): execute request asynchronously
|
|
2812
2749
|
|
|
2813
2750
|
Returns:
|
|
2814
|
-
|
|
2751
|
+
ProductResourceOutcome
|
|
2815
2752
|
If the method is called asynchronously, returns the request
|
|
2816
2753
|
thread.
|
|
2817
2754
|
"""
|
|
@@ -2840,9 +2777,9 @@ class CampaignApi(object):
|
|
|
2840
2777
|
'_content_type')
|
|
2841
2778
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2842
2779
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2843
|
-
kwargs['
|
|
2844
|
-
|
|
2845
|
-
return self.
|
|
2780
|
+
kwargs['line_item_id'] = \
|
|
2781
|
+
line_item_id
|
|
2782
|
+
return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
2846
2783
|
|
|
2847
2784
|
def create_auction_line_item_v2(
|
|
2848
2785
|
self,
|
|
@@ -2928,26 +2865,25 @@ class CampaignApi(object):
|
|
|
2928
2865
|
campaign_id
|
|
2929
2866
|
return self.create_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
2930
2867
|
|
|
2931
|
-
def
|
|
2868
|
+
def create_preferred_line_item_by_campaign_id(
|
|
2932
2869
|
self,
|
|
2933
|
-
|
|
2934
|
-
product_button_id,
|
|
2870
|
+
campaign_id,
|
|
2935
2871
|
**kwargs
|
|
2936
2872
|
):
|
|
2937
|
-
"""
|
|
2873
|
+
"""create_preferred_line_item_by_campaign_id # noqa: E501
|
|
2938
2874
|
|
|
2939
|
-
|
|
2875
|
+
Creates a new preferred line item with the specified settings # noqa: E501
|
|
2940
2876
|
This method makes a synchronous HTTP request by default. To make an
|
|
2941
2877
|
asynchronous HTTP request, please pass async_req=True
|
|
2942
2878
|
|
|
2943
|
-
>>> thread = api.
|
|
2879
|
+
>>> thread = api.create_preferred_line_item_by_campaign_id(campaign_id, async_req=True)
|
|
2944
2880
|
>>> result = thread.get()
|
|
2945
2881
|
|
|
2946
2882
|
Args:
|
|
2947
|
-
|
|
2948
|
-
product_button_id (str): productButtonId used for delete
|
|
2883
|
+
campaign_id (str): The given campaign id
|
|
2949
2884
|
|
|
2950
2885
|
Keyword Args:
|
|
2886
|
+
preferred_line_item_create_model_v2_request (PreferredLineItemCreateModelV2Request): The line item settings to create a line item with. [optional]
|
|
2951
2887
|
_return_http_data_only (bool): response data without head status
|
|
2952
2888
|
code and headers. Default is True.
|
|
2953
2889
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2980,7 +2916,7 @@ class CampaignApi(object):
|
|
|
2980
2916
|
async_req (bool): execute request asynchronously
|
|
2981
2917
|
|
|
2982
2918
|
Returns:
|
|
2983
|
-
|
|
2919
|
+
PreferredLineItemV2Response
|
|
2984
2920
|
If the method is called asynchronously, returns the request
|
|
2985
2921
|
thread.
|
|
2986
2922
|
"""
|
|
@@ -3009,31 +2945,30 @@ class CampaignApi(object):
|
|
|
3009
2945
|
'_content_type')
|
|
3010
2946
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3011
2947
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3012
|
-
kwargs['
|
|
3013
|
-
|
|
3014
|
-
kwargs
|
|
3015
|
-
product_button_id
|
|
3016
|
-
return self.delete_api_external_v1_line_item_by_line_item_id_product_buttonsproduct_button_id_endpoint.call_with_http_info(**kwargs)
|
|
2948
|
+
kwargs['campaign_id'] = \
|
|
2949
|
+
campaign_id
|
|
2950
|
+
return self.create_preferred_line_item_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
3017
2951
|
|
|
3018
|
-
def
|
|
2952
|
+
def delete_product_button_by_line_item_and_product_button_id(
|
|
3019
2953
|
self,
|
|
3020
2954
|
line_item_id,
|
|
2955
|
+
product_button_id,
|
|
3021
2956
|
**kwargs
|
|
3022
2957
|
):
|
|
3023
|
-
"""
|
|
2958
|
+
"""delete_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
3024
2959
|
|
|
3025
|
-
|
|
2960
|
+
Delete Specific Product Button # noqa: E501
|
|
3026
2961
|
This method makes a synchronous HTTP request by default. To make an
|
|
3027
2962
|
asynchronous HTTP request, please pass async_req=True
|
|
3028
2963
|
|
|
3029
|
-
>>> thread = api.
|
|
2964
|
+
>>> thread = api.delete_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
3030
2965
|
>>> result = thread.get()
|
|
3031
2966
|
|
|
3032
2967
|
Args:
|
|
3033
|
-
line_item_id (str):
|
|
2968
|
+
line_item_id (str): LineItemId for productButton delete
|
|
2969
|
+
product_button_id (str): productButtonId used for delete
|
|
3034
2970
|
|
|
3035
2971
|
Keyword Args:
|
|
3036
|
-
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
3037
2972
|
_return_http_data_only (bool): response data without head status
|
|
3038
2973
|
code and headers. Default is True.
|
|
3039
2974
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3066,7 +3001,7 @@ class CampaignApi(object):
|
|
|
3066
3001
|
async_req (bool): execute request asynchronously
|
|
3067
3002
|
|
|
3068
3003
|
Returns:
|
|
3069
|
-
|
|
3004
|
+
ProductButtonResponseListResponse
|
|
3070
3005
|
If the method is called asynchronously, returns the request
|
|
3071
3006
|
thread.
|
|
3072
3007
|
"""
|
|
@@ -3097,26 +3032,29 @@ class CampaignApi(object):
|
|
|
3097
3032
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3098
3033
|
kwargs['line_item_id'] = \
|
|
3099
3034
|
line_item_id
|
|
3100
|
-
|
|
3035
|
+
kwargs['product_button_id'] = \
|
|
3036
|
+
product_button_id
|
|
3037
|
+
return self.delete_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
3101
3038
|
|
|
3102
|
-
def
|
|
3039
|
+
def delete_promoted_products(
|
|
3103
3040
|
self,
|
|
3104
|
-
|
|
3041
|
+
line_item_id,
|
|
3105
3042
|
**kwargs
|
|
3106
3043
|
):
|
|
3107
|
-
"""
|
|
3044
|
+
"""delete_promoted_products # noqa: E501
|
|
3108
3045
|
|
|
3109
|
-
|
|
3046
|
+
Remove a collection of promoted products from a line item # noqa: E501
|
|
3110
3047
|
This method makes a synchronous HTTP request by default. To make an
|
|
3111
3048
|
asynchronous HTTP request, please pass async_req=True
|
|
3112
3049
|
|
|
3113
|
-
>>> thread = api.
|
|
3050
|
+
>>> thread = api.delete_promoted_products(line_item_id, async_req=True)
|
|
3114
3051
|
>>> result = thread.get()
|
|
3115
3052
|
|
|
3116
3053
|
Args:
|
|
3117
|
-
|
|
3054
|
+
line_item_id (str): ID of the line item
|
|
3118
3055
|
|
|
3119
3056
|
Keyword Args:
|
|
3057
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
3120
3058
|
_return_http_data_only (bool): response data without head status
|
|
3121
3059
|
code and headers. Default is True.
|
|
3122
3060
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3149,7 +3087,7 @@ class CampaignApi(object):
|
|
|
3149
3087
|
async_req (bool): execute request asynchronously
|
|
3150
3088
|
|
|
3151
3089
|
Returns:
|
|
3152
|
-
|
|
3090
|
+
None
|
|
3153
3091
|
If the method is called asynchronously, returns the request
|
|
3154
3092
|
thread.
|
|
3155
3093
|
"""
|
|
@@ -3178,31 +3116,28 @@ class CampaignApi(object):
|
|
|
3178
3116
|
'_content_type')
|
|
3179
3117
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3180
3118
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3181
|
-
kwargs['
|
|
3182
|
-
|
|
3183
|
-
return self.
|
|
3119
|
+
kwargs['line_item_id'] = \
|
|
3120
|
+
line_item_id
|
|
3121
|
+
return self.delete_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
3184
3122
|
|
|
3185
|
-
def
|
|
3123
|
+
def fetch_keywords(
|
|
3186
3124
|
self,
|
|
3187
|
-
|
|
3125
|
+
id,
|
|
3188
3126
|
**kwargs
|
|
3189
3127
|
):
|
|
3190
|
-
"""
|
|
3128
|
+
"""fetch_keywords # noqa: E501
|
|
3191
3129
|
|
|
3192
|
-
|
|
3130
|
+
Fetch keywords associated with the specified line item # noqa: E501
|
|
3193
3131
|
This method makes a synchronous HTTP request by default. To make an
|
|
3194
3132
|
asynchronous HTTP request, please pass async_req=True
|
|
3195
3133
|
|
|
3196
|
-
>>> thread = api.
|
|
3134
|
+
>>> thread = api.fetch_keywords(id, async_req=True)
|
|
3197
3135
|
>>> result = thread.get()
|
|
3198
3136
|
|
|
3199
3137
|
Args:
|
|
3200
|
-
|
|
3138
|
+
id (str): ID of the line item
|
|
3201
3139
|
|
|
3202
3140
|
Keyword Args:
|
|
3203
|
-
fields (str): A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`.. [optional]
|
|
3204
|
-
limit (int): Maximum page size to fetch. Defaults to 500.. [optional]
|
|
3205
|
-
offset (int): Offset of the first item to fetch. Defaults to zero.. [optional]
|
|
3206
3141
|
_return_http_data_only (bool): response data without head status
|
|
3207
3142
|
code and headers. Default is True.
|
|
3208
3143
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3235,7 +3170,7 @@ class CampaignApi(object):
|
|
|
3235
3170
|
async_req (bool): execute request asynchronously
|
|
3236
3171
|
|
|
3237
3172
|
Returns:
|
|
3238
|
-
|
|
3173
|
+
KeywordsModelResponse
|
|
3239
3174
|
If the method is called asynchronously, returns the request
|
|
3240
3175
|
thread.
|
|
3241
3176
|
"""
|
|
@@ -3264,30 +3199,31 @@ class CampaignApi(object):
|
|
|
3264
3199
|
'_content_type')
|
|
3265
3200
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3266
3201
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3267
|
-
kwargs['
|
|
3268
|
-
|
|
3269
|
-
return self.
|
|
3202
|
+
kwargs['id'] = \
|
|
3203
|
+
id
|
|
3204
|
+
return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
|
|
3270
3205
|
|
|
3271
|
-
def
|
|
3206
|
+
def fetch_promoted_products(
|
|
3272
3207
|
self,
|
|
3273
3208
|
line_item_id,
|
|
3274
|
-
product_button_id,
|
|
3275
3209
|
**kwargs
|
|
3276
3210
|
):
|
|
3277
|
-
"""
|
|
3211
|
+
"""fetch_promoted_products # noqa: E501
|
|
3278
3212
|
|
|
3279
|
-
|
|
3213
|
+
Retrieve a page of promoted products for a line item # noqa: E501
|
|
3280
3214
|
This method makes a synchronous HTTP request by default. To make an
|
|
3281
3215
|
asynchronous HTTP request, please pass async_req=True
|
|
3282
3216
|
|
|
3283
|
-
>>> thread = api.
|
|
3217
|
+
>>> thread = api.fetch_promoted_products(line_item_id, async_req=True)
|
|
3284
3218
|
>>> result = thread.get()
|
|
3285
3219
|
|
|
3286
3220
|
Args:
|
|
3287
|
-
line_item_id (str):
|
|
3288
|
-
product_button_id (str): productButtonId used for retrieval
|
|
3221
|
+
line_item_id (str): ID of the line item.
|
|
3289
3222
|
|
|
3290
3223
|
Keyword Args:
|
|
3224
|
+
fields (str): A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`.. [optional]
|
|
3225
|
+
limit (int): Maximum page size to fetch. Defaults to 500.. [optional]
|
|
3226
|
+
offset (int): Offset of the first item to fetch. Defaults to zero.. [optional]
|
|
3291
3227
|
_return_http_data_only (bool): response data without head status
|
|
3292
3228
|
code and headers. Default is True.
|
|
3293
3229
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3320,7 +3256,7 @@ class CampaignApi(object):
|
|
|
3320
3256
|
async_req (bool): execute request asynchronously
|
|
3321
3257
|
|
|
3322
3258
|
Returns:
|
|
3323
|
-
|
|
3259
|
+
PromotedProductResourceCollectionOutcome
|
|
3324
3260
|
If the method is called asynchronously, returns the request
|
|
3325
3261
|
thread.
|
|
3326
3262
|
"""
|
|
@@ -3351,26 +3287,24 @@ class CampaignApi(object):
|
|
|
3351
3287
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3352
3288
|
kwargs['line_item_id'] = \
|
|
3353
3289
|
line_item_id
|
|
3354
|
-
kwargs
|
|
3355
|
-
product_button_id
|
|
3356
|
-
return self.get_api_external_v1_line_item_by_line_item_id_product_buttonsproduct_button_id_endpoint.call_with_http_info(**kwargs)
|
|
3290
|
+
return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
3357
3291
|
|
|
3358
|
-
def
|
|
3292
|
+
def get_api_external_v2_catalog_status_by_catalog_id(
|
|
3359
3293
|
self,
|
|
3360
|
-
|
|
3294
|
+
catalog_id,
|
|
3361
3295
|
**kwargs
|
|
3362
3296
|
):
|
|
3363
|
-
"""
|
|
3297
|
+
"""get_api_external_v2_catalog_status_by_catalog_id # noqa: E501
|
|
3364
3298
|
|
|
3365
|
-
|
|
3299
|
+
Check the status of a catalog request. # noqa: E501
|
|
3366
3300
|
This method makes a synchronous HTTP request by default. To make an
|
|
3367
3301
|
asynchronous HTTP request, please pass async_req=True
|
|
3368
3302
|
|
|
3369
|
-
>>> thread = api.
|
|
3303
|
+
>>> thread = api.get_api_external_v2_catalog_status_by_catalog_id(catalog_id, async_req=True)
|
|
3370
3304
|
>>> result = thread.get()
|
|
3371
3305
|
|
|
3372
3306
|
Args:
|
|
3373
|
-
|
|
3307
|
+
catalog_id (str): A catalog ID returned from an account catalog request.
|
|
3374
3308
|
|
|
3375
3309
|
Keyword Args:
|
|
3376
3310
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3405,7 +3339,7 @@ class CampaignApi(object):
|
|
|
3405
3339
|
async_req (bool): execute request asynchronously
|
|
3406
3340
|
|
|
3407
3341
|
Returns:
|
|
3408
|
-
|
|
3342
|
+
EntityResourceOutcomeOfCatalogStatusV2
|
|
3409
3343
|
If the method is called asynchronously, returns the request
|
|
3410
3344
|
thread.
|
|
3411
3345
|
"""
|
|
@@ -3434,31 +3368,30 @@ class CampaignApi(object):
|
|
|
3434
3368
|
'_content_type')
|
|
3435
3369
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3436
3370
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3437
|
-
kwargs['
|
|
3438
|
-
|
|
3439
|
-
return self.
|
|
3371
|
+
kwargs['catalog_id'] = \
|
|
3372
|
+
catalog_id
|
|
3373
|
+
return self.get_api_external_v2_catalog_status_by_catalog_id_endpoint.call_with_http_info(**kwargs)
|
|
3440
3374
|
|
|
3441
|
-
def
|
|
3375
|
+
def get_api_v1_external_retailer_brands_by_retailer_id(
|
|
3442
3376
|
self,
|
|
3443
|
-
|
|
3377
|
+
retailer_id,
|
|
3444
3378
|
**kwargs
|
|
3445
3379
|
):
|
|
3446
|
-
"""
|
|
3380
|
+
"""get_api_v1_external_retailer_brands_by_retailer_id # noqa: E501
|
|
3447
3381
|
|
|
3448
|
-
Gets
|
|
3382
|
+
Gets the brands for the given retailer # noqa: E501
|
|
3449
3383
|
This method makes a synchronous HTTP request by default. To make an
|
|
3450
3384
|
asynchronous HTTP request, please pass async_req=True
|
|
3451
3385
|
|
|
3452
|
-
>>> thread = api.
|
|
3386
|
+
>>> thread = api.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id, async_req=True)
|
|
3453
3387
|
>>> result = thread.get()
|
|
3454
3388
|
|
|
3455
3389
|
Args:
|
|
3456
|
-
|
|
3390
|
+
retailer_id (int): The retailer id for which brands should be fetched.
|
|
3457
3391
|
|
|
3458
3392
|
Keyword Args:
|
|
3459
|
-
|
|
3460
|
-
|
|
3461
|
-
page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
|
|
3393
|
+
brand_type (str): Filter to narrow down brands [all|uc|retailer]. Defaults to uc. [optional]
|
|
3394
|
+
sku_stock_type_filter (str): Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party. [optional]
|
|
3462
3395
|
_return_http_data_only (bool): response data without head status
|
|
3463
3396
|
code and headers. Default is True.
|
|
3464
3397
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3491,7 +3424,7 @@ class CampaignApi(object):
|
|
|
3491
3424
|
async_req (bool): execute request asynchronously
|
|
3492
3425
|
|
|
3493
3426
|
Returns:
|
|
3494
|
-
|
|
3427
|
+
BrandPreviewListResponse
|
|
3495
3428
|
If the method is called asynchronously, returns the request
|
|
3496
3429
|
thread.
|
|
3497
3430
|
"""
|
|
@@ -3519,27 +3452,29 @@ class CampaignApi(object):
|
|
|
3519
3452
|
kwargs['_content_type'] = kwargs.get(
|
|
3520
3453
|
'_content_type')
|
|
3521
3454
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3522
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3523
|
-
kwargs['
|
|
3524
|
-
|
|
3525
|
-
return self.
|
|
3455
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3456
|
+
kwargs['retailer_id'] = \
|
|
3457
|
+
retailer_id
|
|
3458
|
+
return self.get_api_v1_external_retailer_brands_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3526
3459
|
|
|
3527
|
-
def
|
|
3460
|
+
def get_api_v1_external_retailer_by_retailer_id_seller_by_seller(
|
|
3528
3461
|
self,
|
|
3529
|
-
|
|
3462
|
+
retailer_id,
|
|
3463
|
+
seller,
|
|
3530
3464
|
**kwargs
|
|
3531
3465
|
):
|
|
3532
|
-
"""
|
|
3466
|
+
"""get_api_v1_external_retailer_by_retailer_id_seller_by_seller # noqa: E501
|
|
3533
3467
|
|
|
3534
|
-
|
|
3468
|
+
Endpoint to get market place seller id and name # noqa: E501
|
|
3535
3469
|
This method makes a synchronous HTTP request by default. To make an
|
|
3536
3470
|
asynchronous HTTP request, please pass async_req=True
|
|
3537
3471
|
|
|
3538
|
-
>>> thread = api.
|
|
3472
|
+
>>> thread = api.get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller, async_req=True)
|
|
3539
3473
|
>>> result = thread.get()
|
|
3540
3474
|
|
|
3541
3475
|
Args:
|
|
3542
|
-
|
|
3476
|
+
retailer_id (int): The retailer id for which seller should be fetched.
|
|
3477
|
+
seller (str): The seller id or seller name which should be validated.
|
|
3543
3478
|
|
|
3544
3479
|
Keyword Args:
|
|
3545
3480
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3574,7 +3509,7 @@ class CampaignApi(object):
|
|
|
3574
3509
|
async_req (bool): execute request asynchronously
|
|
3575
3510
|
|
|
3576
3511
|
Returns:
|
|
3577
|
-
|
|
3512
|
+
SellerPreviewResponse
|
|
3578
3513
|
If the method is called asynchronously, returns the request
|
|
3579
3514
|
thread.
|
|
3580
3515
|
"""
|
|
@@ -3603,28 +3538,31 @@ class CampaignApi(object):
|
|
|
3603
3538
|
'_content_type')
|
|
3604
3539
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3605
3540
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3606
|
-
kwargs['
|
|
3607
|
-
|
|
3608
|
-
|
|
3541
|
+
kwargs['retailer_id'] = \
|
|
3542
|
+
retailer_id
|
|
3543
|
+
kwargs['seller'] = \
|
|
3544
|
+
seller
|
|
3545
|
+
return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3609
3546
|
|
|
3610
|
-
def
|
|
3547
|
+
def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(
|
|
3611
3548
|
self,
|
|
3612
|
-
|
|
3549
|
+
retailer_id,
|
|
3613
3550
|
**kwargs
|
|
3614
3551
|
):
|
|
3615
|
-
"""
|
|
3552
|
+
"""get_api_v1_external_retailer_category_cpc_rates_by_retailer_id # noqa: E501
|
|
3616
3553
|
|
|
3617
|
-
Gets the
|
|
3554
|
+
Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer # noqa: E501
|
|
3618
3555
|
This method makes a synchronous HTTP request by default. To make an
|
|
3619
3556
|
asynchronous HTTP request, please pass async_req=True
|
|
3620
3557
|
|
|
3621
|
-
>>> thread = api.
|
|
3558
|
+
>>> thread = api.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, async_req=True)
|
|
3622
3559
|
>>> result = thread.get()
|
|
3623
3560
|
|
|
3624
3561
|
Args:
|
|
3625
|
-
|
|
3562
|
+
retailer_id (str): The retailer id
|
|
3626
3563
|
|
|
3627
3564
|
Keyword Args:
|
|
3565
|
+
fields ([str]): The fields in the response that is to be included. [optional]
|
|
3628
3566
|
_return_http_data_only (bool): response data without head status
|
|
3629
3567
|
code and headers. Default is True.
|
|
3630
3568
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3657,7 +3595,7 @@ class CampaignApi(object):
|
|
|
3657
3595
|
async_req (bool): execute request asynchronously
|
|
3658
3596
|
|
|
3659
3597
|
Returns:
|
|
3660
|
-
|
|
3598
|
+
CpcRateCardPreviewResponse
|
|
3661
3599
|
If the method is called asynchronously, returns the request
|
|
3662
3600
|
thread.
|
|
3663
3601
|
"""
|
|
@@ -3686,30 +3624,28 @@ class CampaignApi(object):
|
|
|
3686
3624
|
'_content_type')
|
|
3687
3625
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3688
3626
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3689
|
-
kwargs['
|
|
3690
|
-
|
|
3691
|
-
return self.
|
|
3627
|
+
kwargs['retailer_id'] = \
|
|
3628
|
+
retailer_id
|
|
3629
|
+
return self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3692
3630
|
|
|
3693
|
-
def
|
|
3631
|
+
def get_api_v1_external_retailer_placements_by_retailer_id(
|
|
3694
3632
|
self,
|
|
3695
3633
|
retailer_id,
|
|
3696
3634
|
**kwargs
|
|
3697
3635
|
):
|
|
3698
|
-
"""
|
|
3636
|
+
"""get_api_v1_external_retailer_placements_by_retailer_id # noqa: E501
|
|
3699
3637
|
|
|
3700
|
-
Gets
|
|
3638
|
+
Gets all placement information for the given retailer # noqa: E501
|
|
3701
3639
|
This method makes a synchronous HTTP request by default. To make an
|
|
3702
3640
|
asynchronous HTTP request, please pass async_req=True
|
|
3703
3641
|
|
|
3704
|
-
>>> thread = api.
|
|
3642
|
+
>>> thread = api.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id, async_req=True)
|
|
3705
3643
|
>>> result = thread.get()
|
|
3706
3644
|
|
|
3707
3645
|
Args:
|
|
3708
|
-
retailer_id (
|
|
3646
|
+
retailer_id (str): The retailer id for which placements should be fetched.
|
|
3709
3647
|
|
|
3710
3648
|
Keyword Args:
|
|
3711
|
-
brand_type (str): Filter to narrow down brands [all|uc|retailer]. Defaults to uc. [optional]
|
|
3712
|
-
sku_stock_type_filter (str): Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party. [optional]
|
|
3713
3649
|
_return_http_data_only (bool): response data without head status
|
|
3714
3650
|
code and headers. Default is True.
|
|
3715
3651
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3742,7 +3678,7 @@ class CampaignApi(object):
|
|
|
3742
3678
|
async_req (bool): execute request asynchronously
|
|
3743
3679
|
|
|
3744
3680
|
Returns:
|
|
3745
|
-
|
|
3681
|
+
PlacementPreviewListResponse
|
|
3746
3682
|
If the method is called asynchronously, returns the request
|
|
3747
3683
|
thread.
|
|
3748
3684
|
"""
|
|
@@ -3773,26 +3709,26 @@ class CampaignApi(object):
|
|
|
3773
3709
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3774
3710
|
kwargs['retailer_id'] = \
|
|
3775
3711
|
retailer_id
|
|
3776
|
-
return self.
|
|
3712
|
+
return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3777
3713
|
|
|
3778
|
-
def
|
|
3714
|
+
def get_api_v2_external_account_by_account_id_creativescreative_id(
|
|
3779
3715
|
self,
|
|
3780
|
-
|
|
3781
|
-
|
|
3716
|
+
account_id,
|
|
3717
|
+
creative_id,
|
|
3782
3718
|
**kwargs
|
|
3783
3719
|
):
|
|
3784
|
-
"""
|
|
3720
|
+
"""get_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
|
|
3785
3721
|
|
|
3786
|
-
|
|
3722
|
+
Get the specified creative # noqa: E501
|
|
3787
3723
|
This method makes a synchronous HTTP request by default. To make an
|
|
3788
3724
|
asynchronous HTTP request, please pass async_req=True
|
|
3789
3725
|
|
|
3790
|
-
>>> thread = api.
|
|
3726
|
+
>>> thread = api.get_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
|
|
3791
3727
|
>>> result = thread.get()
|
|
3792
3728
|
|
|
3793
3729
|
Args:
|
|
3794
|
-
|
|
3795
|
-
|
|
3730
|
+
account_id (str): External account id to retrieve creatives for
|
|
3731
|
+
creative_id (str): Creative to get
|
|
3796
3732
|
|
|
3797
3733
|
Keyword Args:
|
|
3798
3734
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3827,7 +3763,7 @@ class CampaignApi(object):
|
|
|
3827
3763
|
async_req (bool): execute request asynchronously
|
|
3828
3764
|
|
|
3829
3765
|
Returns:
|
|
3830
|
-
|
|
3766
|
+
Creative2Response
|
|
3831
3767
|
If the method is called asynchronously, returns the request
|
|
3832
3768
|
thread.
|
|
3833
3769
|
"""
|
|
@@ -3856,31 +3792,30 @@ class CampaignApi(object):
|
|
|
3856
3792
|
'_content_type')
|
|
3857
3793
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3858
3794
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3859
|
-
kwargs['
|
|
3860
|
-
|
|
3861
|
-
kwargs['
|
|
3862
|
-
|
|
3863
|
-
return self.
|
|
3795
|
+
kwargs['account_id'] = \
|
|
3796
|
+
account_id
|
|
3797
|
+
kwargs['creative_id'] = \
|
|
3798
|
+
creative_id
|
|
3799
|
+
return self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
3864
3800
|
|
|
3865
|
-
def
|
|
3801
|
+
def get_auction_line_item_v2(
|
|
3866
3802
|
self,
|
|
3867
|
-
|
|
3803
|
+
line_item_id,
|
|
3868
3804
|
**kwargs
|
|
3869
3805
|
):
|
|
3870
|
-
"""
|
|
3806
|
+
"""get_auction_line_item_v2 # noqa: E501
|
|
3871
3807
|
|
|
3872
|
-
Gets
|
|
3808
|
+
Gets a sponsored product line item by its id. # noqa: E501
|
|
3873
3809
|
This method makes a synchronous HTTP request by default. To make an
|
|
3874
3810
|
asynchronous HTTP request, please pass async_req=True
|
|
3875
3811
|
|
|
3876
|
-
>>> thread = api.
|
|
3812
|
+
>>> thread = api.get_auction_line_item_v2(line_item_id, async_req=True)
|
|
3877
3813
|
>>> result = thread.get()
|
|
3878
3814
|
|
|
3879
3815
|
Args:
|
|
3880
|
-
|
|
3816
|
+
line_item_id (int): The id of the line item
|
|
3881
3817
|
|
|
3882
3818
|
Keyword Args:
|
|
3883
|
-
fields ([str]): The fields in the response that is to be included. [optional]
|
|
3884
3819
|
_return_http_data_only (bool): response data without head status
|
|
3885
3820
|
code and headers. Default is True.
|
|
3886
3821
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3913,7 +3848,7 @@ class CampaignApi(object):
|
|
|
3913
3848
|
async_req (bool): execute request asynchronously
|
|
3914
3849
|
|
|
3915
3850
|
Returns:
|
|
3916
|
-
|
|
3851
|
+
EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
3917
3852
|
If the method is called asynchronously, returns the request
|
|
3918
3853
|
thread.
|
|
3919
3854
|
"""
|
|
@@ -3942,28 +3877,31 @@ class CampaignApi(object):
|
|
|
3942
3877
|
'_content_type')
|
|
3943
3878
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3944
3879
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3945
|
-
kwargs['
|
|
3946
|
-
|
|
3947
|
-
return self.
|
|
3880
|
+
kwargs['line_item_id'] = \
|
|
3881
|
+
line_item_id
|
|
3882
|
+
return self.get_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
3948
3883
|
|
|
3949
|
-
def
|
|
3884
|
+
def get_auction_line_items_by_campaign_id_v2(
|
|
3950
3885
|
self,
|
|
3951
|
-
|
|
3886
|
+
campaign_id,
|
|
3952
3887
|
**kwargs
|
|
3953
3888
|
):
|
|
3954
|
-
"""
|
|
3889
|
+
"""get_auction_line_items_by_campaign_id_v2 # noqa: E501
|
|
3955
3890
|
|
|
3956
|
-
Gets
|
|
3891
|
+
Gets a page of sponsored product line items by campaign id. # noqa: E501
|
|
3957
3892
|
This method makes a synchronous HTTP request by default. To make an
|
|
3958
3893
|
asynchronous HTTP request, please pass async_req=True
|
|
3959
3894
|
|
|
3960
|
-
>>> thread = api.
|
|
3895
|
+
>>> thread = api.get_auction_line_items_by_campaign_id_v2(campaign_id, async_req=True)
|
|
3961
3896
|
>>> result = thread.get()
|
|
3962
3897
|
|
|
3963
3898
|
Args:
|
|
3964
|
-
|
|
3899
|
+
campaign_id (str): The id of the campaign
|
|
3965
3900
|
|
|
3966
3901
|
Keyword Args:
|
|
3902
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3903
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
|
|
3904
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
|
|
3967
3905
|
_return_http_data_only (bool): response data without head status
|
|
3968
3906
|
code and headers. Default is True.
|
|
3969
3907
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3996,7 +3934,7 @@ class CampaignApi(object):
|
|
|
3996
3934
|
async_req (bool): execute request asynchronously
|
|
3997
3935
|
|
|
3998
3936
|
Returns:
|
|
3999
|
-
|
|
3937
|
+
EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
|
|
4000
3938
|
If the method is called asynchronously, returns the request
|
|
4001
3939
|
thread.
|
|
4002
3940
|
"""
|
|
@@ -4025,30 +3963,31 @@ class CampaignApi(object):
|
|
|
4025
3963
|
'_content_type')
|
|
4026
3964
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4027
3965
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4028
|
-
kwargs['
|
|
4029
|
-
|
|
4030
|
-
return self.
|
|
3966
|
+
kwargs['campaign_id'] = \
|
|
3967
|
+
campaign_id
|
|
3968
|
+
return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
|
|
4031
3969
|
|
|
4032
|
-
def
|
|
3970
|
+
def get_preferred_line_items_by_campaign_id(
|
|
4033
3971
|
self,
|
|
4034
|
-
|
|
4035
|
-
creative_id,
|
|
3972
|
+
campaign_id,
|
|
4036
3973
|
**kwargs
|
|
4037
3974
|
):
|
|
4038
|
-
"""
|
|
3975
|
+
"""get_preferred_line_items_by_campaign_id # noqa: E501
|
|
4039
3976
|
|
|
4040
|
-
|
|
3977
|
+
Gets page of preferred line item objects for the given campaign id # noqa: E501
|
|
4041
3978
|
This method makes a synchronous HTTP request by default. To make an
|
|
4042
3979
|
asynchronous HTTP request, please pass async_req=True
|
|
4043
3980
|
|
|
4044
|
-
>>> thread = api.
|
|
3981
|
+
>>> thread = api.get_preferred_line_items_by_campaign_id(campaign_id, async_req=True)
|
|
4045
3982
|
>>> result = thread.get()
|
|
4046
3983
|
|
|
4047
3984
|
Args:
|
|
4048
|
-
|
|
4049
|
-
creative_id (str): Creative to get
|
|
3985
|
+
campaign_id (str): The given campaign id
|
|
4050
3986
|
|
|
4051
3987
|
Keyword Args:
|
|
3988
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3989
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
|
|
3990
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
|
|
4052
3991
|
_return_http_data_only (bool): response data without head status
|
|
4053
3992
|
code and headers. Default is True.
|
|
4054
3993
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4081,7 +4020,7 @@ class CampaignApi(object):
|
|
|
4081
4020
|
async_req (bool): execute request asynchronously
|
|
4082
4021
|
|
|
4083
4022
|
Returns:
|
|
4084
|
-
|
|
4023
|
+
PreferredLineItemV2PagedListResponse
|
|
4085
4024
|
If the method is called asynchronously, returns the request
|
|
4086
4025
|
thread.
|
|
4087
4026
|
"""
|
|
@@ -4110,28 +4049,26 @@ class CampaignApi(object):
|
|
|
4110
4049
|
'_content_type')
|
|
4111
4050
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4112
4051
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4113
|
-
kwargs['
|
|
4114
|
-
|
|
4115
|
-
kwargs
|
|
4116
|
-
creative_id
|
|
4117
|
-
return self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
4052
|
+
kwargs['campaign_id'] = \
|
|
4053
|
+
campaign_id
|
|
4054
|
+
return self.get_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
4118
4055
|
|
|
4119
|
-
def
|
|
4056
|
+
def get_preferred_line_items_by_line_item_id(
|
|
4120
4057
|
self,
|
|
4121
4058
|
line_item_id,
|
|
4122
4059
|
**kwargs
|
|
4123
4060
|
):
|
|
4124
|
-
"""
|
|
4061
|
+
"""get_preferred_line_items_by_line_item_id # noqa: E501
|
|
4125
4062
|
|
|
4126
|
-
Gets
|
|
4063
|
+
Gets the preferred line item for the given line item id # noqa: E501
|
|
4127
4064
|
This method makes a synchronous HTTP request by default. To make an
|
|
4128
4065
|
asynchronous HTTP request, please pass async_req=True
|
|
4129
4066
|
|
|
4130
|
-
>>> thread = api.
|
|
4067
|
+
>>> thread = api.get_preferred_line_items_by_line_item_id(line_item_id, async_req=True)
|
|
4131
4068
|
>>> result = thread.get()
|
|
4132
4069
|
|
|
4133
4070
|
Args:
|
|
4134
|
-
line_item_id (
|
|
4071
|
+
line_item_id (str): The given line item id
|
|
4135
4072
|
|
|
4136
4073
|
Keyword Args:
|
|
4137
4074
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4166,7 +4103,7 @@ class CampaignApi(object):
|
|
|
4166
4103
|
async_req (bool): execute request asynchronously
|
|
4167
4104
|
|
|
4168
4105
|
Returns:
|
|
4169
|
-
|
|
4106
|
+
PreferredLineItemV2Response
|
|
4170
4107
|
If the method is called asynchronously, returns the request
|
|
4171
4108
|
thread.
|
|
4172
4109
|
"""
|
|
@@ -4197,29 +4134,28 @@ class CampaignApi(object):
|
|
|
4197
4134
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4198
4135
|
kwargs['line_item_id'] = \
|
|
4199
4136
|
line_item_id
|
|
4200
|
-
return self.
|
|
4137
|
+
return self.get_preferred_line_items_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4201
4138
|
|
|
4202
|
-
def
|
|
4139
|
+
def get_product_button_by_line_item_and_product_button_id(
|
|
4203
4140
|
self,
|
|
4204
|
-
|
|
4141
|
+
line_item_id,
|
|
4142
|
+
product_button_id,
|
|
4205
4143
|
**kwargs
|
|
4206
4144
|
):
|
|
4207
|
-
"""
|
|
4145
|
+
"""get_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
4208
4146
|
|
|
4209
|
-
|
|
4147
|
+
Get Specific Product Button # noqa: E501
|
|
4210
4148
|
This method makes a synchronous HTTP request by default. To make an
|
|
4211
4149
|
asynchronous HTTP request, please pass async_req=True
|
|
4212
4150
|
|
|
4213
|
-
>>> thread = api.
|
|
4151
|
+
>>> thread = api.get_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
4214
4152
|
>>> result = thread.get()
|
|
4215
4153
|
|
|
4216
4154
|
Args:
|
|
4217
|
-
|
|
4155
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
4156
|
+
product_button_id (str): productButtonId used for retrieval
|
|
4218
4157
|
|
|
4219
4158
|
Keyword Args:
|
|
4220
|
-
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
4221
|
-
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
|
|
4222
|
-
page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
|
|
4223
4159
|
_return_http_data_only (bool): response data without head status
|
|
4224
4160
|
code and headers. Default is True.
|
|
4225
4161
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4252,7 +4188,7 @@ class CampaignApi(object):
|
|
|
4252
4188
|
async_req (bool): execute request asynchronously
|
|
4253
4189
|
|
|
4254
4190
|
Returns:
|
|
4255
|
-
|
|
4191
|
+
ProductButtonResponseListResponse
|
|
4256
4192
|
If the method is called asynchronously, returns the request
|
|
4257
4193
|
thread.
|
|
4258
4194
|
"""
|
|
@@ -4281,29 +4217,30 @@ class CampaignApi(object):
|
|
|
4281
4217
|
'_content_type')
|
|
4282
4218
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4283
4219
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4284
|
-
kwargs['
|
|
4285
|
-
|
|
4286
|
-
|
|
4220
|
+
kwargs['line_item_id'] = \
|
|
4221
|
+
line_item_id
|
|
4222
|
+
kwargs['product_button_id'] = \
|
|
4223
|
+
product_button_id
|
|
4224
|
+
return self.get_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
4287
4225
|
|
|
4288
|
-
def
|
|
4226
|
+
def get_product_buttons_by_line_item_id(
|
|
4289
4227
|
self,
|
|
4290
|
-
|
|
4228
|
+
line_item_id,
|
|
4291
4229
|
**kwargs
|
|
4292
4230
|
):
|
|
4293
|
-
"""
|
|
4231
|
+
"""get_product_buttons_by_line_item_id # noqa: E501
|
|
4294
4232
|
|
|
4295
|
-
|
|
4233
|
+
Get LineItem Product Buttons # noqa: E501
|
|
4296
4234
|
This method makes a synchronous HTTP request by default. To make an
|
|
4297
4235
|
asynchronous HTTP request, please pass async_req=True
|
|
4298
4236
|
|
|
4299
|
-
>>> thread = api.
|
|
4237
|
+
>>> thread = api.get_product_buttons_by_line_item_id(line_item_id, async_req=True)
|
|
4300
4238
|
>>> result = thread.get()
|
|
4301
4239
|
|
|
4302
4240
|
Args:
|
|
4303
|
-
|
|
4241
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
4304
4242
|
|
|
4305
4243
|
Keyword Args:
|
|
4306
|
-
value_resource_input_recommended_categories_request_v1 (ValueResourceInputRecommendedCategoriesRequestV1): Request of recommended categories.. [optional]
|
|
4307
4244
|
_return_http_data_only (bool): response data without head status
|
|
4308
4245
|
code and headers. Default is True.
|
|
4309
4246
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4336,7 +4273,7 @@ class CampaignApi(object):
|
|
|
4336
4273
|
async_req (bool): execute request asynchronously
|
|
4337
4274
|
|
|
4338
4275
|
Returns:
|
|
4339
|
-
|
|
4276
|
+
ProductButtonResponseListResponse
|
|
4340
4277
|
If the method is called asynchronously, returns the request
|
|
4341
4278
|
thread.
|
|
4342
4279
|
"""
|
|
@@ -4365,30 +4302,29 @@ class CampaignApi(object):
|
|
|
4365
4302
|
'_content_type')
|
|
4366
4303
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4367
4304
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4368
|
-
kwargs['
|
|
4369
|
-
|
|
4370
|
-
return self.
|
|
4305
|
+
kwargs['line_item_id'] = \
|
|
4306
|
+
line_item_id
|
|
4307
|
+
return self.get_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4371
4308
|
|
|
4372
|
-
def
|
|
4309
|
+
def get_recommended_categories(
|
|
4373
4310
|
self,
|
|
4374
|
-
|
|
4311
|
+
retailer_id,
|
|
4375
4312
|
**kwargs
|
|
4376
4313
|
):
|
|
4377
|
-
"""
|
|
4314
|
+
"""get_recommended_categories # noqa: E501
|
|
4378
4315
|
|
|
4379
|
-
|
|
4316
|
+
Endpoint to get recommended categories by given retailer id and sku id list. # noqa: E501
|
|
4380
4317
|
This method makes a synchronous HTTP request by default. To make an
|
|
4381
4318
|
asynchronous HTTP request, please pass async_req=True
|
|
4382
4319
|
|
|
4383
|
-
>>> thread = api.
|
|
4320
|
+
>>> thread = api.get_recommended_categories(retailer_id, async_req=True)
|
|
4384
4321
|
>>> result = thread.get()
|
|
4385
4322
|
|
|
4386
4323
|
Args:
|
|
4387
|
-
|
|
4324
|
+
retailer_id (int): Retailer id.
|
|
4388
4325
|
|
|
4389
4326
|
Keyword Args:
|
|
4390
|
-
|
|
4391
|
-
offset (int): Offset for pagination. [optional] if omitted the server will use the default value of 0
|
|
4327
|
+
value_resource_input_recommended_categories_request_v1 (ValueResourceInputRecommendedCategoriesRequestV1): Request of recommended categories.. [optional]
|
|
4392
4328
|
_return_http_data_only (bool): response data without head status
|
|
4393
4329
|
code and headers. Default is True.
|
|
4394
4330
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4421,7 +4357,7 @@ class CampaignApi(object):
|
|
|
4421
4357
|
async_req (bool): execute request asynchronously
|
|
4422
4358
|
|
|
4423
4359
|
Returns:
|
|
4424
|
-
|
|
4360
|
+
EntityResourceCollectionOutcomeCategory202204
|
|
4425
4361
|
If the method is called asynchronously, returns the request
|
|
4426
4362
|
thread.
|
|
4427
4363
|
"""
|
|
@@ -4450,29 +4386,30 @@ class CampaignApi(object):
|
|
|
4450
4386
|
'_content_type')
|
|
4451
4387
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4452
4388
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4453
|
-
kwargs['
|
|
4454
|
-
|
|
4455
|
-
return self.
|
|
4389
|
+
kwargs['retailer_id'] = \
|
|
4390
|
+
retailer_id
|
|
4391
|
+
return self.get_recommended_categories_endpoint.call_with_http_info(**kwargs)
|
|
4456
4392
|
|
|
4457
|
-
def
|
|
4393
|
+
def in_review_report_v1(
|
|
4458
4394
|
self,
|
|
4459
|
-
|
|
4395
|
+
account_id,
|
|
4460
4396
|
**kwargs
|
|
4461
4397
|
):
|
|
4462
|
-
"""
|
|
4398
|
+
"""in_review_report_v1 # noqa: E501
|
|
4463
4399
|
|
|
4464
|
-
|
|
4400
|
+
Generate a list of reports for line items which contain one or more actionable keyword reviews # noqa: E501
|
|
4465
4401
|
This method makes a synchronous HTTP request by default. To make an
|
|
4466
4402
|
asynchronous HTTP request, please pass async_req=True
|
|
4467
4403
|
|
|
4468
|
-
>>> thread = api.
|
|
4404
|
+
>>> thread = api.in_review_report_v1(account_id, async_req=True)
|
|
4469
4405
|
>>> result = thread.get()
|
|
4470
4406
|
|
|
4471
4407
|
Args:
|
|
4472
|
-
|
|
4408
|
+
account_id (int): The account to generate a report for
|
|
4473
4409
|
|
|
4474
4410
|
Keyword Args:
|
|
4475
|
-
|
|
4411
|
+
limit (int): Number of items per page. [optional] if omitted the server will use the default value of 25
|
|
4412
|
+
offset (int): Offset for pagination. [optional] if omitted the server will use the default value of 0
|
|
4476
4413
|
_return_http_data_only (bool): response data without head status
|
|
4477
4414
|
code and headers. Default is True.
|
|
4478
4415
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4505,7 +4442,7 @@ class CampaignApi(object):
|
|
|
4505
4442
|
async_req (bool): execute request asynchronously
|
|
4506
4443
|
|
|
4507
4444
|
Returns:
|
|
4508
|
-
|
|
4445
|
+
EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
|
|
4509
4446
|
If the method is called asynchronously, returns the request
|
|
4510
4447
|
thread.
|
|
4511
4448
|
"""
|
|
@@ -4534,29 +4471,29 @@ class CampaignApi(object):
|
|
|
4534
4471
|
'_content_type')
|
|
4535
4472
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4536
4473
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4537
|
-
kwargs['
|
|
4538
|
-
|
|
4539
|
-
return self.
|
|
4474
|
+
kwargs['account_id'] = \
|
|
4475
|
+
account_id
|
|
4476
|
+
return self.in_review_report_v1_endpoint.call_with_http_info(**kwargs)
|
|
4540
4477
|
|
|
4541
|
-
def
|
|
4478
|
+
def pause_promoted_products(
|
|
4542
4479
|
self,
|
|
4543
4480
|
line_item_id,
|
|
4544
4481
|
**kwargs
|
|
4545
4482
|
):
|
|
4546
|
-
"""
|
|
4483
|
+
"""pause_promoted_products # noqa: E501
|
|
4547
4484
|
|
|
4548
|
-
|
|
4485
|
+
Pause a collection of promoted products associated with a line item # noqa: E501
|
|
4549
4486
|
This method makes a synchronous HTTP request by default. To make an
|
|
4550
4487
|
asynchronous HTTP request, please pass async_req=True
|
|
4551
4488
|
|
|
4552
|
-
>>> thread = api.
|
|
4489
|
+
>>> thread = api.pause_promoted_products(line_item_id, async_req=True)
|
|
4553
4490
|
>>> result = thread.get()
|
|
4554
4491
|
|
|
4555
4492
|
Args:
|
|
4556
|
-
line_item_id (str):
|
|
4493
|
+
line_item_id (str): ID of the line item
|
|
4557
4494
|
|
|
4558
4495
|
Keyword Args:
|
|
4559
|
-
|
|
4496
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
4560
4497
|
_return_http_data_only (bool): response data without head status
|
|
4561
4498
|
code and headers. Default is True.
|
|
4562
4499
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4589,7 +4526,7 @@ class CampaignApi(object):
|
|
|
4589
4526
|
async_req (bool): execute request asynchronously
|
|
4590
4527
|
|
|
4591
4528
|
Returns:
|
|
4592
|
-
|
|
4529
|
+
None
|
|
4593
4530
|
If the method is called asynchronously, returns the request
|
|
4594
4531
|
thread.
|
|
4595
4532
|
"""
|
|
@@ -4620,7 +4557,7 @@ class CampaignApi(object):
|
|
|
4620
4557
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4621
4558
|
kwargs['line_item_id'] = \
|
|
4622
4559
|
line_item_id
|
|
4623
|
-
return self.
|
|
4560
|
+
return self.pause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
4624
4561
|
|
|
4625
4562
|
def post_api_external_v2_account_brand_catalog_export_by_account_id(
|
|
4626
4563
|
self,
|
|
@@ -4790,25 +4727,24 @@ class CampaignApi(object):
|
|
|
4790
4727
|
account_id
|
|
4791
4728
|
return self.post_api_external_v2_account_seller_catalog_export_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
4792
4729
|
|
|
4793
|
-
def
|
|
4730
|
+
def post_api_v1_external_catalogs_sku_retrieval(
|
|
4794
4731
|
self,
|
|
4795
|
-
campaign_id,
|
|
4796
4732
|
**kwargs
|
|
4797
4733
|
):
|
|
4798
|
-
"""
|
|
4734
|
+
"""post_api_v1_external_catalogs_sku_retrieval # noqa: E501
|
|
4799
4735
|
|
|
4800
|
-
|
|
4736
|
+
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
4801
4737
|
This method makes a synchronous HTTP request by default. To make an
|
|
4802
4738
|
asynchronous HTTP request, please pass async_req=True
|
|
4803
4739
|
|
|
4804
|
-
>>> thread = api.
|
|
4740
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_retrieval(async_req=True)
|
|
4805
4741
|
>>> result = thread.get()
|
|
4806
4742
|
|
|
4807
|
-
Args:
|
|
4808
|
-
campaign_id (str): The given campaign id
|
|
4809
4743
|
|
|
4810
4744
|
Keyword Args:
|
|
4811
|
-
|
|
4745
|
+
page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
4746
|
+
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4747
|
+
request_body ([str]): The list of SKU keys to retrieve sku information. [optional]
|
|
4812
4748
|
_return_http_data_only (bool): response data without head status
|
|
4813
4749
|
code and headers. Default is True.
|
|
4814
4750
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4841,7 +4777,7 @@ class CampaignApi(object):
|
|
|
4841
4777
|
async_req (bool): execute request asynchronously
|
|
4842
4778
|
|
|
4843
4779
|
Returns:
|
|
4844
|
-
|
|
4780
|
+
SkuDataPreviewListResponse
|
|
4845
4781
|
If the method is called asynchronously, returns the request
|
|
4846
4782
|
thread.
|
|
4847
4783
|
"""
|
|
@@ -4870,28 +4806,26 @@ class CampaignApi(object):
|
|
|
4870
4806
|
'_content_type')
|
|
4871
4807
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4872
4808
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4873
|
-
kwargs
|
|
4874
|
-
campaign_id
|
|
4875
|
-
return self.post_api_external_v2_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
4809
|
+
return self.post_api_v1_external_catalogs_sku_retrieval_endpoint.call_with_http_info(**kwargs)
|
|
4876
4810
|
|
|
4877
|
-
def
|
|
4811
|
+
def post_api_v1_external_catalogs_sku_search(
|
|
4878
4812
|
self,
|
|
4879
4813
|
**kwargs
|
|
4880
4814
|
):
|
|
4881
|
-
"""
|
|
4815
|
+
"""post_api_v1_external_catalogs_sku_search # noqa: E501
|
|
4882
4816
|
|
|
4883
4817
|
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
4884
4818
|
This method makes a synchronous HTTP request by default. To make an
|
|
4885
4819
|
asynchronous HTTP request, please pass async_req=True
|
|
4886
4820
|
|
|
4887
|
-
>>> thread = api.
|
|
4821
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_search(async_req=True)
|
|
4888
4822
|
>>> result = thread.get()
|
|
4889
4823
|
|
|
4890
4824
|
|
|
4891
4825
|
Keyword Args:
|
|
4892
4826
|
page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
4893
4827
|
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4894
|
-
|
|
4828
|
+
sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional]
|
|
4895
4829
|
_return_http_data_only (bool): response data without head status
|
|
4896
4830
|
code and headers. Default is True.
|
|
4897
4831
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4953,26 +4887,27 @@ class CampaignApi(object):
|
|
|
4953
4887
|
'_content_type')
|
|
4954
4888
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4955
4889
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4956
|
-
return self.
|
|
4890
|
+
return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs)
|
|
4957
4891
|
|
|
4958
|
-
def
|
|
4892
|
+
def post_api_v2_external_account_creatives_by_account_id(
|
|
4959
4893
|
self,
|
|
4894
|
+
account_id,
|
|
4960
4895
|
**kwargs
|
|
4961
4896
|
):
|
|
4962
|
-
"""
|
|
4897
|
+
"""post_api_v2_external_account_creatives_by_account_id # noqa: E501
|
|
4963
4898
|
|
|
4964
|
-
|
|
4899
|
+
Create a creative for an account # noqa: E501
|
|
4965
4900
|
This method makes a synchronous HTTP request by default. To make an
|
|
4966
4901
|
asynchronous HTTP request, please pass async_req=True
|
|
4967
4902
|
|
|
4968
|
-
>>> thread = api.
|
|
4903
|
+
>>> thread = api.post_api_v2_external_account_creatives_by_account_id(account_id, async_req=True)
|
|
4969
4904
|
>>> result = thread.get()
|
|
4970
4905
|
|
|
4906
|
+
Args:
|
|
4907
|
+
account_id (str): External account id to create a creative for
|
|
4971
4908
|
|
|
4972
4909
|
Keyword Args:
|
|
4973
|
-
|
|
4974
|
-
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4975
|
-
sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional]
|
|
4910
|
+
creative_create_model2 (CreativeCreateModel2): The creative to create. [optional]
|
|
4976
4911
|
_return_http_data_only (bool): response data without head status
|
|
4977
4912
|
code and headers. Default is True.
|
|
4978
4913
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5005,7 +4940,7 @@ class CampaignApi(object):
|
|
|
5005
4940
|
async_req (bool): execute request asynchronously
|
|
5006
4941
|
|
|
5007
4942
|
Returns:
|
|
5008
|
-
|
|
4943
|
+
Creative2Response
|
|
5009
4944
|
If the method is called asynchronously, returns the request
|
|
5010
4945
|
thread.
|
|
5011
4946
|
"""
|
|
@@ -5034,27 +4969,29 @@ class CampaignApi(object):
|
|
|
5034
4969
|
'_content_type')
|
|
5035
4970
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5036
4971
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5037
|
-
|
|
4972
|
+
kwargs['account_id'] = \
|
|
4973
|
+
account_id
|
|
4974
|
+
return self.post_api_v2_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
5038
4975
|
|
|
5039
|
-
def
|
|
4976
|
+
def post_api_v2_external_account_creatives_search_by_account_id(
|
|
5040
4977
|
self,
|
|
5041
4978
|
account_id,
|
|
5042
4979
|
**kwargs
|
|
5043
4980
|
):
|
|
5044
|
-
"""
|
|
4981
|
+
"""post_api_v2_external_account_creatives_search_by_account_id # noqa: E501
|
|
5045
4982
|
|
|
5046
|
-
|
|
4983
|
+
Get account creatives # noqa: E501
|
|
5047
4984
|
This method makes a synchronous HTTP request by default. To make an
|
|
5048
4985
|
asynchronous HTTP request, please pass async_req=True
|
|
5049
4986
|
|
|
5050
|
-
>>> thread = api.
|
|
4987
|
+
>>> thread = api.post_api_v2_external_account_creatives_search_by_account_id(account_id, async_req=True)
|
|
5051
4988
|
>>> result = thread.get()
|
|
5052
4989
|
|
|
5053
4990
|
Args:
|
|
5054
|
-
account_id (str): External account id to
|
|
4991
|
+
account_id (str): External account id to retrieve creatives for
|
|
5055
4992
|
|
|
5056
4993
|
Keyword Args:
|
|
5057
|
-
|
|
4994
|
+
creative_ids ([str]): Creatives to filter by. [optional]
|
|
5058
4995
|
_return_http_data_only (bool): response data without head status
|
|
5059
4996
|
code and headers. Default is True.
|
|
5060
4997
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5087,7 +5024,7 @@ class CampaignApi(object):
|
|
|
5087
5024
|
async_req (bool): execute request asynchronously
|
|
5088
5025
|
|
|
5089
5026
|
Returns:
|
|
5090
|
-
|
|
5027
|
+
Creative2ListResponse
|
|
5091
5028
|
If the method is called asynchronously, returns the request
|
|
5092
5029
|
thread.
|
|
5093
5030
|
"""
|
|
@@ -5118,27 +5055,29 @@ class CampaignApi(object):
|
|
|
5118
5055
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5119
5056
|
kwargs['account_id'] = \
|
|
5120
5057
|
account_id
|
|
5121
|
-
return self.
|
|
5058
|
+
return self.post_api_v2_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
5122
5059
|
|
|
5123
|
-
def
|
|
5060
|
+
def put_api_v2_external_account_by_account_id_creativescreative_id(
|
|
5124
5061
|
self,
|
|
5125
5062
|
account_id,
|
|
5063
|
+
creative_id,
|
|
5126
5064
|
**kwargs
|
|
5127
5065
|
):
|
|
5128
|
-
"""
|
|
5066
|
+
"""put_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
|
|
5129
5067
|
|
|
5130
|
-
|
|
5068
|
+
Update a creative # noqa: E501
|
|
5131
5069
|
This method makes a synchronous HTTP request by default. To make an
|
|
5132
5070
|
asynchronous HTTP request, please pass async_req=True
|
|
5133
5071
|
|
|
5134
|
-
>>> thread = api.
|
|
5072
|
+
>>> thread = api.put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
|
|
5135
5073
|
>>> result = thread.get()
|
|
5136
5074
|
|
|
5137
5075
|
Args:
|
|
5138
|
-
account_id (str): External account id
|
|
5076
|
+
account_id (str): External account id containing the creative
|
|
5077
|
+
creative_id (str): Creative to update
|
|
5139
5078
|
|
|
5140
5079
|
Keyword Args:
|
|
5141
|
-
|
|
5080
|
+
creative_update_model2 (CreativeUpdateModel2): The creative to create. [optional]
|
|
5142
5081
|
_return_http_data_only (bool): response data without head status
|
|
5143
5082
|
code and headers. Default is True.
|
|
5144
5083
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5171,7 +5110,7 @@ class CampaignApi(object):
|
|
|
5171
5110
|
async_req (bool): execute request asynchronously
|
|
5172
5111
|
|
|
5173
5112
|
Returns:
|
|
5174
|
-
|
|
5113
|
+
Creative2Response
|
|
5175
5114
|
If the method is called asynchronously, returns the request
|
|
5176
5115
|
thread.
|
|
5177
5116
|
"""
|
|
@@ -5202,29 +5141,29 @@ class CampaignApi(object):
|
|
|
5202
5141
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5203
5142
|
kwargs['account_id'] = \
|
|
5204
5143
|
account_id
|
|
5205
|
-
|
|
5144
|
+
kwargs['creative_id'] = \
|
|
5145
|
+
creative_id
|
|
5146
|
+
return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
5206
5147
|
|
|
5207
|
-
def
|
|
5148
|
+
def recommended_keywords(
|
|
5208
5149
|
self,
|
|
5209
|
-
|
|
5210
|
-
product_button_id,
|
|
5150
|
+
retailer_id,
|
|
5211
5151
|
**kwargs
|
|
5212
5152
|
):
|
|
5213
|
-
"""
|
|
5153
|
+
"""recommended_keywords # noqa: E501
|
|
5214
5154
|
|
|
5215
|
-
|
|
5155
|
+
Recommend keywords by given retailer id and sku ids. # noqa: E501
|
|
5216
5156
|
This method makes a synchronous HTTP request by default. To make an
|
|
5217
5157
|
asynchronous HTTP request, please pass async_req=True
|
|
5218
5158
|
|
|
5219
|
-
>>> thread = api.
|
|
5159
|
+
>>> thread = api.recommended_keywords(retailer_id, async_req=True)
|
|
5220
5160
|
>>> result = thread.get()
|
|
5221
5161
|
|
|
5222
5162
|
Args:
|
|
5223
|
-
|
|
5224
|
-
product_button_id (str): productButtonId used for update
|
|
5163
|
+
retailer_id (str): Retailer id.
|
|
5225
5164
|
|
|
5226
5165
|
Keyword Args:
|
|
5227
|
-
|
|
5166
|
+
value_resource_input_recommended_keywords_request_v1 (ValueResourceInputRecommendedKeywordsRequestV1): Request of recommended keywords.. [optional]
|
|
5228
5167
|
_return_http_data_only (bool): response data without head status
|
|
5229
5168
|
code and headers. Default is True.
|
|
5230
5169
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5257,7 +5196,7 @@ class CampaignApi(object):
|
|
|
5257
5196
|
async_req (bool): execute request asynchronously
|
|
5258
5197
|
|
|
5259
5198
|
Returns:
|
|
5260
|
-
|
|
5199
|
+
ValueResourceOutcomeRecommendedKeywordsResponseV1
|
|
5261
5200
|
If the method is called asynchronously, returns the request
|
|
5262
5201
|
thread.
|
|
5263
5202
|
"""
|
|
@@ -5286,31 +5225,28 @@ class CampaignApi(object):
|
|
|
5286
5225
|
'_content_type')
|
|
5287
5226
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5288
5227
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5289
|
-
kwargs['
|
|
5290
|
-
|
|
5291
|
-
kwargs
|
|
5292
|
-
product_button_id
|
|
5293
|
-
return self.put_api_external_v1_line_item_by_line_item_id_product_buttonsproduct_button_id_endpoint.call_with_http_info(**kwargs)
|
|
5228
|
+
kwargs['retailer_id'] = \
|
|
5229
|
+
retailer_id
|
|
5230
|
+
return self.recommended_keywords_endpoint.call_with_http_info(**kwargs)
|
|
5294
5231
|
|
|
5295
|
-
def
|
|
5232
|
+
def search_brands(
|
|
5296
5233
|
self,
|
|
5297
|
-
line_item_id,
|
|
5298
5234
|
**kwargs
|
|
5299
5235
|
):
|
|
5300
|
-
"""
|
|
5236
|
+
"""search_brands # noqa: E501
|
|
5301
5237
|
|
|
5302
|
-
|
|
5238
|
+
Search for brands given a retailer ID and search term. # noqa: E501
|
|
5303
5239
|
This method makes a synchronous HTTP request by default. To make an
|
|
5304
5240
|
asynchronous HTTP request, please pass async_req=True
|
|
5305
5241
|
|
|
5306
|
-
>>> thread = api.
|
|
5242
|
+
>>> thread = api.search_brands(async_req=True)
|
|
5307
5243
|
>>> result = thread.get()
|
|
5308
5244
|
|
|
5309
|
-
Args:
|
|
5310
|
-
line_item_id (str): The given line item id
|
|
5311
5245
|
|
|
5312
5246
|
Keyword Args:
|
|
5313
|
-
|
|
5247
|
+
limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
|
|
5248
|
+
offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
|
|
5249
|
+
value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
|
|
5314
5250
|
_return_http_data_only (bool): response data without head status
|
|
5315
5251
|
code and headers. Default is True.
|
|
5316
5252
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5343,7 +5279,7 @@ class CampaignApi(object):
|
|
|
5343
5279
|
async_req (bool): execute request asynchronously
|
|
5344
5280
|
|
|
5345
5281
|
Returns:
|
|
5346
|
-
|
|
5282
|
+
EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
|
|
5347
5283
|
If the method is called asynchronously, returns the request
|
|
5348
5284
|
thread.
|
|
5349
5285
|
"""
|
|
@@ -5372,31 +5308,29 @@ class CampaignApi(object):
|
|
|
5372
5308
|
'_content_type')
|
|
5373
5309
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5374
5310
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5375
|
-
kwargs
|
|
5376
|
-
line_item_id
|
|
5377
|
-
return self.put_api_external_v2_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
5311
|
+
return self.search_brands_endpoint.call_with_http_info(**kwargs)
|
|
5378
5312
|
|
|
5379
|
-
def
|
|
5313
|
+
def search_category(
|
|
5380
5314
|
self,
|
|
5381
|
-
|
|
5382
|
-
creative_id,
|
|
5315
|
+
retailer_id,
|
|
5383
5316
|
**kwargs
|
|
5384
5317
|
):
|
|
5385
|
-
"""
|
|
5318
|
+
"""search_category # noqa: E501
|
|
5386
5319
|
|
|
5387
|
-
|
|
5320
|
+
Search a retailer categories by given text substring and category ids. # noqa: E501
|
|
5388
5321
|
This method makes a synchronous HTTP request by default. To make an
|
|
5389
5322
|
asynchronous HTTP request, please pass async_req=True
|
|
5390
5323
|
|
|
5391
|
-
>>> thread = api.
|
|
5324
|
+
>>> thread = api.search_category(retailer_id, async_req=True)
|
|
5392
5325
|
>>> result = thread.get()
|
|
5393
5326
|
|
|
5394
5327
|
Args:
|
|
5395
|
-
|
|
5396
|
-
creative_id (str): Creative to update
|
|
5328
|
+
retailer_id (int): Retailer id.
|
|
5397
5329
|
|
|
5398
5330
|
Keyword Args:
|
|
5399
|
-
|
|
5331
|
+
limit (int): Limit of the search result.. [optional] if omitted the server will use the default value of 50
|
|
5332
|
+
offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
|
|
5333
|
+
value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
|
|
5400
5334
|
_return_http_data_only (bool): response data without head status
|
|
5401
5335
|
code and headers. Default is True.
|
|
5402
5336
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5429,7 +5363,7 @@ class CampaignApi(object):
|
|
|
5429
5363
|
async_req (bool): execute request asynchronously
|
|
5430
5364
|
|
|
5431
5365
|
Returns:
|
|
5432
|
-
|
|
5366
|
+
EntityResourceCollectionOutcomeCategory202204Metadata
|
|
5433
5367
|
If the method is called asynchronously, returns the request
|
|
5434
5368
|
thread.
|
|
5435
5369
|
"""
|
|
@@ -5458,31 +5392,29 @@ class CampaignApi(object):
|
|
|
5458
5392
|
'_content_type')
|
|
5459
5393
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5460
5394
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5461
|
-
kwargs['
|
|
5462
|
-
|
|
5463
|
-
kwargs
|
|
5464
|
-
creative_id
|
|
5465
|
-
return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
5395
|
+
kwargs['retailer_id'] = \
|
|
5396
|
+
retailer_id
|
|
5397
|
+
return self.search_category_endpoint.call_with_http_info(**kwargs)
|
|
5466
5398
|
|
|
5467
|
-
def
|
|
5399
|
+
def set_keyword_bids(
|
|
5468
5400
|
self,
|
|
5469
|
-
|
|
5401
|
+
id,
|
|
5470
5402
|
**kwargs
|
|
5471
5403
|
):
|
|
5472
|
-
"""
|
|
5404
|
+
"""set_keyword_bids # noqa: E501
|
|
5473
5405
|
|
|
5474
|
-
|
|
5406
|
+
Set bid overrides for associated keywords to the given line item in bulk # noqa: E501
|
|
5475
5407
|
This method makes a synchronous HTTP request by default. To make an
|
|
5476
5408
|
asynchronous HTTP request, please pass async_req=True
|
|
5477
5409
|
|
|
5478
|
-
>>> thread = api.
|
|
5410
|
+
>>> thread = api.set_keyword_bids(id, async_req=True)
|
|
5479
5411
|
>>> result = thread.get()
|
|
5480
5412
|
|
|
5481
5413
|
Args:
|
|
5482
|
-
|
|
5414
|
+
id (str): ID of the line item
|
|
5483
5415
|
|
|
5484
5416
|
Keyword Args:
|
|
5485
|
-
|
|
5417
|
+
set_bids_model_request (SetBidsModelRequest): [optional]
|
|
5486
5418
|
_return_http_data_only (bool): response data without head status
|
|
5487
5419
|
code and headers. Default is True.
|
|
5488
5420
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5515,7 +5447,7 @@ class CampaignApi(object):
|
|
|
5515
5447
|
async_req (bool): execute request asynchronously
|
|
5516
5448
|
|
|
5517
5449
|
Returns:
|
|
5518
|
-
|
|
5450
|
+
ResourceOutcome
|
|
5519
5451
|
If the method is called asynchronously, returns the request
|
|
5520
5452
|
thread.
|
|
5521
5453
|
"""
|
|
@@ -5544,28 +5476,29 @@ class CampaignApi(object):
|
|
|
5544
5476
|
'_content_type')
|
|
5545
5477
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5546
5478
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5547
|
-
kwargs['
|
|
5548
|
-
|
|
5549
|
-
return self.
|
|
5479
|
+
kwargs['id'] = \
|
|
5480
|
+
id
|
|
5481
|
+
return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
|
|
5550
5482
|
|
|
5551
|
-
def
|
|
5483
|
+
def unpause_promoted_products(
|
|
5552
5484
|
self,
|
|
5485
|
+
line_item_id,
|
|
5553
5486
|
**kwargs
|
|
5554
5487
|
):
|
|
5555
|
-
"""
|
|
5488
|
+
"""unpause_promoted_products # noqa: E501
|
|
5556
5489
|
|
|
5557
|
-
|
|
5490
|
+
Un-pause a collection of promoted products associated with a line item # noqa: E501
|
|
5558
5491
|
This method makes a synchronous HTTP request by default. To make an
|
|
5559
5492
|
asynchronous HTTP request, please pass async_req=True
|
|
5560
5493
|
|
|
5561
|
-
>>> thread = api.
|
|
5494
|
+
>>> thread = api.unpause_promoted_products(line_item_id, async_req=True)
|
|
5562
5495
|
>>> result = thread.get()
|
|
5563
5496
|
|
|
5497
|
+
Args:
|
|
5498
|
+
line_item_id (str): ID of the line item
|
|
5564
5499
|
|
|
5565
5500
|
Keyword Args:
|
|
5566
|
-
|
|
5567
|
-
offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
|
|
5568
|
-
value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
|
|
5501
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
5569
5502
|
_return_http_data_only (bool): response data without head status
|
|
5570
5503
|
code and headers. Default is True.
|
|
5571
5504
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5598,7 +5531,7 @@ class CampaignApi(object):
|
|
|
5598
5531
|
async_req (bool): execute request asynchronously
|
|
5599
5532
|
|
|
5600
5533
|
Returns:
|
|
5601
|
-
|
|
5534
|
+
None
|
|
5602
5535
|
If the method is called asynchronously, returns the request
|
|
5603
5536
|
thread.
|
|
5604
5537
|
"""
|
|
@@ -5627,27 +5560,29 @@ class CampaignApi(object):
|
|
|
5627
5560
|
'_content_type')
|
|
5628
5561
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5629
5562
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5630
|
-
|
|
5563
|
+
kwargs['line_item_id'] = \
|
|
5564
|
+
line_item_id
|
|
5565
|
+
return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
5631
5566
|
|
|
5632
|
-
def
|
|
5567
|
+
def update_auction_line_item_v2(
|
|
5633
5568
|
self,
|
|
5634
|
-
|
|
5569
|
+
line_item_id,
|
|
5635
5570
|
**kwargs
|
|
5636
5571
|
):
|
|
5637
|
-
"""
|
|
5572
|
+
"""update_auction_line_item_v2 # noqa: E501
|
|
5638
5573
|
|
|
5639
|
-
|
|
5574
|
+
Updates a Sponsored Products Line Item given a line item id and a request. # noqa: E501
|
|
5640
5575
|
This method makes a synchronous HTTP request by default. To make an
|
|
5641
5576
|
asynchronous HTTP request, please pass async_req=True
|
|
5642
5577
|
|
|
5643
|
-
>>> thread = api.
|
|
5578
|
+
>>> thread = api.update_auction_line_item_v2(line_item_id, async_req=True)
|
|
5644
5579
|
>>> result = thread.get()
|
|
5645
5580
|
|
|
5646
5581
|
Args:
|
|
5647
|
-
|
|
5582
|
+
line_item_id (int): The external line item ID of the sponsored products line item.
|
|
5648
5583
|
|
|
5649
5584
|
Keyword Args:
|
|
5650
|
-
|
|
5585
|
+
value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
|
|
5651
5586
|
_return_http_data_only (bool): response data without head status
|
|
5652
5587
|
code and headers. Default is True.
|
|
5653
5588
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5680,7 +5615,7 @@ class CampaignApi(object):
|
|
|
5680
5615
|
async_req (bool): execute request asynchronously
|
|
5681
5616
|
|
|
5682
5617
|
Returns:
|
|
5683
|
-
|
|
5618
|
+
EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
5684
5619
|
If the method is called asynchronously, returns the request
|
|
5685
5620
|
thread.
|
|
5686
5621
|
"""
|
|
@@ -5709,29 +5644,29 @@ class CampaignApi(object):
|
|
|
5709
5644
|
'_content_type')
|
|
5710
5645
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5711
5646
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5712
|
-
kwargs['
|
|
5713
|
-
|
|
5714
|
-
return self.
|
|
5647
|
+
kwargs['line_item_id'] = \
|
|
5648
|
+
line_item_id
|
|
5649
|
+
return self.update_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
5715
5650
|
|
|
5716
|
-
def
|
|
5651
|
+
def update_keyword_reviews_v1(
|
|
5717
5652
|
self,
|
|
5718
5653
|
line_item_id,
|
|
5719
5654
|
**kwargs
|
|
5720
5655
|
):
|
|
5721
|
-
"""
|
|
5656
|
+
"""update_keyword_reviews_v1 # noqa: E501
|
|
5722
5657
|
|
|
5723
|
-
|
|
5658
|
+
Update the status of keyword reviews under a line item # noqa: E501
|
|
5724
5659
|
This method makes a synchronous HTTP request by default. To make an
|
|
5725
5660
|
asynchronous HTTP request, please pass async_req=True
|
|
5726
5661
|
|
|
5727
|
-
>>> thread = api.
|
|
5662
|
+
>>> thread = api.update_keyword_reviews_v1(line_item_id, async_req=True)
|
|
5728
5663
|
>>> result = thread.get()
|
|
5729
5664
|
|
|
5730
5665
|
Args:
|
|
5731
|
-
line_item_id (
|
|
5666
|
+
line_item_id (int): The line item to update keyword review statuses for
|
|
5732
5667
|
|
|
5733
5668
|
Keyword Args:
|
|
5734
|
-
|
|
5669
|
+
value_resource_input_retail_media_keywords_review (ValueResourceInputRetailMediaKeywordsReview): Request object containing a list of Phrase-ReviewState pairs to update. [optional]
|
|
5735
5670
|
_return_http_data_only (bool): response data without head status
|
|
5736
5671
|
code and headers. Default is True.
|
|
5737
5672
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5764,7 +5699,7 @@ class CampaignApi(object):
|
|
|
5764
5699
|
async_req (bool): execute request asynchronously
|
|
5765
5700
|
|
|
5766
5701
|
Returns:
|
|
5767
|
-
|
|
5702
|
+
ValueResourceOutcomeRetailMediaKeywordsReviewResult
|
|
5768
5703
|
If the method is called asynchronously, returns the request
|
|
5769
5704
|
thread.
|
|
5770
5705
|
"""
|
|
@@ -5795,27 +5730,27 @@ class CampaignApi(object):
|
|
|
5795
5730
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5796
5731
|
kwargs['line_item_id'] = \
|
|
5797
5732
|
line_item_id
|
|
5798
|
-
return self.
|
|
5733
|
+
return self.update_keyword_reviews_v1_endpoint.call_with_http_info(**kwargs)
|
|
5799
5734
|
|
|
5800
|
-
def
|
|
5735
|
+
def update_preferred_line_item_by_line_item_id(
|
|
5801
5736
|
self,
|
|
5802
5737
|
line_item_id,
|
|
5803
5738
|
**kwargs
|
|
5804
5739
|
):
|
|
5805
|
-
"""
|
|
5740
|
+
"""update_preferred_line_item_by_line_item_id # noqa: E501
|
|
5806
5741
|
|
|
5807
|
-
Updates
|
|
5742
|
+
Updates the preferred line item for the given line item id # noqa: E501
|
|
5808
5743
|
This method makes a synchronous HTTP request by default. To make an
|
|
5809
5744
|
asynchronous HTTP request, please pass async_req=True
|
|
5810
5745
|
|
|
5811
|
-
>>> thread = api.
|
|
5746
|
+
>>> thread = api.update_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
|
|
5812
5747
|
>>> result = thread.get()
|
|
5813
5748
|
|
|
5814
5749
|
Args:
|
|
5815
|
-
line_item_id (
|
|
5750
|
+
line_item_id (str): The given line item id
|
|
5816
5751
|
|
|
5817
5752
|
Keyword Args:
|
|
5818
|
-
|
|
5753
|
+
preferred_line_item_update_model_v2_request (PreferredLineItemUpdateModelV2Request): The line item settings to create a line item with. [optional]
|
|
5819
5754
|
_return_http_data_only (bool): response data without head status
|
|
5820
5755
|
code and headers. Default is True.
|
|
5821
5756
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5848,7 +5783,7 @@ class CampaignApi(object):
|
|
|
5848
5783
|
async_req (bool): execute request asynchronously
|
|
5849
5784
|
|
|
5850
5785
|
Returns:
|
|
5851
|
-
|
|
5786
|
+
PreferredLineItemV2Response
|
|
5852
5787
|
If the method is called asynchronously, returns the request
|
|
5853
5788
|
thread.
|
|
5854
5789
|
"""
|
|
@@ -5879,27 +5814,29 @@ class CampaignApi(object):
|
|
|
5879
5814
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5880
5815
|
kwargs['line_item_id'] = \
|
|
5881
5816
|
line_item_id
|
|
5882
|
-
return self.
|
|
5817
|
+
return self.update_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
5883
5818
|
|
|
5884
|
-
def
|
|
5819
|
+
def update_product_button_by_line_item_and_product_button_id(
|
|
5885
5820
|
self,
|
|
5886
5821
|
line_item_id,
|
|
5822
|
+
product_button_id,
|
|
5887
5823
|
**kwargs
|
|
5888
5824
|
):
|
|
5889
|
-
"""
|
|
5825
|
+
"""update_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
5890
5826
|
|
|
5891
|
-
Update
|
|
5827
|
+
Update Specific Product Button # noqa: E501
|
|
5892
5828
|
This method makes a synchronous HTTP request by default. To make an
|
|
5893
5829
|
asynchronous HTTP request, please pass async_req=True
|
|
5894
5830
|
|
|
5895
|
-
>>> thread = api.
|
|
5831
|
+
>>> thread = api.update_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
5896
5832
|
>>> result = thread.get()
|
|
5897
5833
|
|
|
5898
5834
|
Args:
|
|
5899
|
-
line_item_id (
|
|
5835
|
+
line_item_id (str): LineItemId for productButton update
|
|
5836
|
+
product_button_id (str): productButtonId used for update
|
|
5900
5837
|
|
|
5901
5838
|
Keyword Args:
|
|
5902
|
-
|
|
5839
|
+
product_button_request_request (ProductButtonRequestRequest): Specific Product button update info. [optional]
|
|
5903
5840
|
_return_http_data_only (bool): response data without head status
|
|
5904
5841
|
code and headers. Default is True.
|
|
5905
5842
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5932,7 +5869,7 @@ class CampaignApi(object):
|
|
|
5932
5869
|
async_req (bool): execute request asynchronously
|
|
5933
5870
|
|
|
5934
5871
|
Returns:
|
|
5935
|
-
|
|
5872
|
+
ProductButtonResponseListResponse
|
|
5936
5873
|
If the method is called asynchronously, returns the request
|
|
5937
5874
|
thread.
|
|
5938
5875
|
"""
|
|
@@ -5963,5 +5900,7 @@ class CampaignApi(object):
|
|
|
5963
5900
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5964
5901
|
kwargs['line_item_id'] = \
|
|
5965
5902
|
line_item_id
|
|
5966
|
-
|
|
5903
|
+
kwargs['product_button_id'] = \
|
|
5904
|
+
product_button_id
|
|
5905
|
+
return self.update_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
5967
5906
|
|