criteo-api-retailmedia-sdk 0.0.250911__py3-none-any.whl → 0.0.251009__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 +71 -83
- criteo_api_retailmedia_preview/api/analytics_api.py +155 -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 +20 -25
- criteo_api_retailmedia_preview/api/campaign_api.py +1103 -996
- criteo_api_retailmedia_preview/api/catalog_api.py +6 -22
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +5 -0
- criteo_api_retailmedia_preview/model/{product_importer_error.py → async_unfilled_placements_report.py} +134 -41
- criteo_api_retailmedia_preview/model/{report_outcome.py → async_unfilled_placements_report_request.py} +9 -15
- criteo_api_retailmedia_preview/model/{error_code_response.py → async_unfilled_placements_report_resource.py} +15 -23
- criteo_api_retailmedia_preview/model/campaign_availability.py +289 -0
- criteo_api_retailmedia_preview/model/demand_managed_fee.py +1 -1
- criteo_api_retailmedia_preview/model/{value_resource_outcome_account_fees_update_result.py → entity_resource_collection_outcome_of_retailer_result_and_metadata.py} +14 -8
- criteo_api_retailmedia_preview/model/{outcome.py → entity_resource_of_retailer_result.py} +17 -15
- criteo_api_retailmedia_preview/model/files_variable_value.py +0 -3
- criteo_api_retailmedia_preview/model/managed_service_fee.py +1 -1
- criteo_api_retailmedia_preview/model/page_type_combination.py +287 -0
- criteo_api_retailmedia_preview/model/private_market_fees.py +6 -14
- criteo_api_retailmedia_preview/model/retailer_result.py +266 -0
- criteo_api_retailmedia_preview/model/{account_fees_update_result.py → retailer_search_request.py} +8 -12
- criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +1 -0
- criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +11 -2
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +8 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +34 -28
- criteo_api_retailmedia_preview/model/value_resource_input_of_retailer_search_request.py +262 -0
- criteo_api_retailmedia_preview/model/{value_resource_account_fees_update_result.py → value_resource_of_retailer_search_request.py} +9 -9
- criteo_api_retailmedia_preview/models/__init__.py +11 -9
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/RECORD +36 -34
- criteo_api_retailmedia_preview/model/fail_response.py +0 -283
- criteo_api_retailmedia_preview/model/product_importer_warning.py +0 -299
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.250911.dist-info → criteo_api_retailmedia_sdk-0.0.251009.dist-info}/top_level.txt +0 -0
|
@@ -32,11 +32,11 @@ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_bra
|
|
|
32
32
|
from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204 import EntityResourceCollectionOutcomeCategory202204
|
|
33
33
|
from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204_metadata import EntityResourceCollectionOutcomeCategory202204Metadata
|
|
34
34
|
from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_line_item_keyword_review_report_and_metadata import EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
|
|
35
|
+
from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retailer_result_and_metadata import EntityResourceCollectionOutcomeOfRetailerResultAndMetadata
|
|
35
36
|
from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_sponsored_products_line_item_and_metadata import EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
|
|
36
37
|
from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_catalog_status_v2 import EntityResourceOutcomeOfCatalogStatusV2
|
|
37
38
|
from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_sponsored_products_line_item import EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
38
39
|
from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse
|
|
39
|
-
from criteo_api_retailmedia_preview.model.outcome import Outcome
|
|
40
40
|
from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse
|
|
41
41
|
from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request
|
|
42
42
|
from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request
|
|
@@ -56,6 +56,7 @@ from criteo_api_retailmedia_preview.model.sku_search_request_preview_request imp
|
|
|
56
56
|
from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
|
|
57
57
|
from criteo_api_retailmedia_preview.model.value_resource_input_categories_search_request_v1 import ValueResourceInputCategoriesSearchRequestV1
|
|
58
58
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_brand_catalog_request_v2 import ValueResourceInputOfBrandCatalogRequestV2
|
|
59
|
+
from criteo_api_retailmedia_preview.model.value_resource_input_of_retailer_search_request import ValueResourceInputOfRetailerSearchRequest
|
|
59
60
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_catalog_request_v2 import ValueResourceInputOfSellerCatalogRequestV2
|
|
60
61
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_products_line_item_create_request_model import ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel
|
|
61
62
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_products_line_item_update_request_model import ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel
|
|
@@ -135,27 +136,28 @@ class CampaignApi(object):
|
|
|
135
136
|
},
|
|
136
137
|
api_client=api_client
|
|
137
138
|
)
|
|
138
|
-
self.
|
|
139
|
+
self.append_product_button_by_line_item_id_endpoint = _Endpoint(
|
|
139
140
|
settings={
|
|
140
|
-
'response_type': (
|
|
141
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
141
142
|
'auth': [
|
|
142
143
|
'oauth',
|
|
143
144
|
'oauth'
|
|
144
145
|
],
|
|
145
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
146
|
-
'operation_id': '
|
|
146
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create',
|
|
147
|
+
'operation_id': 'append_product_button_by_line_item_id',
|
|
147
148
|
'http_method': 'POST',
|
|
148
149
|
'servers': None,
|
|
149
150
|
},
|
|
150
151
|
params_map={
|
|
151
152
|
'all': [
|
|
152
153
|
'line_item_id',
|
|
153
|
-
'
|
|
154
|
+
'product_button_request_list_request',
|
|
154
155
|
],
|
|
155
156
|
'required': [
|
|
156
157
|
'line_item_id',
|
|
157
158
|
],
|
|
158
159
|
'nullable': [
|
|
160
|
+
'product_button_request_list_request',
|
|
159
161
|
],
|
|
160
162
|
'enum': [
|
|
161
163
|
],
|
|
@@ -170,15 +172,15 @@ class CampaignApi(object):
|
|
|
170
172
|
'openapi_types': {
|
|
171
173
|
'line_item_id':
|
|
172
174
|
(str,),
|
|
173
|
-
'
|
|
174
|
-
(
|
|
175
|
+
'product_button_request_list_request':
|
|
176
|
+
(ProductButtonRequestListRequest,),
|
|
175
177
|
},
|
|
176
178
|
'attribute_map': {
|
|
177
179
|
'line_item_id': 'line-item-id',
|
|
178
180
|
},
|
|
179
181
|
'location_map': {
|
|
180
182
|
'line_item_id': 'path',
|
|
181
|
-
'
|
|
183
|
+
'product_button_request_list_request': 'body',
|
|
182
184
|
},
|
|
183
185
|
'collection_format_map': {
|
|
184
186
|
}
|
|
@@ -193,72 +195,50 @@ class CampaignApi(object):
|
|
|
193
195
|
},
|
|
194
196
|
api_client=api_client
|
|
195
197
|
)
|
|
196
|
-
self.
|
|
198
|
+
self.append_promoted_products_endpoint = _Endpoint(
|
|
197
199
|
settings={
|
|
198
|
-
'response_type': (
|
|
200
|
+
'response_type': (ProductResourceOutcome,),
|
|
199
201
|
'auth': [
|
|
200
202
|
'oauth',
|
|
201
203
|
'oauth'
|
|
202
204
|
],
|
|
203
|
-
'endpoint_path': '/preview/retail-media/
|
|
204
|
-
'operation_id': '
|
|
205
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/products/append',
|
|
206
|
+
'operation_id': 'append_promoted_products',
|
|
205
207
|
'http_method': 'POST',
|
|
206
208
|
'servers': None,
|
|
207
209
|
},
|
|
208
210
|
params_map={
|
|
209
211
|
'all': [
|
|
210
|
-
'
|
|
211
|
-
'
|
|
212
|
-
'offset',
|
|
213
|
-
'value_resource_input_categories_search_request_v1',
|
|
212
|
+
'line_item_id',
|
|
213
|
+
'promoted_product_resource_collection_input',
|
|
214
214
|
],
|
|
215
215
|
'required': [
|
|
216
|
-
'
|
|
216
|
+
'line_item_id',
|
|
217
217
|
],
|
|
218
218
|
'nullable': [
|
|
219
219
|
],
|
|
220
220
|
'enum': [
|
|
221
221
|
],
|
|
222
222
|
'validation': [
|
|
223
|
-
'limit',
|
|
224
|
-
'offset',
|
|
225
223
|
]
|
|
226
224
|
},
|
|
227
225
|
root_map={
|
|
228
226
|
'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
227
|
},
|
|
240
228
|
'allowed_values': {
|
|
241
229
|
},
|
|
242
230
|
'openapi_types': {
|
|
243
|
-
'
|
|
244
|
-
(
|
|
245
|
-
'
|
|
246
|
-
(
|
|
247
|
-
'offset':
|
|
248
|
-
(int,),
|
|
249
|
-
'value_resource_input_categories_search_request_v1':
|
|
250
|
-
(ValueResourceInputCategoriesSearchRequestV1,),
|
|
231
|
+
'line_item_id':
|
|
232
|
+
(str,),
|
|
233
|
+
'promoted_product_resource_collection_input':
|
|
234
|
+
(PromotedProductResourceCollectionInput,),
|
|
251
235
|
},
|
|
252
236
|
'attribute_map': {
|
|
253
|
-
'
|
|
254
|
-
'limit': 'limit',
|
|
255
|
-
'offset': 'offset',
|
|
237
|
+
'line_item_id': 'line-item-id',
|
|
256
238
|
},
|
|
257
239
|
'location_map': {
|
|
258
|
-
'
|
|
259
|
-
'
|
|
260
|
-
'offset': 'query',
|
|
261
|
-
'value_resource_input_categories_search_request_v1': 'body',
|
|
240
|
+
'line_item_id': 'path',
|
|
241
|
+
'promoted_product_resource_collection_input': 'body',
|
|
262
242
|
},
|
|
263
243
|
'collection_format_map': {
|
|
264
244
|
}
|
|
@@ -268,10 +248,7 @@ class CampaignApi(object):
|
|
|
268
248
|
'application/json'
|
|
269
249
|
],
|
|
270
250
|
'content_type': [
|
|
271
|
-
'application/json
|
|
272
|
-
'application/json',
|
|
273
|
-
'text/json',
|
|
274
|
-
'application/*+json'
|
|
251
|
+
'application/json'
|
|
275
252
|
]
|
|
276
253
|
},
|
|
277
254
|
api_client=api_client
|
|
@@ -329,14 +306,128 @@ class CampaignApi(object):
|
|
|
329
306
|
'application/json'
|
|
330
307
|
],
|
|
331
308
|
'content_type': [
|
|
332
|
-
'application/json'
|
|
333
|
-
|
|
334
|
-
|
|
309
|
+
'application/json'
|
|
310
|
+
]
|
|
311
|
+
},
|
|
312
|
+
api_client=api_client
|
|
313
|
+
)
|
|
314
|
+
self.create_creative_endpoint = _Endpoint(
|
|
315
|
+
settings={
|
|
316
|
+
'response_type': (Creative2Response,),
|
|
317
|
+
'auth': [
|
|
318
|
+
'oauth',
|
|
319
|
+
'oauth'
|
|
320
|
+
],
|
|
321
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives',
|
|
322
|
+
'operation_id': 'create_creative',
|
|
323
|
+
'http_method': 'POST',
|
|
324
|
+
'servers': None,
|
|
325
|
+
},
|
|
326
|
+
params_map={
|
|
327
|
+
'all': [
|
|
328
|
+
'account_id',
|
|
329
|
+
'creative_create_model2',
|
|
330
|
+
],
|
|
331
|
+
'required': [
|
|
332
|
+
'account_id',
|
|
333
|
+
],
|
|
334
|
+
'nullable': [
|
|
335
|
+
],
|
|
336
|
+
'enum': [
|
|
337
|
+
],
|
|
338
|
+
'validation': [
|
|
339
|
+
]
|
|
340
|
+
},
|
|
341
|
+
root_map={
|
|
342
|
+
'validations': {
|
|
343
|
+
},
|
|
344
|
+
'allowed_values': {
|
|
345
|
+
},
|
|
346
|
+
'openapi_types': {
|
|
347
|
+
'account_id':
|
|
348
|
+
(str,),
|
|
349
|
+
'creative_create_model2':
|
|
350
|
+
(CreativeCreateModel2,),
|
|
351
|
+
},
|
|
352
|
+
'attribute_map': {
|
|
353
|
+
'account_id': 'account-id',
|
|
354
|
+
},
|
|
355
|
+
'location_map': {
|
|
356
|
+
'account_id': 'path',
|
|
357
|
+
'creative_create_model2': 'body',
|
|
358
|
+
},
|
|
359
|
+
'collection_format_map': {
|
|
360
|
+
}
|
|
361
|
+
},
|
|
362
|
+
headers_map={
|
|
363
|
+
'accept': [
|
|
364
|
+
'application/json'
|
|
365
|
+
],
|
|
366
|
+
'content_type': [
|
|
367
|
+
'application/json'
|
|
368
|
+
]
|
|
369
|
+
},
|
|
370
|
+
api_client=api_client
|
|
371
|
+
)
|
|
372
|
+
self.create_preferred_line_item_by_campaign_id_endpoint = _Endpoint(
|
|
373
|
+
settings={
|
|
374
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
375
|
+
'auth': [
|
|
376
|
+
'oauth',
|
|
377
|
+
'oauth'
|
|
378
|
+
],
|
|
379
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
380
|
+
'operation_id': 'create_preferred_line_item_by_campaign_id',
|
|
381
|
+
'http_method': 'POST',
|
|
382
|
+
'servers': None,
|
|
383
|
+
},
|
|
384
|
+
params_map={
|
|
385
|
+
'all': [
|
|
386
|
+
'campaign_id',
|
|
387
|
+
'preferred_line_item_create_model_v2_request',
|
|
388
|
+
],
|
|
389
|
+
'required': [
|
|
390
|
+
'campaign_id',
|
|
391
|
+
],
|
|
392
|
+
'nullable': [
|
|
393
|
+
],
|
|
394
|
+
'enum': [
|
|
395
|
+
],
|
|
396
|
+
'validation': [
|
|
397
|
+
]
|
|
398
|
+
},
|
|
399
|
+
root_map={
|
|
400
|
+
'validations': {
|
|
401
|
+
},
|
|
402
|
+
'allowed_values': {
|
|
403
|
+
},
|
|
404
|
+
'openapi_types': {
|
|
405
|
+
'campaign_id':
|
|
406
|
+
(str,),
|
|
407
|
+
'preferred_line_item_create_model_v2_request':
|
|
408
|
+
(PreferredLineItemCreateModelV2Request,),
|
|
409
|
+
},
|
|
410
|
+
'attribute_map': {
|
|
411
|
+
'campaign_id': 'campaign-id',
|
|
412
|
+
},
|
|
413
|
+
'location_map': {
|
|
414
|
+
'campaign_id': 'path',
|
|
415
|
+
'preferred_line_item_create_model_v2_request': 'body',
|
|
416
|
+
},
|
|
417
|
+
'collection_format_map': {
|
|
418
|
+
}
|
|
419
|
+
},
|
|
420
|
+
headers_map={
|
|
421
|
+
'accept': [
|
|
422
|
+
'application/json'
|
|
423
|
+
],
|
|
424
|
+
'content_type': [
|
|
425
|
+
'application/json'
|
|
335
426
|
]
|
|
336
427
|
},
|
|
337
428
|
api_client=api_client
|
|
338
429
|
)
|
|
339
|
-
self.
|
|
430
|
+
self.delete_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
340
431
|
settings={
|
|
341
432
|
'response_type': (ProductButtonResponseListResponse,),
|
|
342
433
|
'auth': [
|
|
@@ -344,7 +435,7 @@ class CampaignApi(object):
|
|
|
344
435
|
'oauth'
|
|
345
436
|
],
|
|
346
437
|
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
347
|
-
'operation_id': '
|
|
438
|
+
'operation_id': 'delete_product_button_by_line_item_and_product_button_id',
|
|
348
439
|
'http_method': 'DELETE',
|
|
349
440
|
'servers': None,
|
|
350
441
|
},
|
|
@@ -388,9 +479,7 @@ class CampaignApi(object):
|
|
|
388
479
|
},
|
|
389
480
|
headers_map={
|
|
390
481
|
'accept': [
|
|
391
|
-
'
|
|
392
|
-
'application/json',
|
|
393
|
-
'text/json'
|
|
482
|
+
'application/json'
|
|
394
483
|
],
|
|
395
484
|
'content_type': [],
|
|
396
485
|
},
|
|
@@ -445,9 +534,7 @@ class CampaignApi(object):
|
|
|
445
534
|
}
|
|
446
535
|
},
|
|
447
536
|
headers_map={
|
|
448
|
-
'accept': [
|
|
449
|
-
'application/json'
|
|
450
|
-
],
|
|
537
|
+
'accept': [],
|
|
451
538
|
'content_type': [
|
|
452
539
|
'application/json'
|
|
453
540
|
]
|
|
@@ -573,26 +660,24 @@ class CampaignApi(object):
|
|
|
573
660
|
},
|
|
574
661
|
api_client=api_client
|
|
575
662
|
)
|
|
576
|
-
self.
|
|
663
|
+
self.get_api_external_v2_catalog_status_by_catalog_id_endpoint = _Endpoint(
|
|
577
664
|
settings={
|
|
578
|
-
'response_type': (
|
|
665
|
+
'response_type': (EntityResourceOutcomeOfCatalogStatusV2,),
|
|
579
666
|
'auth': [
|
|
580
667
|
'oauth',
|
|
581
668
|
'oauth'
|
|
582
669
|
],
|
|
583
|
-
'endpoint_path': '/preview/retail-media/
|
|
584
|
-
'operation_id': '
|
|
670
|
+
'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/status',
|
|
671
|
+
'operation_id': 'get_api_external_v2_catalog_status_by_catalog_id',
|
|
585
672
|
'http_method': 'GET',
|
|
586
673
|
'servers': None,
|
|
587
674
|
},
|
|
588
675
|
params_map={
|
|
589
676
|
'all': [
|
|
590
|
-
'
|
|
591
|
-
'product_button_id',
|
|
677
|
+
'catalog_id',
|
|
592
678
|
],
|
|
593
679
|
'required': [
|
|
594
|
-
'
|
|
595
|
-
'product_button_id',
|
|
680
|
+
'catalog_id',
|
|
596
681
|
],
|
|
597
682
|
'nullable': [
|
|
598
683
|
],
|
|
@@ -607,54 +692,52 @@ class CampaignApi(object):
|
|
|
607
692
|
'allowed_values': {
|
|
608
693
|
},
|
|
609
694
|
'openapi_types': {
|
|
610
|
-
'
|
|
611
|
-
(str,),
|
|
612
|
-
'product_button_id':
|
|
695
|
+
'catalog_id':
|
|
613
696
|
(str,),
|
|
614
697
|
},
|
|
615
698
|
'attribute_map': {
|
|
616
|
-
'
|
|
617
|
-
'product_button_id': 'product-button-id',
|
|
699
|
+
'catalog_id': 'catalogId',
|
|
618
700
|
},
|
|
619
701
|
'location_map': {
|
|
620
|
-
'
|
|
621
|
-
'product_button_id': 'path',
|
|
702
|
+
'catalog_id': 'path',
|
|
622
703
|
},
|
|
623
704
|
'collection_format_map': {
|
|
624
705
|
}
|
|
625
706
|
},
|
|
626
707
|
headers_map={
|
|
627
708
|
'accept': [
|
|
628
|
-
'
|
|
629
|
-
'application/json',
|
|
630
|
-
'text/json'
|
|
709
|
+
'application/json'
|
|
631
710
|
],
|
|
632
711
|
'content_type': [],
|
|
633
712
|
},
|
|
634
713
|
api_client=api_client
|
|
635
714
|
)
|
|
636
|
-
self.
|
|
715
|
+
self.get_api_v1_external_retailer_brands_by_retailer_id_endpoint = _Endpoint(
|
|
637
716
|
settings={
|
|
638
|
-
'response_type': (
|
|
717
|
+
'response_type': (BrandPreviewListResponse,),
|
|
639
718
|
'auth': [
|
|
640
719
|
'oauth',
|
|
641
720
|
'oauth'
|
|
642
721
|
],
|
|
643
|
-
'endpoint_path': '/preview/retail-media/
|
|
644
|
-
'operation_id': '
|
|
722
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/brands',
|
|
723
|
+
'operation_id': 'get_api_v1_external_retailer_brands_by_retailer_id',
|
|
645
724
|
'http_method': 'GET',
|
|
646
725
|
'servers': None,
|
|
647
726
|
},
|
|
648
727
|
params_map={
|
|
649
728
|
'all': [
|
|
650
|
-
'
|
|
729
|
+
'retailer_id',
|
|
730
|
+
'brand_type',
|
|
731
|
+
'sku_stock_type_filter',
|
|
651
732
|
],
|
|
652
733
|
'required': [
|
|
653
|
-
'
|
|
734
|
+
'retailer_id',
|
|
654
735
|
],
|
|
655
736
|
'nullable': [
|
|
656
737
|
],
|
|
657
738
|
'enum': [
|
|
739
|
+
'brand_type',
|
|
740
|
+
'sku_stock_type_filter',
|
|
658
741
|
],
|
|
659
742
|
'validation': [
|
|
660
743
|
]
|
|
@@ -663,130 +746,125 @@ class CampaignApi(object):
|
|
|
663
746
|
'validations': {
|
|
664
747
|
},
|
|
665
748
|
'allowed_values': {
|
|
749
|
+
('brand_type',): {
|
|
750
|
+
|
|
751
|
+
"ALL": "all",
|
|
752
|
+
"UC": "uc",
|
|
753
|
+
"RETAILER": "retailer"
|
|
754
|
+
},
|
|
755
|
+
('sku_stock_type_filter',): {
|
|
756
|
+
|
|
757
|
+
"FIRST-PARTY": "first-party",
|
|
758
|
+
"THIRD-PARTY": "third-party",
|
|
759
|
+
"FIRST-AND-THIRD-PARTY": "first-and-third-party"
|
|
760
|
+
},
|
|
666
761
|
},
|
|
667
762
|
'openapi_types': {
|
|
668
|
-
'
|
|
763
|
+
'retailer_id':
|
|
764
|
+
(int,),
|
|
765
|
+
'brand_type':
|
|
766
|
+
(str,),
|
|
767
|
+
'sku_stock_type_filter':
|
|
669
768
|
(str,),
|
|
670
769
|
},
|
|
671
770
|
'attribute_map': {
|
|
672
|
-
'
|
|
771
|
+
'retailer_id': 'retailerId',
|
|
772
|
+
'brand_type': 'brand-type',
|
|
773
|
+
'sku_stock_type_filter': 'sku-stock-type-filter',
|
|
673
774
|
},
|
|
674
775
|
'location_map': {
|
|
675
|
-
'
|
|
776
|
+
'retailer_id': 'path',
|
|
777
|
+
'brand_type': 'query',
|
|
778
|
+
'sku_stock_type_filter': 'query',
|
|
676
779
|
},
|
|
677
780
|
'collection_format_map': {
|
|
678
781
|
}
|
|
679
782
|
},
|
|
680
783
|
headers_map={
|
|
681
784
|
'accept': [
|
|
682
|
-
'
|
|
683
|
-
'application/json',
|
|
684
|
-
'text/json'
|
|
785
|
+
'application/json'
|
|
685
786
|
],
|
|
686
787
|
'content_type': [],
|
|
687
788
|
},
|
|
688
789
|
api_client=api_client
|
|
689
790
|
)
|
|
690
|
-
self.
|
|
791
|
+
self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint = _Endpoint(
|
|
691
792
|
settings={
|
|
692
|
-
'response_type': (
|
|
793
|
+
'response_type': (SellerPreviewResponse,),
|
|
693
794
|
'auth': [
|
|
694
795
|
'oauth',
|
|
695
796
|
'oauth'
|
|
696
797
|
],
|
|
697
|
-
'endpoint_path': '/preview/retail-media/
|
|
698
|
-
'operation_id': '
|
|
798
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/sellers/{seller}',
|
|
799
|
+
'operation_id': 'get_api_v1_external_retailer_by_retailer_id_seller_by_seller',
|
|
699
800
|
'http_method': 'GET',
|
|
700
801
|
'servers': None,
|
|
701
802
|
},
|
|
702
803
|
params_map={
|
|
703
804
|
'all': [
|
|
704
|
-
'
|
|
705
|
-
'
|
|
706
|
-
|
|
707
|
-
'page_size',
|
|
708
|
-
],
|
|
805
|
+
'retailer_id',
|
|
806
|
+
'seller',
|
|
807
|
+
],
|
|
709
808
|
'required': [
|
|
710
|
-
'
|
|
809
|
+
'retailer_id',
|
|
810
|
+
'seller',
|
|
711
811
|
],
|
|
712
812
|
'nullable': [
|
|
713
813
|
],
|
|
714
814
|
'enum': [
|
|
715
815
|
],
|
|
716
816
|
'validation': [
|
|
717
|
-
'page_index',
|
|
718
|
-
'page_size',
|
|
719
817
|
]
|
|
720
818
|
},
|
|
721
819
|
root_map={
|
|
722
820
|
'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
821
|
},
|
|
734
822
|
'allowed_values': {
|
|
735
823
|
},
|
|
736
824
|
'openapi_types': {
|
|
737
|
-
'
|
|
738
|
-
(str,),
|
|
739
|
-
'limit_to_id':
|
|
740
|
-
([str],),
|
|
741
|
-
'page_index':
|
|
742
|
-
(int,),
|
|
743
|
-
'page_size':
|
|
825
|
+
'retailer_id':
|
|
744
826
|
(int,),
|
|
827
|
+
'seller':
|
|
828
|
+
(str,),
|
|
745
829
|
},
|
|
746
830
|
'attribute_map': {
|
|
747
|
-
'
|
|
748
|
-
'
|
|
749
|
-
'page_index': 'pageIndex',
|
|
750
|
-
'page_size': 'pageSize',
|
|
831
|
+
'retailer_id': 'retailerId',
|
|
832
|
+
'seller': 'seller',
|
|
751
833
|
},
|
|
752
834
|
'location_map': {
|
|
753
|
-
'
|
|
754
|
-
'
|
|
755
|
-
'page_index': 'query',
|
|
756
|
-
'page_size': 'query',
|
|
835
|
+
'retailer_id': 'path',
|
|
836
|
+
'seller': 'path',
|
|
757
837
|
},
|
|
758
838
|
'collection_format_map': {
|
|
759
|
-
'limit_to_id': 'multi',
|
|
760
839
|
}
|
|
761
840
|
},
|
|
762
841
|
headers_map={
|
|
763
842
|
'accept': [
|
|
764
|
-
'
|
|
765
|
-
'application/json',
|
|
766
|
-
'text/json'
|
|
843
|
+
'application/json'
|
|
767
844
|
],
|
|
768
845
|
'content_type': [],
|
|
769
846
|
},
|
|
770
847
|
api_client=api_client
|
|
771
848
|
)
|
|
772
|
-
self.
|
|
849
|
+
self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint = _Endpoint(
|
|
773
850
|
settings={
|
|
774
|
-
'response_type': (
|
|
851
|
+
'response_type': (CpcRateCardPreviewResponse,),
|
|
775
852
|
'auth': [
|
|
776
853
|
'oauth',
|
|
777
854
|
'oauth'
|
|
778
855
|
],
|
|
779
|
-
'endpoint_path': '/preview/retail-media/
|
|
780
|
-
'operation_id': '
|
|
856
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/cpc-rates',
|
|
857
|
+
'operation_id': 'get_api_v1_external_retailer_category_cpc_rates_by_retailer_id',
|
|
781
858
|
'http_method': 'GET',
|
|
782
859
|
'servers': None,
|
|
783
860
|
},
|
|
784
861
|
params_map={
|
|
785
862
|
'all': [
|
|
786
|
-
'
|
|
863
|
+
'retailer_id',
|
|
864
|
+
'fields',
|
|
787
865
|
],
|
|
788
866
|
'required': [
|
|
789
|
-
'
|
|
867
|
+
'retailer_id',
|
|
790
868
|
],
|
|
791
869
|
'nullable': [
|
|
792
870
|
],
|
|
@@ -801,46 +879,49 @@ class CampaignApi(object):
|
|
|
801
879
|
'allowed_values': {
|
|
802
880
|
},
|
|
803
881
|
'openapi_types': {
|
|
804
|
-
'
|
|
882
|
+
'retailer_id':
|
|
805
883
|
(str,),
|
|
884
|
+
'fields':
|
|
885
|
+
([str],),
|
|
806
886
|
},
|
|
807
887
|
'attribute_map': {
|
|
808
|
-
'
|
|
888
|
+
'retailer_id': 'retailer-id',
|
|
889
|
+
'fields': 'fields',
|
|
809
890
|
},
|
|
810
891
|
'location_map': {
|
|
811
|
-
'
|
|
892
|
+
'retailer_id': 'path',
|
|
893
|
+
'fields': 'query',
|
|
812
894
|
},
|
|
813
895
|
'collection_format_map': {
|
|
896
|
+
'fields': 'multi',
|
|
814
897
|
}
|
|
815
898
|
},
|
|
816
899
|
headers_map={
|
|
817
900
|
'accept': [
|
|
818
|
-
'
|
|
819
|
-
'application/json',
|
|
820
|
-
'text/json'
|
|
901
|
+
'application/json'
|
|
821
902
|
],
|
|
822
903
|
'content_type': [],
|
|
823
904
|
},
|
|
824
905
|
api_client=api_client
|
|
825
906
|
)
|
|
826
|
-
self.
|
|
907
|
+
self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint = _Endpoint(
|
|
827
908
|
settings={
|
|
828
|
-
'response_type': (
|
|
909
|
+
'response_type': (PlacementPreviewListResponse,),
|
|
829
910
|
'auth': [
|
|
830
911
|
'oauth',
|
|
831
912
|
'oauth'
|
|
832
913
|
],
|
|
833
|
-
'endpoint_path': '/preview/retail-media/
|
|
834
|
-
'operation_id': '
|
|
914
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/placements',
|
|
915
|
+
'operation_id': 'get_api_v1_external_retailer_placements_by_retailer_id',
|
|
835
916
|
'http_method': 'GET',
|
|
836
917
|
'servers': None,
|
|
837
918
|
},
|
|
838
919
|
params_map={
|
|
839
920
|
'all': [
|
|
840
|
-
'
|
|
921
|
+
'retailer_id',
|
|
841
922
|
],
|
|
842
923
|
'required': [
|
|
843
|
-
'
|
|
924
|
+
'retailer_id',
|
|
844
925
|
],
|
|
845
926
|
'nullable': [
|
|
846
927
|
],
|
|
@@ -855,54 +936,48 @@ class CampaignApi(object):
|
|
|
855
936
|
'allowed_values': {
|
|
856
937
|
},
|
|
857
938
|
'openapi_types': {
|
|
858
|
-
'
|
|
939
|
+
'retailer_id':
|
|
859
940
|
(str,),
|
|
860
941
|
},
|
|
861
942
|
'attribute_map': {
|
|
862
|
-
'
|
|
943
|
+
'retailer_id': 'retailer-id',
|
|
863
944
|
},
|
|
864
945
|
'location_map': {
|
|
865
|
-
'
|
|
946
|
+
'retailer_id': 'path',
|
|
866
947
|
},
|
|
867
948
|
'collection_format_map': {
|
|
868
949
|
}
|
|
869
950
|
},
|
|
870
951
|
headers_map={
|
|
871
952
|
'accept': [
|
|
872
|
-
'
|
|
873
|
-
'application/json',
|
|
874
|
-
'text/json'
|
|
953
|
+
'application/json'
|
|
875
954
|
],
|
|
876
955
|
'content_type': [],
|
|
877
956
|
},
|
|
878
957
|
api_client=api_client
|
|
879
958
|
)
|
|
880
|
-
self.
|
|
959
|
+
self.get_auction_line_item_v2_endpoint = _Endpoint(
|
|
881
960
|
settings={
|
|
882
|
-
'response_type': (
|
|
961
|
+
'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
|
|
883
962
|
'auth': [
|
|
884
963
|
'oauth',
|
|
885
964
|
'oauth'
|
|
886
965
|
],
|
|
887
|
-
'endpoint_path': '/preview/retail-media/
|
|
888
|
-
'operation_id': '
|
|
966
|
+
'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
|
|
967
|
+
'operation_id': 'get_auction_line_item_v2',
|
|
889
968
|
'http_method': 'GET',
|
|
890
969
|
'servers': None,
|
|
891
970
|
},
|
|
892
971
|
params_map={
|
|
893
972
|
'all': [
|
|
894
|
-
'
|
|
895
|
-
'brand_type',
|
|
896
|
-
'sku_stock_type_filter',
|
|
973
|
+
'line_item_id',
|
|
897
974
|
],
|
|
898
975
|
'required': [
|
|
899
|
-
'
|
|
976
|
+
'line_item_id',
|
|
900
977
|
],
|
|
901
978
|
'nullable': [
|
|
902
979
|
],
|
|
903
980
|
'enum': [
|
|
904
|
-
'brand_type',
|
|
905
|
-
'sku_stock_type_filter',
|
|
906
981
|
],
|
|
907
982
|
'validation': [
|
|
908
983
|
]
|
|
@@ -911,36 +986,16 @@ class CampaignApi(object):
|
|
|
911
986
|
'validations': {
|
|
912
987
|
},
|
|
913
988
|
'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
989
|
},
|
|
927
990
|
'openapi_types': {
|
|
928
|
-
'
|
|
991
|
+
'line_item_id':
|
|
929
992
|
(int,),
|
|
930
|
-
'brand_type':
|
|
931
|
-
(str,),
|
|
932
|
-
'sku_stock_type_filter':
|
|
933
|
-
(str,),
|
|
934
993
|
},
|
|
935
994
|
'attribute_map': {
|
|
936
|
-
'
|
|
937
|
-
'brand_type': 'brand-type',
|
|
938
|
-
'sku_stock_type_filter': 'sku-stock-type-filter',
|
|
995
|
+
'line_item_id': 'lineItemId',
|
|
939
996
|
},
|
|
940
997
|
'location_map': {
|
|
941
|
-
'
|
|
942
|
-
'brand_type': 'query',
|
|
943
|
-
'sku_stock_type_filter': 'query',
|
|
998
|
+
'line_item_id': 'path',
|
|
944
999
|
},
|
|
945
1000
|
'collection_format_map': {
|
|
946
1001
|
}
|
|
@@ -953,54 +1008,76 @@ class CampaignApi(object):
|
|
|
953
1008
|
},
|
|
954
1009
|
api_client=api_client
|
|
955
1010
|
)
|
|
956
|
-
self.
|
|
1011
|
+
self.get_auction_line_items_by_campaign_id_v2_endpoint = _Endpoint(
|
|
957
1012
|
settings={
|
|
958
|
-
'response_type': (
|
|
1013
|
+
'response_type': (EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata,),
|
|
959
1014
|
'auth': [
|
|
960
1015
|
'oauth',
|
|
961
1016
|
'oauth'
|
|
962
1017
|
],
|
|
963
|
-
'endpoint_path': '/preview/retail-media/
|
|
964
|
-
'operation_id': '
|
|
1018
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/auction-line-items',
|
|
1019
|
+
'operation_id': 'get_auction_line_items_by_campaign_id_v2',
|
|
965
1020
|
'http_method': 'GET',
|
|
966
1021
|
'servers': None,
|
|
967
1022
|
},
|
|
968
1023
|
params_map={
|
|
969
1024
|
'all': [
|
|
970
|
-
'
|
|
971
|
-
'
|
|
1025
|
+
'campaign_id',
|
|
1026
|
+
'limit_to_id',
|
|
1027
|
+
'page_index',
|
|
1028
|
+
'page_size',
|
|
972
1029
|
],
|
|
973
1030
|
'required': [
|
|
974
|
-
'
|
|
975
|
-
'seller',
|
|
1031
|
+
'campaign_id',
|
|
976
1032
|
],
|
|
977
1033
|
'nullable': [
|
|
978
1034
|
],
|
|
979
1035
|
'enum': [
|
|
980
1036
|
],
|
|
981
1037
|
'validation': [
|
|
1038
|
+
'page_index',
|
|
1039
|
+
'page_size',
|
|
982
1040
|
]
|
|
983
1041
|
},
|
|
984
1042
|
root_map={
|
|
985
1043
|
'validations': {
|
|
1044
|
+
('page_index',): {
|
|
1045
|
+
|
|
1046
|
+
'inclusive_maximum': 2147483647,
|
|
1047
|
+
'inclusive_minimum': 0,
|
|
1048
|
+
},
|
|
1049
|
+
('page_size',): {
|
|
1050
|
+
|
|
1051
|
+
'inclusive_maximum': 2147483647,
|
|
1052
|
+
'inclusive_minimum': 1,
|
|
1053
|
+
},
|
|
986
1054
|
},
|
|
987
1055
|
'allowed_values': {
|
|
988
1056
|
},
|
|
989
1057
|
'openapi_types': {
|
|
990
|
-
'
|
|
991
|
-
(int,),
|
|
992
|
-
'seller':
|
|
1058
|
+
'campaign_id':
|
|
993
1059
|
(str,),
|
|
1060
|
+
'limit_to_id':
|
|
1061
|
+
([str],),
|
|
1062
|
+
'page_index':
|
|
1063
|
+
(int,),
|
|
1064
|
+
'page_size':
|
|
1065
|
+
(int,),
|
|
994
1066
|
},
|
|
995
1067
|
'attribute_map': {
|
|
996
|
-
'
|
|
997
|
-
'
|
|
1068
|
+
'campaign_id': 'campaignId',
|
|
1069
|
+
'limit_to_id': 'limitToId',
|
|
1070
|
+
'page_index': 'pageIndex',
|
|
1071
|
+
'page_size': 'pageSize',
|
|
998
1072
|
},
|
|
999
1073
|
'location_map': {
|
|
1000
|
-
'
|
|
1001
|
-
'
|
|
1074
|
+
'campaign_id': 'path',
|
|
1075
|
+
'limit_to_id': 'query',
|
|
1076
|
+
'page_index': 'query',
|
|
1077
|
+
'page_size': 'query',
|
|
1002
1078
|
},
|
|
1003
1079
|
'collection_format_map': {
|
|
1080
|
+
'limit_to_id': 'multi',
|
|
1004
1081
|
}
|
|
1005
1082
|
},
|
|
1006
1083
|
headers_map={
|
|
@@ -1011,25 +1088,26 @@ class CampaignApi(object):
|
|
|
1011
1088
|
},
|
|
1012
1089
|
api_client=api_client
|
|
1013
1090
|
)
|
|
1014
|
-
self.
|
|
1091
|
+
self.get_creative_endpoint = _Endpoint(
|
|
1015
1092
|
settings={
|
|
1016
|
-
'response_type': (
|
|
1093
|
+
'response_type': (Creative2Response,),
|
|
1017
1094
|
'auth': [
|
|
1018
1095
|
'oauth',
|
|
1019
1096
|
'oauth'
|
|
1020
1097
|
],
|
|
1021
|
-
'endpoint_path': '/preview/retail-media/
|
|
1022
|
-
'operation_id': '
|
|
1098
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
1099
|
+
'operation_id': 'get_creative',
|
|
1023
1100
|
'http_method': 'GET',
|
|
1024
1101
|
'servers': None,
|
|
1025
1102
|
},
|
|
1026
1103
|
params_map={
|
|
1027
1104
|
'all': [
|
|
1028
|
-
'
|
|
1029
|
-
'
|
|
1105
|
+
'account_id',
|
|
1106
|
+
'creative_id',
|
|
1030
1107
|
],
|
|
1031
1108
|
'required': [
|
|
1032
|
-
'
|
|
1109
|
+
'account_id',
|
|
1110
|
+
'creative_id',
|
|
1033
1111
|
],
|
|
1034
1112
|
'nullable': [
|
|
1035
1113
|
],
|
|
@@ -1044,21 +1122,20 @@ class CampaignApi(object):
|
|
|
1044
1122
|
'allowed_values': {
|
|
1045
1123
|
},
|
|
1046
1124
|
'openapi_types': {
|
|
1047
|
-
'
|
|
1125
|
+
'account_id':
|
|
1126
|
+
(str,),
|
|
1127
|
+
'creative_id':
|
|
1048
1128
|
(str,),
|
|
1049
|
-
'fields':
|
|
1050
|
-
([str],),
|
|
1051
1129
|
},
|
|
1052
1130
|
'attribute_map': {
|
|
1053
|
-
'
|
|
1054
|
-
'
|
|
1131
|
+
'account_id': 'account-id',
|
|
1132
|
+
'creative_id': 'creative-id',
|
|
1055
1133
|
},
|
|
1056
1134
|
'location_map': {
|
|
1057
|
-
'
|
|
1058
|
-
'
|
|
1135
|
+
'account_id': 'path',
|
|
1136
|
+
'creative_id': 'path',
|
|
1059
1137
|
},
|
|
1060
1138
|
'collection_format_map': {
|
|
1061
|
-
'fields': 'multi',
|
|
1062
1139
|
}
|
|
1063
1140
|
},
|
|
1064
1141
|
headers_map={
|
|
@@ -1069,48 +1146,76 @@ class CampaignApi(object):
|
|
|
1069
1146
|
},
|
|
1070
1147
|
api_client=api_client
|
|
1071
1148
|
)
|
|
1072
|
-
self.
|
|
1149
|
+
self.get_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1073
1150
|
settings={
|
|
1074
|
-
'response_type': (
|
|
1151
|
+
'response_type': (PreferredLineItemV2PagedListResponse,),
|
|
1075
1152
|
'auth': [
|
|
1076
1153
|
'oauth',
|
|
1077
1154
|
'oauth'
|
|
1078
1155
|
],
|
|
1079
|
-
'endpoint_path': '/preview/retail-media/
|
|
1080
|
-
'operation_id': '
|
|
1156
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
1157
|
+
'operation_id': 'get_preferred_line_items_by_campaign_id',
|
|
1081
1158
|
'http_method': 'GET',
|
|
1082
1159
|
'servers': None,
|
|
1083
1160
|
},
|
|
1084
1161
|
params_map={
|
|
1085
1162
|
'all': [
|
|
1086
|
-
'
|
|
1163
|
+
'campaign_id',
|
|
1164
|
+
'limit_to_id',
|
|
1165
|
+
'page_index',
|
|
1166
|
+
'page_size',
|
|
1087
1167
|
],
|
|
1088
1168
|
'required': [
|
|
1089
|
-
'
|
|
1169
|
+
'campaign_id',
|
|
1090
1170
|
],
|
|
1091
1171
|
'nullable': [
|
|
1092
1172
|
],
|
|
1093
1173
|
'enum': [
|
|
1094
1174
|
],
|
|
1095
1175
|
'validation': [
|
|
1176
|
+
'page_index',
|
|
1177
|
+
'page_size',
|
|
1096
1178
|
]
|
|
1097
1179
|
},
|
|
1098
1180
|
root_map={
|
|
1099
1181
|
'validations': {
|
|
1182
|
+
('page_index',): {
|
|
1183
|
+
|
|
1184
|
+
'inclusive_maximum': 2147483647,
|
|
1185
|
+
'inclusive_minimum': 0,
|
|
1186
|
+
},
|
|
1187
|
+
('page_size',): {
|
|
1188
|
+
|
|
1189
|
+
'inclusive_maximum': 2147483647,
|
|
1190
|
+
'inclusive_minimum': 1,
|
|
1191
|
+
},
|
|
1100
1192
|
},
|
|
1101
1193
|
'allowed_values': {
|
|
1102
1194
|
},
|
|
1103
1195
|
'openapi_types': {
|
|
1104
|
-
'
|
|
1196
|
+
'campaign_id':
|
|
1105
1197
|
(str,),
|
|
1198
|
+
'limit_to_id':
|
|
1199
|
+
([str],),
|
|
1200
|
+
'page_index':
|
|
1201
|
+
(int,),
|
|
1202
|
+
'page_size':
|
|
1203
|
+
(int,),
|
|
1106
1204
|
},
|
|
1107
1205
|
'attribute_map': {
|
|
1108
|
-
'
|
|
1206
|
+
'campaign_id': 'campaign-id',
|
|
1207
|
+
'limit_to_id': 'limitToId',
|
|
1208
|
+
'page_index': 'pageIndex',
|
|
1209
|
+
'page_size': 'pageSize',
|
|
1109
1210
|
},
|
|
1110
1211
|
'location_map': {
|
|
1111
|
-
'
|
|
1212
|
+
'campaign_id': 'path',
|
|
1213
|
+
'limit_to_id': 'query',
|
|
1214
|
+
'page_index': 'query',
|
|
1215
|
+
'page_size': 'query',
|
|
1112
1216
|
},
|
|
1113
1217
|
'collection_format_map': {
|
|
1218
|
+
'limit_to_id': 'multi',
|
|
1114
1219
|
}
|
|
1115
1220
|
},
|
|
1116
1221
|
headers_map={
|
|
@@ -1121,26 +1226,24 @@ class CampaignApi(object):
|
|
|
1121
1226
|
},
|
|
1122
1227
|
api_client=api_client
|
|
1123
1228
|
)
|
|
1124
|
-
self.
|
|
1229
|
+
self.get_preferred_line_items_by_line_item_id_endpoint = _Endpoint(
|
|
1125
1230
|
settings={
|
|
1126
|
-
'response_type': (
|
|
1231
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1127
1232
|
'auth': [
|
|
1128
1233
|
'oauth',
|
|
1129
1234
|
'oauth'
|
|
1130
1235
|
],
|
|
1131
|
-
'endpoint_path': '/preview/retail-media/
|
|
1132
|
-
'operation_id': '
|
|
1236
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
1237
|
+
'operation_id': 'get_preferred_line_items_by_line_item_id',
|
|
1133
1238
|
'http_method': 'GET',
|
|
1134
1239
|
'servers': None,
|
|
1135
1240
|
},
|
|
1136
1241
|
params_map={
|
|
1137
1242
|
'all': [
|
|
1138
|
-
'
|
|
1139
|
-
'creative_id',
|
|
1243
|
+
'line_item_id',
|
|
1140
1244
|
],
|
|
1141
1245
|
'required': [
|
|
1142
|
-
'
|
|
1143
|
-
'creative_id',
|
|
1246
|
+
'line_item_id',
|
|
1144
1247
|
],
|
|
1145
1248
|
'nullable': [
|
|
1146
1249
|
],
|
|
@@ -1155,50 +1258,46 @@ class CampaignApi(object):
|
|
|
1155
1258
|
'allowed_values': {
|
|
1156
1259
|
},
|
|
1157
1260
|
'openapi_types': {
|
|
1158
|
-
'
|
|
1159
|
-
(str,),
|
|
1160
|
-
'creative_id':
|
|
1261
|
+
'line_item_id':
|
|
1161
1262
|
(str,),
|
|
1162
1263
|
},
|
|
1163
1264
|
'attribute_map': {
|
|
1164
|
-
'
|
|
1165
|
-
'creative_id': 'creative-id',
|
|
1265
|
+
'line_item_id': 'line-item-id',
|
|
1166
1266
|
},
|
|
1167
1267
|
'location_map': {
|
|
1168
|
-
'
|
|
1169
|
-
'creative_id': 'path',
|
|
1268
|
+
'line_item_id': 'path',
|
|
1170
1269
|
},
|
|
1171
1270
|
'collection_format_map': {
|
|
1172
1271
|
}
|
|
1173
1272
|
},
|
|
1174
1273
|
headers_map={
|
|
1175
1274
|
'accept': [
|
|
1176
|
-
'
|
|
1177
|
-
'application/json',
|
|
1178
|
-
'text/json'
|
|
1275
|
+
'application/json'
|
|
1179
1276
|
],
|
|
1180
1277
|
'content_type': [],
|
|
1181
1278
|
},
|
|
1182
1279
|
api_client=api_client
|
|
1183
1280
|
)
|
|
1184
|
-
self.
|
|
1281
|
+
self.get_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
1185
1282
|
settings={
|
|
1186
|
-
'response_type': (
|
|
1283
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
1187
1284
|
'auth': [
|
|
1188
1285
|
'oauth',
|
|
1189
1286
|
'oauth'
|
|
1190
1287
|
],
|
|
1191
|
-
'endpoint_path': '/preview/retail-media/
|
|
1192
|
-
'operation_id': '
|
|
1288
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
1289
|
+
'operation_id': 'get_product_button_by_line_item_and_product_button_id',
|
|
1193
1290
|
'http_method': 'GET',
|
|
1194
1291
|
'servers': None,
|
|
1195
1292
|
},
|
|
1196
1293
|
params_map={
|
|
1197
1294
|
'all': [
|
|
1198
1295
|
'line_item_id',
|
|
1296
|
+
'product_button_id',
|
|
1199
1297
|
],
|
|
1200
1298
|
'required': [
|
|
1201
1299
|
'line_item_id',
|
|
1300
|
+
'product_button_id',
|
|
1202
1301
|
],
|
|
1203
1302
|
'nullable': [
|
|
1204
1303
|
],
|
|
@@ -1214,13 +1313,17 @@ class CampaignApi(object):
|
|
|
1214
1313
|
},
|
|
1215
1314
|
'openapi_types': {
|
|
1216
1315
|
'line_item_id':
|
|
1217
|
-
(
|
|
1316
|
+
(str,),
|
|
1317
|
+
'product_button_id':
|
|
1318
|
+
(str,),
|
|
1218
1319
|
},
|
|
1219
1320
|
'attribute_map': {
|
|
1220
|
-
'line_item_id': '
|
|
1321
|
+
'line_item_id': 'line-item-id',
|
|
1322
|
+
'product_button_id': 'product-button-id',
|
|
1221
1323
|
},
|
|
1222
1324
|
'location_map': {
|
|
1223
1325
|
'line_item_id': 'path',
|
|
1326
|
+
'product_button_id': 'path',
|
|
1224
1327
|
},
|
|
1225
1328
|
'collection_format_map': {
|
|
1226
1329
|
}
|
|
@@ -1233,76 +1336,48 @@ class CampaignApi(object):
|
|
|
1233
1336
|
},
|
|
1234
1337
|
api_client=api_client
|
|
1235
1338
|
)
|
|
1236
|
-
self.
|
|
1339
|
+
self.get_product_buttons_by_line_item_id_endpoint = _Endpoint(
|
|
1237
1340
|
settings={
|
|
1238
|
-
'response_type': (
|
|
1341
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
1239
1342
|
'auth': [
|
|
1240
1343
|
'oauth',
|
|
1241
1344
|
'oauth'
|
|
1242
1345
|
],
|
|
1243
|
-
'endpoint_path': '/preview/retail-media/
|
|
1244
|
-
'operation_id': '
|
|
1346
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons',
|
|
1347
|
+
'operation_id': 'get_product_buttons_by_line_item_id',
|
|
1245
1348
|
'http_method': 'GET',
|
|
1246
1349
|
'servers': None,
|
|
1247
1350
|
},
|
|
1248
1351
|
params_map={
|
|
1249
1352
|
'all': [
|
|
1250
|
-
'
|
|
1251
|
-
'limit_to_id',
|
|
1252
|
-
'page_index',
|
|
1253
|
-
'page_size',
|
|
1353
|
+
'line_item_id',
|
|
1254
1354
|
],
|
|
1255
1355
|
'required': [
|
|
1256
|
-
'
|
|
1356
|
+
'line_item_id',
|
|
1257
1357
|
],
|
|
1258
1358
|
'nullable': [
|
|
1259
1359
|
],
|
|
1260
1360
|
'enum': [
|
|
1261
1361
|
],
|
|
1262
1362
|
'validation': [
|
|
1263
|
-
'page_index',
|
|
1264
|
-
'page_size',
|
|
1265
1363
|
]
|
|
1266
1364
|
},
|
|
1267
1365
|
root_map={
|
|
1268
1366
|
'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
1367
|
},
|
|
1280
1368
|
'allowed_values': {
|
|
1281
1369
|
},
|
|
1282
1370
|
'openapi_types': {
|
|
1283
|
-
'
|
|
1371
|
+
'line_item_id':
|
|
1284
1372
|
(str,),
|
|
1285
|
-
'limit_to_id':
|
|
1286
|
-
([str],),
|
|
1287
|
-
'page_index':
|
|
1288
|
-
(int,),
|
|
1289
|
-
'page_size':
|
|
1290
|
-
(int,),
|
|
1291
1373
|
},
|
|
1292
1374
|
'attribute_map': {
|
|
1293
|
-
'
|
|
1294
|
-
'limit_to_id': 'limitToId',
|
|
1295
|
-
'page_index': 'pageIndex',
|
|
1296
|
-
'page_size': 'pageSize',
|
|
1375
|
+
'line_item_id': 'line-item-id',
|
|
1297
1376
|
},
|
|
1298
1377
|
'location_map': {
|
|
1299
|
-
'
|
|
1300
|
-
'limit_to_id': 'query',
|
|
1301
|
-
'page_index': 'query',
|
|
1302
|
-
'page_size': 'query',
|
|
1378
|
+
'line_item_id': 'path',
|
|
1303
1379
|
},
|
|
1304
1380
|
'collection_format_map': {
|
|
1305
|
-
'limit_to_id': 'multi',
|
|
1306
1381
|
}
|
|
1307
1382
|
},
|
|
1308
1383
|
headers_map={
|
|
@@ -1366,10 +1441,7 @@ class CampaignApi(object):
|
|
|
1366
1441
|
'application/json'
|
|
1367
1442
|
],
|
|
1368
1443
|
'content_type': [
|
|
1369
|
-
'application/json
|
|
1370
|
-
'application/json',
|
|
1371
|
-
'text/json',
|
|
1372
|
-
'application/*+json'
|
|
1444
|
+
'application/json'
|
|
1373
1445
|
]
|
|
1374
1446
|
},
|
|
1375
1447
|
api_client=api_client
|
|
@@ -1442,9 +1514,7 @@ class CampaignApi(object):
|
|
|
1442
1514
|
},
|
|
1443
1515
|
headers_map={
|
|
1444
1516
|
'accept': [
|
|
1445
|
-
'
|
|
1446
|
-
'application/json',
|
|
1447
|
-
'text/json'
|
|
1517
|
+
'application/json'
|
|
1448
1518
|
],
|
|
1449
1519
|
'content_type': [],
|
|
1450
1520
|
},
|
|
@@ -1499,70 +1569,7 @@ class CampaignApi(object):
|
|
|
1499
1569
|
}
|
|
1500
1570
|
},
|
|
1501
1571
|
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
|
-
],
|
|
1572
|
+
'accept': [],
|
|
1566
1573
|
'content_type': [
|
|
1567
1574
|
'application/json'
|
|
1568
1575
|
]
|
|
@@ -1620,9 +1627,7 @@ class CampaignApi(object):
|
|
|
1620
1627
|
},
|
|
1621
1628
|
headers_map={
|
|
1622
1629
|
'accept': [
|
|
1623
|
-
'
|
|
1624
|
-
'application/json',
|
|
1625
|
-
'text/json'
|
|
1630
|
+
'application/json'
|
|
1626
1631
|
],
|
|
1627
1632
|
'content_type': [
|
|
1628
1633
|
'application/json'
|
|
@@ -1681,69 +1686,7 @@ class CampaignApi(object):
|
|
|
1681
1686
|
},
|
|
1682
1687
|
headers_map={
|
|
1683
1688
|
'accept': [
|
|
1684
|
-
'text/plain',
|
|
1685
|
-
'application/json',
|
|
1686
|
-
'text/json'
|
|
1687
|
-
],
|
|
1688
|
-
'content_type': [
|
|
1689
1689
|
'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
1690
|
],
|
|
1748
1691
|
'content_type': [
|
|
1749
1692
|
'application/json'
|
|
@@ -1901,25 +1844,25 @@ class CampaignApi(object):
|
|
|
1901
1844
|
},
|
|
1902
1845
|
api_client=api_client
|
|
1903
1846
|
)
|
|
1904
|
-
self.
|
|
1847
|
+
self.recommended_keywords_endpoint = _Endpoint(
|
|
1905
1848
|
settings={
|
|
1906
|
-
'response_type': (
|
|
1849
|
+
'response_type': (ValueResourceOutcomeRecommendedKeywordsResponseV1,),
|
|
1907
1850
|
'auth': [
|
|
1908
1851
|
'oauth',
|
|
1909
1852
|
'oauth'
|
|
1910
1853
|
],
|
|
1911
|
-
'endpoint_path': '/preview/retail-media/
|
|
1912
|
-
'operation_id': '
|
|
1854
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-keywords',
|
|
1855
|
+
'operation_id': 'recommended_keywords',
|
|
1913
1856
|
'http_method': 'POST',
|
|
1914
1857
|
'servers': None,
|
|
1915
1858
|
},
|
|
1916
1859
|
params_map={
|
|
1917
1860
|
'all': [
|
|
1918
|
-
'
|
|
1919
|
-
'
|
|
1861
|
+
'retailer_id',
|
|
1862
|
+
'value_resource_input_recommended_keywords_request_v1',
|
|
1920
1863
|
],
|
|
1921
1864
|
'required': [
|
|
1922
|
-
'
|
|
1865
|
+
'retailer_id',
|
|
1923
1866
|
],
|
|
1924
1867
|
'nullable': [
|
|
1925
1868
|
],
|
|
@@ -1934,26 +1877,24 @@ class CampaignApi(object):
|
|
|
1934
1877
|
'allowed_values': {
|
|
1935
1878
|
},
|
|
1936
1879
|
'openapi_types': {
|
|
1937
|
-
'
|
|
1880
|
+
'retailer_id':
|
|
1938
1881
|
(str,),
|
|
1939
|
-
'
|
|
1940
|
-
(
|
|
1882
|
+
'value_resource_input_recommended_keywords_request_v1':
|
|
1883
|
+
(ValueResourceInputRecommendedKeywordsRequestV1,),
|
|
1941
1884
|
},
|
|
1942
1885
|
'attribute_map': {
|
|
1943
|
-
'
|
|
1886
|
+
'retailer_id': 'retailerId',
|
|
1944
1887
|
},
|
|
1945
1888
|
'location_map': {
|
|
1946
|
-
'
|
|
1947
|
-
'
|
|
1889
|
+
'retailer_id': 'path',
|
|
1890
|
+
'value_resource_input_recommended_keywords_request_v1': 'body',
|
|
1948
1891
|
},
|
|
1949
1892
|
'collection_format_map': {
|
|
1950
1893
|
}
|
|
1951
1894
|
},
|
|
1952
1895
|
headers_map={
|
|
1953
1896
|
'accept': [
|
|
1954
|
-
'
|
|
1955
|
-
'application/json',
|
|
1956
|
-
'text/json'
|
|
1897
|
+
'application/json'
|
|
1957
1898
|
],
|
|
1958
1899
|
'content_type': [
|
|
1959
1900
|
'application/json'
|
|
@@ -1961,7 +1902,7 @@ class CampaignApi(object):
|
|
|
1961
1902
|
},
|
|
1962
1903
|
api_client=api_client
|
|
1963
1904
|
)
|
|
1964
|
-
self.
|
|
1905
|
+
self.search_account_creatives_endpoint = _Endpoint(
|
|
1965
1906
|
settings={
|
|
1966
1907
|
'response_type': (Creative2ListResponse,),
|
|
1967
1908
|
'auth': [
|
|
@@ -1969,7 +1910,7 @@ class CampaignApi(object):
|
|
|
1969
1910
|
'oauth'
|
|
1970
1911
|
],
|
|
1971
1912
|
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/search',
|
|
1972
|
-
'operation_id': '
|
|
1913
|
+
'operation_id': 'search_account_creatives',
|
|
1973
1914
|
'http_method': 'POST',
|
|
1974
1915
|
'servers': None,
|
|
1975
1916
|
},
|
|
@@ -2013,74 +1954,78 @@ class CampaignApi(object):
|
|
|
2013
1954
|
},
|
|
2014
1955
|
headers_map={
|
|
2015
1956
|
'accept': [
|
|
2016
|
-
'
|
|
2017
|
-
'application/json',
|
|
2018
|
-
'text/json'
|
|
1957
|
+
'application/json'
|
|
2019
1958
|
],
|
|
2020
1959
|
'content_type': [],
|
|
2021
1960
|
},
|
|
2022
1961
|
api_client=api_client
|
|
2023
1962
|
)
|
|
2024
|
-
self.
|
|
1963
|
+
self.search_brands_endpoint = _Endpoint(
|
|
2025
1964
|
settings={
|
|
2026
|
-
'response_type': (
|
|
1965
|
+
'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata,),
|
|
2027
1966
|
'auth': [
|
|
2028
1967
|
'oauth',
|
|
2029
1968
|
'oauth'
|
|
2030
1969
|
],
|
|
2031
|
-
'endpoint_path': '/preview/retail-media/
|
|
2032
|
-
'operation_id': '
|
|
2033
|
-
'http_method': '
|
|
1970
|
+
'endpoint_path': '/preview/retail-media/brands/search',
|
|
1971
|
+
'operation_id': 'search_brands',
|
|
1972
|
+
'http_method': 'POST',
|
|
2034
1973
|
'servers': None,
|
|
2035
1974
|
},
|
|
2036
1975
|
params_map={
|
|
2037
1976
|
'all': [
|
|
2038
|
-
'
|
|
2039
|
-
'
|
|
2040
|
-
'
|
|
2041
|
-
],
|
|
2042
|
-
'required': [
|
|
2043
|
-
'line_item_id',
|
|
2044
|
-
'product_button_id',
|
|
1977
|
+
'limit',
|
|
1978
|
+
'offset',
|
|
1979
|
+
'value_resource_input_brand_id_search_request',
|
|
2045
1980
|
],
|
|
1981
|
+
'required': [],
|
|
2046
1982
|
'nullable': [
|
|
2047
|
-
'product_button_request_request',
|
|
2048
1983
|
],
|
|
2049
1984
|
'enum': [
|
|
2050
1985
|
],
|
|
2051
1986
|
'validation': [
|
|
1987
|
+
'limit',
|
|
1988
|
+
'offset',
|
|
2052
1989
|
]
|
|
2053
1990
|
},
|
|
2054
1991
|
root_map={
|
|
2055
1992
|
'validations': {
|
|
1993
|
+
('limit',): {
|
|
1994
|
+
|
|
1995
|
+
'inclusive_maximum': 100,
|
|
1996
|
+
'inclusive_minimum': 1,
|
|
1997
|
+
},
|
|
1998
|
+
('offset',): {
|
|
1999
|
+
|
|
2000
|
+
'inclusive_maximum': 2147483647,
|
|
2001
|
+
'inclusive_minimum': 0,
|
|
2002
|
+
},
|
|
2056
2003
|
},
|
|
2057
2004
|
'allowed_values': {
|
|
2058
2005
|
},
|
|
2059
2006
|
'openapi_types': {
|
|
2060
|
-
'
|
|
2061
|
-
(
|
|
2062
|
-
'
|
|
2063
|
-
(
|
|
2064
|
-
'
|
|
2065
|
-
(
|
|
2066
|
-
},
|
|
2067
|
-
'attribute_map': {
|
|
2068
|
-
'
|
|
2069
|
-
'
|
|
2007
|
+
'limit':
|
|
2008
|
+
(int,),
|
|
2009
|
+
'offset':
|
|
2010
|
+
(int,),
|
|
2011
|
+
'value_resource_input_brand_id_search_request':
|
|
2012
|
+
(ValueResourceInputBrandIdSearchRequest,),
|
|
2013
|
+
},
|
|
2014
|
+
'attribute_map': {
|
|
2015
|
+
'limit': 'limit',
|
|
2016
|
+
'offset': 'offset',
|
|
2070
2017
|
},
|
|
2071
2018
|
'location_map': {
|
|
2072
|
-
'
|
|
2073
|
-
'
|
|
2074
|
-
'
|
|
2019
|
+
'limit': 'query',
|
|
2020
|
+
'offset': 'query',
|
|
2021
|
+
'value_resource_input_brand_id_search_request': 'body',
|
|
2075
2022
|
},
|
|
2076
2023
|
'collection_format_map': {
|
|
2077
2024
|
}
|
|
2078
2025
|
},
|
|
2079
2026
|
headers_map={
|
|
2080
2027
|
'accept': [
|
|
2081
|
-
'
|
|
2082
|
-
'application/json',
|
|
2083
|
-
'text/json'
|
|
2028
|
+
'application/json'
|
|
2084
2029
|
],
|
|
2085
2030
|
'content_type': [
|
|
2086
2031
|
'application/json'
|
|
@@ -2088,59 +2033,79 @@ class CampaignApi(object):
|
|
|
2088
2033
|
},
|
|
2089
2034
|
api_client=api_client
|
|
2090
2035
|
)
|
|
2091
|
-
self.
|
|
2036
|
+
self.search_category_endpoint = _Endpoint(
|
|
2092
2037
|
settings={
|
|
2093
|
-
'response_type': (
|
|
2038
|
+
'response_type': (EntityResourceCollectionOutcomeCategory202204Metadata,),
|
|
2094
2039
|
'auth': [
|
|
2095
2040
|
'oauth',
|
|
2096
2041
|
'oauth'
|
|
2097
2042
|
],
|
|
2098
|
-
'endpoint_path': '/preview/retail-media/
|
|
2099
|
-
'operation_id': '
|
|
2100
|
-
'http_method': '
|
|
2043
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/categories/search',
|
|
2044
|
+
'operation_id': 'search_category',
|
|
2045
|
+
'http_method': 'POST',
|
|
2101
2046
|
'servers': None,
|
|
2102
2047
|
},
|
|
2103
2048
|
params_map={
|
|
2104
2049
|
'all': [
|
|
2105
|
-
'
|
|
2106
|
-
'
|
|
2050
|
+
'retailer_id',
|
|
2051
|
+
'limit',
|
|
2052
|
+
'offset',
|
|
2053
|
+
'value_resource_input_categories_search_request_v1',
|
|
2107
2054
|
],
|
|
2108
2055
|
'required': [
|
|
2109
|
-
'
|
|
2056
|
+
'retailer_id',
|
|
2110
2057
|
],
|
|
2111
2058
|
'nullable': [
|
|
2112
2059
|
],
|
|
2113
2060
|
'enum': [
|
|
2114
2061
|
],
|
|
2115
2062
|
'validation': [
|
|
2063
|
+
'limit',
|
|
2064
|
+
'offset',
|
|
2116
2065
|
]
|
|
2117
2066
|
},
|
|
2118
2067
|
root_map={
|
|
2119
2068
|
'validations': {
|
|
2069
|
+
('limit',): {
|
|
2070
|
+
|
|
2071
|
+
'inclusive_maximum': 500,
|
|
2072
|
+
'inclusive_minimum': 1,
|
|
2073
|
+
},
|
|
2074
|
+
('offset',): {
|
|
2075
|
+
|
|
2076
|
+
'inclusive_maximum': 2147483647,
|
|
2077
|
+
'inclusive_minimum': 0,
|
|
2078
|
+
},
|
|
2120
2079
|
},
|
|
2121
2080
|
'allowed_values': {
|
|
2122
2081
|
},
|
|
2123
2082
|
'openapi_types': {
|
|
2124
|
-
'
|
|
2125
|
-
(
|
|
2126
|
-
'
|
|
2127
|
-
(
|
|
2083
|
+
'retailer_id':
|
|
2084
|
+
(int,),
|
|
2085
|
+
'limit':
|
|
2086
|
+
(int,),
|
|
2087
|
+
'offset':
|
|
2088
|
+
(int,),
|
|
2089
|
+
'value_resource_input_categories_search_request_v1':
|
|
2090
|
+
(ValueResourceInputCategoriesSearchRequestV1,),
|
|
2128
2091
|
},
|
|
2129
2092
|
'attribute_map': {
|
|
2130
|
-
'
|
|
2093
|
+
'retailer_id': 'retailerId',
|
|
2094
|
+
'limit': 'limit',
|
|
2095
|
+
'offset': 'offset',
|
|
2131
2096
|
},
|
|
2132
2097
|
'location_map': {
|
|
2133
|
-
'
|
|
2134
|
-
'
|
|
2098
|
+
'retailer_id': 'path',
|
|
2099
|
+
'limit': 'query',
|
|
2100
|
+
'offset': 'query',
|
|
2101
|
+
'value_resource_input_categories_search_request_v1': 'body',
|
|
2135
2102
|
},
|
|
2136
2103
|
'collection_format_map': {
|
|
2137
2104
|
}
|
|
2138
2105
|
},
|
|
2139
2106
|
headers_map={
|
|
2140
2107
|
'accept': [
|
|
2141
|
-
'
|
|
2142
|
-
'application/json',
|
|
2143
|
-
'text/json'
|
|
2108
|
+
'application/json'
|
|
2144
2109
|
],
|
|
2145
2110
|
'content_type': [
|
|
2146
2111
|
'application/json'
|
|
@@ -2148,65 +2113,79 @@ class CampaignApi(object):
|
|
|
2148
2113
|
},
|
|
2149
2114
|
api_client=api_client
|
|
2150
2115
|
)
|
|
2151
|
-
self.
|
|
2116
|
+
self.search_retailers_v1_endpoint = _Endpoint(
|
|
2152
2117
|
settings={
|
|
2153
|
-
'response_type': (
|
|
2118
|
+
'response_type': (EntityResourceCollectionOutcomeOfRetailerResultAndMetadata,),
|
|
2154
2119
|
'auth': [
|
|
2155
2120
|
'oauth',
|
|
2156
2121
|
'oauth'
|
|
2157
2122
|
],
|
|
2158
|
-
'endpoint_path': '/preview/retail-media/accounts/{
|
|
2159
|
-
'operation_id': '
|
|
2160
|
-
'http_method': '
|
|
2123
|
+
'endpoint_path': '/preview/retail-media/accounts/{accountId}/retailers/search',
|
|
2124
|
+
'operation_id': 'search_retailers_v1',
|
|
2125
|
+
'http_method': 'POST',
|
|
2161
2126
|
'servers': None,
|
|
2162
2127
|
},
|
|
2163
2128
|
params_map={
|
|
2164
2129
|
'all': [
|
|
2165
2130
|
'account_id',
|
|
2166
|
-
'
|
|
2167
|
-
'
|
|
2131
|
+
'limit',
|
|
2132
|
+
'offset',
|
|
2133
|
+
'value_resource_input_of_retailer_search_request',
|
|
2168
2134
|
],
|
|
2169
2135
|
'required': [
|
|
2170
2136
|
'account_id',
|
|
2171
|
-
'creative_id',
|
|
2172
2137
|
],
|
|
2173
2138
|
'nullable': [
|
|
2174
2139
|
],
|
|
2175
2140
|
'enum': [
|
|
2176
2141
|
],
|
|
2177
2142
|
'validation': [
|
|
2143
|
+
'limit',
|
|
2144
|
+
'offset',
|
|
2178
2145
|
]
|
|
2179
2146
|
},
|
|
2180
2147
|
root_map={
|
|
2181
2148
|
'validations': {
|
|
2149
|
+
('limit',): {
|
|
2150
|
+
|
|
2151
|
+
'inclusive_maximum': 10,
|
|
2152
|
+
'inclusive_minimum': 1,
|
|
2153
|
+
},
|
|
2154
|
+
('offset',): {
|
|
2155
|
+
|
|
2156
|
+
'inclusive_maximum': 2147483647,
|
|
2157
|
+
'inclusive_minimum': 0,
|
|
2158
|
+
},
|
|
2182
2159
|
},
|
|
2183
2160
|
'allowed_values': {
|
|
2184
2161
|
},
|
|
2185
2162
|
'openapi_types': {
|
|
2186
2163
|
'account_id':
|
|
2187
2164
|
(str,),
|
|
2188
|
-
'
|
|
2189
|
-
(
|
|
2190
|
-
'
|
|
2191
|
-
(
|
|
2165
|
+
'limit':
|
|
2166
|
+
(int,),
|
|
2167
|
+
'offset':
|
|
2168
|
+
(int,),
|
|
2169
|
+
'value_resource_input_of_retailer_search_request':
|
|
2170
|
+
(ValueResourceInputOfRetailerSearchRequest,),
|
|
2192
2171
|
},
|
|
2193
2172
|
'attribute_map': {
|
|
2194
|
-
'account_id': '
|
|
2195
|
-
'
|
|
2173
|
+
'account_id': 'accountId',
|
|
2174
|
+
'limit': 'limit',
|
|
2175
|
+
'offset': 'offset',
|
|
2196
2176
|
},
|
|
2197
2177
|
'location_map': {
|
|
2198
2178
|
'account_id': 'path',
|
|
2199
|
-
'
|
|
2200
|
-
'
|
|
2179
|
+
'limit': 'query',
|
|
2180
|
+
'offset': 'query',
|
|
2181
|
+
'value_resource_input_of_retailer_search_request': 'body',
|
|
2201
2182
|
},
|
|
2202
2183
|
'collection_format_map': {
|
|
2203
2184
|
}
|
|
2204
2185
|
},
|
|
2205
2186
|
headers_map={
|
|
2206
2187
|
'accept': [
|
|
2207
|
-
'
|
|
2208
|
-
'application/json',
|
|
2209
|
-
'text/json'
|
|
2188
|
+
'application/json'
|
|
2210
2189
|
],
|
|
2211
2190
|
'content_type': [
|
|
2212
2191
|
'application/json'
|
|
@@ -2214,25 +2193,25 @@ class CampaignApi(object):
|
|
|
2214
2193
|
},
|
|
2215
2194
|
api_client=api_client
|
|
2216
2195
|
)
|
|
2217
|
-
self.
|
|
2196
|
+
self.set_keyword_bids_endpoint = _Endpoint(
|
|
2218
2197
|
settings={
|
|
2219
|
-
'response_type': (
|
|
2198
|
+
'response_type': (ResourceOutcome,),
|
|
2220
2199
|
'auth': [
|
|
2221
2200
|
'oauth',
|
|
2222
2201
|
'oauth'
|
|
2223
2202
|
],
|
|
2224
|
-
'endpoint_path': '/preview/retail-media/
|
|
2225
|
-
'operation_id': '
|
|
2203
|
+
'endpoint_path': '/preview/retail-media/line-items/{id}/keywords/set-bid',
|
|
2204
|
+
'operation_id': 'set_keyword_bids',
|
|
2226
2205
|
'http_method': 'POST',
|
|
2227
2206
|
'servers': None,
|
|
2228
2207
|
},
|
|
2229
2208
|
params_map={
|
|
2230
2209
|
'all': [
|
|
2231
|
-
'
|
|
2232
|
-
'
|
|
2210
|
+
'id',
|
|
2211
|
+
'set_bids_model_request',
|
|
2233
2212
|
],
|
|
2234
2213
|
'required': [
|
|
2235
|
-
'
|
|
2214
|
+
'id',
|
|
2236
2215
|
],
|
|
2237
2216
|
'nullable': [
|
|
2238
2217
|
],
|
|
@@ -2247,17 +2226,17 @@ class CampaignApi(object):
|
|
|
2247
2226
|
'allowed_values': {
|
|
2248
2227
|
},
|
|
2249
2228
|
'openapi_types': {
|
|
2250
|
-
'
|
|
2229
|
+
'id':
|
|
2251
2230
|
(str,),
|
|
2252
|
-
'
|
|
2253
|
-
(
|
|
2231
|
+
'set_bids_model_request':
|
|
2232
|
+
(SetBidsModelRequest,),
|
|
2254
2233
|
},
|
|
2255
2234
|
'attribute_map': {
|
|
2256
|
-
'
|
|
2235
|
+
'id': 'id',
|
|
2257
2236
|
},
|
|
2258
2237
|
'location_map': {
|
|
2259
|
-
'
|
|
2260
|
-
'
|
|
2238
|
+
'id': 'path',
|
|
2239
|
+
'set_bids_model_request': 'body',
|
|
2261
2240
|
},
|
|
2262
2241
|
'collection_format_map': {
|
|
2263
2242
|
}
|
|
@@ -2272,103 +2251,141 @@ class CampaignApi(object):
|
|
|
2272
2251
|
},
|
|
2273
2252
|
api_client=api_client
|
|
2274
2253
|
)
|
|
2275
|
-
self.
|
|
2254
|
+
self.unpause_promoted_products_endpoint = _Endpoint(
|
|
2276
2255
|
settings={
|
|
2277
|
-
'response_type':
|
|
2256
|
+
'response_type': None,
|
|
2278
2257
|
'auth': [
|
|
2279
2258
|
'oauth',
|
|
2280
2259
|
'oauth'
|
|
2281
2260
|
],
|
|
2282
|
-
'endpoint_path': '/preview/retail-media/
|
|
2283
|
-
'operation_id': '
|
|
2261
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/products/unpause',
|
|
2262
|
+
'operation_id': 'unpause_promoted_products',
|
|
2284
2263
|
'http_method': 'POST',
|
|
2285
2264
|
'servers': None,
|
|
2286
2265
|
},
|
|
2287
2266
|
params_map={
|
|
2288
2267
|
'all': [
|
|
2289
|
-
'
|
|
2290
|
-
'
|
|
2291
|
-
|
|
2268
|
+
'line_item_id',
|
|
2269
|
+
'promoted_product_resource_collection_input',
|
|
2270
|
+
],
|
|
2271
|
+
'required': [
|
|
2272
|
+
'line_item_id',
|
|
2292
2273
|
],
|
|
2293
|
-
'required': [],
|
|
2294
2274
|
'nullable': [
|
|
2295
2275
|
],
|
|
2296
2276
|
'enum': [
|
|
2297
2277
|
],
|
|
2298
2278
|
'validation': [
|
|
2299
|
-
'limit',
|
|
2300
|
-
'offset',
|
|
2301
2279
|
]
|
|
2302
2280
|
},
|
|
2303
2281
|
root_map={
|
|
2304
2282
|
'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
2283
|
},
|
|
2316
2284
|
'allowed_values': {
|
|
2317
2285
|
},
|
|
2318
2286
|
'openapi_types': {
|
|
2319
|
-
'
|
|
2320
|
-
(
|
|
2321
|
-
'
|
|
2287
|
+
'line_item_id':
|
|
2288
|
+
(str,),
|
|
2289
|
+
'promoted_product_resource_collection_input':
|
|
2290
|
+
(PromotedProductResourceCollectionInput,),
|
|
2291
|
+
},
|
|
2292
|
+
'attribute_map': {
|
|
2293
|
+
'line_item_id': 'line-item-id',
|
|
2294
|
+
},
|
|
2295
|
+
'location_map': {
|
|
2296
|
+
'line_item_id': 'path',
|
|
2297
|
+
'promoted_product_resource_collection_input': 'body',
|
|
2298
|
+
},
|
|
2299
|
+
'collection_format_map': {
|
|
2300
|
+
}
|
|
2301
|
+
},
|
|
2302
|
+
headers_map={
|
|
2303
|
+
'accept': [],
|
|
2304
|
+
'content_type': [
|
|
2305
|
+
'application/json'
|
|
2306
|
+
]
|
|
2307
|
+
},
|
|
2308
|
+
api_client=api_client
|
|
2309
|
+
)
|
|
2310
|
+
self.update_auction_line_item_v2_endpoint = _Endpoint(
|
|
2311
|
+
settings={
|
|
2312
|
+
'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
|
|
2313
|
+
'auth': [
|
|
2314
|
+
'oauth',
|
|
2315
|
+
'oauth'
|
|
2316
|
+
],
|
|
2317
|
+
'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
|
|
2318
|
+
'operation_id': 'update_auction_line_item_v2',
|
|
2319
|
+
'http_method': 'PUT',
|
|
2320
|
+
'servers': None,
|
|
2321
|
+
},
|
|
2322
|
+
params_map={
|
|
2323
|
+
'all': [
|
|
2324
|
+
'line_item_id',
|
|
2325
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model',
|
|
2326
|
+
],
|
|
2327
|
+
'required': [
|
|
2328
|
+
'line_item_id',
|
|
2329
|
+
],
|
|
2330
|
+
'nullable': [
|
|
2331
|
+
],
|
|
2332
|
+
'enum': [
|
|
2333
|
+
],
|
|
2334
|
+
'validation': [
|
|
2335
|
+
]
|
|
2336
|
+
},
|
|
2337
|
+
root_map={
|
|
2338
|
+
'validations': {
|
|
2339
|
+
},
|
|
2340
|
+
'allowed_values': {
|
|
2341
|
+
},
|
|
2342
|
+
'openapi_types': {
|
|
2343
|
+
'line_item_id':
|
|
2322
2344
|
(int,),
|
|
2323
|
-
'
|
|
2324
|
-
(
|
|
2345
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model':
|
|
2346
|
+
(ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel,),
|
|
2325
2347
|
},
|
|
2326
2348
|
'attribute_map': {
|
|
2327
|
-
'
|
|
2328
|
-
'offset': 'offset',
|
|
2349
|
+
'line_item_id': 'lineItemId',
|
|
2329
2350
|
},
|
|
2330
2351
|
'location_map': {
|
|
2331
|
-
'
|
|
2332
|
-
'
|
|
2333
|
-
'value_resource_input_brand_id_search_request': 'body',
|
|
2352
|
+
'line_item_id': 'path',
|
|
2353
|
+
'value_resource_input_of_sponsored_products_line_item_update_request_model': 'body',
|
|
2334
2354
|
},
|
|
2335
2355
|
'collection_format_map': {
|
|
2336
2356
|
}
|
|
2337
2357
|
},
|
|
2338
2358
|
headers_map={
|
|
2339
2359
|
'accept': [
|
|
2340
|
-
'
|
|
2341
|
-
'application/json',
|
|
2342
|
-
'text/json'
|
|
2360
|
+
'application/json'
|
|
2343
2361
|
],
|
|
2344
2362
|
'content_type': [
|
|
2345
|
-
'application/json
|
|
2346
|
-
'application/json',
|
|
2347
|
-
'text/json',
|
|
2348
|
-
'application/*+json'
|
|
2363
|
+
'application/json'
|
|
2349
2364
|
]
|
|
2350
2365
|
},
|
|
2351
2366
|
api_client=api_client
|
|
2352
2367
|
)
|
|
2353
|
-
self.
|
|
2368
|
+
self.update_creative_endpoint = _Endpoint(
|
|
2354
2369
|
settings={
|
|
2355
|
-
'response_type': (
|
|
2370
|
+
'response_type': (Creative2Response,),
|
|
2356
2371
|
'auth': [
|
|
2357
2372
|
'oauth',
|
|
2358
2373
|
'oauth'
|
|
2359
2374
|
],
|
|
2360
|
-
'endpoint_path': '/preview/retail-media/
|
|
2361
|
-
'operation_id': '
|
|
2362
|
-
'http_method': '
|
|
2375
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
2376
|
+
'operation_id': 'update_creative',
|
|
2377
|
+
'http_method': 'PUT',
|
|
2363
2378
|
'servers': None,
|
|
2364
2379
|
},
|
|
2365
2380
|
params_map={
|
|
2366
2381
|
'all': [
|
|
2367
|
-
'
|
|
2368
|
-
'
|
|
2382
|
+
'account_id',
|
|
2383
|
+
'creative_id',
|
|
2384
|
+
'creative_update_model2',
|
|
2369
2385
|
],
|
|
2370
2386
|
'required': [
|
|
2371
|
-
'
|
|
2387
|
+
'account_id',
|
|
2388
|
+
'creative_id',
|
|
2372
2389
|
],
|
|
2373
2390
|
'nullable': [
|
|
2374
2391
|
],
|
|
@@ -2383,17 +2400,21 @@ class CampaignApi(object):
|
|
|
2383
2400
|
'allowed_values': {
|
|
2384
2401
|
},
|
|
2385
2402
|
'openapi_types': {
|
|
2386
|
-
'
|
|
2403
|
+
'account_id':
|
|
2387
2404
|
(str,),
|
|
2388
|
-
'
|
|
2389
|
-
(
|
|
2405
|
+
'creative_id':
|
|
2406
|
+
(str,),
|
|
2407
|
+
'creative_update_model2':
|
|
2408
|
+
(CreativeUpdateModel2,),
|
|
2390
2409
|
},
|
|
2391
2410
|
'attribute_map': {
|
|
2392
|
-
'
|
|
2411
|
+
'account_id': 'account-id',
|
|
2412
|
+
'creative_id': 'creative-id',
|
|
2393
2413
|
},
|
|
2394
2414
|
'location_map': {
|
|
2395
|
-
'
|
|
2396
|
-
'
|
|
2415
|
+
'account_id': 'path',
|
|
2416
|
+
'creative_id': 'path',
|
|
2417
|
+
'creative_update_model2': 'body',
|
|
2397
2418
|
},
|
|
2398
2419
|
'collection_format_map': {
|
|
2399
2420
|
}
|
|
@@ -2408,22 +2429,22 @@ class CampaignApi(object):
|
|
|
2408
2429
|
},
|
|
2409
2430
|
api_client=api_client
|
|
2410
2431
|
)
|
|
2411
|
-
self.
|
|
2432
|
+
self.update_keyword_reviews_v1_endpoint = _Endpoint(
|
|
2412
2433
|
settings={
|
|
2413
|
-
'response_type':
|
|
2434
|
+
'response_type': (ValueResourceOutcomeRetailMediaKeywordsReviewResult,),
|
|
2414
2435
|
'auth': [
|
|
2415
2436
|
'oauth',
|
|
2416
2437
|
'oauth'
|
|
2417
2438
|
],
|
|
2418
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
2419
|
-
'operation_id': '
|
|
2439
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/keywords/review',
|
|
2440
|
+
'operation_id': 'update_keyword_reviews_v1',
|
|
2420
2441
|
'http_method': 'POST',
|
|
2421
2442
|
'servers': None,
|
|
2422
2443
|
},
|
|
2423
2444
|
params_map={
|
|
2424
2445
|
'all': [
|
|
2425
2446
|
'line_item_id',
|
|
2426
|
-
'
|
|
2447
|
+
'value_resource_input_retail_media_keywords_review',
|
|
2427
2448
|
],
|
|
2428
2449
|
'required': [
|
|
2429
2450
|
'line_item_id',
|
|
@@ -2442,16 +2463,16 @@ class CampaignApi(object):
|
|
|
2442
2463
|
},
|
|
2443
2464
|
'openapi_types': {
|
|
2444
2465
|
'line_item_id':
|
|
2445
|
-
(
|
|
2446
|
-
'
|
|
2447
|
-
(
|
|
2466
|
+
(int,),
|
|
2467
|
+
'value_resource_input_retail_media_keywords_review':
|
|
2468
|
+
(ValueResourceInputRetailMediaKeywordsReview,),
|
|
2448
2469
|
},
|
|
2449
2470
|
'attribute_map': {
|
|
2450
2471
|
'line_item_id': 'line-item-id',
|
|
2451
2472
|
},
|
|
2452
2473
|
'location_map': {
|
|
2453
2474
|
'line_item_id': 'path',
|
|
2454
|
-
'
|
|
2475
|
+
'value_resource_input_retail_media_keywords_review': 'body',
|
|
2455
2476
|
},
|
|
2456
2477
|
'collection_format_map': {
|
|
2457
2478
|
}
|
|
@@ -2466,22 +2487,22 @@ class CampaignApi(object):
|
|
|
2466
2487
|
},
|
|
2467
2488
|
api_client=api_client
|
|
2468
2489
|
)
|
|
2469
|
-
self.
|
|
2490
|
+
self.update_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
2470
2491
|
settings={
|
|
2471
|
-
'response_type': (
|
|
2492
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
2472
2493
|
'auth': [
|
|
2473
2494
|
'oauth',
|
|
2474
2495
|
'oauth'
|
|
2475
2496
|
],
|
|
2476
|
-
'endpoint_path': '/preview/retail-media/
|
|
2477
|
-
'operation_id': '
|
|
2497
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
2498
|
+
'operation_id': 'update_preferred_line_item_by_line_item_id',
|
|
2478
2499
|
'http_method': 'PUT',
|
|
2479
2500
|
'servers': None,
|
|
2480
2501
|
},
|
|
2481
2502
|
params_map={
|
|
2482
2503
|
'all': [
|
|
2483
2504
|
'line_item_id',
|
|
2484
|
-
'
|
|
2505
|
+
'preferred_line_item_update_model_v2_request',
|
|
2485
2506
|
],
|
|
2486
2507
|
'required': [
|
|
2487
2508
|
'line_item_id',
|
|
@@ -2500,16 +2521,16 @@ class CampaignApi(object):
|
|
|
2500
2521
|
},
|
|
2501
2522
|
'openapi_types': {
|
|
2502
2523
|
'line_item_id':
|
|
2503
|
-
(
|
|
2504
|
-
'
|
|
2505
|
-
(
|
|
2524
|
+
(str,),
|
|
2525
|
+
'preferred_line_item_update_model_v2_request':
|
|
2526
|
+
(PreferredLineItemUpdateModelV2Request,),
|
|
2506
2527
|
},
|
|
2507
2528
|
'attribute_map': {
|
|
2508
|
-
'line_item_id': '
|
|
2529
|
+
'line_item_id': 'line-item-id',
|
|
2509
2530
|
},
|
|
2510
2531
|
'location_map': {
|
|
2511
2532
|
'line_item_id': 'path',
|
|
2512
|
-
'
|
|
2533
|
+
'preferred_line_item_update_model_v2_request': 'body',
|
|
2513
2534
|
},
|
|
2514
2535
|
'collection_format_map': {
|
|
2515
2536
|
}
|
|
@@ -2519,34 +2540,35 @@ class CampaignApi(object):
|
|
|
2519
2540
|
'application/json'
|
|
2520
2541
|
],
|
|
2521
2542
|
'content_type': [
|
|
2522
|
-
'application/json'
|
|
2523
|
-
'text/json',
|
|
2524
|
-
'application/*+json'
|
|
2543
|
+
'application/json'
|
|
2525
2544
|
]
|
|
2526
2545
|
},
|
|
2527
2546
|
api_client=api_client
|
|
2528
2547
|
)
|
|
2529
|
-
self.
|
|
2548
|
+
self.update_product_button_by_line_item_and_product_button_id_endpoint = _Endpoint(
|
|
2530
2549
|
settings={
|
|
2531
|
-
'response_type': (
|
|
2550
|
+
'response_type': (ProductButtonResponseListResponse,),
|
|
2532
2551
|
'auth': [
|
|
2533
2552
|
'oauth',
|
|
2534
2553
|
'oauth'
|
|
2535
2554
|
],
|
|
2536
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
2537
|
-
'operation_id': '
|
|
2538
|
-
'http_method': '
|
|
2555
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
2556
|
+
'operation_id': 'update_product_button_by_line_item_and_product_button_id',
|
|
2557
|
+
'http_method': 'PUT',
|
|
2539
2558
|
'servers': None,
|
|
2540
2559
|
},
|
|
2541
2560
|
params_map={
|
|
2542
2561
|
'all': [
|
|
2543
2562
|
'line_item_id',
|
|
2544
|
-
'
|
|
2563
|
+
'product_button_id',
|
|
2564
|
+
'product_button_request_request',
|
|
2545
2565
|
],
|
|
2546
2566
|
'required': [
|
|
2547
2567
|
'line_item_id',
|
|
2568
|
+
'product_button_id',
|
|
2548
2569
|
],
|
|
2549
2570
|
'nullable': [
|
|
2571
|
+
'product_button_request_request',
|
|
2550
2572
|
],
|
|
2551
2573
|
'enum': [
|
|
2552
2574
|
],
|
|
@@ -2560,31 +2582,30 @@ class CampaignApi(object):
|
|
|
2560
2582
|
},
|
|
2561
2583
|
'openapi_types': {
|
|
2562
2584
|
'line_item_id':
|
|
2563
|
-
(
|
|
2564
|
-
'
|
|
2565
|
-
(
|
|
2585
|
+
(str,),
|
|
2586
|
+
'product_button_id':
|
|
2587
|
+
(str,),
|
|
2588
|
+
'product_button_request_request':
|
|
2589
|
+
(ProductButtonRequestRequest,),
|
|
2566
2590
|
},
|
|
2567
2591
|
'attribute_map': {
|
|
2568
2592
|
'line_item_id': 'line-item-id',
|
|
2593
|
+
'product_button_id': 'product-button-id',
|
|
2569
2594
|
},
|
|
2570
2595
|
'location_map': {
|
|
2571
2596
|
'line_item_id': 'path',
|
|
2572
|
-
'
|
|
2597
|
+
'product_button_id': 'path',
|
|
2598
|
+
'product_button_request_request': 'body',
|
|
2573
2599
|
},
|
|
2574
2600
|
'collection_format_map': {
|
|
2575
2601
|
}
|
|
2576
2602
|
},
|
|
2577
2603
|
headers_map={
|
|
2578
2604
|
'accept': [
|
|
2579
|
-
'
|
|
2580
|
-
'application/json',
|
|
2581
|
-
'text/json'
|
|
2605
|
+
'application/json'
|
|
2582
2606
|
],
|
|
2583
2607
|
'content_type': [
|
|
2584
|
-
'application/json
|
|
2585
|
-
'application/json',
|
|
2586
|
-
'text/json',
|
|
2587
|
-
'application/*+json'
|
|
2608
|
+
'application/json'
|
|
2588
2609
|
]
|
|
2589
2610
|
},
|
|
2590
2611
|
api_client=api_client
|
|
@@ -2674,25 +2695,25 @@ class CampaignApi(object):
|
|
|
2674
2695
|
id
|
|
2675
2696
|
return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs)
|
|
2676
2697
|
|
|
2677
|
-
def
|
|
2698
|
+
def append_product_button_by_line_item_id(
|
|
2678
2699
|
self,
|
|
2679
2700
|
line_item_id,
|
|
2680
2701
|
**kwargs
|
|
2681
2702
|
):
|
|
2682
|
-
"""
|
|
2703
|
+
"""append_product_button_by_line_item_id # noqa: E501
|
|
2683
2704
|
|
|
2684
|
-
|
|
2705
|
+
Add Specific Product Buttons # noqa: E501
|
|
2685
2706
|
This method makes a synchronous HTTP request by default. To make an
|
|
2686
2707
|
asynchronous HTTP request, please pass async_req=True
|
|
2687
2708
|
|
|
2688
|
-
>>> thread = api.
|
|
2709
|
+
>>> thread = api.append_product_button_by_line_item_id(line_item_id, async_req=True)
|
|
2689
2710
|
>>> result = thread.get()
|
|
2690
2711
|
|
|
2691
2712
|
Args:
|
|
2692
|
-
line_item_id (str):
|
|
2713
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
2693
2714
|
|
|
2694
2715
|
Keyword Args:
|
|
2695
|
-
|
|
2716
|
+
product_button_request_list_request (ProductButtonRequestListRequest): List of Product Buttons to append. [optional]
|
|
2696
2717
|
_return_http_data_only (bool): response data without head status
|
|
2697
2718
|
code and headers. Default is True.
|
|
2698
2719
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2725,7 +2746,7 @@ class CampaignApi(object):
|
|
|
2725
2746
|
async_req (bool): execute request asynchronously
|
|
2726
2747
|
|
|
2727
2748
|
Returns:
|
|
2728
|
-
|
|
2749
|
+
ProductButtonResponseListResponse
|
|
2729
2750
|
If the method is called asynchronously, returns the request
|
|
2730
2751
|
thread.
|
|
2731
2752
|
"""
|
|
@@ -2756,29 +2777,27 @@ class CampaignApi(object):
|
|
|
2756
2777
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2757
2778
|
kwargs['line_item_id'] = \
|
|
2758
2779
|
line_item_id
|
|
2759
|
-
return self.
|
|
2780
|
+
return self.append_product_button_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
2760
2781
|
|
|
2761
|
-
def
|
|
2782
|
+
def append_promoted_products(
|
|
2762
2783
|
self,
|
|
2763
|
-
|
|
2784
|
+
line_item_id,
|
|
2764
2785
|
**kwargs
|
|
2765
2786
|
):
|
|
2766
|
-
"""
|
|
2787
|
+
"""append_promoted_products # noqa: E501
|
|
2767
2788
|
|
|
2768
|
-
|
|
2789
|
+
Append a collection of promoted products to a line item # noqa: E501
|
|
2769
2790
|
This method makes a synchronous HTTP request by default. To make an
|
|
2770
2791
|
asynchronous HTTP request, please pass async_req=True
|
|
2771
2792
|
|
|
2772
|
-
>>> thread = api.
|
|
2793
|
+
>>> thread = api.append_promoted_products(line_item_id, async_req=True)
|
|
2773
2794
|
>>> result = thread.get()
|
|
2774
2795
|
|
|
2775
2796
|
Args:
|
|
2776
|
-
|
|
2797
|
+
line_item_id (str): ID of the line item
|
|
2777
2798
|
|
|
2778
2799
|
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]
|
|
2800
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
2782
2801
|
_return_http_data_only (bool): response data without head status
|
|
2783
2802
|
code and headers. Default is True.
|
|
2784
2803
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2811,7 +2830,7 @@ class CampaignApi(object):
|
|
|
2811
2830
|
async_req (bool): execute request asynchronously
|
|
2812
2831
|
|
|
2813
2832
|
Returns:
|
|
2814
|
-
|
|
2833
|
+
ProductResourceOutcome
|
|
2815
2834
|
If the method is called asynchronously, returns the request
|
|
2816
2835
|
thread.
|
|
2817
2836
|
"""
|
|
@@ -2840,9 +2859,9 @@ class CampaignApi(object):
|
|
|
2840
2859
|
'_content_type')
|
|
2841
2860
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2842
2861
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2843
|
-
kwargs['
|
|
2844
|
-
|
|
2845
|
-
return self.
|
|
2862
|
+
kwargs['line_item_id'] = \
|
|
2863
|
+
line_item_id
|
|
2864
|
+
return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
2846
2865
|
|
|
2847
2866
|
def create_auction_line_item_v2(
|
|
2848
2867
|
self,
|
|
@@ -2928,26 +2947,25 @@ class CampaignApi(object):
|
|
|
2928
2947
|
campaign_id
|
|
2929
2948
|
return self.create_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
2930
2949
|
|
|
2931
|
-
def
|
|
2950
|
+
def create_creative(
|
|
2932
2951
|
self,
|
|
2933
|
-
|
|
2934
|
-
product_button_id,
|
|
2952
|
+
account_id,
|
|
2935
2953
|
**kwargs
|
|
2936
2954
|
):
|
|
2937
|
-
"""
|
|
2955
|
+
"""create_creative # noqa: E501
|
|
2938
2956
|
|
|
2939
|
-
|
|
2957
|
+
Create a creative for an account # noqa: E501
|
|
2940
2958
|
This method makes a synchronous HTTP request by default. To make an
|
|
2941
2959
|
asynchronous HTTP request, please pass async_req=True
|
|
2942
2960
|
|
|
2943
|
-
>>> thread = api.
|
|
2961
|
+
>>> thread = api.create_creative(account_id, async_req=True)
|
|
2944
2962
|
>>> result = thread.get()
|
|
2945
2963
|
|
|
2946
2964
|
Args:
|
|
2947
|
-
|
|
2948
|
-
product_button_id (str): productButtonId used for delete
|
|
2965
|
+
account_id (str): External account id to create a creative for
|
|
2949
2966
|
|
|
2950
2967
|
Keyword Args:
|
|
2968
|
+
creative_create_model2 (CreativeCreateModel2): The creative to create. [optional]
|
|
2951
2969
|
_return_http_data_only (bool): response data without head status
|
|
2952
2970
|
code and headers. Default is True.
|
|
2953
2971
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2980,7 +2998,7 @@ class CampaignApi(object):
|
|
|
2980
2998
|
async_req (bool): execute request asynchronously
|
|
2981
2999
|
|
|
2982
3000
|
Returns:
|
|
2983
|
-
|
|
3001
|
+
Creative2Response
|
|
2984
3002
|
If the method is called asynchronously, returns the request
|
|
2985
3003
|
thread.
|
|
2986
3004
|
"""
|
|
@@ -3009,31 +3027,29 @@ class CampaignApi(object):
|
|
|
3009
3027
|
'_content_type')
|
|
3010
3028
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3011
3029
|
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)
|
|
3030
|
+
kwargs['account_id'] = \
|
|
3031
|
+
account_id
|
|
3032
|
+
return self.create_creative_endpoint.call_with_http_info(**kwargs)
|
|
3017
3033
|
|
|
3018
|
-
def
|
|
3034
|
+
def create_preferred_line_item_by_campaign_id(
|
|
3019
3035
|
self,
|
|
3020
|
-
|
|
3036
|
+
campaign_id,
|
|
3021
3037
|
**kwargs
|
|
3022
3038
|
):
|
|
3023
|
-
"""
|
|
3039
|
+
"""create_preferred_line_item_by_campaign_id # noqa: E501
|
|
3024
3040
|
|
|
3025
|
-
|
|
3041
|
+
Creates a new preferred line item with the specified settings # noqa: E501
|
|
3026
3042
|
This method makes a synchronous HTTP request by default. To make an
|
|
3027
3043
|
asynchronous HTTP request, please pass async_req=True
|
|
3028
3044
|
|
|
3029
|
-
>>> thread = api.
|
|
3045
|
+
>>> thread = api.create_preferred_line_item_by_campaign_id(campaign_id, async_req=True)
|
|
3030
3046
|
>>> result = thread.get()
|
|
3031
3047
|
|
|
3032
3048
|
Args:
|
|
3033
|
-
|
|
3049
|
+
campaign_id (str): The given campaign id
|
|
3034
3050
|
|
|
3035
3051
|
Keyword Args:
|
|
3036
|
-
|
|
3052
|
+
preferred_line_item_create_model_v2_request (PreferredLineItemCreateModelV2Request): The line item settings to create a line item with. [optional]
|
|
3037
3053
|
_return_http_data_only (bool): response data without head status
|
|
3038
3054
|
code and headers. Default is True.
|
|
3039
3055
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3066,7 +3082,7 @@ class CampaignApi(object):
|
|
|
3066
3082
|
async_req (bool): execute request asynchronously
|
|
3067
3083
|
|
|
3068
3084
|
Returns:
|
|
3069
|
-
|
|
3085
|
+
PreferredLineItemV2Response
|
|
3070
3086
|
If the method is called asynchronously, returns the request
|
|
3071
3087
|
thread.
|
|
3072
3088
|
"""
|
|
@@ -3095,26 +3111,28 @@ class CampaignApi(object):
|
|
|
3095
3111
|
'_content_type')
|
|
3096
3112
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3097
3113
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3098
|
-
kwargs['
|
|
3099
|
-
|
|
3100
|
-
return self.
|
|
3114
|
+
kwargs['campaign_id'] = \
|
|
3115
|
+
campaign_id
|
|
3116
|
+
return self.create_preferred_line_item_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
3101
3117
|
|
|
3102
|
-
def
|
|
3118
|
+
def delete_product_button_by_line_item_and_product_button_id(
|
|
3103
3119
|
self,
|
|
3104
|
-
|
|
3120
|
+
line_item_id,
|
|
3121
|
+
product_button_id,
|
|
3105
3122
|
**kwargs
|
|
3106
3123
|
):
|
|
3107
|
-
"""
|
|
3124
|
+
"""delete_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
3108
3125
|
|
|
3109
|
-
|
|
3126
|
+
Delete Specific Product Button # noqa: E501
|
|
3110
3127
|
This method makes a synchronous HTTP request by default. To make an
|
|
3111
3128
|
asynchronous HTTP request, please pass async_req=True
|
|
3112
3129
|
|
|
3113
|
-
>>> thread = api.
|
|
3130
|
+
>>> thread = api.delete_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
3114
3131
|
>>> result = thread.get()
|
|
3115
3132
|
|
|
3116
3133
|
Args:
|
|
3117
|
-
|
|
3134
|
+
line_item_id (str): LineItemId for productButton delete
|
|
3135
|
+
product_button_id (str): productButtonId used for delete
|
|
3118
3136
|
|
|
3119
3137
|
Keyword Args:
|
|
3120
3138
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3149,7 +3167,7 @@ class CampaignApi(object):
|
|
|
3149
3167
|
async_req (bool): execute request asynchronously
|
|
3150
3168
|
|
|
3151
3169
|
Returns:
|
|
3152
|
-
|
|
3170
|
+
ProductButtonResponseListResponse
|
|
3153
3171
|
If the method is called asynchronously, returns the request
|
|
3154
3172
|
thread.
|
|
3155
3173
|
"""
|
|
@@ -3178,31 +3196,31 @@ class CampaignApi(object):
|
|
|
3178
3196
|
'_content_type')
|
|
3179
3197
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3180
3198
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3181
|
-
kwargs['
|
|
3182
|
-
|
|
3183
|
-
|
|
3199
|
+
kwargs['line_item_id'] = \
|
|
3200
|
+
line_item_id
|
|
3201
|
+
kwargs['product_button_id'] = \
|
|
3202
|
+
product_button_id
|
|
3203
|
+
return self.delete_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
3184
3204
|
|
|
3185
|
-
def
|
|
3205
|
+
def delete_promoted_products(
|
|
3186
3206
|
self,
|
|
3187
3207
|
line_item_id,
|
|
3188
3208
|
**kwargs
|
|
3189
3209
|
):
|
|
3190
|
-
"""
|
|
3210
|
+
"""delete_promoted_products # noqa: E501
|
|
3191
3211
|
|
|
3192
|
-
|
|
3212
|
+
Remove a collection of promoted products from a line item # noqa: E501
|
|
3193
3213
|
This method makes a synchronous HTTP request by default. To make an
|
|
3194
3214
|
asynchronous HTTP request, please pass async_req=True
|
|
3195
3215
|
|
|
3196
|
-
>>> thread = api.
|
|
3216
|
+
>>> thread = api.delete_promoted_products(line_item_id, async_req=True)
|
|
3197
3217
|
>>> result = thread.get()
|
|
3198
3218
|
|
|
3199
3219
|
Args:
|
|
3200
|
-
line_item_id (str): ID of the line item
|
|
3220
|
+
line_item_id (str): ID of the line item
|
|
3201
3221
|
|
|
3202
3222
|
Keyword Args:
|
|
3203
|
-
|
|
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]
|
|
3223
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
3206
3224
|
_return_http_data_only (bool): response data without head status
|
|
3207
3225
|
code and headers. Default is True.
|
|
3208
3226
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3235,7 +3253,7 @@ class CampaignApi(object):
|
|
|
3235
3253
|
async_req (bool): execute request asynchronously
|
|
3236
3254
|
|
|
3237
3255
|
Returns:
|
|
3238
|
-
|
|
3256
|
+
None
|
|
3239
3257
|
If the method is called asynchronously, returns the request
|
|
3240
3258
|
thread.
|
|
3241
3259
|
"""
|
|
@@ -3266,28 +3284,112 @@ class CampaignApi(object):
|
|
|
3266
3284
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3267
3285
|
kwargs['line_item_id'] = \
|
|
3268
3286
|
line_item_id
|
|
3269
|
-
return self.
|
|
3287
|
+
return self.delete_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
3288
|
+
|
|
3289
|
+
def fetch_keywords(
|
|
3290
|
+
self,
|
|
3291
|
+
id,
|
|
3292
|
+
**kwargs
|
|
3293
|
+
):
|
|
3294
|
+
"""fetch_keywords # noqa: E501
|
|
3295
|
+
|
|
3296
|
+
Fetch keywords associated with the specified line item # noqa: E501
|
|
3297
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3298
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3299
|
+
|
|
3300
|
+
>>> thread = api.fetch_keywords(id, async_req=True)
|
|
3301
|
+
>>> result = thread.get()
|
|
3302
|
+
|
|
3303
|
+
Args:
|
|
3304
|
+
id (str): ID of the line item
|
|
3305
|
+
|
|
3306
|
+
Keyword Args:
|
|
3307
|
+
_return_http_data_only (bool): response data without head status
|
|
3308
|
+
code and headers. Default is True.
|
|
3309
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3310
|
+
will be returned without reading/decoding response data.
|
|
3311
|
+
Default is True.
|
|
3312
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3313
|
+
one number provided, it will be total request timeout. It can also
|
|
3314
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3315
|
+
Default is None.
|
|
3316
|
+
_check_input_type (bool): specifies if type checking
|
|
3317
|
+
should be done one the data sent to the server.
|
|
3318
|
+
Default is True.
|
|
3319
|
+
_check_return_type (bool): specifies if type checking
|
|
3320
|
+
should be done one the data received from the server.
|
|
3321
|
+
Default is True.
|
|
3322
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3323
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3324
|
+
False if the variable names in the input data
|
|
3325
|
+
are pythonic names, e.g. snake case (default)
|
|
3326
|
+
_content_type (str/None): force body content-type.
|
|
3327
|
+
Default is None and content-type will be predicted by allowed
|
|
3328
|
+
content-types and body.
|
|
3329
|
+
_host_index (int/None): specifies the index of the server
|
|
3330
|
+
that we want to use.
|
|
3331
|
+
Default is read from the configuration.
|
|
3332
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3333
|
+
request; this effectively ignores the authentication
|
|
3334
|
+
in the spec for a single request.
|
|
3335
|
+
Default is None
|
|
3336
|
+
async_req (bool): execute request asynchronously
|
|
3337
|
+
|
|
3338
|
+
Returns:
|
|
3339
|
+
KeywordsModelResponse
|
|
3340
|
+
If the method is called asynchronously, returns the request
|
|
3341
|
+
thread.
|
|
3342
|
+
"""
|
|
3343
|
+
kwargs['async_req'] = kwargs.get(
|
|
3344
|
+
'async_req', False
|
|
3345
|
+
)
|
|
3346
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3347
|
+
'_return_http_data_only', True
|
|
3348
|
+
)
|
|
3349
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3350
|
+
'_preload_content', True
|
|
3351
|
+
)
|
|
3352
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3353
|
+
'_request_timeout', None
|
|
3354
|
+
)
|
|
3355
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3356
|
+
'_check_input_type', True
|
|
3357
|
+
)
|
|
3358
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3359
|
+
'_check_return_type', True
|
|
3360
|
+
)
|
|
3361
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3362
|
+
'_spec_property_naming', False
|
|
3363
|
+
)
|
|
3364
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3365
|
+
'_content_type')
|
|
3366
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3367
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3368
|
+
kwargs['id'] = \
|
|
3369
|
+
id
|
|
3370
|
+
return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
|
|
3270
3371
|
|
|
3271
|
-
def
|
|
3372
|
+
def fetch_promoted_products(
|
|
3272
3373
|
self,
|
|
3273
3374
|
line_item_id,
|
|
3274
|
-
product_button_id,
|
|
3275
3375
|
**kwargs
|
|
3276
3376
|
):
|
|
3277
|
-
"""
|
|
3377
|
+
"""fetch_promoted_products # noqa: E501
|
|
3278
3378
|
|
|
3279
|
-
|
|
3379
|
+
Retrieve a page of promoted products for a line item # noqa: E501
|
|
3280
3380
|
This method makes a synchronous HTTP request by default. To make an
|
|
3281
3381
|
asynchronous HTTP request, please pass async_req=True
|
|
3282
3382
|
|
|
3283
|
-
>>> thread = api.
|
|
3383
|
+
>>> thread = api.fetch_promoted_products(line_item_id, async_req=True)
|
|
3284
3384
|
>>> result = thread.get()
|
|
3285
3385
|
|
|
3286
3386
|
Args:
|
|
3287
|
-
line_item_id (str):
|
|
3288
|
-
product_button_id (str): productButtonId used for retrieval
|
|
3387
|
+
line_item_id (str): ID of the line item.
|
|
3289
3388
|
|
|
3290
3389
|
Keyword Args:
|
|
3390
|
+
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]
|
|
3391
|
+
limit (int): Maximum page size to fetch. Defaults to 500.. [optional]
|
|
3392
|
+
offset (int): Offset of the first item to fetch. Defaults to zero.. [optional]
|
|
3291
3393
|
_return_http_data_only (bool): response data without head status
|
|
3292
3394
|
code and headers. Default is True.
|
|
3293
3395
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3320,7 +3422,7 @@ class CampaignApi(object):
|
|
|
3320
3422
|
async_req (bool): execute request asynchronously
|
|
3321
3423
|
|
|
3322
3424
|
Returns:
|
|
3323
|
-
|
|
3425
|
+
PromotedProductResourceCollectionOutcome
|
|
3324
3426
|
If the method is called asynchronously, returns the request
|
|
3325
3427
|
thread.
|
|
3326
3428
|
"""
|
|
@@ -3351,26 +3453,24 @@ class CampaignApi(object):
|
|
|
3351
3453
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3352
3454
|
kwargs['line_item_id'] = \
|
|
3353
3455
|
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)
|
|
3456
|
+
return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
3357
3457
|
|
|
3358
|
-
def
|
|
3458
|
+
def get_api_external_v2_catalog_status_by_catalog_id(
|
|
3359
3459
|
self,
|
|
3360
|
-
|
|
3460
|
+
catalog_id,
|
|
3361
3461
|
**kwargs
|
|
3362
3462
|
):
|
|
3363
|
-
"""
|
|
3463
|
+
"""get_api_external_v2_catalog_status_by_catalog_id # noqa: E501
|
|
3364
3464
|
|
|
3365
|
-
|
|
3465
|
+
Check the status of a catalog request. # noqa: E501
|
|
3366
3466
|
This method makes a synchronous HTTP request by default. To make an
|
|
3367
3467
|
asynchronous HTTP request, please pass async_req=True
|
|
3368
3468
|
|
|
3369
|
-
>>> thread = api.
|
|
3469
|
+
>>> thread = api.get_api_external_v2_catalog_status_by_catalog_id(catalog_id, async_req=True)
|
|
3370
3470
|
>>> result = thread.get()
|
|
3371
3471
|
|
|
3372
3472
|
Args:
|
|
3373
|
-
|
|
3473
|
+
catalog_id (str): A catalog ID returned from an account catalog request.
|
|
3374
3474
|
|
|
3375
3475
|
Keyword Args:
|
|
3376
3476
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3405,7 +3505,7 @@ class CampaignApi(object):
|
|
|
3405
3505
|
async_req (bool): execute request asynchronously
|
|
3406
3506
|
|
|
3407
3507
|
Returns:
|
|
3408
|
-
|
|
3508
|
+
EntityResourceOutcomeOfCatalogStatusV2
|
|
3409
3509
|
If the method is called asynchronously, returns the request
|
|
3410
3510
|
thread.
|
|
3411
3511
|
"""
|
|
@@ -3434,31 +3534,30 @@ class CampaignApi(object):
|
|
|
3434
3534
|
'_content_type')
|
|
3435
3535
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3436
3536
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3437
|
-
kwargs['
|
|
3438
|
-
|
|
3439
|
-
return self.
|
|
3537
|
+
kwargs['catalog_id'] = \
|
|
3538
|
+
catalog_id
|
|
3539
|
+
return self.get_api_external_v2_catalog_status_by_catalog_id_endpoint.call_with_http_info(**kwargs)
|
|
3440
3540
|
|
|
3441
|
-
def
|
|
3541
|
+
def get_api_v1_external_retailer_brands_by_retailer_id(
|
|
3442
3542
|
self,
|
|
3443
|
-
|
|
3543
|
+
retailer_id,
|
|
3444
3544
|
**kwargs
|
|
3445
3545
|
):
|
|
3446
|
-
"""
|
|
3546
|
+
"""get_api_v1_external_retailer_brands_by_retailer_id # noqa: E501
|
|
3447
3547
|
|
|
3448
|
-
Gets
|
|
3548
|
+
Gets the brands for the given retailer # noqa: E501
|
|
3449
3549
|
This method makes a synchronous HTTP request by default. To make an
|
|
3450
3550
|
asynchronous HTTP request, please pass async_req=True
|
|
3451
3551
|
|
|
3452
|
-
>>> thread = api.
|
|
3552
|
+
>>> thread = api.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id, async_req=True)
|
|
3453
3553
|
>>> result = thread.get()
|
|
3454
3554
|
|
|
3455
3555
|
Args:
|
|
3456
|
-
|
|
3556
|
+
retailer_id (int): The retailer id for which brands should be fetched.
|
|
3457
3557
|
|
|
3458
3558
|
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
|
|
3559
|
+
brand_type (str): Filter to narrow down brands [all|uc|retailer]. Defaults to uc. [optional]
|
|
3560
|
+
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
3561
|
_return_http_data_only (bool): response data without head status
|
|
3463
3562
|
code and headers. Default is True.
|
|
3464
3563
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3491,7 +3590,7 @@ class CampaignApi(object):
|
|
|
3491
3590
|
async_req (bool): execute request asynchronously
|
|
3492
3591
|
|
|
3493
3592
|
Returns:
|
|
3494
|
-
|
|
3593
|
+
BrandPreviewListResponse
|
|
3495
3594
|
If the method is called asynchronously, returns the request
|
|
3496
3595
|
thread.
|
|
3497
3596
|
"""
|
|
@@ -3520,26 +3619,28 @@ class CampaignApi(object):
|
|
|
3520
3619
|
'_content_type')
|
|
3521
3620
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3522
3621
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3523
|
-
kwargs['
|
|
3524
|
-
|
|
3525
|
-
return self.
|
|
3622
|
+
kwargs['retailer_id'] = \
|
|
3623
|
+
retailer_id
|
|
3624
|
+
return self.get_api_v1_external_retailer_brands_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3526
3625
|
|
|
3527
|
-
def
|
|
3626
|
+
def get_api_v1_external_retailer_by_retailer_id_seller_by_seller(
|
|
3528
3627
|
self,
|
|
3529
|
-
|
|
3628
|
+
retailer_id,
|
|
3629
|
+
seller,
|
|
3530
3630
|
**kwargs
|
|
3531
3631
|
):
|
|
3532
|
-
"""
|
|
3632
|
+
"""get_api_v1_external_retailer_by_retailer_id_seller_by_seller # noqa: E501
|
|
3533
3633
|
|
|
3534
|
-
|
|
3634
|
+
Endpoint to get market place seller id and name # noqa: E501
|
|
3535
3635
|
This method makes a synchronous HTTP request by default. To make an
|
|
3536
3636
|
asynchronous HTTP request, please pass async_req=True
|
|
3537
3637
|
|
|
3538
|
-
>>> thread = api.
|
|
3638
|
+
>>> thread = api.get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller, async_req=True)
|
|
3539
3639
|
>>> result = thread.get()
|
|
3540
3640
|
|
|
3541
3641
|
Args:
|
|
3542
|
-
|
|
3642
|
+
retailer_id (int): The retailer id for which seller should be fetched.
|
|
3643
|
+
seller (str): The seller id or seller name which should be validated.
|
|
3543
3644
|
|
|
3544
3645
|
Keyword Args:
|
|
3545
3646
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3574,7 +3675,7 @@ class CampaignApi(object):
|
|
|
3574
3675
|
async_req (bool): execute request asynchronously
|
|
3575
3676
|
|
|
3576
3677
|
Returns:
|
|
3577
|
-
|
|
3678
|
+
SellerPreviewResponse
|
|
3578
3679
|
If the method is called asynchronously, returns the request
|
|
3579
3680
|
thread.
|
|
3580
3681
|
"""
|
|
@@ -3603,28 +3704,31 @@ class CampaignApi(object):
|
|
|
3603
3704
|
'_content_type')
|
|
3604
3705
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3605
3706
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3606
|
-
kwargs['
|
|
3607
|
-
|
|
3608
|
-
|
|
3707
|
+
kwargs['retailer_id'] = \
|
|
3708
|
+
retailer_id
|
|
3709
|
+
kwargs['seller'] = \
|
|
3710
|
+
seller
|
|
3711
|
+
return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3609
3712
|
|
|
3610
|
-
def
|
|
3713
|
+
def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(
|
|
3611
3714
|
self,
|
|
3612
|
-
|
|
3715
|
+
retailer_id,
|
|
3613
3716
|
**kwargs
|
|
3614
3717
|
):
|
|
3615
|
-
"""
|
|
3718
|
+
"""get_api_v1_external_retailer_category_cpc_rates_by_retailer_id # noqa: E501
|
|
3616
3719
|
|
|
3617
|
-
Gets the
|
|
3720
|
+
Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer # noqa: E501
|
|
3618
3721
|
This method makes a synchronous HTTP request by default. To make an
|
|
3619
3722
|
asynchronous HTTP request, please pass async_req=True
|
|
3620
3723
|
|
|
3621
|
-
>>> thread = api.
|
|
3724
|
+
>>> thread = api.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, async_req=True)
|
|
3622
3725
|
>>> result = thread.get()
|
|
3623
3726
|
|
|
3624
3727
|
Args:
|
|
3625
|
-
|
|
3728
|
+
retailer_id (str): The retailer id
|
|
3626
3729
|
|
|
3627
3730
|
Keyword Args:
|
|
3731
|
+
fields ([str]): The fields in the response that is to be included. [optional]
|
|
3628
3732
|
_return_http_data_only (bool): response data without head status
|
|
3629
3733
|
code and headers. Default is True.
|
|
3630
3734
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3657,7 +3761,7 @@ class CampaignApi(object):
|
|
|
3657
3761
|
async_req (bool): execute request asynchronously
|
|
3658
3762
|
|
|
3659
3763
|
Returns:
|
|
3660
|
-
|
|
3764
|
+
CpcRateCardPreviewResponse
|
|
3661
3765
|
If the method is called asynchronously, returns the request
|
|
3662
3766
|
thread.
|
|
3663
3767
|
"""
|
|
@@ -3686,30 +3790,28 @@ class CampaignApi(object):
|
|
|
3686
3790
|
'_content_type')
|
|
3687
3791
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3688
3792
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3689
|
-
kwargs['
|
|
3690
|
-
|
|
3691
|
-
return self.
|
|
3793
|
+
kwargs['retailer_id'] = \
|
|
3794
|
+
retailer_id
|
|
3795
|
+
return self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3692
3796
|
|
|
3693
|
-
def
|
|
3797
|
+
def get_api_v1_external_retailer_placements_by_retailer_id(
|
|
3694
3798
|
self,
|
|
3695
3799
|
retailer_id,
|
|
3696
3800
|
**kwargs
|
|
3697
3801
|
):
|
|
3698
|
-
"""
|
|
3802
|
+
"""get_api_v1_external_retailer_placements_by_retailer_id # noqa: E501
|
|
3699
3803
|
|
|
3700
|
-
Gets
|
|
3804
|
+
Gets all placement information for the given retailer # noqa: E501
|
|
3701
3805
|
This method makes a synchronous HTTP request by default. To make an
|
|
3702
3806
|
asynchronous HTTP request, please pass async_req=True
|
|
3703
3807
|
|
|
3704
|
-
>>> thread = api.
|
|
3808
|
+
>>> thread = api.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id, async_req=True)
|
|
3705
3809
|
>>> result = thread.get()
|
|
3706
3810
|
|
|
3707
3811
|
Args:
|
|
3708
|
-
retailer_id (
|
|
3812
|
+
retailer_id (str): The retailer id for which placements should be fetched.
|
|
3709
3813
|
|
|
3710
3814
|
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
3815
|
_return_http_data_only (bool): response data without head status
|
|
3714
3816
|
code and headers. Default is True.
|
|
3715
3817
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3742,7 +3844,7 @@ class CampaignApi(object):
|
|
|
3742
3844
|
async_req (bool): execute request asynchronously
|
|
3743
3845
|
|
|
3744
3846
|
Returns:
|
|
3745
|
-
|
|
3847
|
+
PlacementPreviewListResponse
|
|
3746
3848
|
If the method is called asynchronously, returns the request
|
|
3747
3849
|
thread.
|
|
3748
3850
|
"""
|
|
@@ -3773,26 +3875,24 @@ class CampaignApi(object):
|
|
|
3773
3875
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3774
3876
|
kwargs['retailer_id'] = \
|
|
3775
3877
|
retailer_id
|
|
3776
|
-
return self.
|
|
3878
|
+
return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3777
3879
|
|
|
3778
|
-
def
|
|
3880
|
+
def get_auction_line_item_v2(
|
|
3779
3881
|
self,
|
|
3780
|
-
|
|
3781
|
-
seller,
|
|
3882
|
+
line_item_id,
|
|
3782
3883
|
**kwargs
|
|
3783
3884
|
):
|
|
3784
|
-
"""
|
|
3885
|
+
"""get_auction_line_item_v2 # noqa: E501
|
|
3785
3886
|
|
|
3786
|
-
|
|
3887
|
+
Gets a sponsored product line item by its id. # noqa: E501
|
|
3787
3888
|
This method makes a synchronous HTTP request by default. To make an
|
|
3788
3889
|
asynchronous HTTP request, please pass async_req=True
|
|
3789
3890
|
|
|
3790
|
-
>>> thread = api.
|
|
3891
|
+
>>> thread = api.get_auction_line_item_v2(line_item_id, async_req=True)
|
|
3791
3892
|
>>> result = thread.get()
|
|
3792
3893
|
|
|
3793
3894
|
Args:
|
|
3794
|
-
|
|
3795
|
-
seller (str): The seller id or seller name which should be validated.
|
|
3895
|
+
line_item_id (int): The id of the line item
|
|
3796
3896
|
|
|
3797
3897
|
Keyword Args:
|
|
3798
3898
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3827,7 +3927,7 @@ class CampaignApi(object):
|
|
|
3827
3927
|
async_req (bool): execute request asynchronously
|
|
3828
3928
|
|
|
3829
3929
|
Returns:
|
|
3830
|
-
|
|
3930
|
+
EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
3831
3931
|
If the method is called asynchronously, returns the request
|
|
3832
3932
|
thread.
|
|
3833
3933
|
"""
|
|
@@ -3856,31 +3956,31 @@ class CampaignApi(object):
|
|
|
3856
3956
|
'_content_type')
|
|
3857
3957
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3858
3958
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3859
|
-
kwargs['
|
|
3860
|
-
|
|
3861
|
-
kwargs
|
|
3862
|
-
seller
|
|
3863
|
-
return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3959
|
+
kwargs['line_item_id'] = \
|
|
3960
|
+
line_item_id
|
|
3961
|
+
return self.get_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
3864
3962
|
|
|
3865
|
-
def
|
|
3963
|
+
def get_auction_line_items_by_campaign_id_v2(
|
|
3866
3964
|
self,
|
|
3867
|
-
|
|
3965
|
+
campaign_id,
|
|
3868
3966
|
**kwargs
|
|
3869
3967
|
):
|
|
3870
|
-
"""
|
|
3968
|
+
"""get_auction_line_items_by_campaign_id_v2 # noqa: E501
|
|
3871
3969
|
|
|
3872
|
-
Gets
|
|
3970
|
+
Gets a page of sponsored product line items by campaign id. # noqa: E501
|
|
3873
3971
|
This method makes a synchronous HTTP request by default. To make an
|
|
3874
3972
|
asynchronous HTTP request, please pass async_req=True
|
|
3875
3973
|
|
|
3876
|
-
>>> thread = api.
|
|
3974
|
+
>>> thread = api.get_auction_line_items_by_campaign_id_v2(campaign_id, async_req=True)
|
|
3877
3975
|
>>> result = thread.get()
|
|
3878
3976
|
|
|
3879
3977
|
Args:
|
|
3880
|
-
|
|
3978
|
+
campaign_id (str): The id of the campaign
|
|
3881
3979
|
|
|
3882
3980
|
Keyword Args:
|
|
3883
|
-
|
|
3981
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3982
|
+
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
|
|
3983
|
+
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
|
|
3884
3984
|
_return_http_data_only (bool): response data without head status
|
|
3885
3985
|
code and headers. Default is True.
|
|
3886
3986
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3913,7 +4013,7 @@ class CampaignApi(object):
|
|
|
3913
4013
|
async_req (bool): execute request asynchronously
|
|
3914
4014
|
|
|
3915
4015
|
Returns:
|
|
3916
|
-
|
|
4016
|
+
EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
|
|
3917
4017
|
If the method is called asynchronously, returns the request
|
|
3918
4018
|
thread.
|
|
3919
4019
|
"""
|
|
@@ -3942,26 +4042,28 @@ class CampaignApi(object):
|
|
|
3942
4042
|
'_content_type')
|
|
3943
4043
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3944
4044
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3945
|
-
kwargs['
|
|
3946
|
-
|
|
3947
|
-
return self.
|
|
4045
|
+
kwargs['campaign_id'] = \
|
|
4046
|
+
campaign_id
|
|
4047
|
+
return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
|
|
3948
4048
|
|
|
3949
|
-
def
|
|
4049
|
+
def get_creative(
|
|
3950
4050
|
self,
|
|
3951
|
-
|
|
4051
|
+
account_id,
|
|
4052
|
+
creative_id,
|
|
3952
4053
|
**kwargs
|
|
3953
4054
|
):
|
|
3954
|
-
"""
|
|
4055
|
+
"""get_creative # noqa: E501
|
|
3955
4056
|
|
|
3956
|
-
|
|
4057
|
+
Get the specified creative # noqa: E501
|
|
3957
4058
|
This method makes a synchronous HTTP request by default. To make an
|
|
3958
4059
|
asynchronous HTTP request, please pass async_req=True
|
|
3959
4060
|
|
|
3960
|
-
>>> thread = api.
|
|
4061
|
+
>>> thread = api.get_creative(account_id, creative_id, async_req=True)
|
|
3961
4062
|
>>> result = thread.get()
|
|
3962
4063
|
|
|
3963
4064
|
Args:
|
|
3964
|
-
|
|
4065
|
+
account_id (str): External account id to retrieve creatives for
|
|
4066
|
+
creative_id (str): Creative to get
|
|
3965
4067
|
|
|
3966
4068
|
Keyword Args:
|
|
3967
4069
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3996,7 +4098,7 @@ class CampaignApi(object):
|
|
|
3996
4098
|
async_req (bool): execute request asynchronously
|
|
3997
4099
|
|
|
3998
4100
|
Returns:
|
|
3999
|
-
|
|
4101
|
+
Creative2Response
|
|
4000
4102
|
If the method is called asynchronously, returns the request
|
|
4001
4103
|
thread.
|
|
4002
4104
|
"""
|
|
@@ -4025,30 +4127,33 @@ class CampaignApi(object):
|
|
|
4025
4127
|
'_content_type')
|
|
4026
4128
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4027
4129
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4028
|
-
kwargs['
|
|
4029
|
-
|
|
4030
|
-
|
|
4130
|
+
kwargs['account_id'] = \
|
|
4131
|
+
account_id
|
|
4132
|
+
kwargs['creative_id'] = \
|
|
4133
|
+
creative_id
|
|
4134
|
+
return self.get_creative_endpoint.call_with_http_info(**kwargs)
|
|
4031
4135
|
|
|
4032
|
-
def
|
|
4136
|
+
def get_preferred_line_items_by_campaign_id(
|
|
4033
4137
|
self,
|
|
4034
|
-
|
|
4035
|
-
creative_id,
|
|
4138
|
+
campaign_id,
|
|
4036
4139
|
**kwargs
|
|
4037
4140
|
):
|
|
4038
|
-
"""
|
|
4141
|
+
"""get_preferred_line_items_by_campaign_id # noqa: E501
|
|
4039
4142
|
|
|
4040
|
-
|
|
4143
|
+
Gets page of preferred line item objects for the given campaign id # noqa: E501
|
|
4041
4144
|
This method makes a synchronous HTTP request by default. To make an
|
|
4042
4145
|
asynchronous HTTP request, please pass async_req=True
|
|
4043
4146
|
|
|
4044
|
-
>>> thread = api.
|
|
4147
|
+
>>> thread = api.get_preferred_line_items_by_campaign_id(campaign_id, async_req=True)
|
|
4045
4148
|
>>> result = thread.get()
|
|
4046
4149
|
|
|
4047
4150
|
Args:
|
|
4048
|
-
|
|
4049
|
-
creative_id (str): Creative to get
|
|
4151
|
+
campaign_id (str): The given campaign id
|
|
4050
4152
|
|
|
4051
4153
|
Keyword Args:
|
|
4154
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
4155
|
+
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
|
|
4156
|
+
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
4157
|
_return_http_data_only (bool): response data without head status
|
|
4053
4158
|
code and headers. Default is True.
|
|
4054
4159
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4081,7 +4186,7 @@ class CampaignApi(object):
|
|
|
4081
4186
|
async_req (bool): execute request asynchronously
|
|
4082
4187
|
|
|
4083
4188
|
Returns:
|
|
4084
|
-
|
|
4189
|
+
PreferredLineItemV2PagedListResponse
|
|
4085
4190
|
If the method is called asynchronously, returns the request
|
|
4086
4191
|
thread.
|
|
4087
4192
|
"""
|
|
@@ -4110,28 +4215,26 @@ class CampaignApi(object):
|
|
|
4110
4215
|
'_content_type')
|
|
4111
4216
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4112
4217
|
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)
|
|
4218
|
+
kwargs['campaign_id'] = \
|
|
4219
|
+
campaign_id
|
|
4220
|
+
return self.get_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
4118
4221
|
|
|
4119
|
-
def
|
|
4222
|
+
def get_preferred_line_items_by_line_item_id(
|
|
4120
4223
|
self,
|
|
4121
4224
|
line_item_id,
|
|
4122
4225
|
**kwargs
|
|
4123
4226
|
):
|
|
4124
|
-
"""
|
|
4227
|
+
"""get_preferred_line_items_by_line_item_id # noqa: E501
|
|
4125
4228
|
|
|
4126
|
-
Gets
|
|
4229
|
+
Gets the preferred line item for the given line item id # noqa: E501
|
|
4127
4230
|
This method makes a synchronous HTTP request by default. To make an
|
|
4128
4231
|
asynchronous HTTP request, please pass async_req=True
|
|
4129
4232
|
|
|
4130
|
-
>>> thread = api.
|
|
4233
|
+
>>> thread = api.get_preferred_line_items_by_line_item_id(line_item_id, async_req=True)
|
|
4131
4234
|
>>> result = thread.get()
|
|
4132
4235
|
|
|
4133
4236
|
Args:
|
|
4134
|
-
line_item_id (
|
|
4237
|
+
line_item_id (str): The given line item id
|
|
4135
4238
|
|
|
4136
4239
|
Keyword Args:
|
|
4137
4240
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4166,7 +4269,7 @@ class CampaignApi(object):
|
|
|
4166
4269
|
async_req (bool): execute request asynchronously
|
|
4167
4270
|
|
|
4168
4271
|
Returns:
|
|
4169
|
-
|
|
4272
|
+
PreferredLineItemV2Response
|
|
4170
4273
|
If the method is called asynchronously, returns the request
|
|
4171
4274
|
thread.
|
|
4172
4275
|
"""
|
|
@@ -4197,29 +4300,28 @@ class CampaignApi(object):
|
|
|
4197
4300
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4198
4301
|
kwargs['line_item_id'] = \
|
|
4199
4302
|
line_item_id
|
|
4200
|
-
return self.
|
|
4303
|
+
return self.get_preferred_line_items_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4201
4304
|
|
|
4202
|
-
def
|
|
4305
|
+
def get_product_button_by_line_item_and_product_button_id(
|
|
4203
4306
|
self,
|
|
4204
|
-
|
|
4307
|
+
line_item_id,
|
|
4308
|
+
product_button_id,
|
|
4205
4309
|
**kwargs
|
|
4206
4310
|
):
|
|
4207
|
-
"""
|
|
4311
|
+
"""get_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
4208
4312
|
|
|
4209
|
-
|
|
4313
|
+
Get Specific Product Button # noqa: E501
|
|
4210
4314
|
This method makes a synchronous HTTP request by default. To make an
|
|
4211
4315
|
asynchronous HTTP request, please pass async_req=True
|
|
4212
4316
|
|
|
4213
|
-
>>> thread = api.
|
|
4317
|
+
>>> thread = api.get_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
4214
4318
|
>>> result = thread.get()
|
|
4215
4319
|
|
|
4216
4320
|
Args:
|
|
4217
|
-
|
|
4321
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
4322
|
+
product_button_id (str): productButtonId used for retrieval
|
|
4218
4323
|
|
|
4219
4324
|
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
4325
|
_return_http_data_only (bool): response data without head status
|
|
4224
4326
|
code and headers. Default is True.
|
|
4225
4327
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4252,7 +4354,7 @@ class CampaignApi(object):
|
|
|
4252
4354
|
async_req (bool): execute request asynchronously
|
|
4253
4355
|
|
|
4254
4356
|
Returns:
|
|
4255
|
-
|
|
4357
|
+
ProductButtonResponseListResponse
|
|
4256
4358
|
If the method is called asynchronously, returns the request
|
|
4257
4359
|
thread.
|
|
4258
4360
|
"""
|
|
@@ -4281,29 +4383,30 @@ class CampaignApi(object):
|
|
|
4281
4383
|
'_content_type')
|
|
4282
4384
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4283
4385
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4284
|
-
kwargs['
|
|
4285
|
-
|
|
4286
|
-
|
|
4386
|
+
kwargs['line_item_id'] = \
|
|
4387
|
+
line_item_id
|
|
4388
|
+
kwargs['product_button_id'] = \
|
|
4389
|
+
product_button_id
|
|
4390
|
+
return self.get_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
4287
4391
|
|
|
4288
|
-
def
|
|
4392
|
+
def get_product_buttons_by_line_item_id(
|
|
4289
4393
|
self,
|
|
4290
|
-
|
|
4394
|
+
line_item_id,
|
|
4291
4395
|
**kwargs
|
|
4292
4396
|
):
|
|
4293
|
-
"""
|
|
4397
|
+
"""get_product_buttons_by_line_item_id # noqa: E501
|
|
4294
4398
|
|
|
4295
|
-
|
|
4399
|
+
Get LineItem Product Buttons # noqa: E501
|
|
4296
4400
|
This method makes a synchronous HTTP request by default. To make an
|
|
4297
4401
|
asynchronous HTTP request, please pass async_req=True
|
|
4298
4402
|
|
|
4299
|
-
>>> thread = api.
|
|
4403
|
+
>>> thread = api.get_product_buttons_by_line_item_id(line_item_id, async_req=True)
|
|
4300
4404
|
>>> result = thread.get()
|
|
4301
4405
|
|
|
4302
4406
|
Args:
|
|
4303
|
-
|
|
4407
|
+
line_item_id (str): LineItemId for productButton retrieval
|
|
4304
4408
|
|
|
4305
4409
|
Keyword Args:
|
|
4306
|
-
value_resource_input_recommended_categories_request_v1 (ValueResourceInputRecommendedCategoriesRequestV1): Request of recommended categories.. [optional]
|
|
4307
4410
|
_return_http_data_only (bool): response data without head status
|
|
4308
4411
|
code and headers. Default is True.
|
|
4309
4412
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4336,7 +4439,7 @@ class CampaignApi(object):
|
|
|
4336
4439
|
async_req (bool): execute request asynchronously
|
|
4337
4440
|
|
|
4338
4441
|
Returns:
|
|
4339
|
-
|
|
4442
|
+
ProductButtonResponseListResponse
|
|
4340
4443
|
If the method is called asynchronously, returns the request
|
|
4341
4444
|
thread.
|
|
4342
4445
|
"""
|
|
@@ -4365,30 +4468,29 @@ class CampaignApi(object):
|
|
|
4365
4468
|
'_content_type')
|
|
4366
4469
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4367
4470
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4368
|
-
kwargs['
|
|
4369
|
-
|
|
4370
|
-
return self.
|
|
4471
|
+
kwargs['line_item_id'] = \
|
|
4472
|
+
line_item_id
|
|
4473
|
+
return self.get_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4371
4474
|
|
|
4372
|
-
def
|
|
4475
|
+
def get_recommended_categories(
|
|
4373
4476
|
self,
|
|
4374
|
-
|
|
4477
|
+
retailer_id,
|
|
4375
4478
|
**kwargs
|
|
4376
4479
|
):
|
|
4377
|
-
"""
|
|
4480
|
+
"""get_recommended_categories # noqa: E501
|
|
4378
4481
|
|
|
4379
|
-
|
|
4482
|
+
Endpoint to get recommended categories by given retailer id and sku id list. # noqa: E501
|
|
4380
4483
|
This method makes a synchronous HTTP request by default. To make an
|
|
4381
4484
|
asynchronous HTTP request, please pass async_req=True
|
|
4382
4485
|
|
|
4383
|
-
>>> thread = api.
|
|
4486
|
+
>>> thread = api.get_recommended_categories(retailer_id, async_req=True)
|
|
4384
4487
|
>>> result = thread.get()
|
|
4385
4488
|
|
|
4386
4489
|
Args:
|
|
4387
|
-
|
|
4490
|
+
retailer_id (int): Retailer id.
|
|
4388
4491
|
|
|
4389
4492
|
Keyword Args:
|
|
4390
|
-
|
|
4391
|
-
offset (int): Offset for pagination. [optional] if omitted the server will use the default value of 0
|
|
4493
|
+
value_resource_input_recommended_categories_request_v1 (ValueResourceInputRecommendedCategoriesRequestV1): Request of recommended categories.. [optional]
|
|
4392
4494
|
_return_http_data_only (bool): response data without head status
|
|
4393
4495
|
code and headers. Default is True.
|
|
4394
4496
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4421,7 +4523,7 @@ class CampaignApi(object):
|
|
|
4421
4523
|
async_req (bool): execute request asynchronously
|
|
4422
4524
|
|
|
4423
4525
|
Returns:
|
|
4424
|
-
|
|
4526
|
+
EntityResourceCollectionOutcomeCategory202204
|
|
4425
4527
|
If the method is called asynchronously, returns the request
|
|
4426
4528
|
thread.
|
|
4427
4529
|
"""
|
|
@@ -4450,29 +4552,30 @@ class CampaignApi(object):
|
|
|
4450
4552
|
'_content_type')
|
|
4451
4553
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4452
4554
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4453
|
-
kwargs['
|
|
4454
|
-
|
|
4455
|
-
return self.
|
|
4555
|
+
kwargs['retailer_id'] = \
|
|
4556
|
+
retailer_id
|
|
4557
|
+
return self.get_recommended_categories_endpoint.call_with_http_info(**kwargs)
|
|
4456
4558
|
|
|
4457
|
-
def
|
|
4559
|
+
def in_review_report_v1(
|
|
4458
4560
|
self,
|
|
4459
|
-
|
|
4561
|
+
account_id,
|
|
4460
4562
|
**kwargs
|
|
4461
4563
|
):
|
|
4462
|
-
"""
|
|
4564
|
+
"""in_review_report_v1 # noqa: E501
|
|
4463
4565
|
|
|
4464
|
-
|
|
4566
|
+
Generate a list of reports for line items which contain one or more actionable keyword reviews # noqa: E501
|
|
4465
4567
|
This method makes a synchronous HTTP request by default. To make an
|
|
4466
4568
|
asynchronous HTTP request, please pass async_req=True
|
|
4467
4569
|
|
|
4468
|
-
>>> thread = api.
|
|
4570
|
+
>>> thread = api.in_review_report_v1(account_id, async_req=True)
|
|
4469
4571
|
>>> result = thread.get()
|
|
4470
4572
|
|
|
4471
4573
|
Args:
|
|
4472
|
-
|
|
4574
|
+
account_id (int): The account to generate a report for
|
|
4473
4575
|
|
|
4474
4576
|
Keyword Args:
|
|
4475
|
-
|
|
4577
|
+
limit (int): Number of items per page. [optional] if omitted the server will use the default value of 25
|
|
4578
|
+
offset (int): Offset for pagination. [optional] if omitted the server will use the default value of 0
|
|
4476
4579
|
_return_http_data_only (bool): response data without head status
|
|
4477
4580
|
code and headers. Default is True.
|
|
4478
4581
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4505,7 +4608,7 @@ class CampaignApi(object):
|
|
|
4505
4608
|
async_req (bool): execute request asynchronously
|
|
4506
4609
|
|
|
4507
4610
|
Returns:
|
|
4508
|
-
|
|
4611
|
+
EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
|
|
4509
4612
|
If the method is called asynchronously, returns the request
|
|
4510
4613
|
thread.
|
|
4511
4614
|
"""
|
|
@@ -4534,29 +4637,29 @@ class CampaignApi(object):
|
|
|
4534
4637
|
'_content_type')
|
|
4535
4638
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4536
4639
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4537
|
-
kwargs['
|
|
4538
|
-
|
|
4539
|
-
return self.
|
|
4640
|
+
kwargs['account_id'] = \
|
|
4641
|
+
account_id
|
|
4642
|
+
return self.in_review_report_v1_endpoint.call_with_http_info(**kwargs)
|
|
4540
4643
|
|
|
4541
|
-
def
|
|
4644
|
+
def pause_promoted_products(
|
|
4542
4645
|
self,
|
|
4543
4646
|
line_item_id,
|
|
4544
4647
|
**kwargs
|
|
4545
4648
|
):
|
|
4546
|
-
"""
|
|
4649
|
+
"""pause_promoted_products # noqa: E501
|
|
4547
4650
|
|
|
4548
|
-
|
|
4651
|
+
Pause a collection of promoted products associated with a line item # noqa: E501
|
|
4549
4652
|
This method makes a synchronous HTTP request by default. To make an
|
|
4550
4653
|
asynchronous HTTP request, please pass async_req=True
|
|
4551
4654
|
|
|
4552
|
-
>>> thread = api.
|
|
4655
|
+
>>> thread = api.pause_promoted_products(line_item_id, async_req=True)
|
|
4553
4656
|
>>> result = thread.get()
|
|
4554
4657
|
|
|
4555
4658
|
Args:
|
|
4556
|
-
line_item_id (str):
|
|
4659
|
+
line_item_id (str): ID of the line item
|
|
4557
4660
|
|
|
4558
4661
|
Keyword Args:
|
|
4559
|
-
|
|
4662
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
4560
4663
|
_return_http_data_only (bool): response data without head status
|
|
4561
4664
|
code and headers. Default is True.
|
|
4562
4665
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4589,7 +4692,7 @@ class CampaignApi(object):
|
|
|
4589
4692
|
async_req (bool): execute request asynchronously
|
|
4590
4693
|
|
|
4591
4694
|
Returns:
|
|
4592
|
-
|
|
4695
|
+
None
|
|
4593
4696
|
If the method is called asynchronously, returns the request
|
|
4594
4697
|
thread.
|
|
4595
4698
|
"""
|
|
@@ -4620,7 +4723,7 @@ class CampaignApi(object):
|
|
|
4620
4723
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4621
4724
|
kwargs['line_item_id'] = \
|
|
4622
4725
|
line_item_id
|
|
4623
|
-
return self.
|
|
4726
|
+
return self.pause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
4624
4727
|
|
|
4625
4728
|
def post_api_external_v2_account_brand_catalog_export_by_account_id(
|
|
4626
4729
|
self,
|
|
@@ -4790,25 +4893,24 @@ class CampaignApi(object):
|
|
|
4790
4893
|
account_id
|
|
4791
4894
|
return self.post_api_external_v2_account_seller_catalog_export_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
4792
4895
|
|
|
4793
|
-
def
|
|
4896
|
+
def post_api_v1_external_catalogs_sku_retrieval(
|
|
4794
4897
|
self,
|
|
4795
|
-
campaign_id,
|
|
4796
4898
|
**kwargs
|
|
4797
4899
|
):
|
|
4798
|
-
"""
|
|
4900
|
+
"""post_api_v1_external_catalogs_sku_retrieval # noqa: E501
|
|
4799
4901
|
|
|
4800
|
-
|
|
4902
|
+
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
4801
4903
|
This method makes a synchronous HTTP request by default. To make an
|
|
4802
4904
|
asynchronous HTTP request, please pass async_req=True
|
|
4803
4905
|
|
|
4804
|
-
>>> thread = api.
|
|
4906
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_retrieval(async_req=True)
|
|
4805
4907
|
>>> result = thread.get()
|
|
4806
4908
|
|
|
4807
|
-
Args:
|
|
4808
|
-
campaign_id (str): The given campaign id
|
|
4809
4909
|
|
|
4810
4910
|
Keyword Args:
|
|
4811
|
-
|
|
4911
|
+
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
|
|
4912
|
+
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
|
|
4913
|
+
request_body ([str]): The list of SKU keys to retrieve sku information. [optional]
|
|
4812
4914
|
_return_http_data_only (bool): response data without head status
|
|
4813
4915
|
code and headers. Default is True.
|
|
4814
4916
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4841,7 +4943,7 @@ class CampaignApi(object):
|
|
|
4841
4943
|
async_req (bool): execute request asynchronously
|
|
4842
4944
|
|
|
4843
4945
|
Returns:
|
|
4844
|
-
|
|
4946
|
+
SkuDataPreviewListResponse
|
|
4845
4947
|
If the method is called asynchronously, returns the request
|
|
4846
4948
|
thread.
|
|
4847
4949
|
"""
|
|
@@ -4870,28 +4972,26 @@ class CampaignApi(object):
|
|
|
4870
4972
|
'_content_type')
|
|
4871
4973
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4872
4974
|
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)
|
|
4975
|
+
return self.post_api_v1_external_catalogs_sku_retrieval_endpoint.call_with_http_info(**kwargs)
|
|
4876
4976
|
|
|
4877
|
-
def
|
|
4977
|
+
def post_api_v1_external_catalogs_sku_search(
|
|
4878
4978
|
self,
|
|
4879
4979
|
**kwargs
|
|
4880
4980
|
):
|
|
4881
|
-
"""
|
|
4981
|
+
"""post_api_v1_external_catalogs_sku_search # noqa: E501
|
|
4882
4982
|
|
|
4883
4983
|
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
4884
4984
|
This method makes a synchronous HTTP request by default. To make an
|
|
4885
4985
|
asynchronous HTTP request, please pass async_req=True
|
|
4886
4986
|
|
|
4887
|
-
>>> thread = api.
|
|
4987
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_search(async_req=True)
|
|
4888
4988
|
>>> result = thread.get()
|
|
4889
4989
|
|
|
4890
4990
|
|
|
4891
4991
|
Keyword Args:
|
|
4892
4992
|
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
4993
|
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
|
-
|
|
4994
|
+
sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional]
|
|
4895
4995
|
_return_http_data_only (bool): response data without head status
|
|
4896
4996
|
code and headers. Default is True.
|
|
4897
4997
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4953,26 +5053,27 @@ class CampaignApi(object):
|
|
|
4953
5053
|
'_content_type')
|
|
4954
5054
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4955
5055
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4956
|
-
return self.
|
|
5056
|
+
return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs)
|
|
4957
5057
|
|
|
4958
|
-
def
|
|
5058
|
+
def recommended_keywords(
|
|
4959
5059
|
self,
|
|
5060
|
+
retailer_id,
|
|
4960
5061
|
**kwargs
|
|
4961
5062
|
):
|
|
4962
|
-
"""
|
|
5063
|
+
"""recommended_keywords # noqa: E501
|
|
4963
5064
|
|
|
4964
|
-
|
|
5065
|
+
Recommend keywords by given retailer id and sku ids. # noqa: E501
|
|
4965
5066
|
This method makes a synchronous HTTP request by default. To make an
|
|
4966
5067
|
asynchronous HTTP request, please pass async_req=True
|
|
4967
5068
|
|
|
4968
|
-
>>> thread = api.
|
|
5069
|
+
>>> thread = api.recommended_keywords(retailer_id, async_req=True)
|
|
4969
5070
|
>>> result = thread.get()
|
|
4970
5071
|
|
|
5072
|
+
Args:
|
|
5073
|
+
retailer_id (str): Retailer id.
|
|
4971
5074
|
|
|
4972
5075
|
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]
|
|
5076
|
+
value_resource_input_recommended_keywords_request_v1 (ValueResourceInputRecommendedKeywordsRequestV1): Request of recommended keywords.. [optional]
|
|
4976
5077
|
_return_http_data_only (bool): response data without head status
|
|
4977
5078
|
code and headers. Default is True.
|
|
4978
5079
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5005,7 +5106,7 @@ class CampaignApi(object):
|
|
|
5005
5106
|
async_req (bool): execute request asynchronously
|
|
5006
5107
|
|
|
5007
5108
|
Returns:
|
|
5008
|
-
|
|
5109
|
+
ValueResourceOutcomeRecommendedKeywordsResponseV1
|
|
5009
5110
|
If the method is called asynchronously, returns the request
|
|
5010
5111
|
thread.
|
|
5011
5112
|
"""
|
|
@@ -5034,27 +5135,29 @@ class CampaignApi(object):
|
|
|
5034
5135
|
'_content_type')
|
|
5035
5136
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5036
5137
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5037
|
-
|
|
5138
|
+
kwargs['retailer_id'] = \
|
|
5139
|
+
retailer_id
|
|
5140
|
+
return self.recommended_keywords_endpoint.call_with_http_info(**kwargs)
|
|
5038
5141
|
|
|
5039
|
-
def
|
|
5142
|
+
def search_account_creatives(
|
|
5040
5143
|
self,
|
|
5041
5144
|
account_id,
|
|
5042
5145
|
**kwargs
|
|
5043
5146
|
):
|
|
5044
|
-
"""
|
|
5147
|
+
"""search_account_creatives # noqa: E501
|
|
5045
5148
|
|
|
5046
|
-
|
|
5149
|
+
Get account creatives # noqa: E501
|
|
5047
5150
|
This method makes a synchronous HTTP request by default. To make an
|
|
5048
5151
|
asynchronous HTTP request, please pass async_req=True
|
|
5049
5152
|
|
|
5050
|
-
>>> thread = api.
|
|
5153
|
+
>>> thread = api.search_account_creatives(account_id, async_req=True)
|
|
5051
5154
|
>>> result = thread.get()
|
|
5052
5155
|
|
|
5053
5156
|
Args:
|
|
5054
|
-
account_id (str): External account id to
|
|
5157
|
+
account_id (str): External account id to retrieve creatives for
|
|
5055
5158
|
|
|
5056
5159
|
Keyword Args:
|
|
5057
|
-
|
|
5160
|
+
creative_ids ([str]): Creatives to filter by. [optional]
|
|
5058
5161
|
_return_http_data_only (bool): response data without head status
|
|
5059
5162
|
code and headers. Default is True.
|
|
5060
5163
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5087,7 +5190,7 @@ class CampaignApi(object):
|
|
|
5087
5190
|
async_req (bool): execute request asynchronously
|
|
5088
5191
|
|
|
5089
5192
|
Returns:
|
|
5090
|
-
|
|
5193
|
+
Creative2ListResponse
|
|
5091
5194
|
If the method is called asynchronously, returns the request
|
|
5092
5195
|
thread.
|
|
5093
5196
|
"""
|
|
@@ -5118,27 +5221,26 @@ class CampaignApi(object):
|
|
|
5118
5221
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5119
5222
|
kwargs['account_id'] = \
|
|
5120
5223
|
account_id
|
|
5121
|
-
return self.
|
|
5224
|
+
return self.search_account_creatives_endpoint.call_with_http_info(**kwargs)
|
|
5122
5225
|
|
|
5123
|
-
def
|
|
5226
|
+
def search_brands(
|
|
5124
5227
|
self,
|
|
5125
|
-
account_id,
|
|
5126
5228
|
**kwargs
|
|
5127
5229
|
):
|
|
5128
|
-
"""
|
|
5230
|
+
"""search_brands # noqa: E501
|
|
5129
5231
|
|
|
5130
|
-
|
|
5232
|
+
Search for brands given a retailer ID and search term. # noqa: E501
|
|
5131
5233
|
This method makes a synchronous HTTP request by default. To make an
|
|
5132
5234
|
asynchronous HTTP request, please pass async_req=True
|
|
5133
5235
|
|
|
5134
|
-
>>> thread = api.
|
|
5236
|
+
>>> thread = api.search_brands(async_req=True)
|
|
5135
5237
|
>>> result = thread.get()
|
|
5136
5238
|
|
|
5137
|
-
Args:
|
|
5138
|
-
account_id (str): External account id to retrieve creatives for
|
|
5139
5239
|
|
|
5140
5240
|
Keyword Args:
|
|
5141
|
-
|
|
5241
|
+
limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
|
|
5242
|
+
offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
|
|
5243
|
+
value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
|
|
5142
5244
|
_return_http_data_only (bool): response data without head status
|
|
5143
5245
|
code and headers. Default is True.
|
|
5144
5246
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5171,7 +5273,7 @@ class CampaignApi(object):
|
|
|
5171
5273
|
async_req (bool): execute request asynchronously
|
|
5172
5274
|
|
|
5173
5275
|
Returns:
|
|
5174
|
-
|
|
5276
|
+
EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
|
|
5175
5277
|
If the method is called asynchronously, returns the request
|
|
5176
5278
|
thread.
|
|
5177
5279
|
"""
|
|
@@ -5200,31 +5302,29 @@ class CampaignApi(object):
|
|
|
5200
5302
|
'_content_type')
|
|
5201
5303
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5202
5304
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5203
|
-
kwargs
|
|
5204
|
-
account_id
|
|
5205
|
-
return self.post_api_v2_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
5305
|
+
return self.search_brands_endpoint.call_with_http_info(**kwargs)
|
|
5206
5306
|
|
|
5207
|
-
def
|
|
5307
|
+
def search_category(
|
|
5208
5308
|
self,
|
|
5209
|
-
|
|
5210
|
-
product_button_id,
|
|
5309
|
+
retailer_id,
|
|
5211
5310
|
**kwargs
|
|
5212
5311
|
):
|
|
5213
|
-
"""
|
|
5312
|
+
"""search_category # noqa: E501
|
|
5214
5313
|
|
|
5215
|
-
|
|
5314
|
+
Search a retailer categories by given text substring and category ids. # noqa: E501
|
|
5216
5315
|
This method makes a synchronous HTTP request by default. To make an
|
|
5217
5316
|
asynchronous HTTP request, please pass async_req=True
|
|
5218
5317
|
|
|
5219
|
-
>>> thread = api.
|
|
5318
|
+
>>> thread = api.search_category(retailer_id, async_req=True)
|
|
5220
5319
|
>>> result = thread.get()
|
|
5221
5320
|
|
|
5222
5321
|
Args:
|
|
5223
|
-
|
|
5224
|
-
product_button_id (str): productButtonId used for update
|
|
5322
|
+
retailer_id (int): Retailer id.
|
|
5225
5323
|
|
|
5226
5324
|
Keyword Args:
|
|
5227
|
-
|
|
5325
|
+
limit (int): Limit of the search result.. [optional] if omitted the server will use the default value of 50
|
|
5326
|
+
offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
|
|
5327
|
+
value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
|
|
5228
5328
|
_return_http_data_only (bool): response data without head status
|
|
5229
5329
|
code and headers. Default is True.
|
|
5230
5330
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5257,7 +5357,7 @@ class CampaignApi(object):
|
|
|
5257
5357
|
async_req (bool): execute request asynchronously
|
|
5258
5358
|
|
|
5259
5359
|
Returns:
|
|
5260
|
-
|
|
5360
|
+
EntityResourceCollectionOutcomeCategory202204Metadata
|
|
5261
5361
|
If the method is called asynchronously, returns the request
|
|
5262
5362
|
thread.
|
|
5263
5363
|
"""
|
|
@@ -5286,31 +5386,31 @@ class CampaignApi(object):
|
|
|
5286
5386
|
'_content_type')
|
|
5287
5387
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5288
5388
|
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)
|
|
5389
|
+
kwargs['retailer_id'] = \
|
|
5390
|
+
retailer_id
|
|
5391
|
+
return self.search_category_endpoint.call_with_http_info(**kwargs)
|
|
5294
5392
|
|
|
5295
|
-
def
|
|
5393
|
+
def search_retailers_v1(
|
|
5296
5394
|
self,
|
|
5297
|
-
|
|
5395
|
+
account_id,
|
|
5298
5396
|
**kwargs
|
|
5299
5397
|
):
|
|
5300
|
-
"""
|
|
5398
|
+
"""search_retailers_v1 # noqa: E501
|
|
5301
5399
|
|
|
5302
|
-
|
|
5400
|
+
Searches for retailers associated with the specified account based on provided search criteria # noqa: E501
|
|
5303
5401
|
This method makes a synchronous HTTP request by default. To make an
|
|
5304
5402
|
asynchronous HTTP request, please pass async_req=True
|
|
5305
5403
|
|
|
5306
|
-
>>> thread = api.
|
|
5404
|
+
>>> thread = api.search_retailers_v1(account_id, async_req=True)
|
|
5307
5405
|
>>> result = thread.get()
|
|
5308
5406
|
|
|
5309
5407
|
Args:
|
|
5310
|
-
|
|
5408
|
+
account_id (str): The external account identifier
|
|
5311
5409
|
|
|
5312
5410
|
Keyword Args:
|
|
5313
|
-
|
|
5411
|
+
limit (int): The maximum number of items to return. Must be between 1 and 10. Default is 5.. [optional] if omitted the server will use the default value of 5
|
|
5412
|
+
offset (int): The number of items to skip before starting to collect the result set. Default is 0.. [optional] if omitted the server will use the default value of 0
|
|
5413
|
+
value_resource_input_of_retailer_search_request (ValueResourceInputOfRetailerSearchRequest): The search request containing filtering parameters. [optional]
|
|
5314
5414
|
_return_http_data_only (bool): response data without head status
|
|
5315
5415
|
code and headers. Default is True.
|
|
5316
5416
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5343,7 +5443,7 @@ class CampaignApi(object):
|
|
|
5343
5443
|
async_req (bool): execute request asynchronously
|
|
5344
5444
|
|
|
5345
5445
|
Returns:
|
|
5346
|
-
|
|
5446
|
+
EntityResourceCollectionOutcomeOfRetailerResultAndMetadata
|
|
5347
5447
|
If the method is called asynchronously, returns the request
|
|
5348
5448
|
thread.
|
|
5349
5449
|
"""
|
|
@@ -5372,31 +5472,29 @@ class CampaignApi(object):
|
|
|
5372
5472
|
'_content_type')
|
|
5373
5473
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5374
5474
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5375
|
-
kwargs['
|
|
5376
|
-
|
|
5377
|
-
return self.
|
|
5475
|
+
kwargs['account_id'] = \
|
|
5476
|
+
account_id
|
|
5477
|
+
return self.search_retailers_v1_endpoint.call_with_http_info(**kwargs)
|
|
5378
5478
|
|
|
5379
|
-
def
|
|
5479
|
+
def set_keyword_bids(
|
|
5380
5480
|
self,
|
|
5381
|
-
|
|
5382
|
-
creative_id,
|
|
5481
|
+
id,
|
|
5383
5482
|
**kwargs
|
|
5384
5483
|
):
|
|
5385
|
-
"""
|
|
5484
|
+
"""set_keyword_bids # noqa: E501
|
|
5386
5485
|
|
|
5387
|
-
|
|
5486
|
+
Set bid overrides for associated keywords to the given line item in bulk # noqa: E501
|
|
5388
5487
|
This method makes a synchronous HTTP request by default. To make an
|
|
5389
5488
|
asynchronous HTTP request, please pass async_req=True
|
|
5390
5489
|
|
|
5391
|
-
>>> thread = api.
|
|
5490
|
+
>>> thread = api.set_keyword_bids(id, async_req=True)
|
|
5392
5491
|
>>> result = thread.get()
|
|
5393
5492
|
|
|
5394
5493
|
Args:
|
|
5395
|
-
|
|
5396
|
-
creative_id (str): Creative to update
|
|
5494
|
+
id (str): ID of the line item
|
|
5397
5495
|
|
|
5398
5496
|
Keyword Args:
|
|
5399
|
-
|
|
5497
|
+
set_bids_model_request (SetBidsModelRequest): [optional]
|
|
5400
5498
|
_return_http_data_only (bool): response data without head status
|
|
5401
5499
|
code and headers. Default is True.
|
|
5402
5500
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5429,7 +5527,7 @@ class CampaignApi(object):
|
|
|
5429
5527
|
async_req (bool): execute request asynchronously
|
|
5430
5528
|
|
|
5431
5529
|
Returns:
|
|
5432
|
-
|
|
5530
|
+
ResourceOutcome
|
|
5433
5531
|
If the method is called asynchronously, returns the request
|
|
5434
5532
|
thread.
|
|
5435
5533
|
"""
|
|
@@ -5458,31 +5556,29 @@ class CampaignApi(object):
|
|
|
5458
5556
|
'_content_type')
|
|
5459
5557
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5460
5558
|
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)
|
|
5559
|
+
kwargs['id'] = \
|
|
5560
|
+
id
|
|
5561
|
+
return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
|
|
5466
5562
|
|
|
5467
|
-
def
|
|
5563
|
+
def unpause_promoted_products(
|
|
5468
5564
|
self,
|
|
5469
|
-
|
|
5565
|
+
line_item_id,
|
|
5470
5566
|
**kwargs
|
|
5471
5567
|
):
|
|
5472
|
-
"""
|
|
5568
|
+
"""unpause_promoted_products # noqa: E501
|
|
5473
5569
|
|
|
5474
|
-
|
|
5570
|
+
Un-pause a collection of promoted products associated with a line item # noqa: E501
|
|
5475
5571
|
This method makes a synchronous HTTP request by default. To make an
|
|
5476
5572
|
asynchronous HTTP request, please pass async_req=True
|
|
5477
5573
|
|
|
5478
|
-
>>> thread = api.
|
|
5574
|
+
>>> thread = api.unpause_promoted_products(line_item_id, async_req=True)
|
|
5479
5575
|
>>> result = thread.get()
|
|
5480
5576
|
|
|
5481
5577
|
Args:
|
|
5482
|
-
|
|
5578
|
+
line_item_id (str): ID of the line item
|
|
5483
5579
|
|
|
5484
5580
|
Keyword Args:
|
|
5485
|
-
|
|
5581
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
5486
5582
|
_return_http_data_only (bool): response data without head status
|
|
5487
5583
|
code and headers. Default is True.
|
|
5488
5584
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5515,7 +5611,7 @@ class CampaignApi(object):
|
|
|
5515
5611
|
async_req (bool): execute request asynchronously
|
|
5516
5612
|
|
|
5517
5613
|
Returns:
|
|
5518
|
-
|
|
5614
|
+
None
|
|
5519
5615
|
If the method is called asynchronously, returns the request
|
|
5520
5616
|
thread.
|
|
5521
5617
|
"""
|
|
@@ -5544,28 +5640,29 @@ class CampaignApi(object):
|
|
|
5544
5640
|
'_content_type')
|
|
5545
5641
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5546
5642
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5547
|
-
kwargs['
|
|
5548
|
-
|
|
5549
|
-
return self.
|
|
5643
|
+
kwargs['line_item_id'] = \
|
|
5644
|
+
line_item_id
|
|
5645
|
+
return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
5550
5646
|
|
|
5551
|
-
def
|
|
5647
|
+
def update_auction_line_item_v2(
|
|
5552
5648
|
self,
|
|
5649
|
+
line_item_id,
|
|
5553
5650
|
**kwargs
|
|
5554
5651
|
):
|
|
5555
|
-
"""
|
|
5652
|
+
"""update_auction_line_item_v2 # noqa: E501
|
|
5556
5653
|
|
|
5557
|
-
|
|
5654
|
+
Updates a Sponsored Products Line Item given a line item id and a request. # noqa: E501
|
|
5558
5655
|
This method makes a synchronous HTTP request by default. To make an
|
|
5559
5656
|
asynchronous HTTP request, please pass async_req=True
|
|
5560
5657
|
|
|
5561
|
-
>>> thread = api.
|
|
5658
|
+
>>> thread = api.update_auction_line_item_v2(line_item_id, async_req=True)
|
|
5562
5659
|
>>> result = thread.get()
|
|
5563
5660
|
|
|
5661
|
+
Args:
|
|
5662
|
+
line_item_id (int): The external line item ID of the sponsored products line item.
|
|
5564
5663
|
|
|
5565
5664
|
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]
|
|
5665
|
+
value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
|
|
5569
5666
|
_return_http_data_only (bool): response data without head status
|
|
5570
5667
|
code and headers. Default is True.
|
|
5571
5668
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5598,7 +5695,7 @@ class CampaignApi(object):
|
|
|
5598
5695
|
async_req (bool): execute request asynchronously
|
|
5599
5696
|
|
|
5600
5697
|
Returns:
|
|
5601
|
-
|
|
5698
|
+
EntityResourceOutcomeOfSponsoredProductsLineItem
|
|
5602
5699
|
If the method is called asynchronously, returns the request
|
|
5603
5700
|
thread.
|
|
5604
5701
|
"""
|
|
@@ -5627,27 +5724,31 @@ class CampaignApi(object):
|
|
|
5627
5724
|
'_content_type')
|
|
5628
5725
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5629
5726
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5630
|
-
|
|
5727
|
+
kwargs['line_item_id'] = \
|
|
5728
|
+
line_item_id
|
|
5729
|
+
return self.update_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
|
|
5631
5730
|
|
|
5632
|
-
def
|
|
5731
|
+
def update_creative(
|
|
5633
5732
|
self,
|
|
5634
|
-
|
|
5733
|
+
account_id,
|
|
5734
|
+
creative_id,
|
|
5635
5735
|
**kwargs
|
|
5636
5736
|
):
|
|
5637
|
-
"""
|
|
5737
|
+
"""update_creative # noqa: E501
|
|
5638
5738
|
|
|
5639
|
-
|
|
5739
|
+
Update a creative # noqa: E501
|
|
5640
5740
|
This method makes a synchronous HTTP request by default. To make an
|
|
5641
5741
|
asynchronous HTTP request, please pass async_req=True
|
|
5642
5742
|
|
|
5643
|
-
>>> thread = api.
|
|
5743
|
+
>>> thread = api.update_creative(account_id, creative_id, async_req=True)
|
|
5644
5744
|
>>> result = thread.get()
|
|
5645
5745
|
|
|
5646
5746
|
Args:
|
|
5647
|
-
|
|
5747
|
+
account_id (str): External account id containing the creative
|
|
5748
|
+
creative_id (str): Creative to update
|
|
5648
5749
|
|
|
5649
5750
|
Keyword Args:
|
|
5650
|
-
|
|
5751
|
+
creative_update_model2 (CreativeUpdateModel2): The creative to create. [optional]
|
|
5651
5752
|
_return_http_data_only (bool): response data without head status
|
|
5652
5753
|
code and headers. Default is True.
|
|
5653
5754
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5680,7 +5781,7 @@ class CampaignApi(object):
|
|
|
5680
5781
|
async_req (bool): execute request asynchronously
|
|
5681
5782
|
|
|
5682
5783
|
Returns:
|
|
5683
|
-
|
|
5784
|
+
Creative2Response
|
|
5684
5785
|
If the method is called asynchronously, returns the request
|
|
5685
5786
|
thread.
|
|
5686
5787
|
"""
|
|
@@ -5709,29 +5810,31 @@ class CampaignApi(object):
|
|
|
5709
5810
|
'_content_type')
|
|
5710
5811
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5711
5812
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5712
|
-
kwargs['
|
|
5713
|
-
|
|
5714
|
-
|
|
5813
|
+
kwargs['account_id'] = \
|
|
5814
|
+
account_id
|
|
5815
|
+
kwargs['creative_id'] = \
|
|
5816
|
+
creative_id
|
|
5817
|
+
return self.update_creative_endpoint.call_with_http_info(**kwargs)
|
|
5715
5818
|
|
|
5716
|
-
def
|
|
5819
|
+
def update_keyword_reviews_v1(
|
|
5717
5820
|
self,
|
|
5718
5821
|
line_item_id,
|
|
5719
5822
|
**kwargs
|
|
5720
5823
|
):
|
|
5721
|
-
"""
|
|
5824
|
+
"""update_keyword_reviews_v1 # noqa: E501
|
|
5722
5825
|
|
|
5723
|
-
|
|
5826
|
+
Update the status of keyword reviews under a line item # noqa: E501
|
|
5724
5827
|
This method makes a synchronous HTTP request by default. To make an
|
|
5725
5828
|
asynchronous HTTP request, please pass async_req=True
|
|
5726
5829
|
|
|
5727
|
-
>>> thread = api.
|
|
5830
|
+
>>> thread = api.update_keyword_reviews_v1(line_item_id, async_req=True)
|
|
5728
5831
|
>>> result = thread.get()
|
|
5729
5832
|
|
|
5730
5833
|
Args:
|
|
5731
|
-
line_item_id (
|
|
5834
|
+
line_item_id (int): The line item to update keyword review statuses for
|
|
5732
5835
|
|
|
5733
5836
|
Keyword Args:
|
|
5734
|
-
|
|
5837
|
+
value_resource_input_retail_media_keywords_review (ValueResourceInputRetailMediaKeywordsReview): Request object containing a list of Phrase-ReviewState pairs to update. [optional]
|
|
5735
5838
|
_return_http_data_only (bool): response data without head status
|
|
5736
5839
|
code and headers. Default is True.
|
|
5737
5840
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5764,7 +5867,7 @@ class CampaignApi(object):
|
|
|
5764
5867
|
async_req (bool): execute request asynchronously
|
|
5765
5868
|
|
|
5766
5869
|
Returns:
|
|
5767
|
-
|
|
5870
|
+
ValueResourceOutcomeRetailMediaKeywordsReviewResult
|
|
5768
5871
|
If the method is called asynchronously, returns the request
|
|
5769
5872
|
thread.
|
|
5770
5873
|
"""
|
|
@@ -5795,27 +5898,27 @@ class CampaignApi(object):
|
|
|
5795
5898
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5796
5899
|
kwargs['line_item_id'] = \
|
|
5797
5900
|
line_item_id
|
|
5798
|
-
return self.
|
|
5901
|
+
return self.update_keyword_reviews_v1_endpoint.call_with_http_info(**kwargs)
|
|
5799
5902
|
|
|
5800
|
-
def
|
|
5903
|
+
def update_preferred_line_item_by_line_item_id(
|
|
5801
5904
|
self,
|
|
5802
5905
|
line_item_id,
|
|
5803
5906
|
**kwargs
|
|
5804
5907
|
):
|
|
5805
|
-
"""
|
|
5908
|
+
"""update_preferred_line_item_by_line_item_id # noqa: E501
|
|
5806
5909
|
|
|
5807
|
-
Updates
|
|
5910
|
+
Updates the preferred line item for the given line item id # noqa: E501
|
|
5808
5911
|
This method makes a synchronous HTTP request by default. To make an
|
|
5809
5912
|
asynchronous HTTP request, please pass async_req=True
|
|
5810
5913
|
|
|
5811
|
-
>>> thread = api.
|
|
5914
|
+
>>> thread = api.update_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
|
|
5812
5915
|
>>> result = thread.get()
|
|
5813
5916
|
|
|
5814
5917
|
Args:
|
|
5815
|
-
line_item_id (
|
|
5918
|
+
line_item_id (str): The given line item id
|
|
5816
5919
|
|
|
5817
5920
|
Keyword Args:
|
|
5818
|
-
|
|
5921
|
+
preferred_line_item_update_model_v2_request (PreferredLineItemUpdateModelV2Request): The line item settings to create a line item with. [optional]
|
|
5819
5922
|
_return_http_data_only (bool): response data without head status
|
|
5820
5923
|
code and headers. Default is True.
|
|
5821
5924
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5848,7 +5951,7 @@ class CampaignApi(object):
|
|
|
5848
5951
|
async_req (bool): execute request asynchronously
|
|
5849
5952
|
|
|
5850
5953
|
Returns:
|
|
5851
|
-
|
|
5954
|
+
PreferredLineItemV2Response
|
|
5852
5955
|
If the method is called asynchronously, returns the request
|
|
5853
5956
|
thread.
|
|
5854
5957
|
"""
|
|
@@ -5879,27 +5982,29 @@ class CampaignApi(object):
|
|
|
5879
5982
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5880
5983
|
kwargs['line_item_id'] = \
|
|
5881
5984
|
line_item_id
|
|
5882
|
-
return self.
|
|
5985
|
+
return self.update_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
5883
5986
|
|
|
5884
|
-
def
|
|
5987
|
+
def update_product_button_by_line_item_and_product_button_id(
|
|
5885
5988
|
self,
|
|
5886
5989
|
line_item_id,
|
|
5990
|
+
product_button_id,
|
|
5887
5991
|
**kwargs
|
|
5888
5992
|
):
|
|
5889
|
-
"""
|
|
5993
|
+
"""update_product_button_by_line_item_and_product_button_id # noqa: E501
|
|
5890
5994
|
|
|
5891
|
-
Update
|
|
5995
|
+
Update Specific Product Button # noqa: E501
|
|
5892
5996
|
This method makes a synchronous HTTP request by default. To make an
|
|
5893
5997
|
asynchronous HTTP request, please pass async_req=True
|
|
5894
5998
|
|
|
5895
|
-
>>> thread = api.
|
|
5999
|
+
>>> thread = api.update_product_button_by_line_item_and_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
5896
6000
|
>>> result = thread.get()
|
|
5897
6001
|
|
|
5898
6002
|
Args:
|
|
5899
|
-
line_item_id (
|
|
6003
|
+
line_item_id (str): LineItemId for productButton update
|
|
6004
|
+
product_button_id (str): productButtonId used for update
|
|
5900
6005
|
|
|
5901
6006
|
Keyword Args:
|
|
5902
|
-
|
|
6007
|
+
product_button_request_request (ProductButtonRequestRequest): Specific Product button update info. [optional]
|
|
5903
6008
|
_return_http_data_only (bool): response data without head status
|
|
5904
6009
|
code and headers. Default is True.
|
|
5905
6010
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5932,7 +6037,7 @@ class CampaignApi(object):
|
|
|
5932
6037
|
async_req (bool): execute request asynchronously
|
|
5933
6038
|
|
|
5934
6039
|
Returns:
|
|
5935
|
-
|
|
6040
|
+
ProductButtonResponseListResponse
|
|
5936
6041
|
If the method is called asynchronously, returns the request
|
|
5937
6042
|
thread.
|
|
5938
6043
|
"""
|
|
@@ -5963,5 +6068,7 @@ class CampaignApi(object):
|
|
|
5963
6068
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5964
6069
|
kwargs['line_item_id'] = \
|
|
5965
6070
|
line_item_id
|
|
5966
|
-
|
|
6071
|
+
kwargs['product_button_id'] = \
|
|
6072
|
+
product_button_id
|
|
6073
|
+
return self.update_product_button_by_line_item_and_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
5967
6074
|
|