criteo-api-retailmedia-sdk 0.0.240118__py3-none-any.whl → 0.0.240404__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 +181 -35
- criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
- criteo_api_retailmedia_preview/api/audience_api.py +2 -313
- criteo_api_retailmedia_preview/api/campaign_api.py +443 -974
- criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/{creative202210.py → async_accounts_report.py} +149 -95
- criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
- criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +57 -53
- criteo_api_retailmedia_preview/model/async_line_items_report.py +57 -54
- criteo_api_retailmedia_preview/model/{customer_list_details.py → batch_accepted_response.py} +11 -11
- criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → change_details.py} +27 -26
- criteo_api_retailmedia_preview/model/{color_variable_value.py → custom_attribute.py} +17 -16
- criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
- criteo_api_retailmedia_preview/model/external_account.py +4 -0
- criteo_api_retailmedia_preview/model/{files_variable_value.py → external_line_item_capping_v2.py} +22 -13
- criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
- criteo_api_retailmedia_preview/model/{page_type_environment.py → external_line_item_page_v2.py} +40 -29
- criteo_api_retailmedia_preview/model/{retail_media_audience_attributes.py → external_preferred_line_item_create_model_v2.py} +79 -25
- criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
- criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
- criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → fail_response.py} +21 -23
- criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py +273 -0
- criteo_api_retailmedia_preview/model/{retail_media_audience.py → insertion_order_history_change_data_capture.py} +48 -42
- criteo_api_retailmedia_preview/model/installment.py +273 -0
- criteo_api_retailmedia_preview/model/{creative202210_response.py → loyalty_points.py} +15 -25
- criteo_api_retailmedia_preview/model/metadata.py +273 -0
- criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
- criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
- criteo_api_retailmedia_preview/model/{common_status_code_response.py → preferred_line_item_update_model_v2_request.py} +9 -15
- criteo_api_retailmedia_preview/model/{retail_media_audience_v2_list_response.py → preferred_line_item_v2_paged_list_response.py} +21 -27
- criteo_api_retailmedia_preview/model/{creative202210_list_response.py → preferred_line_item_v2_response.py} +16 -16
- criteo_api_retailmedia_preview/model/price.py +267 -0
- criteo_api_retailmedia_preview/model/product.py +626 -0
- criteo_api_retailmedia_preview/model/{retail_media_audience_v2.py → product_importer_error.py} +37 -29
- criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
- criteo_api_retailmedia_preview/model/product_shipping.py +293 -0
- criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
- criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
- criteo_api_retailmedia_preview/model/product_tax.py +283 -0
- criteo_api_retailmedia_preview/model/{choice_variable_value.py → product_unit_pricing_base_measure.py} +13 -15
- criteo_api_retailmedia_preview/model/{text_variable_specification.py → product_unit_pricing_measure.py} +11 -7
- criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
- criteo_api_retailmedia_preview/model/{retail_media_audience_v2_attributes.py → products_custom_batch_request_entry.py} +43 -29
- criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → report_detail_error.py} +35 -15
- criteo_api_retailmedia_preview/model/report_detail_errors.py +281 -0
- criteo_api_retailmedia_preview/model/{template_variable_value.py → report_ok_response.py} +58 -43
- criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_preferred_line_item_update_model_v2.py} +9 -9
- criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_preferred_line_item_v2.py} +9 -9
- criteo_api_retailmedia_preview/model/retail_media_account.py +4 -0
- criteo_api_retailmedia_preview/model/retail_media_brand_account_creation.py +4 -0
- criteo_api_retailmedia_preview/model/{text_variable_value.py → retail_media_brands.py} +10 -22
- criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +4 -0
- criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +3 -3
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +37 -37
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +51 -47
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +53 -50
- criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
- criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → value_resource_input_of_retail_media_brands.py} +15 -22
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
- criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
- criteo_api_retailmedia_preview/models/__init__.py +48 -42
- {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/RECORD +73 -66
- {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_preview/model/choice_option.py +0 -281
- criteo_api_retailmedia_preview/model/choice_variable_specification.py +0 -283
- criteo_api_retailmedia_preview/model/create_user_behavior_segment_v2.py +0 -309
- criteo_api_retailmedia_preview/model/creative_create_model202207.py +0 -297
- criteo_api_retailmedia_preview/model/creative_update_model202207.py +0 -297
- criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
- criteo_api_retailmedia_preview/model/get_page_of_audiences_by_account_id_response.py +0 -295
- criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +0 -287
- criteo_api_retailmedia_preview/model/template_list_response.py +0 -281
- criteo_api_retailmedia_preview/model/template_response.py +0 -281
- criteo_api_retailmedia_preview/model/template_variable.py +0 -310
- criteo_api_retailmedia_preview/model/user_behavior_details.py +0 -306
- criteo_api_retailmedia_preview/model/user_behavior_details_v2.py +0 -279
- {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/top_level.txt +0 -0
|
@@ -23,19 +23,18 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
|
|
|
23
23
|
)
|
|
24
24
|
from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse
|
|
25
25
|
from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse
|
|
26
|
-
from criteo_api_retailmedia_preview.model.creative202210_list_response import Creative202210ListResponse
|
|
27
|
-
from criteo_api_retailmedia_preview.model.creative202210_response import Creative202210Response
|
|
28
|
-
from criteo_api_retailmedia_preview.model.creative_create_model202207 import CreativeCreateModel202207
|
|
29
|
-
from criteo_api_retailmedia_preview.model.creative_update_model202207 import CreativeUpdateModel202207
|
|
30
26
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
|
|
31
27
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand
|
|
32
28
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer
|
|
33
|
-
from criteo_api_retailmedia_preview.model.json_api_request_of_catalog_request_preview import JsonApiRequestOfCatalogRequestPreview
|
|
34
|
-
from criteo_api_retailmedia_preview.model.json_api_single_response_of_catalog_status import JsonApiSingleResponseOfCatalogStatus
|
|
35
29
|
from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers import JsonApiSingleResponseOfLineItemBidMultipliers
|
|
36
30
|
from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_request import LineItemBidMultipliersRequest
|
|
37
31
|
from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_response import LineItemBidMultipliersResponse
|
|
32
|
+
from criteo_api_retailmedia_preview.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture
|
|
38
33
|
from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse
|
|
34
|
+
from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request
|
|
35
|
+
from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request
|
|
36
|
+
from criteo_api_retailmedia_preview.model.preferred_line_item_v2_paged_list_response import PreferredLineItemV2PagedListResponse
|
|
37
|
+
from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import PreferredLineItemV2Response
|
|
39
38
|
from criteo_api_retailmedia_preview.model.product_button_list_request import ProductButtonListRequest
|
|
40
39
|
from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse
|
|
41
40
|
from criteo_api_retailmedia_preview.model.product_button_request import ProductButtonRequest
|
|
@@ -53,8 +52,6 @@ from criteo_api_retailmedia_preview.model.sku_search_request_slim_preview_reques
|
|
|
53
52
|
from criteo_api_retailmedia_preview.model.sku_search_request_slim_v2_preview_request import SkuSearchRequestSlimV2PreviewRequest
|
|
54
53
|
from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response import SkuSlimDataPreviewListResponse
|
|
55
54
|
from criteo_api_retailmedia_preview.model.sku_slim_data_v2_list_response import SkuSlimDataV2ListResponse
|
|
56
|
-
from criteo_api_retailmedia_preview.model.template_list_response import TemplateListResponse
|
|
57
|
-
from criteo_api_retailmedia_preview.model.template_response import TemplateResponse
|
|
58
55
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_campaign_budget_overrides import ValueResourceInputOfCampaignBudgetOverrides
|
|
59
56
|
from criteo_api_retailmedia_preview.model.value_resource_input_of_line_item_budget_overrides import ValueResourceInputOfLineItemBudgetOverrides
|
|
60
57
|
from criteo_api_retailmedia_preview.model.value_resource_outcome_of_campaign_budget_overrides import ValueResourceOutcomeOfCampaignBudgetOverrides
|
|
@@ -297,174 +294,6 @@ class CampaignApi(object):
|
|
|
297
294
|
},
|
|
298
295
|
api_client=api_client
|
|
299
296
|
)
|
|
300
|
-
self.get_api202207_external_retailer_by_retailer_id_templatestemplate_id_endpoint = _Endpoint(
|
|
301
|
-
settings={
|
|
302
|
-
'response_type': (TemplateResponse,),
|
|
303
|
-
'auth': [
|
|
304
|
-
'oauth',
|
|
305
|
-
'oauth'
|
|
306
|
-
],
|
|
307
|
-
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/templates/{template-id}',
|
|
308
|
-
'operation_id': 'get_api202207_external_retailer_by_retailer_id_templatestemplate_id',
|
|
309
|
-
'http_method': 'GET',
|
|
310
|
-
'servers': None,
|
|
311
|
-
},
|
|
312
|
-
params_map={
|
|
313
|
-
'all': [
|
|
314
|
-
'retailer_id',
|
|
315
|
-
'template_id',
|
|
316
|
-
],
|
|
317
|
-
'required': [
|
|
318
|
-
'retailer_id',
|
|
319
|
-
'template_id',
|
|
320
|
-
],
|
|
321
|
-
'nullable': [
|
|
322
|
-
],
|
|
323
|
-
'enum': [
|
|
324
|
-
],
|
|
325
|
-
'validation': [
|
|
326
|
-
]
|
|
327
|
-
},
|
|
328
|
-
root_map={
|
|
329
|
-
'validations': {
|
|
330
|
-
},
|
|
331
|
-
'allowed_values': {
|
|
332
|
-
},
|
|
333
|
-
'openapi_types': {
|
|
334
|
-
'retailer_id':
|
|
335
|
-
(int,),
|
|
336
|
-
'template_id':
|
|
337
|
-
(int,),
|
|
338
|
-
},
|
|
339
|
-
'attribute_map': {
|
|
340
|
-
'retailer_id': 'retailer-id',
|
|
341
|
-
'template_id': 'template-id',
|
|
342
|
-
},
|
|
343
|
-
'location_map': {
|
|
344
|
-
'retailer_id': 'path',
|
|
345
|
-
'template_id': 'path',
|
|
346
|
-
},
|
|
347
|
-
'collection_format_map': {
|
|
348
|
-
}
|
|
349
|
-
},
|
|
350
|
-
headers_map={
|
|
351
|
-
'accept': [
|
|
352
|
-
'application/json'
|
|
353
|
-
],
|
|
354
|
-
'content_type': [],
|
|
355
|
-
},
|
|
356
|
-
api_client=api_client
|
|
357
|
-
)
|
|
358
|
-
self.get_api202207_external_retailer_templates_by_retailer_id_endpoint = _Endpoint(
|
|
359
|
-
settings={
|
|
360
|
-
'response_type': (TemplateListResponse,),
|
|
361
|
-
'auth': [
|
|
362
|
-
'oauth',
|
|
363
|
-
'oauth'
|
|
364
|
-
],
|
|
365
|
-
'endpoint_path': '/preview/retail-media/retailers/{retailer-id}/templates',
|
|
366
|
-
'operation_id': 'get_api202207_external_retailer_templates_by_retailer_id',
|
|
367
|
-
'http_method': 'GET',
|
|
368
|
-
'servers': None,
|
|
369
|
-
},
|
|
370
|
-
params_map={
|
|
371
|
-
'all': [
|
|
372
|
-
'retailer_id',
|
|
373
|
-
],
|
|
374
|
-
'required': [
|
|
375
|
-
'retailer_id',
|
|
376
|
-
],
|
|
377
|
-
'nullable': [
|
|
378
|
-
],
|
|
379
|
-
'enum': [
|
|
380
|
-
],
|
|
381
|
-
'validation': [
|
|
382
|
-
]
|
|
383
|
-
},
|
|
384
|
-
root_map={
|
|
385
|
-
'validations': {
|
|
386
|
-
},
|
|
387
|
-
'allowed_values': {
|
|
388
|
-
},
|
|
389
|
-
'openapi_types': {
|
|
390
|
-
'retailer_id':
|
|
391
|
-
(int,),
|
|
392
|
-
},
|
|
393
|
-
'attribute_map': {
|
|
394
|
-
'retailer_id': 'retailer-id',
|
|
395
|
-
},
|
|
396
|
-
'location_map': {
|
|
397
|
-
'retailer_id': 'path',
|
|
398
|
-
},
|
|
399
|
-
'collection_format_map': {
|
|
400
|
-
}
|
|
401
|
-
},
|
|
402
|
-
headers_map={
|
|
403
|
-
'accept': [
|
|
404
|
-
'application/json'
|
|
405
|
-
],
|
|
406
|
-
'content_type': [],
|
|
407
|
-
},
|
|
408
|
-
api_client=api_client
|
|
409
|
-
)
|
|
410
|
-
self.get_api202210_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
|
|
411
|
-
settings={
|
|
412
|
-
'response_type': (Creative202210Response,),
|
|
413
|
-
'auth': [
|
|
414
|
-
'oauth',
|
|
415
|
-
'oauth'
|
|
416
|
-
],
|
|
417
|
-
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
418
|
-
'operation_id': 'get_api202210_external_account_by_account_id_creativescreative_id',
|
|
419
|
-
'http_method': 'GET',
|
|
420
|
-
'servers': None,
|
|
421
|
-
},
|
|
422
|
-
params_map={
|
|
423
|
-
'all': [
|
|
424
|
-
'account_id',
|
|
425
|
-
'creative_id',
|
|
426
|
-
],
|
|
427
|
-
'required': [
|
|
428
|
-
'account_id',
|
|
429
|
-
'creative_id',
|
|
430
|
-
],
|
|
431
|
-
'nullable': [
|
|
432
|
-
],
|
|
433
|
-
'enum': [
|
|
434
|
-
],
|
|
435
|
-
'validation': [
|
|
436
|
-
]
|
|
437
|
-
},
|
|
438
|
-
root_map={
|
|
439
|
-
'validations': {
|
|
440
|
-
},
|
|
441
|
-
'allowed_values': {
|
|
442
|
-
},
|
|
443
|
-
'openapi_types': {
|
|
444
|
-
'account_id':
|
|
445
|
-
(str,),
|
|
446
|
-
'creative_id':
|
|
447
|
-
(str,),
|
|
448
|
-
},
|
|
449
|
-
'attribute_map': {
|
|
450
|
-
'account_id': 'account-id',
|
|
451
|
-
'creative_id': 'creative-id',
|
|
452
|
-
},
|
|
453
|
-
'location_map': {
|
|
454
|
-
'account_id': 'path',
|
|
455
|
-
'creative_id': 'path',
|
|
456
|
-
},
|
|
457
|
-
'collection_format_map': {
|
|
458
|
-
}
|
|
459
|
-
},
|
|
460
|
-
headers_map={
|
|
461
|
-
'accept': [
|
|
462
|
-
'application/json'
|
|
463
|
-
],
|
|
464
|
-
'content_type': [],
|
|
465
|
-
},
|
|
466
|
-
api_client=api_client
|
|
467
|
-
)
|
|
468
297
|
self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint = _Endpoint(
|
|
469
298
|
settings={
|
|
470
299
|
'response_type': (ProductButtonListResponse,),
|
|
@@ -629,111 +458,6 @@ class CampaignApi(object):
|
|
|
629
458
|
},
|
|
630
459
|
api_client=api_client
|
|
631
460
|
)
|
|
632
|
-
self.get_api_v0_external_catalog_output_by_catalog_id_endpoint = _Endpoint(
|
|
633
|
-
settings={
|
|
634
|
-
'response_type': None,
|
|
635
|
-
'auth': [
|
|
636
|
-
'oauth',
|
|
637
|
-
'oauth'
|
|
638
|
-
],
|
|
639
|
-
'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/output',
|
|
640
|
-
'operation_id': 'get_api_v0_external_catalog_output_by_catalog_id',
|
|
641
|
-
'http_method': 'GET',
|
|
642
|
-
'servers': None,
|
|
643
|
-
},
|
|
644
|
-
params_map={
|
|
645
|
-
'all': [
|
|
646
|
-
'catalog_id',
|
|
647
|
-
],
|
|
648
|
-
'required': [
|
|
649
|
-
'catalog_id',
|
|
650
|
-
],
|
|
651
|
-
'nullable': [
|
|
652
|
-
],
|
|
653
|
-
'enum': [
|
|
654
|
-
],
|
|
655
|
-
'validation': [
|
|
656
|
-
]
|
|
657
|
-
},
|
|
658
|
-
root_map={
|
|
659
|
-
'validations': {
|
|
660
|
-
},
|
|
661
|
-
'allowed_values': {
|
|
662
|
-
},
|
|
663
|
-
'openapi_types': {
|
|
664
|
-
'catalog_id':
|
|
665
|
-
(str,),
|
|
666
|
-
},
|
|
667
|
-
'attribute_map': {
|
|
668
|
-
'catalog_id': 'catalogId',
|
|
669
|
-
},
|
|
670
|
-
'location_map': {
|
|
671
|
-
'catalog_id': 'path',
|
|
672
|
-
},
|
|
673
|
-
'collection_format_map': {
|
|
674
|
-
}
|
|
675
|
-
},
|
|
676
|
-
headers_map={
|
|
677
|
-
'accept': [
|
|
678
|
-
'application/x-json-stream',
|
|
679
|
-
'application/json'
|
|
680
|
-
],
|
|
681
|
-
'content_type': [],
|
|
682
|
-
},
|
|
683
|
-
api_client=api_client
|
|
684
|
-
)
|
|
685
|
-
self.get_api_v0_external_catalog_status_by_catalog_id_endpoint = _Endpoint(
|
|
686
|
-
settings={
|
|
687
|
-
'response_type': (JsonApiSingleResponseOfCatalogStatus,),
|
|
688
|
-
'auth': [
|
|
689
|
-
'oauth',
|
|
690
|
-
'oauth'
|
|
691
|
-
],
|
|
692
|
-
'endpoint_path': '/preview/retail-media/catalogs/{catalogId}/status',
|
|
693
|
-
'operation_id': 'get_api_v0_external_catalog_status_by_catalog_id',
|
|
694
|
-
'http_method': 'GET',
|
|
695
|
-
'servers': None,
|
|
696
|
-
},
|
|
697
|
-
params_map={
|
|
698
|
-
'all': [
|
|
699
|
-
'catalog_id',
|
|
700
|
-
],
|
|
701
|
-
'required': [
|
|
702
|
-
'catalog_id',
|
|
703
|
-
],
|
|
704
|
-
'nullable': [
|
|
705
|
-
],
|
|
706
|
-
'enum': [
|
|
707
|
-
],
|
|
708
|
-
'validation': [
|
|
709
|
-
]
|
|
710
|
-
},
|
|
711
|
-
root_map={
|
|
712
|
-
'validations': {
|
|
713
|
-
},
|
|
714
|
-
'allowed_values': {
|
|
715
|
-
},
|
|
716
|
-
'openapi_types': {
|
|
717
|
-
'catalog_id':
|
|
718
|
-
(str,),
|
|
719
|
-
},
|
|
720
|
-
'attribute_map': {
|
|
721
|
-
'catalog_id': 'catalogId',
|
|
722
|
-
},
|
|
723
|
-
'location_map': {
|
|
724
|
-
'catalog_id': 'path',
|
|
725
|
-
},
|
|
726
|
-
'collection_format_map': {
|
|
727
|
-
}
|
|
728
|
-
},
|
|
729
|
-
headers_map={
|
|
730
|
-
'accept': [
|
|
731
|
-
'application/json'
|
|
732
|
-
],
|
|
733
|
-
'content_type': [],
|
|
734
|
-
},
|
|
735
|
-
api_client=api_client
|
|
736
|
-
)
|
|
737
461
|
self.get_api_v1_external_account_brands_by_account_id_endpoint = _Endpoint(
|
|
738
462
|
settings={
|
|
739
463
|
'response_type': (JsonApiPageResponseOfBrand,),
|
|
@@ -1175,21 +899,24 @@ class CampaignApi(object):
|
|
|
1175
899
|
},
|
|
1176
900
|
api_client=api_client
|
|
1177
901
|
)
|
|
1178
|
-
self.
|
|
902
|
+
self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1179
903
|
settings={
|
|
1180
|
-
'response_type': (
|
|
904
|
+
'response_type': (PreferredLineItemV2PagedListResponse,),
|
|
1181
905
|
'auth': [
|
|
1182
906
|
'oauth',
|
|
1183
907
|
'oauth'
|
|
1184
908
|
],
|
|
1185
|
-
'endpoint_path': '/preview/retail-media/campaigns/{
|
|
1186
|
-
'operation_id': '
|
|
909
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
910
|
+
'operation_id': 'get_api_v2_external_campaign_preferred_line_items_by_campaign_id',
|
|
1187
911
|
'http_method': 'GET',
|
|
1188
912
|
'servers': None,
|
|
1189
913
|
},
|
|
1190
914
|
params_map={
|
|
1191
915
|
'all': [
|
|
1192
916
|
'campaign_id',
|
|
917
|
+
'limit_to_id',
|
|
918
|
+
'page_index',
|
|
919
|
+
'page_size',
|
|
1193
920
|
],
|
|
1194
921
|
'required': [
|
|
1195
922
|
'campaign_id',
|
|
@@ -1208,15 +935,28 @@ class CampaignApi(object):
|
|
|
1208
935
|
},
|
|
1209
936
|
'openapi_types': {
|
|
1210
937
|
'campaign_id':
|
|
938
|
+
(str,),
|
|
939
|
+
'limit_to_id':
|
|
940
|
+
([str],),
|
|
941
|
+
'page_index':
|
|
942
|
+
(int,),
|
|
943
|
+
'page_size':
|
|
1211
944
|
(int,),
|
|
1212
945
|
},
|
|
1213
946
|
'attribute_map': {
|
|
1214
|
-
'campaign_id': '
|
|
947
|
+
'campaign_id': 'campaign-id',
|
|
948
|
+
'limit_to_id': 'limitToId',
|
|
949
|
+
'page_index': 'pageIndex',
|
|
950
|
+
'page_size': 'pageSize',
|
|
1215
951
|
},
|
|
1216
952
|
'location_map': {
|
|
1217
953
|
'campaign_id': 'path',
|
|
954
|
+
'limit_to_id': 'query',
|
|
955
|
+
'page_index': 'query',
|
|
956
|
+
'page_size': 'query',
|
|
1218
957
|
},
|
|
1219
958
|
'collection_format_map': {
|
|
959
|
+
'limit_to_id': 'multi',
|
|
1220
960
|
}
|
|
1221
961
|
},
|
|
1222
962
|
headers_map={
|
|
@@ -1227,15 +967,15 @@ class CampaignApi(object):
|
|
|
1227
967
|
},
|
|
1228
968
|
api_client=api_client
|
|
1229
969
|
)
|
|
1230
|
-
self.
|
|
970
|
+
self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
1231
971
|
settings={
|
|
1232
|
-
'response_type': (
|
|
972
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1233
973
|
'auth': [
|
|
1234
974
|
'oauth',
|
|
1235
975
|
'oauth'
|
|
1236
976
|
],
|
|
1237
|
-
'endpoint_path': '/preview/retail-media/line-items/{
|
|
1238
|
-
'operation_id': '
|
|
977
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
978
|
+
'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id',
|
|
1239
979
|
'http_method': 'GET',
|
|
1240
980
|
'servers': None,
|
|
1241
981
|
},
|
|
@@ -1263,7 +1003,7 @@ class CampaignApi(object):
|
|
|
1263
1003
|
(str,),
|
|
1264
1004
|
},
|
|
1265
1005
|
'attribute_map': {
|
|
1266
|
-
'line_item_id': '
|
|
1006
|
+
'line_item_id': 'line-item-id',
|
|
1267
1007
|
},
|
|
1268
1008
|
'location_map': {
|
|
1269
1009
|
'line_item_id': 'path',
|
|
@@ -1279,24 +1019,24 @@ class CampaignApi(object):
|
|
|
1279
1019
|
},
|
|
1280
1020
|
api_client=api_client
|
|
1281
1021
|
)
|
|
1282
|
-
self.
|
|
1022
|
+
self.get_campaign_budget_overrides_endpoint = _Endpoint(
|
|
1283
1023
|
settings={
|
|
1284
|
-
'response_type': (
|
|
1024
|
+
'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
|
|
1285
1025
|
'auth': [
|
|
1286
1026
|
'oauth',
|
|
1287
1027
|
'oauth'
|
|
1288
1028
|
],
|
|
1289
|
-
'endpoint_path': '/preview/retail-media/
|
|
1290
|
-
'operation_id': '
|
|
1029
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides',
|
|
1030
|
+
'operation_id': 'get_campaign_budget_overrides',
|
|
1291
1031
|
'http_method': 'GET',
|
|
1292
1032
|
'servers': None,
|
|
1293
1033
|
},
|
|
1294
1034
|
params_map={
|
|
1295
1035
|
'all': [
|
|
1296
|
-
'
|
|
1036
|
+
'campaign_id',
|
|
1297
1037
|
],
|
|
1298
1038
|
'required': [
|
|
1299
|
-
'
|
|
1039
|
+
'campaign_id',
|
|
1300
1040
|
],
|
|
1301
1041
|
'nullable': [
|
|
1302
1042
|
],
|
|
@@ -1311,14 +1051,14 @@ class CampaignApi(object):
|
|
|
1311
1051
|
'allowed_values': {
|
|
1312
1052
|
},
|
|
1313
1053
|
'openapi_types': {
|
|
1314
|
-
'
|
|
1315
|
-
(
|
|
1054
|
+
'campaign_id':
|
|
1055
|
+
(int,),
|
|
1316
1056
|
},
|
|
1317
1057
|
'attribute_map': {
|
|
1318
|
-
'
|
|
1058
|
+
'campaign_id': 'campaignId',
|
|
1319
1059
|
},
|
|
1320
1060
|
'location_map': {
|
|
1321
|
-
'
|
|
1061
|
+
'campaign_id': 'path',
|
|
1322
1062
|
},
|
|
1323
1063
|
'collection_format_map': {
|
|
1324
1064
|
}
|
|
@@ -1331,54 +1071,39 @@ class CampaignApi(object):
|
|
|
1331
1071
|
},
|
|
1332
1072
|
api_client=api_client
|
|
1333
1073
|
)
|
|
1334
|
-
self.
|
|
1074
|
+
self.get_insertion_order_history_change_data_capture_endpoint = _Endpoint(
|
|
1335
1075
|
settings={
|
|
1336
|
-
'response_type': (
|
|
1076
|
+
'response_type': (PageOfInsertionOrderHistoryChangeDataCapture,),
|
|
1337
1077
|
'auth': [
|
|
1338
1078
|
'oauth',
|
|
1339
1079
|
'oauth'
|
|
1340
1080
|
],
|
|
1341
|
-
'endpoint_path': '/preview/retail-media/
|
|
1342
|
-
'operation_id': '
|
|
1343
|
-
'http_method': '
|
|
1081
|
+
'endpoint_path': '/preview/retail-media/insertion-order-history/{insertionOrderId}/change-data-capture',
|
|
1082
|
+
'operation_id': 'get_insertion_order_history_change_data_capture',
|
|
1083
|
+
'http_method': 'GET',
|
|
1344
1084
|
'servers': None,
|
|
1345
1085
|
},
|
|
1346
1086
|
params_map={
|
|
1347
1087
|
'all': [
|
|
1348
|
-
'
|
|
1349
|
-
'retailer_id',
|
|
1088
|
+
'insertion_order_id',
|
|
1350
1089
|
'offset',
|
|
1351
1090
|
'limit',
|
|
1352
|
-
'
|
|
1091
|
+
'limit_to_change_types',
|
|
1353
1092
|
],
|
|
1354
1093
|
'required': [
|
|
1355
|
-
'
|
|
1356
|
-
'retailer_id',
|
|
1094
|
+
'insertion_order_id',
|
|
1357
1095
|
],
|
|
1358
1096
|
'nullable': [
|
|
1359
1097
|
],
|
|
1360
1098
|
'enum': [
|
|
1361
1099
|
],
|
|
1362
1100
|
'validation': [
|
|
1363
|
-
'account_id',
|
|
1364
|
-
'retailer_id',
|
|
1365
1101
|
'offset',
|
|
1366
1102
|
'limit',
|
|
1367
1103
|
]
|
|
1368
1104
|
},
|
|
1369
1105
|
root_map={
|
|
1370
1106
|
'validations': {
|
|
1371
|
-
('account_id',): {
|
|
1372
|
-
|
|
1373
|
-
'regex': {
|
|
1374
|
-
'pattern': r'^\d+$', # noqa: E501
|
|
1375
|
-
},
|
|
1376
|
-
},
|
|
1377
|
-
('retailer_id',): {
|
|
1378
|
-
|
|
1379
|
-
'inclusive_maximum': 2147483647,
|
|
1380
|
-
'inclusive_minimum': 1,
|
|
1381
|
-
},
|
|
1382
1107
|
('offset',): {
|
|
1383
1108
|
|
|
1384
1109
|
'inclusive_maximum': 2147483647,
|
|
@@ -1386,36 +1111,33 @@ class CampaignApi(object):
|
|
|
1386
1111
|
},
|
|
1387
1112
|
('limit',): {
|
|
1388
1113
|
|
|
1389
|
-
'inclusive_maximum':
|
|
1114
|
+
'inclusive_maximum': 100,
|
|
1390
1115
|
'inclusive_minimum': 1,
|
|
1391
1116
|
},
|
|
1392
1117
|
},
|
|
1393
1118
|
'allowed_values': {
|
|
1394
1119
|
},
|
|
1395
1120
|
'openapi_types': {
|
|
1396
|
-
'
|
|
1121
|
+
'insertion_order_id':
|
|
1397
1122
|
(str,),
|
|
1398
|
-
'retailer_id':
|
|
1399
|
-
(int,),
|
|
1400
1123
|
'offset':
|
|
1401
1124
|
(int,),
|
|
1402
1125
|
'limit':
|
|
1403
1126
|
(int,),
|
|
1404
|
-
'
|
|
1405
|
-
(
|
|
1127
|
+
'limit_to_change_types':
|
|
1128
|
+
(str,),
|
|
1406
1129
|
},
|
|
1407
1130
|
'attribute_map': {
|
|
1408
|
-
'
|
|
1409
|
-
'retailer_id': 'retailerId',
|
|
1131
|
+
'insertion_order_id': 'insertionOrderId',
|
|
1410
1132
|
'offset': 'offset',
|
|
1411
1133
|
'limit': 'limit',
|
|
1134
|
+
'limit_to_change_types': 'limitToChangeTypes',
|
|
1412
1135
|
},
|
|
1413
1136
|
'location_map': {
|
|
1414
|
-
'
|
|
1415
|
-
'retailer_id': 'path',
|
|
1137
|
+
'insertion_order_id': 'path',
|
|
1416
1138
|
'offset': 'query',
|
|
1417
1139
|
'limit': 'query',
|
|
1418
|
-
'
|
|
1140
|
+
'limit_to_change_types': 'query',
|
|
1419
1141
|
},
|
|
1420
1142
|
'collection_format_map': {
|
|
1421
1143
|
}
|
|
@@ -1424,34 +1146,28 @@ class CampaignApi(object):
|
|
|
1424
1146
|
'accept': [
|
|
1425
1147
|
'application/json'
|
|
1426
1148
|
],
|
|
1427
|
-
'content_type': [
|
|
1428
|
-
'application/json-patch+json',
|
|
1429
|
-
'application/json',
|
|
1430
|
-
'text/json',
|
|
1431
|
-
'application/*+json'
|
|
1432
|
-
]
|
|
1149
|
+
'content_type': [],
|
|
1433
1150
|
},
|
|
1434
1151
|
api_client=api_client
|
|
1435
1152
|
)
|
|
1436
|
-
self.
|
|
1153
|
+
self.get_line_item_budget_overrides_endpoint = _Endpoint(
|
|
1437
1154
|
settings={
|
|
1438
|
-
'response_type': (
|
|
1155
|
+
'response_type': (ValueResourceOutcomeOfLineItemBudgetOverrides,),
|
|
1439
1156
|
'auth': [
|
|
1440
1157
|
'oauth',
|
|
1441
1158
|
'oauth'
|
|
1442
1159
|
],
|
|
1443
|
-
'endpoint_path': '/preview/retail-media/
|
|
1444
|
-
'operation_id': '
|
|
1445
|
-
'http_method': '
|
|
1160
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/line-item-budget-overrides',
|
|
1161
|
+
'operation_id': 'get_line_item_budget_overrides',
|
|
1162
|
+
'http_method': 'GET',
|
|
1446
1163
|
'servers': None,
|
|
1447
1164
|
},
|
|
1448
1165
|
params_map={
|
|
1449
1166
|
'all': [
|
|
1450
|
-
'
|
|
1451
|
-
'creative_create_model202207',
|
|
1167
|
+
'line_item_id',
|
|
1452
1168
|
],
|
|
1453
1169
|
'required': [
|
|
1454
|
-
'
|
|
1170
|
+
'line_item_id',
|
|
1455
1171
|
],
|
|
1456
1172
|
'nullable': [
|
|
1457
1173
|
],
|
|
@@ -1466,17 +1182,14 @@ class CampaignApi(object):
|
|
|
1466
1182
|
'allowed_values': {
|
|
1467
1183
|
},
|
|
1468
1184
|
'openapi_types': {
|
|
1469
|
-
'
|
|
1185
|
+
'line_item_id':
|
|
1470
1186
|
(str,),
|
|
1471
|
-
'creative_create_model202207':
|
|
1472
|
-
(CreativeCreateModel202207,),
|
|
1473
1187
|
},
|
|
1474
1188
|
'attribute_map': {
|
|
1475
|
-
'
|
|
1189
|
+
'line_item_id': 'lineItemId',
|
|
1476
1190
|
},
|
|
1477
1191
|
'location_map': {
|
|
1478
|
-
'
|
|
1479
|
-
'creative_create_model202207': 'body',
|
|
1192
|
+
'line_item_id': 'path',
|
|
1480
1193
|
},
|
|
1481
1194
|
'collection_format_map': {
|
|
1482
1195
|
}
|
|
@@ -1485,89 +1198,184 @@ class CampaignApi(object):
|
|
|
1485
1198
|
'accept': [
|
|
1486
1199
|
'application/json'
|
|
1487
1200
|
],
|
|
1488
|
-
'content_type': [
|
|
1489
|
-
|
|
1201
|
+
'content_type': [],
|
|
1202
|
+
},
|
|
1203
|
+
api_client=api_client
|
|
1204
|
+
)
|
|
1205
|
+
self.get_recommended_keywords_endpoint = _Endpoint(
|
|
1206
|
+
settings={
|
|
1207
|
+
'response_type': (ValueResourceOutcomeOfRecommendedKeywordsResult,),
|
|
1208
|
+
'auth': [
|
|
1209
|
+
'oauth',
|
|
1210
|
+
'oauth'
|
|
1211
|
+
],
|
|
1212
|
+
'endpoint_path': '/preview/retail-media/line-items/{externalLineItemId}/keywords/recommended',
|
|
1213
|
+
'operation_id': 'get_recommended_keywords',
|
|
1214
|
+
'http_method': 'GET',
|
|
1215
|
+
'servers': None,
|
|
1216
|
+
},
|
|
1217
|
+
params_map={
|
|
1218
|
+
'all': [
|
|
1219
|
+
'external_line_item_id',
|
|
1220
|
+
],
|
|
1221
|
+
'required': [
|
|
1222
|
+
'external_line_item_id',
|
|
1223
|
+
],
|
|
1224
|
+
'nullable': [
|
|
1225
|
+
],
|
|
1226
|
+
'enum': [
|
|
1227
|
+
],
|
|
1228
|
+
'validation': [
|
|
1490
1229
|
]
|
|
1491
1230
|
},
|
|
1231
|
+
root_map={
|
|
1232
|
+
'validations': {
|
|
1233
|
+
},
|
|
1234
|
+
'allowed_values': {
|
|
1235
|
+
},
|
|
1236
|
+
'openapi_types': {
|
|
1237
|
+
'external_line_item_id':
|
|
1238
|
+
(str,),
|
|
1239
|
+
},
|
|
1240
|
+
'attribute_map': {
|
|
1241
|
+
'external_line_item_id': 'externalLineItemId',
|
|
1242
|
+
},
|
|
1243
|
+
'location_map': {
|
|
1244
|
+
'external_line_item_id': 'path',
|
|
1245
|
+
},
|
|
1246
|
+
'collection_format_map': {
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
headers_map={
|
|
1250
|
+
'accept': [
|
|
1251
|
+
'application/json'
|
|
1252
|
+
],
|
|
1253
|
+
'content_type': [],
|
|
1254
|
+
},
|
|
1492
1255
|
api_client=api_client
|
|
1493
1256
|
)
|
|
1494
|
-
self.
|
|
1257
|
+
self.get_sku_by_product_id_endpoint = _Endpoint(
|
|
1495
1258
|
settings={
|
|
1496
|
-
'response_type': (
|
|
1259
|
+
'response_type': (ResourceCollectionOutcomeOfSkuSearchResult,),
|
|
1497
1260
|
'auth': [
|
|
1498
1261
|
'oauth',
|
|
1499
1262
|
'oauth'
|
|
1500
1263
|
],
|
|
1501
|
-
'endpoint_path': '/preview/retail-media/accounts/{
|
|
1502
|
-
'operation_id': '
|
|
1264
|
+
'endpoint_path': '/preview/retail-media/catalogs/sku/search/accounts/{accountId}/retailers/{retailerId}/by-id',
|
|
1265
|
+
'operation_id': 'get_sku_by_product_id',
|
|
1503
1266
|
'http_method': 'POST',
|
|
1504
1267
|
'servers': None,
|
|
1505
1268
|
},
|
|
1506
1269
|
params_map={
|
|
1507
1270
|
'all': [
|
|
1508
1271
|
'account_id',
|
|
1509
|
-
'
|
|
1272
|
+
'retailer_id',
|
|
1273
|
+
'offset',
|
|
1274
|
+
'limit',
|
|
1275
|
+
'sku_search_request',
|
|
1510
1276
|
],
|
|
1511
1277
|
'required': [
|
|
1512
1278
|
'account_id',
|
|
1279
|
+
'retailer_id',
|
|
1513
1280
|
],
|
|
1514
1281
|
'nullable': [
|
|
1515
1282
|
],
|
|
1516
1283
|
'enum': [
|
|
1517
1284
|
],
|
|
1518
1285
|
'validation': [
|
|
1286
|
+
'account_id',
|
|
1287
|
+
'retailer_id',
|
|
1288
|
+
'offset',
|
|
1289
|
+
'limit',
|
|
1519
1290
|
]
|
|
1520
1291
|
},
|
|
1521
1292
|
root_map={
|
|
1522
1293
|
'validations': {
|
|
1294
|
+
('account_id',): {
|
|
1295
|
+
|
|
1296
|
+
'regex': {
|
|
1297
|
+
'pattern': r'^\d+$', # noqa: E501
|
|
1298
|
+
},
|
|
1299
|
+
},
|
|
1300
|
+
('retailer_id',): {
|
|
1301
|
+
|
|
1302
|
+
'inclusive_maximum': 2147483647,
|
|
1303
|
+
'inclusive_minimum': 1,
|
|
1304
|
+
},
|
|
1305
|
+
('offset',): {
|
|
1306
|
+
|
|
1307
|
+
'inclusive_maximum': 2147483647,
|
|
1308
|
+
'inclusive_minimum': 0,
|
|
1309
|
+
},
|
|
1310
|
+
('limit',): {
|
|
1311
|
+
|
|
1312
|
+
'inclusive_maximum': 2147483647,
|
|
1313
|
+
'inclusive_minimum': 1,
|
|
1314
|
+
},
|
|
1523
1315
|
},
|
|
1524
1316
|
'allowed_values': {
|
|
1525
1317
|
},
|
|
1526
1318
|
'openapi_types': {
|
|
1527
1319
|
'account_id':
|
|
1528
1320
|
(str,),
|
|
1529
|
-
'
|
|
1530
|
-
(
|
|
1321
|
+
'retailer_id':
|
|
1322
|
+
(int,),
|
|
1323
|
+
'offset':
|
|
1324
|
+
(int,),
|
|
1325
|
+
'limit':
|
|
1326
|
+
(int,),
|
|
1327
|
+
'sku_search_request':
|
|
1328
|
+
(SkuSearchRequest,),
|
|
1531
1329
|
},
|
|
1532
1330
|
'attribute_map': {
|
|
1533
|
-
'account_id': '
|
|
1534
|
-
'
|
|
1331
|
+
'account_id': 'accountId',
|
|
1332
|
+
'retailer_id': 'retailerId',
|
|
1333
|
+
'offset': 'offset',
|
|
1334
|
+
'limit': 'limit',
|
|
1535
1335
|
},
|
|
1536
1336
|
'location_map': {
|
|
1537
1337
|
'account_id': 'path',
|
|
1538
|
-
'
|
|
1338
|
+
'retailer_id': 'path',
|
|
1339
|
+
'offset': 'query',
|
|
1340
|
+
'limit': 'query',
|
|
1341
|
+
'sku_search_request': 'body',
|
|
1539
1342
|
},
|
|
1540
1343
|
'collection_format_map': {
|
|
1541
|
-
'creative_ids': 'multi',
|
|
1542
1344
|
}
|
|
1543
1345
|
},
|
|
1544
1346
|
headers_map={
|
|
1545
1347
|
'accept': [
|
|
1546
1348
|
'application/json'
|
|
1547
1349
|
],
|
|
1548
|
-
'content_type': [
|
|
1350
|
+
'content_type': [
|
|
1351
|
+
'application/json-patch+json',
|
|
1352
|
+
'application/json',
|
|
1353
|
+
'text/json',
|
|
1354
|
+
'application/*+json'
|
|
1355
|
+
]
|
|
1549
1356
|
},
|
|
1550
1357
|
api_client=api_client
|
|
1551
1358
|
)
|
|
1552
|
-
self.
|
|
1359
|
+
self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1553
1360
|
settings={
|
|
1554
|
-
'response_type': (
|
|
1361
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1555
1362
|
'auth': [
|
|
1556
1363
|
'oauth',
|
|
1557
1364
|
'oauth'
|
|
1558
1365
|
],
|
|
1559
|
-
'endpoint_path': '/preview/retail-media/
|
|
1560
|
-
'operation_id': '
|
|
1366
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaign-id}/preferred-line-items',
|
|
1367
|
+
'operation_id': 'post_api202110_external_campaign_preferred_line_items_by_campaign_id',
|
|
1561
1368
|
'http_method': 'POST',
|
|
1562
1369
|
'servers': None,
|
|
1563
1370
|
},
|
|
1564
1371
|
params_map={
|
|
1565
1372
|
'all': [
|
|
1566
|
-
'
|
|
1567
|
-
'
|
|
1373
|
+
'campaign_id',
|
|
1374
|
+
'preferred_line_item_create_model_v2_request',
|
|
1568
1375
|
],
|
|
1569
1376
|
'required': [
|
|
1570
|
-
'
|
|
1377
|
+
'campaign_id',
|
|
1378
|
+
'preferred_line_item_create_model_v2_request',
|
|
1571
1379
|
],
|
|
1572
1380
|
'nullable': [
|
|
1573
1381
|
],
|
|
@@ -1582,17 +1390,17 @@ class CampaignApi(object):
|
|
|
1582
1390
|
'allowed_values': {
|
|
1583
1391
|
},
|
|
1584
1392
|
'openapi_types': {
|
|
1585
|
-
'
|
|
1393
|
+
'campaign_id':
|
|
1586
1394
|
(str,),
|
|
1587
|
-
'
|
|
1588
|
-
(
|
|
1395
|
+
'preferred_line_item_create_model_v2_request':
|
|
1396
|
+
(PreferredLineItemCreateModelV2Request,),
|
|
1589
1397
|
},
|
|
1590
1398
|
'attribute_map': {
|
|
1591
|
-
'
|
|
1399
|
+
'campaign_id': 'campaign-id',
|
|
1592
1400
|
},
|
|
1593
1401
|
'location_map': {
|
|
1594
|
-
'
|
|
1595
|
-
'
|
|
1402
|
+
'campaign_id': 'path',
|
|
1403
|
+
'preferred_line_item_create_model_v2_request': 'body',
|
|
1596
1404
|
},
|
|
1597
1405
|
'collection_format_map': {
|
|
1598
1406
|
}
|
|
@@ -1607,25 +1415,25 @@ class CampaignApi(object):
|
|
|
1607
1415
|
},
|
|
1608
1416
|
api_client=api_client
|
|
1609
1417
|
)
|
|
1610
|
-
self.
|
|
1418
|
+
self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint = _Endpoint(
|
|
1611
1419
|
settings={
|
|
1612
|
-
'response_type': (
|
|
1420
|
+
'response_type': (ProductButtonListResponse,),
|
|
1613
1421
|
'auth': [
|
|
1614
1422
|
'oauth',
|
|
1615
1423
|
'oauth'
|
|
1616
1424
|
],
|
|
1617
|
-
'endpoint_path': '/preview/retail-media/
|
|
1618
|
-
'operation_id': '
|
|
1425
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/create',
|
|
1426
|
+
'operation_id': 'post_api202210_external_line_item_product_buttons_create_by_line_item_id',
|
|
1619
1427
|
'http_method': 'POST',
|
|
1620
1428
|
'servers': None,
|
|
1621
1429
|
},
|
|
1622
1430
|
params_map={
|
|
1623
1431
|
'all': [
|
|
1624
|
-
'
|
|
1625
|
-
'
|
|
1432
|
+
'line_item_id',
|
|
1433
|
+
'product_button_list_request',
|
|
1626
1434
|
],
|
|
1627
1435
|
'required': [
|
|
1628
|
-
'
|
|
1436
|
+
'line_item_id',
|
|
1629
1437
|
],
|
|
1630
1438
|
'nullable': [
|
|
1631
1439
|
],
|
|
@@ -1640,17 +1448,17 @@ class CampaignApi(object):
|
|
|
1640
1448
|
'allowed_values': {
|
|
1641
1449
|
},
|
|
1642
1450
|
'openapi_types': {
|
|
1643
|
-
'
|
|
1451
|
+
'line_item_id':
|
|
1644
1452
|
(str,),
|
|
1645
|
-
'
|
|
1646
|
-
(
|
|
1453
|
+
'product_button_list_request':
|
|
1454
|
+
(ProductButtonListRequest,),
|
|
1647
1455
|
},
|
|
1648
1456
|
'attribute_map': {
|
|
1649
|
-
'
|
|
1457
|
+
'line_item_id': 'line-item-id',
|
|
1650
1458
|
},
|
|
1651
1459
|
'location_map': {
|
|
1652
|
-
'
|
|
1653
|
-
'
|
|
1460
|
+
'line_item_id': 'path',
|
|
1461
|
+
'product_button_list_request': 'body',
|
|
1654
1462
|
},
|
|
1655
1463
|
'collection_format_map': {
|
|
1656
1464
|
}
|
|
@@ -1974,27 +1782,26 @@ class CampaignApi(object):
|
|
|
1974
1782
|
},
|
|
1975
1783
|
api_client=api_client
|
|
1976
1784
|
)
|
|
1977
|
-
self.
|
|
1785
|
+
self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
1978
1786
|
settings={
|
|
1979
|
-
'response_type': (
|
|
1787
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1980
1788
|
'auth': [
|
|
1981
1789
|
'oauth',
|
|
1982
1790
|
'oauth'
|
|
1983
1791
|
],
|
|
1984
|
-
'endpoint_path': '/preview/retail-media/
|
|
1985
|
-
'operation_id': '
|
|
1792
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
1793
|
+
'operation_id': 'put_api202110_external_preferred_line_item_by_line_item_id',
|
|
1986
1794
|
'http_method': 'PUT',
|
|
1987
1795
|
'servers': None,
|
|
1988
1796
|
},
|
|
1989
1797
|
params_map={
|
|
1990
1798
|
'all': [
|
|
1991
|
-
'
|
|
1992
|
-
'
|
|
1993
|
-
'creative_update_model202207',
|
|
1799
|
+
'line_item_id',
|
|
1800
|
+
'preferred_line_item_update_model_v2_request',
|
|
1994
1801
|
],
|
|
1995
1802
|
'required': [
|
|
1996
|
-
'
|
|
1997
|
-
'
|
|
1803
|
+
'line_item_id',
|
|
1804
|
+
'preferred_line_item_update_model_v2_request',
|
|
1998
1805
|
],
|
|
1999
1806
|
'nullable': [
|
|
2000
1807
|
],
|
|
@@ -2009,21 +1816,17 @@ class CampaignApi(object):
|
|
|
2009
1816
|
'allowed_values': {
|
|
2010
1817
|
},
|
|
2011
1818
|
'openapi_types': {
|
|
2012
|
-
'
|
|
2013
|
-
(str,),
|
|
2014
|
-
'creative_id':
|
|
1819
|
+
'line_item_id':
|
|
2015
1820
|
(str,),
|
|
2016
|
-
'
|
|
2017
|
-
(
|
|
1821
|
+
'preferred_line_item_update_model_v2_request':
|
|
1822
|
+
(PreferredLineItemUpdateModelV2Request,),
|
|
2018
1823
|
},
|
|
2019
1824
|
'attribute_map': {
|
|
2020
|
-
'
|
|
2021
|
-
'creative_id': 'creative-id',
|
|
1825
|
+
'line_item_id': 'line-item-id',
|
|
2022
1826
|
},
|
|
2023
1827
|
'location_map': {
|
|
2024
|
-
'
|
|
2025
|
-
'
|
|
2026
|
-
'creative_update_model202207': 'body',
|
|
1828
|
+
'line_item_id': 'path',
|
|
1829
|
+
'preferred_line_item_update_model_v2_request': 'body',
|
|
2027
1830
|
},
|
|
2028
1831
|
'collection_format_map': {
|
|
2029
1832
|
}
|
|
@@ -2654,446 +2457,21 @@ class CampaignApi(object):
|
|
|
2654
2457
|
return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
|
|
2655
2458
|
|
|
2656
2459
|
def fetch_proposal(
|
|
2657
|
-
self,
|
|
2658
|
-
id,
|
|
2659
|
-
**kwargs
|
|
2660
|
-
):
|
|
2661
|
-
"""fetch_proposal # noqa: E501
|
|
2662
|
-
|
|
2663
|
-
Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501
|
|
2664
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
2665
|
-
asynchronous HTTP request, please pass async_req=True
|
|
2666
|
-
|
|
2667
|
-
>>> thread = api.fetch_proposal(id, async_req=True)
|
|
2668
|
-
>>> result = thread.get()
|
|
2669
|
-
|
|
2670
|
-
Args:
|
|
2671
|
-
id (str): The external id of a line item.
|
|
2672
|
-
|
|
2673
|
-
Keyword Args:
|
|
2674
|
-
_return_http_data_only (bool): response data without head status
|
|
2675
|
-
code and headers. Default is True.
|
|
2676
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2677
|
-
will be returned without reading/decoding response data.
|
|
2678
|
-
Default is True.
|
|
2679
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2680
|
-
one number provided, it will be total request timeout. It can also
|
|
2681
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
2682
|
-
Default is None.
|
|
2683
|
-
_check_input_type (bool): specifies if type checking
|
|
2684
|
-
should be done one the data sent to the server.
|
|
2685
|
-
Default is True.
|
|
2686
|
-
_check_return_type (bool): specifies if type checking
|
|
2687
|
-
should be done one the data received from the server.
|
|
2688
|
-
Default is True.
|
|
2689
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
2690
|
-
are serialized names, as specified in the OpenAPI document.
|
|
2691
|
-
False if the variable names in the input data
|
|
2692
|
-
are pythonic names, e.g. snake case (default)
|
|
2693
|
-
_content_type (str/None): force body content-type.
|
|
2694
|
-
Default is None and content-type will be predicted by allowed
|
|
2695
|
-
content-types and body.
|
|
2696
|
-
_host_index (int/None): specifies the index of the server
|
|
2697
|
-
that we want to use.
|
|
2698
|
-
Default is read from the configuration.
|
|
2699
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
2700
|
-
request; this effectively ignores the authentication
|
|
2701
|
-
in the spec for a single request.
|
|
2702
|
-
Default is None
|
|
2703
|
-
async_req (bool): execute request asynchronously
|
|
2704
|
-
|
|
2705
|
-
Returns:
|
|
2706
|
-
RetailMediaExternalv1ProposalStatusModelResponse
|
|
2707
|
-
If the method is called asynchronously, returns the request
|
|
2708
|
-
thread.
|
|
2709
|
-
"""
|
|
2710
|
-
kwargs['async_req'] = kwargs.get(
|
|
2711
|
-
'async_req', False
|
|
2712
|
-
)
|
|
2713
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2714
|
-
'_return_http_data_only', True
|
|
2715
|
-
)
|
|
2716
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
2717
|
-
'_preload_content', True
|
|
2718
|
-
)
|
|
2719
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
2720
|
-
'_request_timeout', None
|
|
2721
|
-
)
|
|
2722
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
2723
|
-
'_check_input_type', True
|
|
2724
|
-
)
|
|
2725
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
2726
|
-
'_check_return_type', True
|
|
2727
|
-
)
|
|
2728
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2729
|
-
'_spec_property_naming', False
|
|
2730
|
-
)
|
|
2731
|
-
kwargs['_content_type'] = kwargs.get(
|
|
2732
|
-
'_content_type')
|
|
2733
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2734
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2735
|
-
kwargs['id'] = \
|
|
2736
|
-
id
|
|
2737
|
-
return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
|
|
2738
|
-
|
|
2739
|
-
def get_api202207_external_retailer_by_retailer_id_templatestemplate_id(
|
|
2740
|
-
self,
|
|
2741
|
-
retailer_id,
|
|
2742
|
-
template_id,
|
|
2743
|
-
**kwargs
|
|
2744
|
-
):
|
|
2745
|
-
"""get_api202207_external_retailer_by_retailer_id_templatestemplate_id # noqa: E501
|
|
2746
|
-
|
|
2747
|
-
Gets the template for the specified retailer id and template id # noqa: E501
|
|
2748
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
2749
|
-
asynchronous HTTP request, please pass async_req=True
|
|
2750
|
-
|
|
2751
|
-
>>> thread = api.get_api202207_external_retailer_by_retailer_id_templatestemplate_id(retailer_id, template_id, async_req=True)
|
|
2752
|
-
>>> result = thread.get()
|
|
2753
|
-
|
|
2754
|
-
Args:
|
|
2755
|
-
retailer_id (int): Retailer Id
|
|
2756
|
-
template_id (int): Template Id
|
|
2757
|
-
|
|
2758
|
-
Keyword Args:
|
|
2759
|
-
_return_http_data_only (bool): response data without head status
|
|
2760
|
-
code and headers. Default is True.
|
|
2761
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2762
|
-
will be returned without reading/decoding response data.
|
|
2763
|
-
Default is True.
|
|
2764
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2765
|
-
one number provided, it will be total request timeout. It can also
|
|
2766
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
2767
|
-
Default is None.
|
|
2768
|
-
_check_input_type (bool): specifies if type checking
|
|
2769
|
-
should be done one the data sent to the server.
|
|
2770
|
-
Default is True.
|
|
2771
|
-
_check_return_type (bool): specifies if type checking
|
|
2772
|
-
should be done one the data received from the server.
|
|
2773
|
-
Default is True.
|
|
2774
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
2775
|
-
are serialized names, as specified in the OpenAPI document.
|
|
2776
|
-
False if the variable names in the input data
|
|
2777
|
-
are pythonic names, e.g. snake case (default)
|
|
2778
|
-
_content_type (str/None): force body content-type.
|
|
2779
|
-
Default is None and content-type will be predicted by allowed
|
|
2780
|
-
content-types and body.
|
|
2781
|
-
_host_index (int/None): specifies the index of the server
|
|
2782
|
-
that we want to use.
|
|
2783
|
-
Default is read from the configuration.
|
|
2784
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
2785
|
-
request; this effectively ignores the authentication
|
|
2786
|
-
in the spec for a single request.
|
|
2787
|
-
Default is None
|
|
2788
|
-
async_req (bool): execute request asynchronously
|
|
2789
|
-
|
|
2790
|
-
Returns:
|
|
2791
|
-
TemplateResponse
|
|
2792
|
-
If the method is called asynchronously, returns the request
|
|
2793
|
-
thread.
|
|
2794
|
-
"""
|
|
2795
|
-
kwargs['async_req'] = kwargs.get(
|
|
2796
|
-
'async_req', False
|
|
2797
|
-
)
|
|
2798
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2799
|
-
'_return_http_data_only', True
|
|
2800
|
-
)
|
|
2801
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
2802
|
-
'_preload_content', True
|
|
2803
|
-
)
|
|
2804
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
2805
|
-
'_request_timeout', None
|
|
2806
|
-
)
|
|
2807
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
2808
|
-
'_check_input_type', True
|
|
2809
|
-
)
|
|
2810
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
2811
|
-
'_check_return_type', True
|
|
2812
|
-
)
|
|
2813
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2814
|
-
'_spec_property_naming', False
|
|
2815
|
-
)
|
|
2816
|
-
kwargs['_content_type'] = kwargs.get(
|
|
2817
|
-
'_content_type')
|
|
2818
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2819
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2820
|
-
kwargs['retailer_id'] = \
|
|
2821
|
-
retailer_id
|
|
2822
|
-
kwargs['template_id'] = \
|
|
2823
|
-
template_id
|
|
2824
|
-
return self.get_api202207_external_retailer_by_retailer_id_templatestemplate_id_endpoint.call_with_http_info(**kwargs)
|
|
2825
|
-
|
|
2826
|
-
def get_api202207_external_retailer_templates_by_retailer_id(
|
|
2827
|
-
self,
|
|
2828
|
-
retailer_id,
|
|
2829
|
-
**kwargs
|
|
2830
|
-
):
|
|
2831
|
-
"""get_api202207_external_retailer_templates_by_retailer_id # noqa: E501
|
|
2832
|
-
|
|
2833
|
-
Get retailer creative templates # noqa: E501
|
|
2834
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
2835
|
-
asynchronous HTTP request, please pass async_req=True
|
|
2836
|
-
|
|
2837
|
-
>>> thread = api.get_api202207_external_retailer_templates_by_retailer_id(retailer_id, async_req=True)
|
|
2838
|
-
>>> result = thread.get()
|
|
2839
|
-
|
|
2840
|
-
Args:
|
|
2841
|
-
retailer_id (int): External retailer id to retrieve creative templates for
|
|
2842
|
-
|
|
2843
|
-
Keyword Args:
|
|
2844
|
-
_return_http_data_only (bool): response data without head status
|
|
2845
|
-
code and headers. Default is True.
|
|
2846
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2847
|
-
will be returned without reading/decoding response data.
|
|
2848
|
-
Default is True.
|
|
2849
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2850
|
-
one number provided, it will be total request timeout. It can also
|
|
2851
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
2852
|
-
Default is None.
|
|
2853
|
-
_check_input_type (bool): specifies if type checking
|
|
2854
|
-
should be done one the data sent to the server.
|
|
2855
|
-
Default is True.
|
|
2856
|
-
_check_return_type (bool): specifies if type checking
|
|
2857
|
-
should be done one the data received from the server.
|
|
2858
|
-
Default is True.
|
|
2859
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
2860
|
-
are serialized names, as specified in the OpenAPI document.
|
|
2861
|
-
False if the variable names in the input data
|
|
2862
|
-
are pythonic names, e.g. snake case (default)
|
|
2863
|
-
_content_type (str/None): force body content-type.
|
|
2864
|
-
Default is None and content-type will be predicted by allowed
|
|
2865
|
-
content-types and body.
|
|
2866
|
-
_host_index (int/None): specifies the index of the server
|
|
2867
|
-
that we want to use.
|
|
2868
|
-
Default is read from the configuration.
|
|
2869
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
2870
|
-
request; this effectively ignores the authentication
|
|
2871
|
-
in the spec for a single request.
|
|
2872
|
-
Default is None
|
|
2873
|
-
async_req (bool): execute request asynchronously
|
|
2874
|
-
|
|
2875
|
-
Returns:
|
|
2876
|
-
TemplateListResponse
|
|
2877
|
-
If the method is called asynchronously, returns the request
|
|
2878
|
-
thread.
|
|
2879
|
-
"""
|
|
2880
|
-
kwargs['async_req'] = kwargs.get(
|
|
2881
|
-
'async_req', False
|
|
2882
|
-
)
|
|
2883
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2884
|
-
'_return_http_data_only', True
|
|
2885
|
-
)
|
|
2886
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
2887
|
-
'_preload_content', True
|
|
2888
|
-
)
|
|
2889
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
2890
|
-
'_request_timeout', None
|
|
2891
|
-
)
|
|
2892
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
2893
|
-
'_check_input_type', True
|
|
2894
|
-
)
|
|
2895
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
2896
|
-
'_check_return_type', True
|
|
2897
|
-
)
|
|
2898
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2899
|
-
'_spec_property_naming', False
|
|
2900
|
-
)
|
|
2901
|
-
kwargs['_content_type'] = kwargs.get(
|
|
2902
|
-
'_content_type')
|
|
2903
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2904
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2905
|
-
kwargs['retailer_id'] = \
|
|
2906
|
-
retailer_id
|
|
2907
|
-
return self.get_api202207_external_retailer_templates_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
2908
|
-
|
|
2909
|
-
def get_api202210_external_account_by_account_id_creativescreative_id(
|
|
2910
|
-
self,
|
|
2911
|
-
account_id,
|
|
2912
|
-
creative_id,
|
|
2913
|
-
**kwargs
|
|
2914
|
-
):
|
|
2915
|
-
"""get_api202210_external_account_by_account_id_creativescreative_id # noqa: E501
|
|
2916
|
-
|
|
2917
|
-
Get the specified creative # noqa: E501
|
|
2918
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
2919
|
-
asynchronous HTTP request, please pass async_req=True
|
|
2920
|
-
|
|
2921
|
-
>>> thread = api.get_api202210_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
|
|
2922
|
-
>>> result = thread.get()
|
|
2923
|
-
|
|
2924
|
-
Args:
|
|
2925
|
-
account_id (str): External account id to retrieve creatives for
|
|
2926
|
-
creative_id (str): Creative to get
|
|
2927
|
-
|
|
2928
|
-
Keyword Args:
|
|
2929
|
-
_return_http_data_only (bool): response data without head status
|
|
2930
|
-
code and headers. Default is True.
|
|
2931
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2932
|
-
will be returned without reading/decoding response data.
|
|
2933
|
-
Default is True.
|
|
2934
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2935
|
-
one number provided, it will be total request timeout. It can also
|
|
2936
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
2937
|
-
Default is None.
|
|
2938
|
-
_check_input_type (bool): specifies if type checking
|
|
2939
|
-
should be done one the data sent to the server.
|
|
2940
|
-
Default is True.
|
|
2941
|
-
_check_return_type (bool): specifies if type checking
|
|
2942
|
-
should be done one the data received from the server.
|
|
2943
|
-
Default is True.
|
|
2944
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
2945
|
-
are serialized names, as specified in the OpenAPI document.
|
|
2946
|
-
False if the variable names in the input data
|
|
2947
|
-
are pythonic names, e.g. snake case (default)
|
|
2948
|
-
_content_type (str/None): force body content-type.
|
|
2949
|
-
Default is None and content-type will be predicted by allowed
|
|
2950
|
-
content-types and body.
|
|
2951
|
-
_host_index (int/None): specifies the index of the server
|
|
2952
|
-
that we want to use.
|
|
2953
|
-
Default is read from the configuration.
|
|
2954
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
2955
|
-
request; this effectively ignores the authentication
|
|
2956
|
-
in the spec for a single request.
|
|
2957
|
-
Default is None
|
|
2958
|
-
async_req (bool): execute request asynchronously
|
|
2959
|
-
|
|
2960
|
-
Returns:
|
|
2961
|
-
Creative202210Response
|
|
2962
|
-
If the method is called asynchronously, returns the request
|
|
2963
|
-
thread.
|
|
2964
|
-
"""
|
|
2965
|
-
kwargs['async_req'] = kwargs.get(
|
|
2966
|
-
'async_req', False
|
|
2967
|
-
)
|
|
2968
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2969
|
-
'_return_http_data_only', True
|
|
2970
|
-
)
|
|
2971
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
2972
|
-
'_preload_content', True
|
|
2973
|
-
)
|
|
2974
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
2975
|
-
'_request_timeout', None
|
|
2976
|
-
)
|
|
2977
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
2978
|
-
'_check_input_type', True
|
|
2979
|
-
)
|
|
2980
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
2981
|
-
'_check_return_type', True
|
|
2982
|
-
)
|
|
2983
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2984
|
-
'_spec_property_naming', False
|
|
2985
|
-
)
|
|
2986
|
-
kwargs['_content_type'] = kwargs.get(
|
|
2987
|
-
'_content_type')
|
|
2988
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2989
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2990
|
-
kwargs['account_id'] = \
|
|
2991
|
-
account_id
|
|
2992
|
-
kwargs['creative_id'] = \
|
|
2993
|
-
creative_id
|
|
2994
|
-
return self.get_api202210_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
2995
|
-
|
|
2996
|
-
def get_api202210_external_line_item_product_buttons_by_line_item_id(
|
|
2997
|
-
self,
|
|
2998
|
-
line_item_id,
|
|
2999
|
-
**kwargs
|
|
3000
|
-
):
|
|
3001
|
-
"""get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501
|
|
3002
|
-
|
|
3003
|
-
Get all the product buttons associated with a line item # noqa: E501
|
|
3004
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
3005
|
-
asynchronous HTTP request, please pass async_req=True
|
|
3006
|
-
|
|
3007
|
-
>>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True)
|
|
3008
|
-
>>> result = thread.get()
|
|
3009
|
-
|
|
3010
|
-
Args:
|
|
3011
|
-
line_item_id (str): Long external id of the associated line item
|
|
3012
|
-
|
|
3013
|
-
Keyword Args:
|
|
3014
|
-
_return_http_data_only (bool): response data without head status
|
|
3015
|
-
code and headers. Default is True.
|
|
3016
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3017
|
-
will be returned without reading/decoding response data.
|
|
3018
|
-
Default is True.
|
|
3019
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3020
|
-
one number provided, it will be total request timeout. It can also
|
|
3021
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
3022
|
-
Default is None.
|
|
3023
|
-
_check_input_type (bool): specifies if type checking
|
|
3024
|
-
should be done one the data sent to the server.
|
|
3025
|
-
Default is True.
|
|
3026
|
-
_check_return_type (bool): specifies if type checking
|
|
3027
|
-
should be done one the data received from the server.
|
|
3028
|
-
Default is True.
|
|
3029
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
3030
|
-
are serialized names, as specified in the OpenAPI document.
|
|
3031
|
-
False if the variable names in the input data
|
|
3032
|
-
are pythonic names, e.g. snake case (default)
|
|
3033
|
-
_content_type (str/None): force body content-type.
|
|
3034
|
-
Default is None and content-type will be predicted by allowed
|
|
3035
|
-
content-types and body.
|
|
3036
|
-
_host_index (int/None): specifies the index of the server
|
|
3037
|
-
that we want to use.
|
|
3038
|
-
Default is read from the configuration.
|
|
3039
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
3040
|
-
request; this effectively ignores the authentication
|
|
3041
|
-
in the spec for a single request.
|
|
3042
|
-
Default is None
|
|
3043
|
-
async_req (bool): execute request asynchronously
|
|
3044
|
-
|
|
3045
|
-
Returns:
|
|
3046
|
-
ProductButtonListResponse
|
|
3047
|
-
If the method is called asynchronously, returns the request
|
|
3048
|
-
thread.
|
|
3049
|
-
"""
|
|
3050
|
-
kwargs['async_req'] = kwargs.get(
|
|
3051
|
-
'async_req', False
|
|
3052
|
-
)
|
|
3053
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3054
|
-
'_return_http_data_only', True
|
|
3055
|
-
)
|
|
3056
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
3057
|
-
'_preload_content', True
|
|
3058
|
-
)
|
|
3059
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
3060
|
-
'_request_timeout', None
|
|
3061
|
-
)
|
|
3062
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
3063
|
-
'_check_input_type', True
|
|
3064
|
-
)
|
|
3065
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
3066
|
-
'_check_return_type', True
|
|
3067
|
-
)
|
|
3068
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3069
|
-
'_spec_property_naming', False
|
|
3070
|
-
)
|
|
3071
|
-
kwargs['_content_type'] = kwargs.get(
|
|
3072
|
-
'_content_type')
|
|
3073
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3074
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3075
|
-
kwargs['line_item_id'] = \
|
|
3076
|
-
line_item_id
|
|
3077
|
-
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3078
|
-
|
|
3079
|
-
def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
3080
|
-
self,
|
|
3081
|
-
line_item_id,
|
|
3082
|
-
product_button_id,
|
|
2460
|
+
self,
|
|
2461
|
+
id,
|
|
3083
2462
|
**kwargs
|
|
3084
2463
|
):
|
|
3085
|
-
"""
|
|
2464
|
+
"""fetch_proposal # noqa: E501
|
|
3086
2465
|
|
|
3087
|
-
|
|
2466
|
+
Fetch the status of a proposal to modify a Preferred Deal Line Item. # noqa: E501
|
|
3088
2467
|
This method makes a synchronous HTTP request by default. To make an
|
|
3089
2468
|
asynchronous HTTP request, please pass async_req=True
|
|
3090
2469
|
|
|
3091
|
-
>>> thread = api.
|
|
2470
|
+
>>> thread = api.fetch_proposal(id, async_req=True)
|
|
3092
2471
|
>>> result = thread.get()
|
|
3093
2472
|
|
|
3094
2473
|
Args:
|
|
3095
|
-
|
|
3096
|
-
product_button_id (str): Sequential id of the product button
|
|
2474
|
+
id (str): The external id of a line item.
|
|
3097
2475
|
|
|
3098
2476
|
Keyword Args:
|
|
3099
2477
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3128,7 +2506,7 @@ class CampaignApi(object):
|
|
|
3128
2506
|
async_req (bool): execute request asynchronously
|
|
3129
2507
|
|
|
3130
2508
|
Returns:
|
|
3131
|
-
|
|
2509
|
+
RetailMediaExternalv1ProposalStatusModelResponse
|
|
3132
2510
|
If the method is called asynchronously, returns the request
|
|
3133
2511
|
thread.
|
|
3134
2512
|
"""
|
|
@@ -3157,24 +2535,22 @@ class CampaignApi(object):
|
|
|
3157
2535
|
'_content_type')
|
|
3158
2536
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3159
2537
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3160
|
-
kwargs['
|
|
3161
|
-
|
|
3162
|
-
kwargs
|
|
3163
|
-
product_button_id
|
|
3164
|
-
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
2538
|
+
kwargs['id'] = \
|
|
2539
|
+
id
|
|
2540
|
+
return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
|
|
3165
2541
|
|
|
3166
|
-
def
|
|
2542
|
+
def get_api202210_external_line_item_product_buttons_by_line_item_id(
|
|
3167
2543
|
self,
|
|
3168
2544
|
line_item_id,
|
|
3169
2545
|
**kwargs
|
|
3170
2546
|
):
|
|
3171
|
-
"""
|
|
2547
|
+
"""get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501
|
|
3172
2548
|
|
|
3173
|
-
Get
|
|
2549
|
+
Get all the product buttons associated with a line item # noqa: E501
|
|
3174
2550
|
This method makes a synchronous HTTP request by default. To make an
|
|
3175
2551
|
asynchronous HTTP request, please pass async_req=True
|
|
3176
2552
|
|
|
3177
|
-
>>> thread = api.
|
|
2553
|
+
>>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True)
|
|
3178
2554
|
>>> result = thread.get()
|
|
3179
2555
|
|
|
3180
2556
|
Args:
|
|
@@ -3213,7 +2589,7 @@ class CampaignApi(object):
|
|
|
3213
2589
|
async_req (bool): execute request asynchronously
|
|
3214
2590
|
|
|
3215
2591
|
Returns:
|
|
3216
|
-
|
|
2592
|
+
ProductButtonListResponse
|
|
3217
2593
|
If the method is called asynchronously, returns the request
|
|
3218
2594
|
thread.
|
|
3219
2595
|
"""
|
|
@@ -3244,24 +2620,26 @@ class CampaignApi(object):
|
|
|
3244
2620
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3245
2621
|
kwargs['line_item_id'] = \
|
|
3246
2622
|
line_item_id
|
|
3247
|
-
return self.
|
|
2623
|
+
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3248
2624
|
|
|
3249
|
-
def
|
|
2625
|
+
def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
3250
2626
|
self,
|
|
3251
|
-
|
|
2627
|
+
line_item_id,
|
|
2628
|
+
product_button_id,
|
|
3252
2629
|
**kwargs
|
|
3253
2630
|
):
|
|
3254
|
-
"""
|
|
2631
|
+
"""get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501
|
|
3255
2632
|
|
|
3256
|
-
|
|
2633
|
+
Get a single product button # noqa: E501
|
|
3257
2634
|
This method makes a synchronous HTTP request by default. To make an
|
|
3258
2635
|
asynchronous HTTP request, please pass async_req=True
|
|
3259
2636
|
|
|
3260
|
-
>>> thread = api.
|
|
2637
|
+
>>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
3261
2638
|
>>> result = thread.get()
|
|
3262
2639
|
|
|
3263
2640
|
Args:
|
|
3264
|
-
|
|
2641
|
+
line_item_id (str): Long external id of the associated line item
|
|
2642
|
+
product_button_id (str): Sequential id of the product button
|
|
3265
2643
|
|
|
3266
2644
|
Keyword Args:
|
|
3267
2645
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3296,7 +2674,7 @@ class CampaignApi(object):
|
|
|
3296
2674
|
async_req (bool): execute request asynchronously
|
|
3297
2675
|
|
|
3298
2676
|
Returns:
|
|
3299
|
-
|
|
2677
|
+
ProductButtonListResponse
|
|
3300
2678
|
If the method is called asynchronously, returns the request
|
|
3301
2679
|
thread.
|
|
3302
2680
|
"""
|
|
@@ -3325,26 +2703,28 @@ class CampaignApi(object):
|
|
|
3325
2703
|
'_content_type')
|
|
3326
2704
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3327
2705
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3328
|
-
kwargs['
|
|
3329
|
-
|
|
3330
|
-
|
|
2706
|
+
kwargs['line_item_id'] = \
|
|
2707
|
+
line_item_id
|
|
2708
|
+
kwargs['product_button_id'] = \
|
|
2709
|
+
product_button_id
|
|
2710
|
+
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
3331
2711
|
|
|
3332
|
-
def
|
|
2712
|
+
def get_api202301_external_line_item_bid_multipliers_by_line_item_id(
|
|
3333
2713
|
self,
|
|
3334
|
-
|
|
2714
|
+
line_item_id,
|
|
3335
2715
|
**kwargs
|
|
3336
2716
|
):
|
|
3337
|
-
"""
|
|
2717
|
+
"""get_api202301_external_line_item_bid_multipliers_by_line_item_id # noqa: E501
|
|
3338
2718
|
|
|
3339
|
-
|
|
2719
|
+
Get bid multipliers by line item # noqa: E501
|
|
3340
2720
|
This method makes a synchronous HTTP request by default. To make an
|
|
3341
2721
|
asynchronous HTTP request, please pass async_req=True
|
|
3342
2722
|
|
|
3343
|
-
>>> thread = api.
|
|
2723
|
+
>>> thread = api.get_api202301_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True)
|
|
3344
2724
|
>>> result = thread.get()
|
|
3345
2725
|
|
|
3346
2726
|
Args:
|
|
3347
|
-
|
|
2727
|
+
line_item_id (str): Long external id of the associated line item
|
|
3348
2728
|
|
|
3349
2729
|
Keyword Args:
|
|
3350
2730
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3379,7 +2759,7 @@ class CampaignApi(object):
|
|
|
3379
2759
|
async_req (bool): execute request asynchronously
|
|
3380
2760
|
|
|
3381
2761
|
Returns:
|
|
3382
|
-
|
|
2762
|
+
JsonApiSingleResponseOfLineItemBidMultipliers
|
|
3383
2763
|
If the method is called asynchronously, returns the request
|
|
3384
2764
|
thread.
|
|
3385
2765
|
"""
|
|
@@ -3408,9 +2788,9 @@ class CampaignApi(object):
|
|
|
3408
2788
|
'_content_type')
|
|
3409
2789
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3410
2790
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3411
|
-
kwargs['
|
|
3412
|
-
|
|
3413
|
-
return self.
|
|
2791
|
+
kwargs['line_item_id'] = \
|
|
2792
|
+
line_item_id
|
|
2793
|
+
return self.get_api202301_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3414
2794
|
|
|
3415
2795
|
def get_api_v1_external_account_brands_by_account_id(
|
|
3416
2796
|
self,
|
|
@@ -4004,24 +3384,27 @@ class CampaignApi(object):
|
|
|
4004
3384
|
retailer_id
|
|
4005
3385
|
return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
4006
3386
|
|
|
4007
|
-
def
|
|
3387
|
+
def get_api_v2_external_campaign_preferred_line_items_by_campaign_id(
|
|
4008
3388
|
self,
|
|
4009
3389
|
campaign_id,
|
|
4010
3390
|
**kwargs
|
|
4011
3391
|
):
|
|
4012
|
-
"""
|
|
3392
|
+
"""get_api_v2_external_campaign_preferred_line_items_by_campaign_id # noqa: E501
|
|
4013
3393
|
|
|
4014
|
-
|
|
3394
|
+
Gets page of preferred line item objects for the given campaign id # noqa: E501
|
|
4015
3395
|
This method makes a synchronous HTTP request by default. To make an
|
|
4016
3396
|
asynchronous HTTP request, please pass async_req=True
|
|
4017
3397
|
|
|
4018
|
-
>>> thread = api.
|
|
3398
|
+
>>> thread = api.get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True)
|
|
4019
3399
|
>>> result = thread.get()
|
|
4020
3400
|
|
|
4021
3401
|
Args:
|
|
4022
|
-
campaign_id (
|
|
3402
|
+
campaign_id (str): The given campaign id
|
|
4023
3403
|
|
|
4024
3404
|
Keyword Args:
|
|
3405
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3406
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
3407
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
4025
3408
|
_return_http_data_only (bool): response data without head status
|
|
4026
3409
|
code and headers. Default is True.
|
|
4027
3410
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4054,7 +3437,7 @@ class CampaignApi(object):
|
|
|
4054
3437
|
async_req (bool): execute request asynchronously
|
|
4055
3438
|
|
|
4056
3439
|
Returns:
|
|
4057
|
-
|
|
3440
|
+
PreferredLineItemV2PagedListResponse
|
|
4058
3441
|
If the method is called asynchronously, returns the request
|
|
4059
3442
|
thread.
|
|
4060
3443
|
"""
|
|
@@ -4085,24 +3468,24 @@ class CampaignApi(object):
|
|
|
4085
3468
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4086
3469
|
kwargs['campaign_id'] = \
|
|
4087
3470
|
campaign_id
|
|
4088
|
-
return self.
|
|
3471
|
+
return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
4089
3472
|
|
|
4090
|
-
def
|
|
3473
|
+
def get_api_v2_external_preferred_line_item_by_line_item_id(
|
|
4091
3474
|
self,
|
|
4092
3475
|
line_item_id,
|
|
4093
3476
|
**kwargs
|
|
4094
3477
|
):
|
|
4095
|
-
"""
|
|
3478
|
+
"""get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501
|
|
4096
3479
|
|
|
4097
|
-
Gets
|
|
3480
|
+
Gets the preferred line item for the given line item id # noqa: E501
|
|
4098
3481
|
This method makes a synchronous HTTP request by default. To make an
|
|
4099
3482
|
asynchronous HTTP request, please pass async_req=True
|
|
4100
3483
|
|
|
4101
|
-
>>> thread = api.
|
|
3484
|
+
>>> thread = api.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
|
|
4102
3485
|
>>> result = thread.get()
|
|
4103
3486
|
|
|
4104
3487
|
Args:
|
|
4105
|
-
line_item_id (str): The line item id
|
|
3488
|
+
line_item_id (str): The given line item id
|
|
4106
3489
|
|
|
4107
3490
|
Keyword Args:
|
|
4108
3491
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4137,7 +3520,7 @@ class CampaignApi(object):
|
|
|
4137
3520
|
async_req (bool): execute request asynchronously
|
|
4138
3521
|
|
|
4139
3522
|
Returns:
|
|
4140
|
-
|
|
3523
|
+
PreferredLineItemV2Response
|
|
4141
3524
|
If the method is called asynchronously, returns the request
|
|
4142
3525
|
thread.
|
|
4143
3526
|
"""
|
|
@@ -4168,24 +3551,24 @@ class CampaignApi(object):
|
|
|
4168
3551
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4169
3552
|
kwargs['line_item_id'] = \
|
|
4170
3553
|
line_item_id
|
|
4171
|
-
return self.
|
|
3554
|
+
return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4172
3555
|
|
|
4173
|
-
def
|
|
3556
|
+
def get_campaign_budget_overrides(
|
|
4174
3557
|
self,
|
|
4175
|
-
|
|
3558
|
+
campaign_id,
|
|
4176
3559
|
**kwargs
|
|
4177
3560
|
):
|
|
4178
|
-
"""
|
|
3561
|
+
"""get_campaign_budget_overrides # noqa: E501
|
|
4179
3562
|
|
|
4180
|
-
|
|
3563
|
+
Get current campaign budget overrides by given external campaign id. # noqa: E501
|
|
4181
3564
|
This method makes a synchronous HTTP request by default. To make an
|
|
4182
3565
|
asynchronous HTTP request, please pass async_req=True
|
|
4183
3566
|
|
|
4184
|
-
>>> thread = api.
|
|
3567
|
+
>>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True)
|
|
4185
3568
|
>>> result = thread.get()
|
|
4186
3569
|
|
|
4187
3570
|
Args:
|
|
4188
|
-
|
|
3571
|
+
campaign_id (int): External campaign id.
|
|
4189
3572
|
|
|
4190
3573
|
Keyword Args:
|
|
4191
3574
|
_return_http_data_only (bool): response data without head status
|
|
@@ -4220,7 +3603,7 @@ class CampaignApi(object):
|
|
|
4220
3603
|
async_req (bool): execute request asynchronously
|
|
4221
3604
|
|
|
4222
3605
|
Returns:
|
|
4223
|
-
|
|
3606
|
+
ValueResourceOutcomeOfCampaignBudgetOverrides
|
|
4224
3607
|
If the method is called asynchronously, returns the request
|
|
4225
3608
|
thread.
|
|
4226
3609
|
"""
|
|
@@ -4249,33 +3632,31 @@ class CampaignApi(object):
|
|
|
4249
3632
|
'_content_type')
|
|
4250
3633
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4251
3634
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4252
|
-
kwargs['
|
|
4253
|
-
|
|
4254
|
-
return self.
|
|
3635
|
+
kwargs['campaign_id'] = \
|
|
3636
|
+
campaign_id
|
|
3637
|
+
return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs)
|
|
4255
3638
|
|
|
4256
|
-
def
|
|
3639
|
+
def get_insertion_order_history_change_data_capture(
|
|
4257
3640
|
self,
|
|
4258
|
-
|
|
4259
|
-
retailer_id,
|
|
3641
|
+
insertion_order_id,
|
|
4260
3642
|
**kwargs
|
|
4261
3643
|
):
|
|
4262
|
-
"""
|
|
3644
|
+
"""get_insertion_order_history_change_data_capture # noqa: E501
|
|
4263
3645
|
|
|
4264
|
-
Gets
|
|
3646
|
+
Gets the balance's historical data change capture. # noqa: E501
|
|
4265
3647
|
This method makes a synchronous HTTP request by default. To make an
|
|
4266
3648
|
asynchronous HTTP request, please pass async_req=True
|
|
4267
3649
|
|
|
4268
|
-
>>> thread = api.
|
|
3650
|
+
>>> thread = api.get_insertion_order_history_change_data_capture(insertion_order_id, async_req=True)
|
|
4269
3651
|
>>> result = thread.get()
|
|
4270
3652
|
|
|
4271
3653
|
Args:
|
|
4272
|
-
|
|
4273
|
-
retailer_id (int): retailer id
|
|
3654
|
+
insertion_order_id (str): External insertion order id.
|
|
4274
3655
|
|
|
4275
3656
|
Keyword Args:
|
|
4276
|
-
offset (int):
|
|
4277
|
-
limit (int):
|
|
4278
|
-
|
|
3657
|
+
offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
|
|
3658
|
+
limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
|
|
3659
|
+
limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
|
|
4279
3660
|
_return_http_data_only (bool): response data without head status
|
|
4280
3661
|
code and headers. Default is True.
|
|
4281
3662
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4308,7 +3689,7 @@ class CampaignApi(object):
|
|
|
4308
3689
|
async_req (bool): execute request asynchronously
|
|
4309
3690
|
|
|
4310
3691
|
Returns:
|
|
4311
|
-
|
|
3692
|
+
PageOfInsertionOrderHistoryChangeDataCapture
|
|
4312
3693
|
If the method is called asynchronously, returns the request
|
|
4313
3694
|
thread.
|
|
4314
3695
|
"""
|
|
@@ -4337,31 +3718,28 @@ class CampaignApi(object):
|
|
|
4337
3718
|
'_content_type')
|
|
4338
3719
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4339
3720
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4340
|
-
kwargs['
|
|
4341
|
-
|
|
4342
|
-
kwargs
|
|
4343
|
-
retailer_id
|
|
4344
|
-
return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs)
|
|
3721
|
+
kwargs['insertion_order_id'] = \
|
|
3722
|
+
insertion_order_id
|
|
3723
|
+
return self.get_insertion_order_history_change_data_capture_endpoint.call_with_http_info(**kwargs)
|
|
4345
3724
|
|
|
4346
|
-
def
|
|
3725
|
+
def get_line_item_budget_overrides(
|
|
4347
3726
|
self,
|
|
4348
|
-
|
|
3727
|
+
line_item_id,
|
|
4349
3728
|
**kwargs
|
|
4350
3729
|
):
|
|
4351
|
-
"""
|
|
3730
|
+
"""get_line_item_budget_overrides # noqa: E501
|
|
4352
3731
|
|
|
4353
|
-
|
|
3732
|
+
Gets a collection of monthly and daily budget overrides for the provided line item. # noqa: E501
|
|
4354
3733
|
This method makes a synchronous HTTP request by default. To make an
|
|
4355
3734
|
asynchronous HTTP request, please pass async_req=True
|
|
4356
3735
|
|
|
4357
|
-
>>> thread = api.
|
|
3736
|
+
>>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True)
|
|
4358
3737
|
>>> result = thread.get()
|
|
4359
3738
|
|
|
4360
3739
|
Args:
|
|
4361
|
-
|
|
3740
|
+
line_item_id (str): The line item id to get budget overrides for.
|
|
4362
3741
|
|
|
4363
3742
|
Keyword Args:
|
|
4364
|
-
creative_create_model202207 (CreativeCreateModel202207): The creative to create. [optional]
|
|
4365
3743
|
_return_http_data_only (bool): response data without head status
|
|
4366
3744
|
code and headers. Default is True.
|
|
4367
3745
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4394,7 +3772,7 @@ class CampaignApi(object):
|
|
|
4394
3772
|
async_req (bool): execute request asynchronously
|
|
4395
3773
|
|
|
4396
3774
|
Returns:
|
|
4397
|
-
|
|
3775
|
+
ValueResourceOutcomeOfLineItemBudgetOverrides
|
|
4398
3776
|
If the method is called asynchronously, returns the request
|
|
4399
3777
|
thread.
|
|
4400
3778
|
"""
|
|
@@ -4423,29 +3801,116 @@ class CampaignApi(object):
|
|
|
4423
3801
|
'_content_type')
|
|
4424
3802
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4425
3803
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4426
|
-
kwargs['
|
|
4427
|
-
|
|
4428
|
-
return self.
|
|
3804
|
+
kwargs['line_item_id'] = \
|
|
3805
|
+
line_item_id
|
|
3806
|
+
return self.get_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs)
|
|
3807
|
+
|
|
3808
|
+
def get_recommended_keywords(
|
|
3809
|
+
self,
|
|
3810
|
+
external_line_item_id,
|
|
3811
|
+
**kwargs
|
|
3812
|
+
):
|
|
3813
|
+
"""get_recommended_keywords # noqa: E501
|
|
3814
|
+
|
|
3815
|
+
Retrieves a collection of recommended keywords for a line item # noqa: E501
|
|
3816
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3817
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3818
|
+
|
|
3819
|
+
>>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True)
|
|
3820
|
+
>>> result = thread.get()
|
|
3821
|
+
|
|
3822
|
+
Args:
|
|
3823
|
+
external_line_item_id (str): The external line item identifier
|
|
3824
|
+
|
|
3825
|
+
Keyword Args:
|
|
3826
|
+
_return_http_data_only (bool): response data without head status
|
|
3827
|
+
code and headers. Default is True.
|
|
3828
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3829
|
+
will be returned without reading/decoding response data.
|
|
3830
|
+
Default is True.
|
|
3831
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3832
|
+
one number provided, it will be total request timeout. It can also
|
|
3833
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3834
|
+
Default is None.
|
|
3835
|
+
_check_input_type (bool): specifies if type checking
|
|
3836
|
+
should be done one the data sent to the server.
|
|
3837
|
+
Default is True.
|
|
3838
|
+
_check_return_type (bool): specifies if type checking
|
|
3839
|
+
should be done one the data received from the server.
|
|
3840
|
+
Default is True.
|
|
3841
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3842
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3843
|
+
False if the variable names in the input data
|
|
3844
|
+
are pythonic names, e.g. snake case (default)
|
|
3845
|
+
_content_type (str/None): force body content-type.
|
|
3846
|
+
Default is None and content-type will be predicted by allowed
|
|
3847
|
+
content-types and body.
|
|
3848
|
+
_host_index (int/None): specifies the index of the server
|
|
3849
|
+
that we want to use.
|
|
3850
|
+
Default is read from the configuration.
|
|
3851
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3852
|
+
request; this effectively ignores the authentication
|
|
3853
|
+
in the spec for a single request.
|
|
3854
|
+
Default is None
|
|
3855
|
+
async_req (bool): execute request asynchronously
|
|
3856
|
+
|
|
3857
|
+
Returns:
|
|
3858
|
+
ValueResourceOutcomeOfRecommendedKeywordsResult
|
|
3859
|
+
If the method is called asynchronously, returns the request
|
|
3860
|
+
thread.
|
|
3861
|
+
"""
|
|
3862
|
+
kwargs['async_req'] = kwargs.get(
|
|
3863
|
+
'async_req', False
|
|
3864
|
+
)
|
|
3865
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3866
|
+
'_return_http_data_only', True
|
|
3867
|
+
)
|
|
3868
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3869
|
+
'_preload_content', True
|
|
3870
|
+
)
|
|
3871
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3872
|
+
'_request_timeout', None
|
|
3873
|
+
)
|
|
3874
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3875
|
+
'_check_input_type', True
|
|
3876
|
+
)
|
|
3877
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3878
|
+
'_check_return_type', True
|
|
3879
|
+
)
|
|
3880
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3881
|
+
'_spec_property_naming', False
|
|
3882
|
+
)
|
|
3883
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3884
|
+
'_content_type')
|
|
3885
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3886
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3887
|
+
kwargs['external_line_item_id'] = \
|
|
3888
|
+
external_line_item_id
|
|
3889
|
+
return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs)
|
|
4429
3890
|
|
|
4430
|
-
def
|
|
3891
|
+
def get_sku_by_product_id(
|
|
4431
3892
|
self,
|
|
4432
3893
|
account_id,
|
|
3894
|
+
retailer_id,
|
|
4433
3895
|
**kwargs
|
|
4434
3896
|
):
|
|
4435
|
-
"""
|
|
3897
|
+
"""get_sku_by_product_id # noqa: E501
|
|
4436
3898
|
|
|
4437
|
-
|
|
3899
|
+
Gets a list of SKUs based on a privided list of Product Ids # noqa: E501
|
|
4438
3900
|
This method makes a synchronous HTTP request by default. To make an
|
|
4439
3901
|
asynchronous HTTP request, please pass async_req=True
|
|
4440
3902
|
|
|
4441
|
-
>>> thread = api.
|
|
3903
|
+
>>> thread = api.get_sku_by_product_id(account_id, retailer_id, async_req=True)
|
|
4442
3904
|
>>> result = thread.get()
|
|
4443
3905
|
|
|
4444
3906
|
Args:
|
|
4445
|
-
account_id (str):
|
|
3907
|
+
account_id (str): account id
|
|
3908
|
+
retailer_id (int): retailer id
|
|
4446
3909
|
|
|
4447
3910
|
Keyword Args:
|
|
4448
|
-
|
|
3911
|
+
offset (int): skip a number of matches before retrning results, used with limit. [optional] if omitted the server will use the default value of 0
|
|
3912
|
+
limit (int): max number of results to return. [optional] if omitted the server will use the default value of 100
|
|
3913
|
+
sku_search_request (SkuSearchRequest): . [optional]
|
|
4449
3914
|
_return_http_data_only (bool): response data without head status
|
|
4450
3915
|
code and headers. Default is True.
|
|
4451
3916
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4478,7 +3943,7 @@ class CampaignApi(object):
|
|
|
4478
3943
|
async_req (bool): execute request asynchronously
|
|
4479
3944
|
|
|
4480
3945
|
Returns:
|
|
4481
|
-
|
|
3946
|
+
ResourceCollectionOutcomeOfSkuSearchResult
|
|
4482
3947
|
If the method is called asynchronously, returns the request
|
|
4483
3948
|
thread.
|
|
4484
3949
|
"""
|
|
@@ -4509,27 +3974,30 @@ class CampaignApi(object):
|
|
|
4509
3974
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4510
3975
|
kwargs['account_id'] = \
|
|
4511
3976
|
account_id
|
|
4512
|
-
|
|
3977
|
+
kwargs['retailer_id'] = \
|
|
3978
|
+
retailer_id
|
|
3979
|
+
return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs)
|
|
4513
3980
|
|
|
4514
|
-
def
|
|
3981
|
+
def post_api202110_external_campaign_preferred_line_items_by_campaign_id(
|
|
4515
3982
|
self,
|
|
4516
|
-
|
|
3983
|
+
campaign_id,
|
|
3984
|
+
preferred_line_item_create_model_v2_request,
|
|
4517
3985
|
**kwargs
|
|
4518
3986
|
):
|
|
4519
|
-
"""
|
|
3987
|
+
"""post_api202110_external_campaign_preferred_line_items_by_campaign_id # noqa: E501
|
|
4520
3988
|
|
|
4521
|
-
|
|
3989
|
+
Creates a new preferred line item with the specified settings # noqa: E501
|
|
4522
3990
|
This method makes a synchronous HTTP request by default. To make an
|
|
4523
3991
|
asynchronous HTTP request, please pass async_req=True
|
|
4524
3992
|
|
|
4525
|
-
>>> thread = api.
|
|
3993
|
+
>>> thread = api.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request, async_req=True)
|
|
4526
3994
|
>>> result = thread.get()
|
|
4527
3995
|
|
|
4528
3996
|
Args:
|
|
4529
|
-
|
|
3997
|
+
campaign_id (str): The given campaign id
|
|
3998
|
+
preferred_line_item_create_model_v2_request (PreferredLineItemCreateModelV2Request): The line item settings to create a line item with
|
|
4530
3999
|
|
|
4531
4000
|
Keyword Args:
|
|
4532
|
-
product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional]
|
|
4533
4001
|
_return_http_data_only (bool): response data without head status
|
|
4534
4002
|
code and headers. Default is True.
|
|
4535
4003
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4562,7 +4030,7 @@ class CampaignApi(object):
|
|
|
4562
4030
|
async_req (bool): execute request asynchronously
|
|
4563
4031
|
|
|
4564
4032
|
Returns:
|
|
4565
|
-
|
|
4033
|
+
PreferredLineItemV2Response
|
|
4566
4034
|
If the method is called asynchronously, returns the request
|
|
4567
4035
|
thread.
|
|
4568
4036
|
"""
|
|
@@ -4591,29 +4059,31 @@ class CampaignApi(object):
|
|
|
4591
4059
|
'_content_type')
|
|
4592
4060
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4593
4061
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4594
|
-
kwargs['
|
|
4595
|
-
|
|
4596
|
-
|
|
4062
|
+
kwargs['campaign_id'] = \
|
|
4063
|
+
campaign_id
|
|
4064
|
+
kwargs['preferred_line_item_create_model_v2_request'] = \
|
|
4065
|
+
preferred_line_item_create_model_v2_request
|
|
4066
|
+
return self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
4597
4067
|
|
|
4598
|
-
def
|
|
4068
|
+
def post_api202210_external_line_item_product_buttons_create_by_line_item_id(
|
|
4599
4069
|
self,
|
|
4600
|
-
|
|
4070
|
+
line_item_id,
|
|
4601
4071
|
**kwargs
|
|
4602
4072
|
):
|
|
4603
|
-
"""
|
|
4073
|
+
"""post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501
|
|
4604
4074
|
|
|
4605
|
-
|
|
4075
|
+
Append new product buttons to a line item # noqa: E501
|
|
4606
4076
|
This method makes a synchronous HTTP request by default. To make an
|
|
4607
4077
|
asynchronous HTTP request, please pass async_req=True
|
|
4608
4078
|
|
|
4609
|
-
>>> thread = api.
|
|
4079
|
+
>>> thread = api.post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_id, async_req=True)
|
|
4610
4080
|
>>> result = thread.get()
|
|
4611
4081
|
|
|
4612
4082
|
Args:
|
|
4613
|
-
|
|
4083
|
+
line_item_id (str): Long external id of the associated line item
|
|
4614
4084
|
|
|
4615
4085
|
Keyword Args:
|
|
4616
|
-
|
|
4086
|
+
product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional]
|
|
4617
4087
|
_return_http_data_only (bool): response data without head status
|
|
4618
4088
|
code and headers. Default is True.
|
|
4619
4089
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4646,7 +4116,7 @@ class CampaignApi(object):
|
|
|
4646
4116
|
async_req (bool): execute request asynchronously
|
|
4647
4117
|
|
|
4648
4118
|
Returns:
|
|
4649
|
-
|
|
4119
|
+
ProductButtonListResponse
|
|
4650
4120
|
If the method is called asynchronously, returns the request
|
|
4651
4121
|
thread.
|
|
4652
4122
|
"""
|
|
@@ -4675,9 +4145,9 @@ class CampaignApi(object):
|
|
|
4675
4145
|
'_content_type')
|
|
4676
4146
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4677
4147
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4678
|
-
kwargs['
|
|
4679
|
-
|
|
4680
|
-
return self.
|
|
4148
|
+
kwargs['line_item_id'] = \
|
|
4149
|
+
line_item_id
|
|
4150
|
+
return self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4681
4151
|
|
|
4682
4152
|
def post_api_v1_external_catalogs_sku_retrieval(
|
|
4683
4153
|
self,
|
|
@@ -5018,27 +4488,26 @@ class CampaignApi(object):
|
|
|
5018
4488
|
retailer_id
|
|
5019
4489
|
return self.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
5020
4490
|
|
|
5021
|
-
def
|
|
4491
|
+
def put_api202110_external_preferred_line_item_by_line_item_id(
|
|
5022
4492
|
self,
|
|
5023
|
-
|
|
5024
|
-
|
|
4493
|
+
line_item_id,
|
|
4494
|
+
preferred_line_item_update_model_v2_request,
|
|
5025
4495
|
**kwargs
|
|
5026
4496
|
):
|
|
5027
|
-
"""
|
|
4497
|
+
"""put_api202110_external_preferred_line_item_by_line_item_id # noqa: E501
|
|
5028
4498
|
|
|
5029
|
-
|
|
4499
|
+
Updates the preferred line item for the given line item id # noqa: E501
|
|
5030
4500
|
This method makes a synchronous HTTP request by default. To make an
|
|
5031
4501
|
asynchronous HTTP request, please pass async_req=True
|
|
5032
4502
|
|
|
5033
|
-
>>> thread = api.
|
|
4503
|
+
>>> thread = api.put_api202110_external_preferred_line_item_by_line_item_id(line_item_id, preferred_line_item_update_model_v2_request, async_req=True)
|
|
5034
4504
|
>>> result = thread.get()
|
|
5035
4505
|
|
|
5036
4506
|
Args:
|
|
5037
|
-
|
|
5038
|
-
|
|
4507
|
+
line_item_id (str): The given line item id
|
|
4508
|
+
preferred_line_item_update_model_v2_request (PreferredLineItemUpdateModelV2Request): The line item settings to create a line item with
|
|
5039
4509
|
|
|
5040
4510
|
Keyword Args:
|
|
5041
|
-
creative_update_model202207 (CreativeUpdateModel202207): The creative to create. [optional]
|
|
5042
4511
|
_return_http_data_only (bool): response data without head status
|
|
5043
4512
|
code and headers. Default is True.
|
|
5044
4513
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -5071,7 +4540,7 @@ class CampaignApi(object):
|
|
|
5071
4540
|
async_req (bool): execute request asynchronously
|
|
5072
4541
|
|
|
5073
4542
|
Returns:
|
|
5074
|
-
|
|
4543
|
+
PreferredLineItemV2Response
|
|
5075
4544
|
If the method is called asynchronously, returns the request
|
|
5076
4545
|
thread.
|
|
5077
4546
|
"""
|
|
@@ -5100,11 +4569,11 @@ class CampaignApi(object):
|
|
|
5100
4569
|
'_content_type')
|
|
5101
4570
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
5102
4571
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
5103
|
-
kwargs['
|
|
5104
|
-
|
|
5105
|
-
kwargs['
|
|
5106
|
-
|
|
5107
|
-
return self.
|
|
4572
|
+
kwargs['line_item_id'] = \
|
|
4573
|
+
line_item_id
|
|
4574
|
+
kwargs['preferred_line_item_update_model_v2_request'] = \
|
|
4575
|
+
preferred_line_item_update_model_v2_request
|
|
4576
|
+
return self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
5108
4577
|
|
|
5109
4578
|
def put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
5110
4579
|
self,
|