criteo-api-retailmedia-sdk 0.0.240404__py3-none-any.whl → 0.0.240515__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.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/audience_api.py +284 -0
- criteo_api_retailmedia_preview/api/campaign_api.py +1755 -448
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
- criteo_api_retailmedia_preview/model/add_remove_keywords_model.py +262 -0
- criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py +262 -0
- criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py +270 -0
- criteo_api_retailmedia_preview/model/approval_status_model.py +292 -0
- criteo_api_retailmedia_preview/model/async_accounts_report.py +39 -27
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +24 -13
- criteo_api_retailmedia_preview/model/async_line_items_report.py +24 -13
- criteo_api_retailmedia_preview/model/audience_error.py +310 -0
- criteo_api_retailmedia_preview/model/audience_warning.py +312 -0
- criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_response.py → creative_v2_list_response.py} +16 -16
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_resource_outcome.py → creative_v2_response.py} +19 -17
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_request.py → error_code_response.py} +23 -11
- criteo_api_retailmedia_preview/model/external_choice_variable_value.py +269 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model.py → external_color_variable_value.py} +11 -14
- criteo_api_retailmedia_preview/model/external_creative_create_model_v2.py +297 -0
- criteo_api_retailmedia_preview/model/external_creative_update_model_v2.py +297 -0
- criteo_api_retailmedia_preview/model/external_creative_v2.py +361 -0
- criteo_api_retailmedia_preview/model/external_files_variable_value.py +272 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_request.py → external_hyperlink_variable_value.py} +7 -13
- criteo_api_retailmedia_preview/model/{line_item_bid_multipliers.py → external_line_item_bid_multipliers_v2.py} +41 -29
- criteo_api_retailmedia_preview/model/external_page_type_environment.py +293 -0
- criteo_api_retailmedia_preview/model/external_template_variable_value.py +309 -0
- criteo_api_retailmedia_preview/model/external_text_variable_value.py +263 -0
- criteo_api_retailmedia_preview/model/external_video_variable_value.py +293 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
- criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py → json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py} +8 -8
- criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers.py → json_api_single_response_of_line_item_bid_multipliers_v2.py} +14 -14
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
- criteo_api_retailmedia_preview/model/keywords_model_resource.py +270 -0
- criteo_api_retailmedia_preview/model/keywords_model_response.py +274 -0
- criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_request.py → line_item_bid_multipliers_v2_request.py} +8 -8
- criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +281 -0
- criteo_api_retailmedia_preview/model/line_item_product_status.py +291 -0
- criteo_api_retailmedia_preview/model/match_type_model.py +291 -0
- criteo_api_retailmedia_preview/model/negotiation_state_model.py +293 -0
- criteo_api_retailmedia_preview/model/product_metadata.py +269 -0
- criteo_api_retailmedia_preview/model/product_resource_outcome.py +266 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model.py → promoted_product.py} +18 -19
- criteo_api_retailmedia_preview/model/promoted_product_resource.py +270 -0
- criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +262 -0
- criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +278 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
- criteo_api_retailmedia_preview/model/proposal_status_model_resource.py +270 -0
- criteo_api_retailmedia_preview/model/proposal_status_model_response.py +274 -0
- criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers.py → resource_of_creative_v2.py} +8 -8
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_resource.py → resource_of_line_item_bid_multipliers_v2.py} +17 -23
- criteo_api_retailmedia_preview/model/resource_outcome.py +268 -0
- criteo_api_retailmedia_preview/model/retail_media_account.py +6 -6
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_resource.py → retail_media_contactlist_amendment.py} +16 -20
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → retail_media_contactlist_amendment_attributes.py} +34 -25
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py +275 -0
- criteo_api_retailmedia_preview/model/retail_media_contactlist_operation.py +291 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_proposal_status_model_resource.py → retail_media_contactlist_operation_response_attributes.py} +14 -16
- criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py +297 -0
- criteo_api_retailmedia_preview/model/review_state_model.py +294 -0
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
- criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
- criteo_api_retailmedia_preview/model/set_bids_model.py +262 -0
- criteo_api_retailmedia_preview/model/set_bids_model_request.py +262 -0
- criteo_api_retailmedia_preview/model/set_bids_model_resource.py +270 -0
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +12 -10
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +24 -13
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +24 -13
- criteo_api_retailmedia_preview/models/__init__.py +58 -24
- {criteo_api_retailmedia_sdk-0.0.240404.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.240404.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/RECORD +75 -41
- criteo_api_retailmedia_preview/model/retail_media_externalv1_keywords_model_response.py +0 -285
- criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
- {criteo_api_retailmedia_sdk-0.0.240404.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.240404.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/top_level.txt +0 -0
|
@@ -21,14 +21,20 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
|
|
|
21
21
|
none_type,
|
|
22
22
|
validate_and_convert_types
|
|
23
23
|
)
|
|
24
|
+
from criteo_api_retailmedia_preview.model.add_remove_keywords_model_request import AddRemoveKeywordsModelRequest
|
|
24
25
|
from criteo_api_retailmedia_preview.model.brand_preview_list_response import BrandPreviewListResponse
|
|
25
26
|
from criteo_api_retailmedia_preview.model.cpc_rate_card_preview_response import CpcRateCardPreviewResponse
|
|
27
|
+
from criteo_api_retailmedia_preview.model.creative_v2_list_response import CreativeV2ListResponse
|
|
28
|
+
from criteo_api_retailmedia_preview.model.creative_v2_response import CreativeV2Response
|
|
29
|
+
from criteo_api_retailmedia_preview.model.external_creative_create_model_v2 import ExternalCreativeCreateModelV2
|
|
30
|
+
from criteo_api_retailmedia_preview.model.external_creative_update_model_v2 import ExternalCreativeUpdateModelV2
|
|
26
31
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_account import JsonApiPageResponseOfAccount
|
|
27
32
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand
|
|
28
33
|
from criteo_api_retailmedia_preview.model.json_api_page_response_of_retailer import JsonApiPageResponseOfRetailer
|
|
29
|
-
from criteo_api_retailmedia_preview.model.
|
|
30
|
-
from criteo_api_retailmedia_preview.model.
|
|
31
|
-
from criteo_api_retailmedia_preview.model.
|
|
34
|
+
from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2
|
|
35
|
+
from criteo_api_retailmedia_preview.model.keywords_model_response import KeywordsModelResponse
|
|
36
|
+
from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_request import LineItemBidMultipliersV2Request
|
|
37
|
+
from criteo_api_retailmedia_preview.model.line_item_bid_multipliers_v2_response import LineItemBidMultipliersV2Response
|
|
32
38
|
from criteo_api_retailmedia_preview.model.page_of_insertion_order_history_change_data_capture import PageOfInsertionOrderHistoryChangeDataCapture
|
|
33
39
|
from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse
|
|
34
40
|
from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request
|
|
@@ -38,13 +44,14 @@ from criteo_api_retailmedia_preview.model.preferred_line_item_v2_response import
|
|
|
38
44
|
from criteo_api_retailmedia_preview.model.product_button_list_request import ProductButtonListRequest
|
|
39
45
|
from criteo_api_retailmedia_preview.model.product_button_list_response import ProductButtonListResponse
|
|
40
46
|
from criteo_api_retailmedia_preview.model.product_button_request import ProductButtonRequest
|
|
47
|
+
from criteo_api_retailmedia_preview.model.product_resource_outcome import ProductResourceOutcome
|
|
48
|
+
from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput
|
|
49
|
+
from criteo_api_retailmedia_preview.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome
|
|
50
|
+
from criteo_api_retailmedia_preview.model.proposal_status_model_response import ProposalStatusModelResponse
|
|
41
51
|
from criteo_api_retailmedia_preview.model.resource_collection_outcome_of_sku_search_result import ResourceCollectionOutcomeOfSkuSearchResult
|
|
42
|
-
from criteo_api_retailmedia_preview.model.
|
|
43
|
-
from criteo_api_retailmedia_preview.model.retail_media_externalv1_keywords_model_response import RetailMediaExternalv1KeywordsModelResponse
|
|
44
|
-
from criteo_api_retailmedia_preview.model.retail_media_externalv1_proposal_status_model_response import RetailMediaExternalv1ProposalStatusModelResponse
|
|
45
|
-
from criteo_api_retailmedia_preview.model.retail_media_externalv1_resource_outcome import RetailMediaExternalv1ResourceOutcome
|
|
46
|
-
from criteo_api_retailmedia_preview.model.retail_media_externalv1_set_bids_model_request import RetailMediaExternalv1SetBidsModelRequest
|
|
52
|
+
from criteo_api_retailmedia_preview.model.resource_outcome import ResourceOutcome
|
|
47
53
|
from criteo_api_retailmedia_preview.model.seller_preview_response import SellerPreviewResponse
|
|
54
|
+
from criteo_api_retailmedia_preview.model.set_bids_model_request import SetBidsModelRequest
|
|
48
55
|
from criteo_api_retailmedia_preview.model.sku_data_preview_list_response import SkuDataPreviewListResponse
|
|
49
56
|
from criteo_api_retailmedia_preview.model.sku_search_request import SkuSearchRequest
|
|
50
57
|
from criteo_api_retailmedia_preview.model.sku_search_request_preview_request import SkuSearchRequestPreviewRequest
|
|
@@ -72,7 +79,7 @@ class CampaignApi(object):
|
|
|
72
79
|
self.api_client = api_client
|
|
73
80
|
self.add_remove_keywords_endpoint = _Endpoint(
|
|
74
81
|
settings={
|
|
75
|
-
'response_type': (
|
|
82
|
+
'response_type': (ResourceOutcome,),
|
|
76
83
|
'auth': [
|
|
77
84
|
'oauth',
|
|
78
85
|
'oauth'
|
|
@@ -85,7 +92,7 @@ class CampaignApi(object):
|
|
|
85
92
|
params_map={
|
|
86
93
|
'all': [
|
|
87
94
|
'id',
|
|
88
|
-
'
|
|
95
|
+
'add_remove_keywords_model_request',
|
|
89
96
|
],
|
|
90
97
|
'required': [
|
|
91
98
|
'id',
|
|
@@ -105,24 +112,80 @@ class CampaignApi(object):
|
|
|
105
112
|
'openapi_types': {
|
|
106
113
|
'id':
|
|
107
114
|
(str,),
|
|
108
|
-
'
|
|
109
|
-
(
|
|
115
|
+
'add_remove_keywords_model_request':
|
|
116
|
+
(AddRemoveKeywordsModelRequest,),
|
|
110
117
|
},
|
|
111
118
|
'attribute_map': {
|
|
112
119
|
'id': 'id',
|
|
113
120
|
},
|
|
114
121
|
'location_map': {
|
|
115
122
|
'id': 'path',
|
|
116
|
-
'
|
|
123
|
+
'add_remove_keywords_model_request': 'body',
|
|
117
124
|
},
|
|
118
125
|
'collection_format_map': {
|
|
119
126
|
}
|
|
120
127
|
},
|
|
121
128
|
headers_map={
|
|
122
129
|
'accept': [
|
|
123
|
-
'
|
|
124
|
-
|
|
125
|
-
|
|
130
|
+
'application/json'
|
|
131
|
+
],
|
|
132
|
+
'content_type': [
|
|
133
|
+
'application/json'
|
|
134
|
+
]
|
|
135
|
+
},
|
|
136
|
+
api_client=api_client
|
|
137
|
+
)
|
|
138
|
+
self.append_promoted_products_endpoint = _Endpoint(
|
|
139
|
+
settings={
|
|
140
|
+
'response_type': None,
|
|
141
|
+
'auth': [
|
|
142
|
+
'oauth',
|
|
143
|
+
'oauth'
|
|
144
|
+
],
|
|
145
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/append',
|
|
146
|
+
'operation_id': 'append_promoted_products',
|
|
147
|
+
'http_method': 'POST',
|
|
148
|
+
'servers': None,
|
|
149
|
+
},
|
|
150
|
+
params_map={
|
|
151
|
+
'all': [
|
|
152
|
+
'line_item_id',
|
|
153
|
+
'promoted_product_resource_collection_input',
|
|
154
|
+
],
|
|
155
|
+
'required': [
|
|
156
|
+
'line_item_id',
|
|
157
|
+
],
|
|
158
|
+
'nullable': [
|
|
159
|
+
],
|
|
160
|
+
'enum': [
|
|
161
|
+
],
|
|
162
|
+
'validation': [
|
|
163
|
+
]
|
|
164
|
+
},
|
|
165
|
+
root_map={
|
|
166
|
+
'validations': {
|
|
167
|
+
},
|
|
168
|
+
'allowed_values': {
|
|
169
|
+
},
|
|
170
|
+
'openapi_types': {
|
|
171
|
+
'line_item_id':
|
|
172
|
+
(str,),
|
|
173
|
+
'promoted_product_resource_collection_input':
|
|
174
|
+
(PromotedProductResourceCollectionInput,),
|
|
175
|
+
},
|
|
176
|
+
'attribute_map': {
|
|
177
|
+
'line_item_id': 'lineItemId',
|
|
178
|
+
},
|
|
179
|
+
'location_map': {
|
|
180
|
+
'line_item_id': 'path',
|
|
181
|
+
'promoted_product_resource_collection_input': 'body',
|
|
182
|
+
},
|
|
183
|
+
'collection_format_map': {
|
|
184
|
+
}
|
|
185
|
+
},
|
|
186
|
+
headers_map={
|
|
187
|
+
'accept': [
|
|
188
|
+
'application/json'
|
|
126
189
|
],
|
|
127
190
|
'content_type': [
|
|
128
191
|
'application/json'
|
|
@@ -186,9 +249,67 @@ class CampaignApi(object):
|
|
|
186
249
|
},
|
|
187
250
|
api_client=api_client
|
|
188
251
|
)
|
|
252
|
+
self.delete_promoted_products_endpoint = _Endpoint(
|
|
253
|
+
settings={
|
|
254
|
+
'response_type': None,
|
|
255
|
+
'auth': [
|
|
256
|
+
'oauth',
|
|
257
|
+
'oauth'
|
|
258
|
+
],
|
|
259
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/delete',
|
|
260
|
+
'operation_id': 'delete_promoted_products',
|
|
261
|
+
'http_method': 'POST',
|
|
262
|
+
'servers': None,
|
|
263
|
+
},
|
|
264
|
+
params_map={
|
|
265
|
+
'all': [
|
|
266
|
+
'line_item_id',
|
|
267
|
+
'promoted_product_resource_collection_input',
|
|
268
|
+
],
|
|
269
|
+
'required': [
|
|
270
|
+
'line_item_id',
|
|
271
|
+
],
|
|
272
|
+
'nullable': [
|
|
273
|
+
],
|
|
274
|
+
'enum': [
|
|
275
|
+
],
|
|
276
|
+
'validation': [
|
|
277
|
+
]
|
|
278
|
+
},
|
|
279
|
+
root_map={
|
|
280
|
+
'validations': {
|
|
281
|
+
},
|
|
282
|
+
'allowed_values': {
|
|
283
|
+
},
|
|
284
|
+
'openapi_types': {
|
|
285
|
+
'line_item_id':
|
|
286
|
+
(str,),
|
|
287
|
+
'promoted_product_resource_collection_input':
|
|
288
|
+
(PromotedProductResourceCollectionInput,),
|
|
289
|
+
},
|
|
290
|
+
'attribute_map': {
|
|
291
|
+
'line_item_id': 'lineItemId',
|
|
292
|
+
},
|
|
293
|
+
'location_map': {
|
|
294
|
+
'line_item_id': 'path',
|
|
295
|
+
'promoted_product_resource_collection_input': 'body',
|
|
296
|
+
},
|
|
297
|
+
'collection_format_map': {
|
|
298
|
+
}
|
|
299
|
+
},
|
|
300
|
+
headers_map={
|
|
301
|
+
'accept': [
|
|
302
|
+
'application/json'
|
|
303
|
+
],
|
|
304
|
+
'content_type': [
|
|
305
|
+
'application/json'
|
|
306
|
+
]
|
|
307
|
+
},
|
|
308
|
+
api_client=api_client
|
|
309
|
+
)
|
|
189
310
|
self.fetch_keywords_endpoint = _Endpoint(
|
|
190
311
|
settings={
|
|
191
|
-
'response_type': (
|
|
312
|
+
'response_type': (KeywordsModelResponse,),
|
|
192
313
|
'auth': [
|
|
193
314
|
'oauth',
|
|
194
315
|
'oauth'
|
|
@@ -232,32 +353,33 @@ class CampaignApi(object):
|
|
|
232
353
|
},
|
|
233
354
|
headers_map={
|
|
234
355
|
'accept': [
|
|
235
|
-
'
|
|
236
|
-
'application/json',
|
|
237
|
-
'text/json'
|
|
356
|
+
'application/json'
|
|
238
357
|
],
|
|
239
358
|
'content_type': [],
|
|
240
359
|
},
|
|
241
360
|
api_client=api_client
|
|
242
361
|
)
|
|
243
|
-
self.
|
|
362
|
+
self.fetch_promoted_products_endpoint = _Endpoint(
|
|
244
363
|
settings={
|
|
245
|
-
'response_type': (
|
|
364
|
+
'response_type': (PromotedProductResourceCollectionOutcome,),
|
|
246
365
|
'auth': [
|
|
247
366
|
'oauth',
|
|
248
367
|
'oauth'
|
|
249
368
|
],
|
|
250
|
-
'endpoint_path': '/preview/retail-media/
|
|
251
|
-
'operation_id': '
|
|
369
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products',
|
|
370
|
+
'operation_id': 'fetch_promoted_products',
|
|
252
371
|
'http_method': 'GET',
|
|
253
372
|
'servers': None,
|
|
254
373
|
},
|
|
255
374
|
params_map={
|
|
256
375
|
'all': [
|
|
257
|
-
'
|
|
376
|
+
'line_item_id',
|
|
377
|
+
'offset',
|
|
378
|
+
'limit',
|
|
379
|
+
'fields',
|
|
258
380
|
],
|
|
259
381
|
'required': [
|
|
260
|
-
'
|
|
382
|
+
'line_item_id',
|
|
261
383
|
],
|
|
262
384
|
'nullable': [
|
|
263
385
|
],
|
|
@@ -272,46 +394,56 @@ class CampaignApi(object):
|
|
|
272
394
|
'allowed_values': {
|
|
273
395
|
},
|
|
274
396
|
'openapi_types': {
|
|
275
|
-
'
|
|
397
|
+
'line_item_id':
|
|
398
|
+
(str,),
|
|
399
|
+
'offset':
|
|
400
|
+
(int,),
|
|
401
|
+
'limit':
|
|
402
|
+
(int,),
|
|
403
|
+
'fields':
|
|
276
404
|
(str,),
|
|
277
405
|
},
|
|
278
406
|
'attribute_map': {
|
|
279
|
-
'
|
|
407
|
+
'line_item_id': 'lineItemId',
|
|
408
|
+
'offset': 'offset',
|
|
409
|
+
'limit': 'limit',
|
|
410
|
+
'fields': 'fields',
|
|
280
411
|
},
|
|
281
412
|
'location_map': {
|
|
282
|
-
'
|
|
413
|
+
'line_item_id': 'path',
|
|
414
|
+
'offset': 'query',
|
|
415
|
+
'limit': 'query',
|
|
416
|
+
'fields': 'query',
|
|
283
417
|
},
|
|
284
418
|
'collection_format_map': {
|
|
285
419
|
}
|
|
286
420
|
},
|
|
287
421
|
headers_map={
|
|
288
422
|
'accept': [
|
|
289
|
-
'
|
|
290
|
-
'application/json',
|
|
291
|
-
'text/json'
|
|
423
|
+
'application/json'
|
|
292
424
|
],
|
|
293
425
|
'content_type': [],
|
|
294
426
|
},
|
|
295
427
|
api_client=api_client
|
|
296
428
|
)
|
|
297
|
-
self.
|
|
429
|
+
self.fetch_proposal_endpoint = _Endpoint(
|
|
298
430
|
settings={
|
|
299
|
-
'response_type': (
|
|
431
|
+
'response_type': (ProposalStatusModelResponse,),
|
|
300
432
|
'auth': [
|
|
301
433
|
'oauth',
|
|
302
434
|
'oauth'
|
|
303
435
|
],
|
|
304
|
-
'endpoint_path': '/preview/retail-media/line-items/{
|
|
305
|
-
'operation_id': '
|
|
436
|
+
'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal',
|
|
437
|
+
'operation_id': 'fetch_proposal',
|
|
306
438
|
'http_method': 'GET',
|
|
307
439
|
'servers': None,
|
|
308
440
|
},
|
|
309
441
|
params_map={
|
|
310
442
|
'all': [
|
|
311
|
-
'
|
|
443
|
+
'id',
|
|
312
444
|
],
|
|
313
445
|
'required': [
|
|
314
|
-
'
|
|
446
|
+
'id',
|
|
315
447
|
],
|
|
316
448
|
'nullable': [
|
|
317
449
|
],
|
|
@@ -326,14 +458,14 @@ class CampaignApi(object):
|
|
|
326
458
|
'allowed_values': {
|
|
327
459
|
},
|
|
328
460
|
'openapi_types': {
|
|
329
|
-
'
|
|
461
|
+
'id':
|
|
330
462
|
(str,),
|
|
331
463
|
},
|
|
332
464
|
'attribute_map': {
|
|
333
|
-
'
|
|
465
|
+
'id': 'id',
|
|
334
466
|
},
|
|
335
467
|
'location_map': {
|
|
336
|
-
'
|
|
468
|
+
'id': 'path',
|
|
337
469
|
},
|
|
338
470
|
'collection_format_map': {
|
|
339
471
|
}
|
|
@@ -346,26 +478,24 @@ class CampaignApi(object):
|
|
|
346
478
|
},
|
|
347
479
|
api_client=api_client
|
|
348
480
|
)
|
|
349
|
-
self.
|
|
481
|
+
self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint = _Endpoint(
|
|
350
482
|
settings={
|
|
351
483
|
'response_type': (ProductButtonListResponse,),
|
|
352
484
|
'auth': [
|
|
353
485
|
'oauth',
|
|
354
486
|
'oauth'
|
|
355
487
|
],
|
|
356
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons
|
|
357
|
-
'operation_id': '
|
|
488
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons',
|
|
489
|
+
'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id',
|
|
358
490
|
'http_method': 'GET',
|
|
359
491
|
'servers': None,
|
|
360
492
|
},
|
|
361
493
|
params_map={
|
|
362
494
|
'all': [
|
|
363
495
|
'line_item_id',
|
|
364
|
-
'product_button_id',
|
|
365
496
|
],
|
|
366
497
|
'required': [
|
|
367
498
|
'line_item_id',
|
|
368
|
-
'product_button_id',
|
|
369
499
|
],
|
|
370
500
|
'nullable': [
|
|
371
501
|
],
|
|
@@ -382,16 +512,12 @@ class CampaignApi(object):
|
|
|
382
512
|
'openapi_types': {
|
|
383
513
|
'line_item_id':
|
|
384
514
|
(str,),
|
|
385
|
-
'product_button_id':
|
|
386
|
-
(str,),
|
|
387
515
|
},
|
|
388
516
|
'attribute_map': {
|
|
389
517
|
'line_item_id': 'line-item-id',
|
|
390
|
-
'product_button_id': 'product-button-id',
|
|
391
518
|
},
|
|
392
519
|
'location_map': {
|
|
393
520
|
'line_item_id': 'path',
|
|
394
|
-
'product_button_id': 'path',
|
|
395
521
|
},
|
|
396
522
|
'collection_format_map': {
|
|
397
523
|
}
|
|
@@ -404,24 +530,26 @@ class CampaignApi(object):
|
|
|
404
530
|
},
|
|
405
531
|
api_client=api_client
|
|
406
532
|
)
|
|
407
|
-
self.
|
|
533
|
+
self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint = _Endpoint(
|
|
408
534
|
settings={
|
|
409
|
-
'response_type': (
|
|
535
|
+
'response_type': (ProductButtonListResponse,),
|
|
410
536
|
'auth': [
|
|
411
537
|
'oauth',
|
|
412
538
|
'oauth'
|
|
413
539
|
],
|
|
414
|
-
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/
|
|
415
|
-
'operation_id': '
|
|
540
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/product-buttons/{product-button-id}',
|
|
541
|
+
'operation_id': 'get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id',
|
|
416
542
|
'http_method': 'GET',
|
|
417
543
|
'servers': None,
|
|
418
544
|
},
|
|
419
545
|
params_map={
|
|
420
546
|
'all': [
|
|
421
547
|
'line_item_id',
|
|
548
|
+
'product_button_id',
|
|
422
549
|
],
|
|
423
550
|
'required': [
|
|
424
551
|
'line_item_id',
|
|
552
|
+
'product_button_id',
|
|
425
553
|
],
|
|
426
554
|
'nullable': [
|
|
427
555
|
],
|
|
@@ -438,21 +566,23 @@ class CampaignApi(object):
|
|
|
438
566
|
'openapi_types': {
|
|
439
567
|
'line_item_id':
|
|
440
568
|
(str,),
|
|
569
|
+
'product_button_id':
|
|
570
|
+
(str,),
|
|
441
571
|
},
|
|
442
572
|
'attribute_map': {
|
|
443
573
|
'line_item_id': 'line-item-id',
|
|
574
|
+
'product_button_id': 'product-button-id',
|
|
444
575
|
},
|
|
445
576
|
'location_map': {
|
|
446
577
|
'line_item_id': 'path',
|
|
578
|
+
'product_button_id': 'path',
|
|
447
579
|
},
|
|
448
580
|
'collection_format_map': {
|
|
449
581
|
}
|
|
450
582
|
},
|
|
451
583
|
headers_map={
|
|
452
584
|
'accept': [
|
|
453
|
-
'
|
|
454
|
-
'application/json',
|
|
455
|
-
'text/json'
|
|
585
|
+
'application/json'
|
|
456
586
|
],
|
|
457
587
|
'content_type': [],
|
|
458
588
|
},
|
|
@@ -899,6 +1029,66 @@ class CampaignApi(object):
|
|
|
899
1029
|
},
|
|
900
1030
|
api_client=api_client
|
|
901
1031
|
)
|
|
1032
|
+
self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
|
|
1033
|
+
settings={
|
|
1034
|
+
'response_type': (CreativeV2Response,),
|
|
1035
|
+
'auth': [
|
|
1036
|
+
'oauth',
|
|
1037
|
+
'oauth'
|
|
1038
|
+
],
|
|
1039
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
1040
|
+
'operation_id': 'get_api_v2_external_account_by_account_id_creativescreative_id',
|
|
1041
|
+
'http_method': 'GET',
|
|
1042
|
+
'servers': None,
|
|
1043
|
+
},
|
|
1044
|
+
params_map={
|
|
1045
|
+
'all': [
|
|
1046
|
+
'account_id',
|
|
1047
|
+
'creative_id',
|
|
1048
|
+
],
|
|
1049
|
+
'required': [
|
|
1050
|
+
'account_id',
|
|
1051
|
+
'creative_id',
|
|
1052
|
+
],
|
|
1053
|
+
'nullable': [
|
|
1054
|
+
],
|
|
1055
|
+
'enum': [
|
|
1056
|
+
],
|
|
1057
|
+
'validation': [
|
|
1058
|
+
]
|
|
1059
|
+
},
|
|
1060
|
+
root_map={
|
|
1061
|
+
'validations': {
|
|
1062
|
+
},
|
|
1063
|
+
'allowed_values': {
|
|
1064
|
+
},
|
|
1065
|
+
'openapi_types': {
|
|
1066
|
+
'account_id':
|
|
1067
|
+
(str,),
|
|
1068
|
+
'creative_id':
|
|
1069
|
+
(str,),
|
|
1070
|
+
},
|
|
1071
|
+
'attribute_map': {
|
|
1072
|
+
'account_id': 'account-id',
|
|
1073
|
+
'creative_id': 'creative-id',
|
|
1074
|
+
},
|
|
1075
|
+
'location_map': {
|
|
1076
|
+
'account_id': 'path',
|
|
1077
|
+
'creative_id': 'path',
|
|
1078
|
+
},
|
|
1079
|
+
'collection_format_map': {
|
|
1080
|
+
}
|
|
1081
|
+
},
|
|
1082
|
+
headers_map={
|
|
1083
|
+
'accept': [
|
|
1084
|
+
'text/plain',
|
|
1085
|
+
'application/json',
|
|
1086
|
+
'text/json'
|
|
1087
|
+
],
|
|
1088
|
+
'content_type': [],
|
|
1089
|
+
},
|
|
1090
|
+
api_client=api_client
|
|
1091
|
+
)
|
|
902
1092
|
self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
903
1093
|
settings={
|
|
904
1094
|
'response_type': (PreferredLineItemV2PagedListResponse,),
|
|
@@ -967,15 +1157,15 @@ class CampaignApi(object):
|
|
|
967
1157
|
},
|
|
968
1158
|
api_client=api_client
|
|
969
1159
|
)
|
|
970
|
-
self.
|
|
1160
|
+
self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint(
|
|
971
1161
|
settings={
|
|
972
|
-
'response_type': (
|
|
1162
|
+
'response_type': (JsonApiSingleResponseOfLineItemBidMultipliersV2,),
|
|
973
1163
|
'auth': [
|
|
974
1164
|
'oauth',
|
|
975
1165
|
'oauth'
|
|
976
1166
|
],
|
|
977
|
-
'endpoint_path': '/preview/retail-media/
|
|
978
|
-
'operation_id': '
|
|
1167
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers',
|
|
1168
|
+
'operation_id': 'get_api_v2_external_line_item_bid_multipliers_by_line_item_id',
|
|
979
1169
|
'http_method': 'GET',
|
|
980
1170
|
'servers': None,
|
|
981
1171
|
},
|
|
@@ -1013,27 +1203,81 @@ class CampaignApi(object):
|
|
|
1013
1203
|
},
|
|
1014
1204
|
headers_map={
|
|
1015
1205
|
'accept': [
|
|
1016
|
-
'
|
|
1206
|
+
'text/plain',
|
|
1207
|
+
'application/json',
|
|
1208
|
+
'text/json'
|
|
1017
1209
|
],
|
|
1018
1210
|
'content_type': [],
|
|
1019
1211
|
},
|
|
1020
1212
|
api_client=api_client
|
|
1021
1213
|
)
|
|
1022
|
-
self.
|
|
1214
|
+
self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
1023
1215
|
settings={
|
|
1024
|
-
'response_type': (
|
|
1216
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1025
1217
|
'auth': [
|
|
1026
1218
|
'oauth',
|
|
1027
1219
|
'oauth'
|
|
1028
1220
|
],
|
|
1029
|
-
'endpoint_path': '/preview/retail-media/
|
|
1030
|
-
'operation_id': '
|
|
1221
|
+
'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
|
|
1222
|
+
'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id',
|
|
1031
1223
|
'http_method': 'GET',
|
|
1032
1224
|
'servers': None,
|
|
1033
1225
|
},
|
|
1034
1226
|
params_map={
|
|
1035
1227
|
'all': [
|
|
1036
|
-
'
|
|
1228
|
+
'line_item_id',
|
|
1229
|
+
],
|
|
1230
|
+
'required': [
|
|
1231
|
+
'line_item_id',
|
|
1232
|
+
],
|
|
1233
|
+
'nullable': [
|
|
1234
|
+
],
|
|
1235
|
+
'enum': [
|
|
1236
|
+
],
|
|
1237
|
+
'validation': [
|
|
1238
|
+
]
|
|
1239
|
+
},
|
|
1240
|
+
root_map={
|
|
1241
|
+
'validations': {
|
|
1242
|
+
},
|
|
1243
|
+
'allowed_values': {
|
|
1244
|
+
},
|
|
1245
|
+
'openapi_types': {
|
|
1246
|
+
'line_item_id':
|
|
1247
|
+
(str,),
|
|
1248
|
+
},
|
|
1249
|
+
'attribute_map': {
|
|
1250
|
+
'line_item_id': 'line-item-id',
|
|
1251
|
+
},
|
|
1252
|
+
'location_map': {
|
|
1253
|
+
'line_item_id': 'path',
|
|
1254
|
+
},
|
|
1255
|
+
'collection_format_map': {
|
|
1256
|
+
}
|
|
1257
|
+
},
|
|
1258
|
+
headers_map={
|
|
1259
|
+
'accept': [
|
|
1260
|
+
'application/json'
|
|
1261
|
+
],
|
|
1262
|
+
'content_type': [],
|
|
1263
|
+
},
|
|
1264
|
+
api_client=api_client
|
|
1265
|
+
)
|
|
1266
|
+
self.get_campaign_budget_overrides_endpoint = _Endpoint(
|
|
1267
|
+
settings={
|
|
1268
|
+
'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
|
|
1269
|
+
'auth': [
|
|
1270
|
+
'oauth',
|
|
1271
|
+
'oauth'
|
|
1272
|
+
],
|
|
1273
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides',
|
|
1274
|
+
'operation_id': 'get_campaign_budget_overrides',
|
|
1275
|
+
'http_method': 'GET',
|
|
1276
|
+
'servers': None,
|
|
1277
|
+
},
|
|
1278
|
+
params_map={
|
|
1279
|
+
'all': [
|
|
1280
|
+
'campaign_id',
|
|
1037
1281
|
],
|
|
1038
1282
|
'required': [
|
|
1039
1283
|
'campaign_id',
|
|
@@ -1356,6 +1600,64 @@ class CampaignApi(object):
|
|
|
1356
1600
|
},
|
|
1357
1601
|
api_client=api_client
|
|
1358
1602
|
)
|
|
1603
|
+
self.pause_promoted_products_endpoint = _Endpoint(
|
|
1604
|
+
settings={
|
|
1605
|
+
'response_type': None,
|
|
1606
|
+
'auth': [
|
|
1607
|
+
'oauth',
|
|
1608
|
+
'oauth'
|
|
1609
|
+
],
|
|
1610
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/pause',
|
|
1611
|
+
'operation_id': 'pause_promoted_products',
|
|
1612
|
+
'http_method': 'POST',
|
|
1613
|
+
'servers': None,
|
|
1614
|
+
},
|
|
1615
|
+
params_map={
|
|
1616
|
+
'all': [
|
|
1617
|
+
'line_item_id',
|
|
1618
|
+
'promoted_product_resource_collection_input',
|
|
1619
|
+
],
|
|
1620
|
+
'required': [
|
|
1621
|
+
'line_item_id',
|
|
1622
|
+
],
|
|
1623
|
+
'nullable': [
|
|
1624
|
+
],
|
|
1625
|
+
'enum': [
|
|
1626
|
+
],
|
|
1627
|
+
'validation': [
|
|
1628
|
+
]
|
|
1629
|
+
},
|
|
1630
|
+
root_map={
|
|
1631
|
+
'validations': {
|
|
1632
|
+
},
|
|
1633
|
+
'allowed_values': {
|
|
1634
|
+
},
|
|
1635
|
+
'openapi_types': {
|
|
1636
|
+
'line_item_id':
|
|
1637
|
+
(str,),
|
|
1638
|
+
'promoted_product_resource_collection_input':
|
|
1639
|
+
(PromotedProductResourceCollectionInput,),
|
|
1640
|
+
},
|
|
1641
|
+
'attribute_map': {
|
|
1642
|
+
'line_item_id': 'lineItemId',
|
|
1643
|
+
},
|
|
1644
|
+
'location_map': {
|
|
1645
|
+
'line_item_id': 'path',
|
|
1646
|
+
'promoted_product_resource_collection_input': 'body',
|
|
1647
|
+
},
|
|
1648
|
+
'collection_format_map': {
|
|
1649
|
+
}
|
|
1650
|
+
},
|
|
1651
|
+
headers_map={
|
|
1652
|
+
'accept': [
|
|
1653
|
+
'application/json'
|
|
1654
|
+
],
|
|
1655
|
+
'content_type': [
|
|
1656
|
+
'application/json'
|
|
1657
|
+
]
|
|
1658
|
+
},
|
|
1659
|
+
api_client=api_client
|
|
1660
|
+
)
|
|
1359
1661
|
self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1360
1662
|
settings={
|
|
1361
1663
|
'response_type': (PreferredLineItemV2Response,),
|
|
@@ -1782,6 +2084,126 @@ class CampaignApi(object):
|
|
|
1782
2084
|
},
|
|
1783
2085
|
api_client=api_client
|
|
1784
2086
|
)
|
|
2087
|
+
self.post_api_v2_external_account_creatives_by_account_id_endpoint = _Endpoint(
|
|
2088
|
+
settings={
|
|
2089
|
+
'response_type': (CreativeV2Response,),
|
|
2090
|
+
'auth': [
|
|
2091
|
+
'oauth',
|
|
2092
|
+
'oauth'
|
|
2093
|
+
],
|
|
2094
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives',
|
|
2095
|
+
'operation_id': 'post_api_v2_external_account_creatives_by_account_id',
|
|
2096
|
+
'http_method': 'POST',
|
|
2097
|
+
'servers': None,
|
|
2098
|
+
},
|
|
2099
|
+
params_map={
|
|
2100
|
+
'all': [
|
|
2101
|
+
'account_id',
|
|
2102
|
+
'external_creative_create_model_v2',
|
|
2103
|
+
],
|
|
2104
|
+
'required': [
|
|
2105
|
+
'account_id',
|
|
2106
|
+
],
|
|
2107
|
+
'nullable': [
|
|
2108
|
+
],
|
|
2109
|
+
'enum': [
|
|
2110
|
+
],
|
|
2111
|
+
'validation': [
|
|
2112
|
+
]
|
|
2113
|
+
},
|
|
2114
|
+
root_map={
|
|
2115
|
+
'validations': {
|
|
2116
|
+
},
|
|
2117
|
+
'allowed_values': {
|
|
2118
|
+
},
|
|
2119
|
+
'openapi_types': {
|
|
2120
|
+
'account_id':
|
|
2121
|
+
(str,),
|
|
2122
|
+
'external_creative_create_model_v2':
|
|
2123
|
+
(ExternalCreativeCreateModelV2,),
|
|
2124
|
+
},
|
|
2125
|
+
'attribute_map': {
|
|
2126
|
+
'account_id': 'account-id',
|
|
2127
|
+
},
|
|
2128
|
+
'location_map': {
|
|
2129
|
+
'account_id': 'path',
|
|
2130
|
+
'external_creative_create_model_v2': 'body',
|
|
2131
|
+
},
|
|
2132
|
+
'collection_format_map': {
|
|
2133
|
+
}
|
|
2134
|
+
},
|
|
2135
|
+
headers_map={
|
|
2136
|
+
'accept': [
|
|
2137
|
+
'text/plain',
|
|
2138
|
+
'application/json',
|
|
2139
|
+
'text/json'
|
|
2140
|
+
],
|
|
2141
|
+
'content_type': [
|
|
2142
|
+
'application/json'
|
|
2143
|
+
]
|
|
2144
|
+
},
|
|
2145
|
+
api_client=api_client
|
|
2146
|
+
)
|
|
2147
|
+
self.post_api_v2_external_account_creatives_search_by_account_id_endpoint = _Endpoint(
|
|
2148
|
+
settings={
|
|
2149
|
+
'response_type': (CreativeV2ListResponse,),
|
|
2150
|
+
'auth': [
|
|
2151
|
+
'oauth',
|
|
2152
|
+
'oauth'
|
|
2153
|
+
],
|
|
2154
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/search',
|
|
2155
|
+
'operation_id': 'post_api_v2_external_account_creatives_search_by_account_id',
|
|
2156
|
+
'http_method': 'POST',
|
|
2157
|
+
'servers': None,
|
|
2158
|
+
},
|
|
2159
|
+
params_map={
|
|
2160
|
+
'all': [
|
|
2161
|
+
'account_id',
|
|
2162
|
+
'creative_ids',
|
|
2163
|
+
],
|
|
2164
|
+
'required': [
|
|
2165
|
+
'account_id',
|
|
2166
|
+
],
|
|
2167
|
+
'nullable': [
|
|
2168
|
+
],
|
|
2169
|
+
'enum': [
|
|
2170
|
+
],
|
|
2171
|
+
'validation': [
|
|
2172
|
+
]
|
|
2173
|
+
},
|
|
2174
|
+
root_map={
|
|
2175
|
+
'validations': {
|
|
2176
|
+
},
|
|
2177
|
+
'allowed_values': {
|
|
2178
|
+
},
|
|
2179
|
+
'openapi_types': {
|
|
2180
|
+
'account_id':
|
|
2181
|
+
(str,),
|
|
2182
|
+
'creative_ids':
|
|
2183
|
+
([str],),
|
|
2184
|
+
},
|
|
2185
|
+
'attribute_map': {
|
|
2186
|
+
'account_id': 'account-id',
|
|
2187
|
+
'creative_ids': 'creative-ids',
|
|
2188
|
+
},
|
|
2189
|
+
'location_map': {
|
|
2190
|
+
'account_id': 'path',
|
|
2191
|
+
'creative_ids': 'query',
|
|
2192
|
+
},
|
|
2193
|
+
'collection_format_map': {
|
|
2194
|
+
'creative_ids': 'multi',
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
headers_map={
|
|
2198
|
+
'accept': [
|
|
2199
|
+
'text/plain',
|
|
2200
|
+
'application/json',
|
|
2201
|
+
'text/json'
|
|
2202
|
+
],
|
|
2203
|
+
'content_type': [],
|
|
2204
|
+
},
|
|
2205
|
+
api_client=api_client
|
|
2206
|
+
)
|
|
1785
2207
|
self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
|
|
1786
2208
|
settings={
|
|
1787
2209
|
'response_type': (PreferredLineItemV2Response,),
|
|
@@ -1905,25 +2327,27 @@ class CampaignApi(object):
|
|
|
1905
2327
|
},
|
|
1906
2328
|
api_client=api_client
|
|
1907
2329
|
)
|
|
1908
|
-
self.
|
|
2330
|
+
self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
|
|
1909
2331
|
settings={
|
|
1910
|
-
'response_type': (
|
|
2332
|
+
'response_type': (CreativeV2Response,),
|
|
1911
2333
|
'auth': [
|
|
1912
2334
|
'oauth',
|
|
1913
2335
|
'oauth'
|
|
1914
2336
|
],
|
|
1915
|
-
'endpoint_path': '/preview/retail-media/
|
|
1916
|
-
'operation_id': '
|
|
2337
|
+
'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
|
|
2338
|
+
'operation_id': 'put_api_v2_external_account_by_account_id_creativescreative_id',
|
|
1917
2339
|
'http_method': 'PUT',
|
|
1918
2340
|
'servers': None,
|
|
1919
2341
|
},
|
|
1920
2342
|
params_map={
|
|
1921
2343
|
'all': [
|
|
1922
|
-
'
|
|
1923
|
-
'
|
|
2344
|
+
'account_id',
|
|
2345
|
+
'creative_id',
|
|
2346
|
+
'external_creative_update_model_v2',
|
|
1924
2347
|
],
|
|
1925
2348
|
'required': [
|
|
1926
|
-
'
|
|
2349
|
+
'account_id',
|
|
2350
|
+
'creative_id',
|
|
1927
2351
|
],
|
|
1928
2352
|
'nullable': [
|
|
1929
2353
|
],
|
|
@@ -1938,17 +2362,21 @@ class CampaignApi(object):
|
|
|
1938
2362
|
'allowed_values': {
|
|
1939
2363
|
},
|
|
1940
2364
|
'openapi_types': {
|
|
1941
|
-
'
|
|
2365
|
+
'account_id':
|
|
2366
|
+
(str,),
|
|
2367
|
+
'creative_id':
|
|
1942
2368
|
(str,),
|
|
1943
|
-
'
|
|
1944
|
-
(
|
|
2369
|
+
'external_creative_update_model_v2':
|
|
2370
|
+
(ExternalCreativeUpdateModelV2,),
|
|
1945
2371
|
},
|
|
1946
2372
|
'attribute_map': {
|
|
1947
|
-
'
|
|
2373
|
+
'account_id': 'account-id',
|
|
2374
|
+
'creative_id': 'creative-id',
|
|
1948
2375
|
},
|
|
1949
2376
|
'location_map': {
|
|
1950
|
-
'
|
|
1951
|
-
'
|
|
2377
|
+
'account_id': 'path',
|
|
2378
|
+
'creative_id': 'path',
|
|
2379
|
+
'external_creative_update_model_v2': 'body',
|
|
1952
2380
|
},
|
|
1953
2381
|
'collection_format_map': {
|
|
1954
2382
|
}
|
|
@@ -1965,25 +2393,25 @@ class CampaignApi(object):
|
|
|
1965
2393
|
},
|
|
1966
2394
|
api_client=api_client
|
|
1967
2395
|
)
|
|
1968
|
-
self.
|
|
2396
|
+
self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint(
|
|
1969
2397
|
settings={
|
|
1970
|
-
'response_type': (
|
|
2398
|
+
'response_type': (LineItemBidMultipliersV2Response,),
|
|
1971
2399
|
'auth': [
|
|
1972
2400
|
'oauth',
|
|
1973
2401
|
'oauth'
|
|
1974
2402
|
],
|
|
1975
|
-
'endpoint_path': '/preview/retail-media/line-items/{id}/
|
|
1976
|
-
'operation_id': '
|
|
1977
|
-
'http_method': '
|
|
2403
|
+
'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers',
|
|
2404
|
+
'operation_id': 'put_api_v2_external_line_item_bid_multipliers_by_line_item_id',
|
|
2405
|
+
'http_method': 'PUT',
|
|
1978
2406
|
'servers': None,
|
|
1979
2407
|
},
|
|
1980
2408
|
params_map={
|
|
1981
2409
|
'all': [
|
|
1982
|
-
'
|
|
1983
|
-
'
|
|
2410
|
+
'line_item_id',
|
|
2411
|
+
'line_item_bid_multipliers_v2_request',
|
|
1984
2412
|
],
|
|
1985
2413
|
'required': [
|
|
1986
|
-
'
|
|
2414
|
+
'line_item_id',
|
|
1987
2415
|
],
|
|
1988
2416
|
'nullable': [
|
|
1989
2417
|
],
|
|
@@ -1998,17 +2426,17 @@ class CampaignApi(object):
|
|
|
1998
2426
|
'allowed_values': {
|
|
1999
2427
|
},
|
|
2000
2428
|
'openapi_types': {
|
|
2001
|
-
'
|
|
2429
|
+
'line_item_id':
|
|
2002
2430
|
(str,),
|
|
2003
|
-
'
|
|
2004
|
-
(
|
|
2431
|
+
'line_item_bid_multipliers_v2_request':
|
|
2432
|
+
(LineItemBidMultipliersV2Request,),
|
|
2005
2433
|
},
|
|
2006
2434
|
'attribute_map': {
|
|
2007
|
-
'
|
|
2435
|
+
'line_item_id': 'line-item-id',
|
|
2008
2436
|
},
|
|
2009
2437
|
'location_map': {
|
|
2010
|
-
'
|
|
2011
|
-
'
|
|
2438
|
+
'line_item_id': 'path',
|
|
2439
|
+
'line_item_bid_multipliers_v2_request': 'body',
|
|
2012
2440
|
},
|
|
2013
2441
|
'collection_format_map': {
|
|
2014
2442
|
}
|
|
@@ -2025,21 +2453,22 @@ class CampaignApi(object):
|
|
|
2025
2453
|
},
|
|
2026
2454
|
api_client=api_client
|
|
2027
2455
|
)
|
|
2028
|
-
self.
|
|
2456
|
+
self.set_keyword_bids_endpoint = _Endpoint(
|
|
2029
2457
|
settings={
|
|
2030
|
-
'response_type': (
|
|
2458
|
+
'response_type': (ResourceOutcome,),
|
|
2031
2459
|
'auth': [
|
|
2032
2460
|
'oauth',
|
|
2033
2461
|
'oauth'
|
|
2034
2462
|
],
|
|
2035
|
-
'endpoint_path': '/preview/retail-media/
|
|
2036
|
-
'operation_id': '
|
|
2463
|
+
'endpoint_path': '/preview/retail-media/line-items/{id}/keywords/set-bid',
|
|
2464
|
+
'operation_id': 'set_keyword_bids',
|
|
2037
2465
|
'http_method': 'POST',
|
|
2038
2466
|
'servers': None,
|
|
2039
2467
|
},
|
|
2040
2468
|
params_map={
|
|
2041
2469
|
'all': [
|
|
2042
2470
|
'id',
|
|
2471
|
+
'set_bids_model_request',
|
|
2043
2472
|
],
|
|
2044
2473
|
'required': [
|
|
2045
2474
|
'id',
|
|
@@ -2059,38 +2488,151 @@ class CampaignApi(object):
|
|
|
2059
2488
|
'openapi_types': {
|
|
2060
2489
|
'id':
|
|
2061
2490
|
(str,),
|
|
2491
|
+
'set_bids_model_request':
|
|
2492
|
+
(SetBidsModelRequest,),
|
|
2062
2493
|
},
|
|
2063
2494
|
'attribute_map': {
|
|
2064
2495
|
'id': 'id',
|
|
2065
2496
|
},
|
|
2066
2497
|
'location_map': {
|
|
2067
2498
|
'id': 'path',
|
|
2499
|
+
'set_bids_model_request': 'body',
|
|
2068
2500
|
},
|
|
2069
2501
|
'collection_format_map': {
|
|
2070
2502
|
}
|
|
2071
2503
|
},
|
|
2072
2504
|
headers_map={
|
|
2073
2505
|
'accept': [
|
|
2074
|
-
'
|
|
2075
|
-
'application/json',
|
|
2076
|
-
'text/json'
|
|
2506
|
+
'application/json'
|
|
2077
2507
|
],
|
|
2078
|
-
'content_type': [
|
|
2508
|
+
'content_type': [
|
|
2509
|
+
'application/json'
|
|
2510
|
+
]
|
|
2079
2511
|
},
|
|
2080
2512
|
api_client=api_client
|
|
2081
2513
|
)
|
|
2082
|
-
self.
|
|
2514
|
+
self.submit_proposal_endpoint = _Endpoint(
|
|
2083
2515
|
settings={
|
|
2084
|
-
'response_type': (
|
|
2516
|
+
'response_type': (ProposalStatusModelResponse,),
|
|
2085
2517
|
'auth': [
|
|
2086
2518
|
'oauth',
|
|
2087
2519
|
'oauth'
|
|
2088
2520
|
],
|
|
2089
|
-
'endpoint_path': '/preview/retail-media/
|
|
2090
|
-
'operation_id': '
|
|
2091
|
-
'http_method': '
|
|
2092
|
-
'servers': None,
|
|
2093
|
-
},
|
|
2521
|
+
'endpoint_path': '/preview/retail-media/preferred-deal-line-items/{id}/proposal/submit',
|
|
2522
|
+
'operation_id': 'submit_proposal',
|
|
2523
|
+
'http_method': 'POST',
|
|
2524
|
+
'servers': None,
|
|
2525
|
+
},
|
|
2526
|
+
params_map={
|
|
2527
|
+
'all': [
|
|
2528
|
+
'id',
|
|
2529
|
+
],
|
|
2530
|
+
'required': [
|
|
2531
|
+
'id',
|
|
2532
|
+
],
|
|
2533
|
+
'nullable': [
|
|
2534
|
+
],
|
|
2535
|
+
'enum': [
|
|
2536
|
+
],
|
|
2537
|
+
'validation': [
|
|
2538
|
+
]
|
|
2539
|
+
},
|
|
2540
|
+
root_map={
|
|
2541
|
+
'validations': {
|
|
2542
|
+
},
|
|
2543
|
+
'allowed_values': {
|
|
2544
|
+
},
|
|
2545
|
+
'openapi_types': {
|
|
2546
|
+
'id':
|
|
2547
|
+
(str,),
|
|
2548
|
+
},
|
|
2549
|
+
'attribute_map': {
|
|
2550
|
+
'id': 'id',
|
|
2551
|
+
},
|
|
2552
|
+
'location_map': {
|
|
2553
|
+
'id': 'path',
|
|
2554
|
+
},
|
|
2555
|
+
'collection_format_map': {
|
|
2556
|
+
}
|
|
2557
|
+
},
|
|
2558
|
+
headers_map={
|
|
2559
|
+
'accept': [
|
|
2560
|
+
'application/json'
|
|
2561
|
+
],
|
|
2562
|
+
'content_type': [],
|
|
2563
|
+
},
|
|
2564
|
+
api_client=api_client
|
|
2565
|
+
)
|
|
2566
|
+
self.unpause_promoted_products_endpoint = _Endpoint(
|
|
2567
|
+
settings={
|
|
2568
|
+
'response_type': None,
|
|
2569
|
+
'auth': [
|
|
2570
|
+
'oauth',
|
|
2571
|
+
'oauth'
|
|
2572
|
+
],
|
|
2573
|
+
'endpoint_path': '/preview/retail-media/line-items/{lineItemId}/products/unpause',
|
|
2574
|
+
'operation_id': 'unpause_promoted_products',
|
|
2575
|
+
'http_method': 'POST',
|
|
2576
|
+
'servers': None,
|
|
2577
|
+
},
|
|
2578
|
+
params_map={
|
|
2579
|
+
'all': [
|
|
2580
|
+
'line_item_id',
|
|
2581
|
+
'promoted_product_resource_collection_input',
|
|
2582
|
+
],
|
|
2583
|
+
'required': [
|
|
2584
|
+
'line_item_id',
|
|
2585
|
+
],
|
|
2586
|
+
'nullable': [
|
|
2587
|
+
],
|
|
2588
|
+
'enum': [
|
|
2589
|
+
],
|
|
2590
|
+
'validation': [
|
|
2591
|
+
]
|
|
2592
|
+
},
|
|
2593
|
+
root_map={
|
|
2594
|
+
'validations': {
|
|
2595
|
+
},
|
|
2596
|
+
'allowed_values': {
|
|
2597
|
+
},
|
|
2598
|
+
'openapi_types': {
|
|
2599
|
+
'line_item_id':
|
|
2600
|
+
(str,),
|
|
2601
|
+
'promoted_product_resource_collection_input':
|
|
2602
|
+
(PromotedProductResourceCollectionInput,),
|
|
2603
|
+
},
|
|
2604
|
+
'attribute_map': {
|
|
2605
|
+
'line_item_id': 'lineItemId',
|
|
2606
|
+
},
|
|
2607
|
+
'location_map': {
|
|
2608
|
+
'line_item_id': 'path',
|
|
2609
|
+
'promoted_product_resource_collection_input': 'body',
|
|
2610
|
+
},
|
|
2611
|
+
'collection_format_map': {
|
|
2612
|
+
}
|
|
2613
|
+
},
|
|
2614
|
+
headers_map={
|
|
2615
|
+
'accept': [
|
|
2616
|
+
'application/json'
|
|
2617
|
+
],
|
|
2618
|
+
'content_type': [
|
|
2619
|
+
'application/json'
|
|
2620
|
+
]
|
|
2621
|
+
},
|
|
2622
|
+
api_client=api_client
|
|
2623
|
+
)
|
|
2624
|
+
self.update_campaign_budget_overrides_endpoint = _Endpoint(
|
|
2625
|
+
settings={
|
|
2626
|
+
'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
|
|
2627
|
+
'auth': [
|
|
2628
|
+
'oauth',
|
|
2629
|
+
'oauth'
|
|
2630
|
+
],
|
|
2631
|
+
'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/campaign-budget-overrides',
|
|
2632
|
+
'operation_id': 'update_campaign_budget_overrides',
|
|
2633
|
+
'http_method': 'PUT',
|
|
2634
|
+
'servers': None,
|
|
2635
|
+
},
|
|
2094
2636
|
params_map={
|
|
2095
2637
|
'all': [
|
|
2096
2638
|
'campaign_id',
|
|
@@ -2209,7 +2751,7 @@ class CampaignApi(object):
|
|
|
2209
2751
|
):
|
|
2210
2752
|
"""add_remove_keywords # noqa: E501
|
|
2211
2753
|
|
|
2212
|
-
Add or Remove keywords from the
|
|
2754
|
+
Add or Remove keywords from the line item in bulk # noqa: E501
|
|
2213
2755
|
This method makes a synchronous HTTP request by default. To make an
|
|
2214
2756
|
asynchronous HTTP request, please pass async_req=True
|
|
2215
2757
|
|
|
@@ -2217,10 +2759,10 @@ class CampaignApi(object):
|
|
|
2217
2759
|
>>> result = thread.get()
|
|
2218
2760
|
|
|
2219
2761
|
Args:
|
|
2220
|
-
id (str):
|
|
2762
|
+
id (str): ID of the line item
|
|
2221
2763
|
|
|
2222
2764
|
Keyword Args:
|
|
2223
|
-
|
|
2765
|
+
add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [optional]
|
|
2224
2766
|
_return_http_data_only (bool): response data without head status
|
|
2225
2767
|
code and headers. Default is True.
|
|
2226
2768
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2253,7 +2795,7 @@ class CampaignApi(object):
|
|
|
2253
2795
|
async_req (bool): execute request asynchronously
|
|
2254
2796
|
|
|
2255
2797
|
Returns:
|
|
2256
|
-
|
|
2798
|
+
ResourceOutcome
|
|
2257
2799
|
If the method is called asynchronously, returns the request
|
|
2258
2800
|
thread.
|
|
2259
2801
|
"""
|
|
@@ -2286,6 +2828,90 @@ class CampaignApi(object):
|
|
|
2286
2828
|
id
|
|
2287
2829
|
return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs)
|
|
2288
2830
|
|
|
2831
|
+
def append_promoted_products(
|
|
2832
|
+
self,
|
|
2833
|
+
line_item_id,
|
|
2834
|
+
**kwargs
|
|
2835
|
+
):
|
|
2836
|
+
"""append_promoted_products # noqa: E501
|
|
2837
|
+
|
|
2838
|
+
Append a collection of promoted products to a line item # noqa: E501
|
|
2839
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
2840
|
+
asynchronous HTTP request, please pass async_req=True
|
|
2841
|
+
|
|
2842
|
+
>>> thread = api.append_promoted_products(line_item_id, async_req=True)
|
|
2843
|
+
>>> result = thread.get()
|
|
2844
|
+
|
|
2845
|
+
Args:
|
|
2846
|
+
line_item_id (str): ID of the line item
|
|
2847
|
+
|
|
2848
|
+
Keyword Args:
|
|
2849
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
2850
|
+
_return_http_data_only (bool): response data without head status
|
|
2851
|
+
code and headers. Default is True.
|
|
2852
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
2853
|
+
will be returned without reading/decoding response data.
|
|
2854
|
+
Default is True.
|
|
2855
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
2856
|
+
one number provided, it will be total request timeout. It can also
|
|
2857
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
2858
|
+
Default is None.
|
|
2859
|
+
_check_input_type (bool): specifies if type checking
|
|
2860
|
+
should be done one the data sent to the server.
|
|
2861
|
+
Default is True.
|
|
2862
|
+
_check_return_type (bool): specifies if type checking
|
|
2863
|
+
should be done one the data received from the server.
|
|
2864
|
+
Default is True.
|
|
2865
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
2866
|
+
are serialized names, as specified in the OpenAPI document.
|
|
2867
|
+
False if the variable names in the input data
|
|
2868
|
+
are pythonic names, e.g. snake case (default)
|
|
2869
|
+
_content_type (str/None): force body content-type.
|
|
2870
|
+
Default is None and content-type will be predicted by allowed
|
|
2871
|
+
content-types and body.
|
|
2872
|
+
_host_index (int/None): specifies the index of the server
|
|
2873
|
+
that we want to use.
|
|
2874
|
+
Default is read from the configuration.
|
|
2875
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
2876
|
+
request; this effectively ignores the authentication
|
|
2877
|
+
in the spec for a single request.
|
|
2878
|
+
Default is None
|
|
2879
|
+
async_req (bool): execute request asynchronously
|
|
2880
|
+
|
|
2881
|
+
Returns:
|
|
2882
|
+
None
|
|
2883
|
+
If the method is called asynchronously, returns the request
|
|
2884
|
+
thread.
|
|
2885
|
+
"""
|
|
2886
|
+
kwargs['async_req'] = kwargs.get(
|
|
2887
|
+
'async_req', False
|
|
2888
|
+
)
|
|
2889
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
2890
|
+
'_return_http_data_only', True
|
|
2891
|
+
)
|
|
2892
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
2893
|
+
'_preload_content', True
|
|
2894
|
+
)
|
|
2895
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
2896
|
+
'_request_timeout', None
|
|
2897
|
+
)
|
|
2898
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
2899
|
+
'_check_input_type', True
|
|
2900
|
+
)
|
|
2901
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
2902
|
+
'_check_return_type', True
|
|
2903
|
+
)
|
|
2904
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
2905
|
+
'_spec_property_naming', False
|
|
2906
|
+
)
|
|
2907
|
+
kwargs['_content_type'] = kwargs.get(
|
|
2908
|
+
'_content_type')
|
|
2909
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2910
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2911
|
+
kwargs['line_item_id'] = \
|
|
2912
|
+
line_item_id
|
|
2913
|
+
return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
2914
|
+
|
|
2289
2915
|
def delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
2290
2916
|
self,
|
|
2291
2917
|
line_item_id,
|
|
@@ -2373,24 +2999,25 @@ class CampaignApi(object):
|
|
|
2373
2999
|
product_button_id
|
|
2374
3000
|
return self.delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
2375
3001
|
|
|
2376
|
-
def
|
|
3002
|
+
def delete_promoted_products(
|
|
2377
3003
|
self,
|
|
2378
|
-
|
|
3004
|
+
line_item_id,
|
|
2379
3005
|
**kwargs
|
|
2380
3006
|
):
|
|
2381
|
-
"""
|
|
3007
|
+
"""delete_promoted_products # noqa: E501
|
|
2382
3008
|
|
|
2383
|
-
|
|
3009
|
+
Remove a collection of promoted products from a line item # noqa: E501
|
|
2384
3010
|
This method makes a synchronous HTTP request by default. To make an
|
|
2385
3011
|
asynchronous HTTP request, please pass async_req=True
|
|
2386
3012
|
|
|
2387
|
-
>>> thread = api.
|
|
3013
|
+
>>> thread = api.delete_promoted_products(line_item_id, async_req=True)
|
|
2388
3014
|
>>> result = thread.get()
|
|
2389
3015
|
|
|
2390
3016
|
Args:
|
|
2391
|
-
|
|
3017
|
+
line_item_id (str): ID of the line item
|
|
2392
3018
|
|
|
2393
3019
|
Keyword Args:
|
|
3020
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
2394
3021
|
_return_http_data_only (bool): response data without head status
|
|
2395
3022
|
code and headers. Default is True.
|
|
2396
3023
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2423,7 +3050,7 @@ class CampaignApi(object):
|
|
|
2423
3050
|
async_req (bool): execute request asynchronously
|
|
2424
3051
|
|
|
2425
3052
|
Returns:
|
|
2426
|
-
|
|
3053
|
+
None
|
|
2427
3054
|
If the method is called asynchronously, returns the request
|
|
2428
3055
|
thread.
|
|
2429
3056
|
"""
|
|
@@ -2452,26 +3079,26 @@ class CampaignApi(object):
|
|
|
2452
3079
|
'_content_type')
|
|
2453
3080
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2454
3081
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2455
|
-
kwargs['
|
|
2456
|
-
|
|
2457
|
-
return self.
|
|
3082
|
+
kwargs['line_item_id'] = \
|
|
3083
|
+
line_item_id
|
|
3084
|
+
return self.delete_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
2458
3085
|
|
|
2459
|
-
def
|
|
3086
|
+
def fetch_keywords(
|
|
2460
3087
|
self,
|
|
2461
3088
|
id,
|
|
2462
3089
|
**kwargs
|
|
2463
3090
|
):
|
|
2464
|
-
"""
|
|
3091
|
+
"""fetch_keywords # noqa: E501
|
|
2465
3092
|
|
|
2466
|
-
Fetch
|
|
3093
|
+
Fetch keywords associated with the specified line item # noqa: E501
|
|
2467
3094
|
This method makes a synchronous HTTP request by default. To make an
|
|
2468
3095
|
asynchronous HTTP request, please pass async_req=True
|
|
2469
3096
|
|
|
2470
|
-
>>> thread = api.
|
|
3097
|
+
>>> thread = api.fetch_keywords(id, async_req=True)
|
|
2471
3098
|
>>> result = thread.get()
|
|
2472
3099
|
|
|
2473
3100
|
Args:
|
|
2474
|
-
id (str):
|
|
3101
|
+
id (str): ID of the line item
|
|
2475
3102
|
|
|
2476
3103
|
Keyword Args:
|
|
2477
3104
|
_return_http_data_only (bool): response data without head status
|
|
@@ -2506,7 +3133,7 @@ class CampaignApi(object):
|
|
|
2506
3133
|
async_req (bool): execute request asynchronously
|
|
2507
3134
|
|
|
2508
3135
|
Returns:
|
|
2509
|
-
|
|
3136
|
+
KeywordsModelResponse
|
|
2510
3137
|
If the method is called asynchronously, returns the request
|
|
2511
3138
|
thread.
|
|
2512
3139
|
"""
|
|
@@ -2537,26 +3164,29 @@ class CampaignApi(object):
|
|
|
2537
3164
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2538
3165
|
kwargs['id'] = \
|
|
2539
3166
|
id
|
|
2540
|
-
return self.
|
|
3167
|
+
return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
|
|
2541
3168
|
|
|
2542
|
-
def
|
|
3169
|
+
def fetch_promoted_products(
|
|
2543
3170
|
self,
|
|
2544
3171
|
line_item_id,
|
|
2545
3172
|
**kwargs
|
|
2546
3173
|
):
|
|
2547
|
-
"""
|
|
3174
|
+
"""fetch_promoted_products # noqa: E501
|
|
2548
3175
|
|
|
2549
|
-
|
|
3176
|
+
Retrieve a page of promoted products for a line item # noqa: E501
|
|
2550
3177
|
This method makes a synchronous HTTP request by default. To make an
|
|
2551
3178
|
asynchronous HTTP request, please pass async_req=True
|
|
2552
3179
|
|
|
2553
|
-
>>> thread = api.
|
|
3180
|
+
>>> thread = api.fetch_promoted_products(line_item_id, async_req=True)
|
|
2554
3181
|
>>> result = thread.get()
|
|
2555
3182
|
|
|
2556
3183
|
Args:
|
|
2557
|
-
line_item_id (str):
|
|
3184
|
+
line_item_id (str): ID of the line item.
|
|
2558
3185
|
|
|
2559
3186
|
Keyword Args:
|
|
3187
|
+
offset (int): Offset of the first item to fetch. Defaults to zero.. [optional]
|
|
3188
|
+
limit (int): Maximum page size to fetch. Defaults to 500.. [optional]
|
|
3189
|
+
fields (str): A comma separated list of attribute names from the response model to compute and return. Valid values are `status` and `bidOverride` in any order. Defaults to `status`.. [optional]
|
|
2560
3190
|
_return_http_data_only (bool): response data without head status
|
|
2561
3191
|
code and headers. Default is True.
|
|
2562
3192
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2589,7 +3219,7 @@ class CampaignApi(object):
|
|
|
2589
3219
|
async_req (bool): execute request asynchronously
|
|
2590
3220
|
|
|
2591
3221
|
Returns:
|
|
2592
|
-
|
|
3222
|
+
PromotedProductResourceCollectionOutcome
|
|
2593
3223
|
If the method is called asynchronously, returns the request
|
|
2594
3224
|
thread.
|
|
2595
3225
|
"""
|
|
@@ -2620,26 +3250,24 @@ class CampaignApi(object):
|
|
|
2620
3250
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2621
3251
|
kwargs['line_item_id'] = \
|
|
2622
3252
|
line_item_id
|
|
2623
|
-
return self.
|
|
3253
|
+
return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
2624
3254
|
|
|
2625
|
-
def
|
|
3255
|
+
def fetch_proposal(
|
|
2626
3256
|
self,
|
|
2627
|
-
|
|
2628
|
-
product_button_id,
|
|
3257
|
+
id,
|
|
2629
3258
|
**kwargs
|
|
2630
3259
|
):
|
|
2631
|
-
"""
|
|
3260
|
+
"""fetch_proposal # noqa: E501
|
|
2632
3261
|
|
|
2633
|
-
|
|
3262
|
+
Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501
|
|
2634
3263
|
This method makes a synchronous HTTP request by default. To make an
|
|
2635
3264
|
asynchronous HTTP request, please pass async_req=True
|
|
2636
3265
|
|
|
2637
|
-
>>> thread = api.
|
|
3266
|
+
>>> thread = api.fetch_proposal(id, async_req=True)
|
|
2638
3267
|
>>> result = thread.get()
|
|
2639
3268
|
|
|
2640
3269
|
Args:
|
|
2641
|
-
|
|
2642
|
-
product_button_id (str): Sequential id of the product button
|
|
3270
|
+
id (str): ID of the line item
|
|
2643
3271
|
|
|
2644
3272
|
Keyword Args:
|
|
2645
3273
|
_return_http_data_only (bool): response data without head status
|
|
@@ -2674,7 +3302,686 @@ class CampaignApi(object):
|
|
|
2674
3302
|
async_req (bool): execute request asynchronously
|
|
2675
3303
|
|
|
2676
3304
|
Returns:
|
|
2677
|
-
|
|
3305
|
+
ProposalStatusModelResponse
|
|
3306
|
+
If the method is called asynchronously, returns the request
|
|
3307
|
+
thread.
|
|
3308
|
+
"""
|
|
3309
|
+
kwargs['async_req'] = kwargs.get(
|
|
3310
|
+
'async_req', False
|
|
3311
|
+
)
|
|
3312
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3313
|
+
'_return_http_data_only', True
|
|
3314
|
+
)
|
|
3315
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3316
|
+
'_preload_content', True
|
|
3317
|
+
)
|
|
3318
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3319
|
+
'_request_timeout', None
|
|
3320
|
+
)
|
|
3321
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3322
|
+
'_check_input_type', True
|
|
3323
|
+
)
|
|
3324
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3325
|
+
'_check_return_type', True
|
|
3326
|
+
)
|
|
3327
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3328
|
+
'_spec_property_naming', False
|
|
3329
|
+
)
|
|
3330
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3331
|
+
'_content_type')
|
|
3332
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3333
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3334
|
+
kwargs['id'] = \
|
|
3335
|
+
id
|
|
3336
|
+
return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
|
|
3337
|
+
|
|
3338
|
+
def get_api202210_external_line_item_product_buttons_by_line_item_id(
|
|
3339
|
+
self,
|
|
3340
|
+
line_item_id,
|
|
3341
|
+
**kwargs
|
|
3342
|
+
):
|
|
3343
|
+
"""get_api202210_external_line_item_product_buttons_by_line_item_id # noqa: E501
|
|
3344
|
+
|
|
3345
|
+
Get all the product buttons associated with a line item # noqa: E501
|
|
3346
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3347
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3348
|
+
|
|
3349
|
+
>>> thread = api.get_api202210_external_line_item_product_buttons_by_line_item_id(line_item_id, async_req=True)
|
|
3350
|
+
>>> result = thread.get()
|
|
3351
|
+
|
|
3352
|
+
Args:
|
|
3353
|
+
line_item_id (str): Long external id of the associated line item
|
|
3354
|
+
|
|
3355
|
+
Keyword Args:
|
|
3356
|
+
_return_http_data_only (bool): response data without head status
|
|
3357
|
+
code and headers. Default is True.
|
|
3358
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3359
|
+
will be returned without reading/decoding response data.
|
|
3360
|
+
Default is True.
|
|
3361
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3362
|
+
one number provided, it will be total request timeout. It can also
|
|
3363
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3364
|
+
Default is None.
|
|
3365
|
+
_check_input_type (bool): specifies if type checking
|
|
3366
|
+
should be done one the data sent to the server.
|
|
3367
|
+
Default is True.
|
|
3368
|
+
_check_return_type (bool): specifies if type checking
|
|
3369
|
+
should be done one the data received from the server.
|
|
3370
|
+
Default is True.
|
|
3371
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3372
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3373
|
+
False if the variable names in the input data
|
|
3374
|
+
are pythonic names, e.g. snake case (default)
|
|
3375
|
+
_content_type (str/None): force body content-type.
|
|
3376
|
+
Default is None and content-type will be predicted by allowed
|
|
3377
|
+
content-types and body.
|
|
3378
|
+
_host_index (int/None): specifies the index of the server
|
|
3379
|
+
that we want to use.
|
|
3380
|
+
Default is read from the configuration.
|
|
3381
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3382
|
+
request; this effectively ignores the authentication
|
|
3383
|
+
in the spec for a single request.
|
|
3384
|
+
Default is None
|
|
3385
|
+
async_req (bool): execute request asynchronously
|
|
3386
|
+
|
|
3387
|
+
Returns:
|
|
3388
|
+
ProductButtonListResponse
|
|
3389
|
+
If the method is called asynchronously, returns the request
|
|
3390
|
+
thread.
|
|
3391
|
+
"""
|
|
3392
|
+
kwargs['async_req'] = kwargs.get(
|
|
3393
|
+
'async_req', False
|
|
3394
|
+
)
|
|
3395
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3396
|
+
'_return_http_data_only', True
|
|
3397
|
+
)
|
|
3398
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3399
|
+
'_preload_content', True
|
|
3400
|
+
)
|
|
3401
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3402
|
+
'_request_timeout', None
|
|
3403
|
+
)
|
|
3404
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3405
|
+
'_check_input_type', True
|
|
3406
|
+
)
|
|
3407
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3408
|
+
'_check_return_type', True
|
|
3409
|
+
)
|
|
3410
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3411
|
+
'_spec_property_naming', False
|
|
3412
|
+
)
|
|
3413
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3414
|
+
'_content_type')
|
|
3415
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3416
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3417
|
+
kwargs['line_item_id'] = \
|
|
3418
|
+
line_item_id
|
|
3419
|
+
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3420
|
+
|
|
3421
|
+
def get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
3422
|
+
self,
|
|
3423
|
+
line_item_id,
|
|
3424
|
+
product_button_id,
|
|
3425
|
+
**kwargs
|
|
3426
|
+
):
|
|
3427
|
+
"""get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501
|
|
3428
|
+
|
|
3429
|
+
Get a single product button # noqa: E501
|
|
3430
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3431
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3432
|
+
|
|
3433
|
+
>>> 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)
|
|
3434
|
+
>>> result = thread.get()
|
|
3435
|
+
|
|
3436
|
+
Args:
|
|
3437
|
+
line_item_id (str): Long external id of the associated line item
|
|
3438
|
+
product_button_id (str): Sequential id of the product button
|
|
3439
|
+
|
|
3440
|
+
Keyword Args:
|
|
3441
|
+
_return_http_data_only (bool): response data without head status
|
|
3442
|
+
code and headers. Default is True.
|
|
3443
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3444
|
+
will be returned without reading/decoding response data.
|
|
3445
|
+
Default is True.
|
|
3446
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3447
|
+
one number provided, it will be total request timeout. It can also
|
|
3448
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3449
|
+
Default is None.
|
|
3450
|
+
_check_input_type (bool): specifies if type checking
|
|
3451
|
+
should be done one the data sent to the server.
|
|
3452
|
+
Default is True.
|
|
3453
|
+
_check_return_type (bool): specifies if type checking
|
|
3454
|
+
should be done one the data received from the server.
|
|
3455
|
+
Default is True.
|
|
3456
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3457
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3458
|
+
False if the variable names in the input data
|
|
3459
|
+
are pythonic names, e.g. snake case (default)
|
|
3460
|
+
_content_type (str/None): force body content-type.
|
|
3461
|
+
Default is None and content-type will be predicted by allowed
|
|
3462
|
+
content-types and body.
|
|
3463
|
+
_host_index (int/None): specifies the index of the server
|
|
3464
|
+
that we want to use.
|
|
3465
|
+
Default is read from the configuration.
|
|
3466
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3467
|
+
request; this effectively ignores the authentication
|
|
3468
|
+
in the spec for a single request.
|
|
3469
|
+
Default is None
|
|
3470
|
+
async_req (bool): execute request asynchronously
|
|
3471
|
+
|
|
3472
|
+
Returns:
|
|
3473
|
+
ProductButtonListResponse
|
|
3474
|
+
If the method is called asynchronously, returns the request
|
|
3475
|
+
thread.
|
|
3476
|
+
"""
|
|
3477
|
+
kwargs['async_req'] = kwargs.get(
|
|
3478
|
+
'async_req', False
|
|
3479
|
+
)
|
|
3480
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3481
|
+
'_return_http_data_only', True
|
|
3482
|
+
)
|
|
3483
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3484
|
+
'_preload_content', True
|
|
3485
|
+
)
|
|
3486
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3487
|
+
'_request_timeout', None
|
|
3488
|
+
)
|
|
3489
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3490
|
+
'_check_input_type', True
|
|
3491
|
+
)
|
|
3492
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3493
|
+
'_check_return_type', True
|
|
3494
|
+
)
|
|
3495
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3496
|
+
'_spec_property_naming', False
|
|
3497
|
+
)
|
|
3498
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3499
|
+
'_content_type')
|
|
3500
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3501
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3502
|
+
kwargs['line_item_id'] = \
|
|
3503
|
+
line_item_id
|
|
3504
|
+
kwargs['product_button_id'] = \
|
|
3505
|
+
product_button_id
|
|
3506
|
+
return self.get_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
3507
|
+
|
|
3508
|
+
def get_api_v1_external_account_brands_by_account_id(
|
|
3509
|
+
self,
|
|
3510
|
+
account_id,
|
|
3511
|
+
**kwargs
|
|
3512
|
+
):
|
|
3513
|
+
"""get_api_v1_external_account_brands_by_account_id # noqa: E501
|
|
3514
|
+
|
|
3515
|
+
Gets page of retailer objects that are associated with the given account # noqa: E501
|
|
3516
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3517
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3518
|
+
|
|
3519
|
+
>>> thread = api.get_api_v1_external_account_brands_by_account_id(account_id, async_req=True)
|
|
3520
|
+
>>> result = thread.get()
|
|
3521
|
+
|
|
3522
|
+
Args:
|
|
3523
|
+
account_id (str): The given account id
|
|
3524
|
+
|
|
3525
|
+
Keyword Args:
|
|
3526
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3527
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
3528
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
3529
|
+
_return_http_data_only (bool): response data without head status
|
|
3530
|
+
code and headers. Default is True.
|
|
3531
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3532
|
+
will be returned without reading/decoding response data.
|
|
3533
|
+
Default is True.
|
|
3534
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3535
|
+
one number provided, it will be total request timeout. It can also
|
|
3536
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3537
|
+
Default is None.
|
|
3538
|
+
_check_input_type (bool): specifies if type checking
|
|
3539
|
+
should be done one the data sent to the server.
|
|
3540
|
+
Default is True.
|
|
3541
|
+
_check_return_type (bool): specifies if type checking
|
|
3542
|
+
should be done one the data received from the server.
|
|
3543
|
+
Default is True.
|
|
3544
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3545
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3546
|
+
False if the variable names in the input data
|
|
3547
|
+
are pythonic names, e.g. snake case (default)
|
|
3548
|
+
_content_type (str/None): force body content-type.
|
|
3549
|
+
Default is None and content-type will be predicted by allowed
|
|
3550
|
+
content-types and body.
|
|
3551
|
+
_host_index (int/None): specifies the index of the server
|
|
3552
|
+
that we want to use.
|
|
3553
|
+
Default is read from the configuration.
|
|
3554
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3555
|
+
request; this effectively ignores the authentication
|
|
3556
|
+
in the spec for a single request.
|
|
3557
|
+
Default is None
|
|
3558
|
+
async_req (bool): execute request asynchronously
|
|
3559
|
+
|
|
3560
|
+
Returns:
|
|
3561
|
+
JsonApiPageResponseOfBrand
|
|
3562
|
+
If the method is called asynchronously, returns the request
|
|
3563
|
+
thread.
|
|
3564
|
+
"""
|
|
3565
|
+
kwargs['async_req'] = kwargs.get(
|
|
3566
|
+
'async_req', False
|
|
3567
|
+
)
|
|
3568
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3569
|
+
'_return_http_data_only', True
|
|
3570
|
+
)
|
|
3571
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3572
|
+
'_preload_content', True
|
|
3573
|
+
)
|
|
3574
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3575
|
+
'_request_timeout', None
|
|
3576
|
+
)
|
|
3577
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3578
|
+
'_check_input_type', True
|
|
3579
|
+
)
|
|
3580
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3581
|
+
'_check_return_type', True
|
|
3582
|
+
)
|
|
3583
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3584
|
+
'_spec_property_naming', False
|
|
3585
|
+
)
|
|
3586
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3587
|
+
'_content_type')
|
|
3588
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3589
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3590
|
+
kwargs['account_id'] = \
|
|
3591
|
+
account_id
|
|
3592
|
+
return self.get_api_v1_external_account_brands_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
3593
|
+
|
|
3594
|
+
def get_api_v1_external_account_retailers_by_account_id(
|
|
3595
|
+
self,
|
|
3596
|
+
account_id,
|
|
3597
|
+
**kwargs
|
|
3598
|
+
):
|
|
3599
|
+
"""get_api_v1_external_account_retailers_by_account_id # noqa: E501
|
|
3600
|
+
|
|
3601
|
+
Gets page of retailer objects that are associated with the given account # noqa: E501
|
|
3602
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3603
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3604
|
+
|
|
3605
|
+
>>> thread = api.get_api_v1_external_account_retailers_by_account_id(account_id, async_req=True)
|
|
3606
|
+
>>> result = thread.get()
|
|
3607
|
+
|
|
3608
|
+
Args:
|
|
3609
|
+
account_id (str): The given account id
|
|
3610
|
+
|
|
3611
|
+
Keyword Args:
|
|
3612
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3613
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
3614
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
3615
|
+
_return_http_data_only (bool): response data without head status
|
|
3616
|
+
code and headers. Default is True.
|
|
3617
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3618
|
+
will be returned without reading/decoding response data.
|
|
3619
|
+
Default is True.
|
|
3620
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3621
|
+
one number provided, it will be total request timeout. It can also
|
|
3622
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3623
|
+
Default is None.
|
|
3624
|
+
_check_input_type (bool): specifies if type checking
|
|
3625
|
+
should be done one the data sent to the server.
|
|
3626
|
+
Default is True.
|
|
3627
|
+
_check_return_type (bool): specifies if type checking
|
|
3628
|
+
should be done one the data received from the server.
|
|
3629
|
+
Default is True.
|
|
3630
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3631
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3632
|
+
False if the variable names in the input data
|
|
3633
|
+
are pythonic names, e.g. snake case (default)
|
|
3634
|
+
_content_type (str/None): force body content-type.
|
|
3635
|
+
Default is None and content-type will be predicted by allowed
|
|
3636
|
+
content-types and body.
|
|
3637
|
+
_host_index (int/None): specifies the index of the server
|
|
3638
|
+
that we want to use.
|
|
3639
|
+
Default is read from the configuration.
|
|
3640
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3641
|
+
request; this effectively ignores the authentication
|
|
3642
|
+
in the spec for a single request.
|
|
3643
|
+
Default is None
|
|
3644
|
+
async_req (bool): execute request asynchronously
|
|
3645
|
+
|
|
3646
|
+
Returns:
|
|
3647
|
+
JsonApiPageResponseOfRetailer
|
|
3648
|
+
If the method is called asynchronously, returns the request
|
|
3649
|
+
thread.
|
|
3650
|
+
"""
|
|
3651
|
+
kwargs['async_req'] = kwargs.get(
|
|
3652
|
+
'async_req', False
|
|
3653
|
+
)
|
|
3654
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3655
|
+
'_return_http_data_only', True
|
|
3656
|
+
)
|
|
3657
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3658
|
+
'_preload_content', True
|
|
3659
|
+
)
|
|
3660
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3661
|
+
'_request_timeout', None
|
|
3662
|
+
)
|
|
3663
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3664
|
+
'_check_input_type', True
|
|
3665
|
+
)
|
|
3666
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3667
|
+
'_check_return_type', True
|
|
3668
|
+
)
|
|
3669
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3670
|
+
'_spec_property_naming', False
|
|
3671
|
+
)
|
|
3672
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3673
|
+
'_content_type')
|
|
3674
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3675
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3676
|
+
kwargs['account_id'] = \
|
|
3677
|
+
account_id
|
|
3678
|
+
return self.get_api_v1_external_account_retailers_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
3679
|
+
|
|
3680
|
+
def get_api_v1_external_accounts(
|
|
3681
|
+
self,
|
|
3682
|
+
**kwargs
|
|
3683
|
+
):
|
|
3684
|
+
"""get_api_v1_external_accounts # noqa: E501
|
|
3685
|
+
|
|
3686
|
+
Gets page of account objects that the current user can access # noqa: E501
|
|
3687
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3688
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3689
|
+
|
|
3690
|
+
>>> thread = api.get_api_v1_external_accounts(async_req=True)
|
|
3691
|
+
>>> result = thread.get()
|
|
3692
|
+
|
|
3693
|
+
|
|
3694
|
+
Keyword Args:
|
|
3695
|
+
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
3696
|
+
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
3697
|
+
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
3698
|
+
_return_http_data_only (bool): response data without head status
|
|
3699
|
+
code and headers. Default is True.
|
|
3700
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3701
|
+
will be returned without reading/decoding response data.
|
|
3702
|
+
Default is True.
|
|
3703
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3704
|
+
one number provided, it will be total request timeout. It can also
|
|
3705
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3706
|
+
Default is None.
|
|
3707
|
+
_check_input_type (bool): specifies if type checking
|
|
3708
|
+
should be done one the data sent to the server.
|
|
3709
|
+
Default is True.
|
|
3710
|
+
_check_return_type (bool): specifies if type checking
|
|
3711
|
+
should be done one the data received from the server.
|
|
3712
|
+
Default is True.
|
|
3713
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3714
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3715
|
+
False if the variable names in the input data
|
|
3716
|
+
are pythonic names, e.g. snake case (default)
|
|
3717
|
+
_content_type (str/None): force body content-type.
|
|
3718
|
+
Default is None and content-type will be predicted by allowed
|
|
3719
|
+
content-types and body.
|
|
3720
|
+
_host_index (int/None): specifies the index of the server
|
|
3721
|
+
that we want to use.
|
|
3722
|
+
Default is read from the configuration.
|
|
3723
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3724
|
+
request; this effectively ignores the authentication
|
|
3725
|
+
in the spec for a single request.
|
|
3726
|
+
Default is None
|
|
3727
|
+
async_req (bool): execute request asynchronously
|
|
3728
|
+
|
|
3729
|
+
Returns:
|
|
3730
|
+
JsonApiPageResponseOfAccount
|
|
3731
|
+
If the method is called asynchronously, returns the request
|
|
3732
|
+
thread.
|
|
3733
|
+
"""
|
|
3734
|
+
kwargs['async_req'] = kwargs.get(
|
|
3735
|
+
'async_req', False
|
|
3736
|
+
)
|
|
3737
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3738
|
+
'_return_http_data_only', True
|
|
3739
|
+
)
|
|
3740
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3741
|
+
'_preload_content', True
|
|
3742
|
+
)
|
|
3743
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3744
|
+
'_request_timeout', None
|
|
3745
|
+
)
|
|
3746
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3747
|
+
'_check_input_type', True
|
|
3748
|
+
)
|
|
3749
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3750
|
+
'_check_return_type', True
|
|
3751
|
+
)
|
|
3752
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3753
|
+
'_spec_property_naming', False
|
|
3754
|
+
)
|
|
3755
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3756
|
+
'_content_type')
|
|
3757
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3758
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3759
|
+
return self.get_api_v1_external_accounts_endpoint.call_with_http_info(**kwargs)
|
|
3760
|
+
|
|
3761
|
+
def get_api_v1_external_retailer_brands_by_retailer_id(
|
|
3762
|
+
self,
|
|
3763
|
+
retailer_id,
|
|
3764
|
+
**kwargs
|
|
3765
|
+
):
|
|
3766
|
+
"""get_api_v1_external_retailer_brands_by_retailer_id # noqa: E501
|
|
3767
|
+
|
|
3768
|
+
Gets the brands for the given retailer # noqa: E501
|
|
3769
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3770
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3771
|
+
|
|
3772
|
+
>>> thread = api.get_api_v1_external_retailer_brands_by_retailer_id(retailer_id, async_req=True)
|
|
3773
|
+
>>> result = thread.get()
|
|
3774
|
+
|
|
3775
|
+
Args:
|
|
3776
|
+
retailer_id (int): The retailer id for which brands should be fetched.
|
|
3777
|
+
|
|
3778
|
+
Keyword Args:
|
|
3779
|
+
sku_stock_type_filter (str): Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party. [optional]
|
|
3780
|
+
brand_type (str): Filter to narrow down brands [all|uc|retailer]. Defaults to uc. [optional]
|
|
3781
|
+
_return_http_data_only (bool): response data without head status
|
|
3782
|
+
code and headers. Default is True.
|
|
3783
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3784
|
+
will be returned without reading/decoding response data.
|
|
3785
|
+
Default is True.
|
|
3786
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3787
|
+
one number provided, it will be total request timeout. It can also
|
|
3788
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3789
|
+
Default is None.
|
|
3790
|
+
_check_input_type (bool): specifies if type checking
|
|
3791
|
+
should be done one the data sent to the server.
|
|
3792
|
+
Default is True.
|
|
3793
|
+
_check_return_type (bool): specifies if type checking
|
|
3794
|
+
should be done one the data received from the server.
|
|
3795
|
+
Default is True.
|
|
3796
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3797
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3798
|
+
False if the variable names in the input data
|
|
3799
|
+
are pythonic names, e.g. snake case (default)
|
|
3800
|
+
_content_type (str/None): force body content-type.
|
|
3801
|
+
Default is None and content-type will be predicted by allowed
|
|
3802
|
+
content-types and body.
|
|
3803
|
+
_host_index (int/None): specifies the index of the server
|
|
3804
|
+
that we want to use.
|
|
3805
|
+
Default is read from the configuration.
|
|
3806
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3807
|
+
request; this effectively ignores the authentication
|
|
3808
|
+
in the spec for a single request.
|
|
3809
|
+
Default is None
|
|
3810
|
+
async_req (bool): execute request asynchronously
|
|
3811
|
+
|
|
3812
|
+
Returns:
|
|
3813
|
+
BrandPreviewListResponse
|
|
3814
|
+
If the method is called asynchronously, returns the request
|
|
3815
|
+
thread.
|
|
3816
|
+
"""
|
|
3817
|
+
kwargs['async_req'] = kwargs.get(
|
|
3818
|
+
'async_req', False
|
|
3819
|
+
)
|
|
3820
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3821
|
+
'_return_http_data_only', True
|
|
3822
|
+
)
|
|
3823
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3824
|
+
'_preload_content', True
|
|
3825
|
+
)
|
|
3826
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3827
|
+
'_request_timeout', None
|
|
3828
|
+
)
|
|
3829
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3830
|
+
'_check_input_type', True
|
|
3831
|
+
)
|
|
3832
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3833
|
+
'_check_return_type', True
|
|
3834
|
+
)
|
|
3835
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3836
|
+
'_spec_property_naming', False
|
|
3837
|
+
)
|
|
3838
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3839
|
+
'_content_type')
|
|
3840
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3841
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3842
|
+
kwargs['retailer_id'] = \
|
|
3843
|
+
retailer_id
|
|
3844
|
+
return self.get_api_v1_external_retailer_brands_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
3845
|
+
|
|
3846
|
+
def get_api_v1_external_retailer_by_retailer_id_seller_by_seller(
|
|
3847
|
+
self,
|
|
3848
|
+
retailer_id,
|
|
3849
|
+
seller,
|
|
3850
|
+
**kwargs
|
|
3851
|
+
):
|
|
3852
|
+
"""get_api_v1_external_retailer_by_retailer_id_seller_by_seller # noqa: E501
|
|
3853
|
+
|
|
3854
|
+
Endpoint to get market place seller id and name # noqa: E501
|
|
3855
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3856
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3857
|
+
|
|
3858
|
+
>>> thread = api.get_api_v1_external_retailer_by_retailer_id_seller_by_seller(retailer_id, seller, async_req=True)
|
|
3859
|
+
>>> result = thread.get()
|
|
3860
|
+
|
|
3861
|
+
Args:
|
|
3862
|
+
retailer_id (int): The retailer id for which seller should be fetched.
|
|
3863
|
+
seller (str): The seller id or seller name which should be validated.
|
|
3864
|
+
|
|
3865
|
+
Keyword Args:
|
|
3866
|
+
_return_http_data_only (bool): response data without head status
|
|
3867
|
+
code and headers. Default is True.
|
|
3868
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3869
|
+
will be returned without reading/decoding response data.
|
|
3870
|
+
Default is True.
|
|
3871
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3872
|
+
one number provided, it will be total request timeout. It can also
|
|
3873
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3874
|
+
Default is None.
|
|
3875
|
+
_check_input_type (bool): specifies if type checking
|
|
3876
|
+
should be done one the data sent to the server.
|
|
3877
|
+
Default is True.
|
|
3878
|
+
_check_return_type (bool): specifies if type checking
|
|
3879
|
+
should be done one the data received from the server.
|
|
3880
|
+
Default is True.
|
|
3881
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3882
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3883
|
+
False if the variable names in the input data
|
|
3884
|
+
are pythonic names, e.g. snake case (default)
|
|
3885
|
+
_content_type (str/None): force body content-type.
|
|
3886
|
+
Default is None and content-type will be predicted by allowed
|
|
3887
|
+
content-types and body.
|
|
3888
|
+
_host_index (int/None): specifies the index of the server
|
|
3889
|
+
that we want to use.
|
|
3890
|
+
Default is read from the configuration.
|
|
3891
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3892
|
+
request; this effectively ignores the authentication
|
|
3893
|
+
in the spec for a single request.
|
|
3894
|
+
Default is None
|
|
3895
|
+
async_req (bool): execute request asynchronously
|
|
3896
|
+
|
|
3897
|
+
Returns:
|
|
3898
|
+
SellerPreviewResponse
|
|
3899
|
+
If the method is called asynchronously, returns the request
|
|
3900
|
+
thread.
|
|
3901
|
+
"""
|
|
3902
|
+
kwargs['async_req'] = kwargs.get(
|
|
3903
|
+
'async_req', False
|
|
3904
|
+
)
|
|
3905
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
3906
|
+
'_return_http_data_only', True
|
|
3907
|
+
)
|
|
3908
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
3909
|
+
'_preload_content', True
|
|
3910
|
+
)
|
|
3911
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
3912
|
+
'_request_timeout', None
|
|
3913
|
+
)
|
|
3914
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
3915
|
+
'_check_input_type', True
|
|
3916
|
+
)
|
|
3917
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
3918
|
+
'_check_return_type', True
|
|
3919
|
+
)
|
|
3920
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
3921
|
+
'_spec_property_naming', False
|
|
3922
|
+
)
|
|
3923
|
+
kwargs['_content_type'] = kwargs.get(
|
|
3924
|
+
'_content_type')
|
|
3925
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3926
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3927
|
+
kwargs['retailer_id'] = \
|
|
3928
|
+
retailer_id
|
|
3929
|
+
kwargs['seller'] = \
|
|
3930
|
+
seller
|
|
3931
|
+
return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
3932
|
+
|
|
3933
|
+
def get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(
|
|
3934
|
+
self,
|
|
3935
|
+
retailer_id,
|
|
3936
|
+
**kwargs
|
|
3937
|
+
):
|
|
3938
|
+
"""get_api_v1_external_retailer_category_cpc_rates_by_retailer_id # noqa: E501
|
|
3939
|
+
|
|
3940
|
+
Gets the minimum cpc bid for the retailer, and optionally the categories under the retailer # noqa: E501
|
|
3941
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
3942
|
+
asynchronous HTTP request, please pass async_req=True
|
|
3943
|
+
|
|
3944
|
+
>>> thread = api.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id(retailer_id, async_req=True)
|
|
3945
|
+
>>> result = thread.get()
|
|
3946
|
+
|
|
3947
|
+
Args:
|
|
3948
|
+
retailer_id (str): The retailer id
|
|
3949
|
+
|
|
3950
|
+
Keyword Args:
|
|
3951
|
+
fields ([str]): The fields in the response that is to be included. [optional]
|
|
3952
|
+
_return_http_data_only (bool): response data without head status
|
|
3953
|
+
code and headers. Default is True.
|
|
3954
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
3955
|
+
will be returned without reading/decoding response data.
|
|
3956
|
+
Default is True.
|
|
3957
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
3958
|
+
one number provided, it will be total request timeout. It can also
|
|
3959
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
3960
|
+
Default is None.
|
|
3961
|
+
_check_input_type (bool): specifies if type checking
|
|
3962
|
+
should be done one the data sent to the server.
|
|
3963
|
+
Default is True.
|
|
3964
|
+
_check_return_type (bool): specifies if type checking
|
|
3965
|
+
should be done one the data received from the server.
|
|
3966
|
+
Default is True.
|
|
3967
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
3968
|
+
are serialized names, as specified in the OpenAPI document.
|
|
3969
|
+
False if the variable names in the input data
|
|
3970
|
+
are pythonic names, e.g. snake case (default)
|
|
3971
|
+
_content_type (str/None): force body content-type.
|
|
3972
|
+
Default is None and content-type will be predicted by allowed
|
|
3973
|
+
content-types and body.
|
|
3974
|
+
_host_index (int/None): specifies the index of the server
|
|
3975
|
+
that we want to use.
|
|
3976
|
+
Default is read from the configuration.
|
|
3977
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
3978
|
+
request; this effectively ignores the authentication
|
|
3979
|
+
in the spec for a single request.
|
|
3980
|
+
Default is None
|
|
3981
|
+
async_req (bool): execute request asynchronously
|
|
3982
|
+
|
|
3983
|
+
Returns:
|
|
3984
|
+
CpcRateCardPreviewResponse
|
|
2678
3985
|
If the method is called asynchronously, returns the request
|
|
2679
3986
|
thread.
|
|
2680
3987
|
"""
|
|
@@ -2703,28 +4010,26 @@ class CampaignApi(object):
|
|
|
2703
4010
|
'_content_type')
|
|
2704
4011
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2705
4012
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2706
|
-
kwargs['
|
|
2707
|
-
|
|
2708
|
-
kwargs
|
|
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)
|
|
4013
|
+
kwargs['retailer_id'] = \
|
|
4014
|
+
retailer_id
|
|
4015
|
+
return self.get_api_v1_external_retailer_category_cpc_rates_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
2711
4016
|
|
|
2712
|
-
def
|
|
4017
|
+
def get_api_v1_external_retailer_placements_by_retailer_id(
|
|
2713
4018
|
self,
|
|
2714
|
-
|
|
4019
|
+
retailer_id,
|
|
2715
4020
|
**kwargs
|
|
2716
4021
|
):
|
|
2717
|
-
"""
|
|
4022
|
+
"""get_api_v1_external_retailer_placements_by_retailer_id # noqa: E501
|
|
2718
4023
|
|
|
2719
|
-
|
|
4024
|
+
Gets all placement information for the given retailer # noqa: E501
|
|
2720
4025
|
This method makes a synchronous HTTP request by default. To make an
|
|
2721
4026
|
asynchronous HTTP request, please pass async_req=True
|
|
2722
4027
|
|
|
2723
|
-
>>> thread = api.
|
|
4028
|
+
>>> thread = api.get_api_v1_external_retailer_placements_by_retailer_id(retailer_id, async_req=True)
|
|
2724
4029
|
>>> result = thread.get()
|
|
2725
4030
|
|
|
2726
4031
|
Args:
|
|
2727
|
-
|
|
4032
|
+
retailer_id (str): The retailer id for which placements should be fetched.
|
|
2728
4033
|
|
|
2729
4034
|
Keyword Args:
|
|
2730
4035
|
_return_http_data_only (bool): response data without head status
|
|
@@ -2759,7 +4064,7 @@ class CampaignApi(object):
|
|
|
2759
4064
|
async_req (bool): execute request asynchronously
|
|
2760
4065
|
|
|
2761
4066
|
Returns:
|
|
2762
|
-
|
|
4067
|
+
PlacementPreviewListResponse
|
|
2763
4068
|
If the method is called asynchronously, returns the request
|
|
2764
4069
|
thread.
|
|
2765
4070
|
"""
|
|
@@ -2788,31 +4093,30 @@ class CampaignApi(object):
|
|
|
2788
4093
|
'_content_type')
|
|
2789
4094
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2790
4095
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2791
|
-
kwargs['
|
|
2792
|
-
|
|
2793
|
-
return self.
|
|
4096
|
+
kwargs['retailer_id'] = \
|
|
4097
|
+
retailer_id
|
|
4098
|
+
return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
2794
4099
|
|
|
2795
|
-
def
|
|
4100
|
+
def get_api_v2_external_account_by_account_id_creativescreative_id(
|
|
2796
4101
|
self,
|
|
2797
4102
|
account_id,
|
|
4103
|
+
creative_id,
|
|
2798
4104
|
**kwargs
|
|
2799
4105
|
):
|
|
2800
|
-
"""
|
|
4106
|
+
"""get_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
|
|
2801
4107
|
|
|
2802
|
-
|
|
4108
|
+
Get the specified creative # noqa: E501
|
|
2803
4109
|
This method makes a synchronous HTTP request by default. To make an
|
|
2804
4110
|
asynchronous HTTP request, please pass async_req=True
|
|
2805
4111
|
|
|
2806
|
-
>>> thread = api.
|
|
4112
|
+
>>> thread = api.get_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
|
|
2807
4113
|
>>> result = thread.get()
|
|
2808
4114
|
|
|
2809
4115
|
Args:
|
|
2810
|
-
account_id (str):
|
|
4116
|
+
account_id (str): External account id to retrieve creatives for
|
|
4117
|
+
creative_id (str): Creative to get
|
|
2811
4118
|
|
|
2812
4119
|
Keyword Args:
|
|
2813
|
-
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
2814
|
-
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
2815
|
-
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
2816
4120
|
_return_http_data_only (bool): response data without head status
|
|
2817
4121
|
code and headers. Default is True.
|
|
2818
4122
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -2845,7 +4149,7 @@ class CampaignApi(object):
|
|
|
2845
4149
|
async_req (bool): execute request asynchronously
|
|
2846
4150
|
|
|
2847
4151
|
Returns:
|
|
2848
|
-
|
|
4152
|
+
CreativeV2Response
|
|
2849
4153
|
If the method is called asynchronously, returns the request
|
|
2850
4154
|
thread.
|
|
2851
4155
|
"""
|
|
@@ -2876,24 +4180,26 @@ class CampaignApi(object):
|
|
|
2876
4180
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2877
4181
|
kwargs['account_id'] = \
|
|
2878
4182
|
account_id
|
|
2879
|
-
|
|
4183
|
+
kwargs['creative_id'] = \
|
|
4184
|
+
creative_id
|
|
4185
|
+
return self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
2880
4186
|
|
|
2881
|
-
def
|
|
4187
|
+
def get_api_v2_external_campaign_preferred_line_items_by_campaign_id(
|
|
2882
4188
|
self,
|
|
2883
|
-
|
|
4189
|
+
campaign_id,
|
|
2884
4190
|
**kwargs
|
|
2885
4191
|
):
|
|
2886
|
-
"""
|
|
4192
|
+
"""get_api_v2_external_campaign_preferred_line_items_by_campaign_id # noqa: E501
|
|
2887
4193
|
|
|
2888
|
-
Gets page of
|
|
4194
|
+
Gets page of preferred line item objects for the given campaign id # noqa: E501
|
|
2889
4195
|
This method makes a synchronous HTTP request by default. To make an
|
|
2890
4196
|
asynchronous HTTP request, please pass async_req=True
|
|
2891
4197
|
|
|
2892
|
-
>>> thread = api.
|
|
4198
|
+
>>> thread = api.get_api_v2_external_campaign_preferred_line_items_by_campaign_id(campaign_id, async_req=True)
|
|
2893
4199
|
>>> result = thread.get()
|
|
2894
4200
|
|
|
2895
4201
|
Args:
|
|
2896
|
-
|
|
4202
|
+
campaign_id (str): The given campaign id
|
|
2897
4203
|
|
|
2898
4204
|
Keyword Args:
|
|
2899
4205
|
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
@@ -2931,7 +4237,7 @@ class CampaignApi(object):
|
|
|
2931
4237
|
async_req (bool): execute request asynchronously
|
|
2932
4238
|
|
|
2933
4239
|
Returns:
|
|
2934
|
-
|
|
4240
|
+
PreferredLineItemV2PagedListResponse
|
|
2935
4241
|
If the method is called asynchronously, returns the request
|
|
2936
4242
|
thread.
|
|
2937
4243
|
"""
|
|
@@ -2960,28 +4266,28 @@ class CampaignApi(object):
|
|
|
2960
4266
|
'_content_type')
|
|
2961
4267
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
2962
4268
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
2963
|
-
kwargs['
|
|
2964
|
-
|
|
2965
|
-
return self.
|
|
4269
|
+
kwargs['campaign_id'] = \
|
|
4270
|
+
campaign_id
|
|
4271
|
+
return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
2966
4272
|
|
|
2967
|
-
def
|
|
4273
|
+
def get_api_v2_external_line_item_bid_multipliers_by_line_item_id(
|
|
2968
4274
|
self,
|
|
4275
|
+
line_item_id,
|
|
2969
4276
|
**kwargs
|
|
2970
4277
|
):
|
|
2971
|
-
"""
|
|
4278
|
+
"""get_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501
|
|
2972
4279
|
|
|
2973
|
-
|
|
4280
|
+
Fetch all bid multipliers for a given line item # noqa: E501
|
|
2974
4281
|
This method makes a synchronous HTTP request by default. To make an
|
|
2975
4282
|
asynchronous HTTP request, please pass async_req=True
|
|
2976
4283
|
|
|
2977
|
-
>>> thread = api.
|
|
4284
|
+
>>> thread = api.get_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True)
|
|
2978
4285
|
>>> result = thread.get()
|
|
2979
4286
|
|
|
4287
|
+
Args:
|
|
4288
|
+
line_item_id (str): External LineItemId for bid multiplier retrieval
|
|
2980
4289
|
|
|
2981
4290
|
Keyword Args:
|
|
2982
|
-
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
2983
|
-
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
2984
|
-
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
2985
4291
|
_return_http_data_only (bool): response data without head status
|
|
2986
4292
|
code and headers. Default is True.
|
|
2987
4293
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3014,7 +4320,7 @@ class CampaignApi(object):
|
|
|
3014
4320
|
async_req (bool): execute request asynchronously
|
|
3015
4321
|
|
|
3016
4322
|
Returns:
|
|
3017
|
-
|
|
4323
|
+
JsonApiSingleResponseOfLineItemBidMultipliersV2
|
|
3018
4324
|
If the method is called asynchronously, returns the request
|
|
3019
4325
|
thread.
|
|
3020
4326
|
"""
|
|
@@ -3043,28 +4349,28 @@ class CampaignApi(object):
|
|
|
3043
4349
|
'_content_type')
|
|
3044
4350
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3045
4351
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3046
|
-
|
|
4352
|
+
kwargs['line_item_id'] = \
|
|
4353
|
+
line_item_id
|
|
4354
|
+
return self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3047
4355
|
|
|
3048
|
-
def
|
|
4356
|
+
def get_api_v2_external_preferred_line_item_by_line_item_id(
|
|
3049
4357
|
self,
|
|
3050
|
-
|
|
4358
|
+
line_item_id,
|
|
3051
4359
|
**kwargs
|
|
3052
4360
|
):
|
|
3053
|
-
"""
|
|
4361
|
+
"""get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501
|
|
3054
4362
|
|
|
3055
|
-
Gets the
|
|
4363
|
+
Gets the preferred line item for the given line item id # noqa: E501
|
|
3056
4364
|
This method makes a synchronous HTTP request by default. To make an
|
|
3057
4365
|
asynchronous HTTP request, please pass async_req=True
|
|
3058
4366
|
|
|
3059
|
-
>>> thread = api.
|
|
4367
|
+
>>> thread = api.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
|
|
3060
4368
|
>>> result = thread.get()
|
|
3061
4369
|
|
|
3062
4370
|
Args:
|
|
3063
|
-
|
|
4371
|
+
line_item_id (str): The given line item id
|
|
3064
4372
|
|
|
3065
4373
|
Keyword Args:
|
|
3066
|
-
sku_stock_type_filter (str): Filter to narrow down brands [first-party|third-party|first-and-third-party]. Defaults to first-and-third-party. [optional]
|
|
3067
|
-
brand_type (str): Filter to narrow down brands [all|uc|retailer]. Defaults to uc. [optional]
|
|
3068
4374
|
_return_http_data_only (bool): response data without head status
|
|
3069
4375
|
code and headers. Default is True.
|
|
3070
4376
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3097,7 +4403,7 @@ class CampaignApi(object):
|
|
|
3097
4403
|
async_req (bool): execute request asynchronously
|
|
3098
4404
|
|
|
3099
4405
|
Returns:
|
|
3100
|
-
|
|
4406
|
+
PreferredLineItemV2Response
|
|
3101
4407
|
If the method is called asynchronously, returns the request
|
|
3102
4408
|
thread.
|
|
3103
4409
|
"""
|
|
@@ -3126,28 +4432,26 @@ class CampaignApi(object):
|
|
|
3126
4432
|
'_content_type')
|
|
3127
4433
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3128
4434
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3129
|
-
kwargs['
|
|
3130
|
-
|
|
3131
|
-
return self.
|
|
4435
|
+
kwargs['line_item_id'] = \
|
|
4436
|
+
line_item_id
|
|
4437
|
+
return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3132
4438
|
|
|
3133
|
-
def
|
|
4439
|
+
def get_campaign_budget_overrides(
|
|
3134
4440
|
self,
|
|
3135
|
-
|
|
3136
|
-
seller,
|
|
4441
|
+
campaign_id,
|
|
3137
4442
|
**kwargs
|
|
3138
4443
|
):
|
|
3139
|
-
"""
|
|
4444
|
+
"""get_campaign_budget_overrides # noqa: E501
|
|
3140
4445
|
|
|
3141
|
-
|
|
4446
|
+
Get current campaign budget overrides by given external campaign id. # noqa: E501
|
|
3142
4447
|
This method makes a synchronous HTTP request by default. To make an
|
|
3143
4448
|
asynchronous HTTP request, please pass async_req=True
|
|
3144
4449
|
|
|
3145
|
-
>>> thread = api.
|
|
4450
|
+
>>> thread = api.get_campaign_budget_overrides(campaign_id, async_req=True)
|
|
3146
4451
|
>>> result = thread.get()
|
|
3147
4452
|
|
|
3148
4453
|
Args:
|
|
3149
|
-
|
|
3150
|
-
seller (str): The seller id or seller name which should be validated.
|
|
4454
|
+
campaign_id (int): External campaign id.
|
|
3151
4455
|
|
|
3152
4456
|
Keyword Args:
|
|
3153
4457
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3182,7 +4486,7 @@ class CampaignApi(object):
|
|
|
3182
4486
|
async_req (bool): execute request asynchronously
|
|
3183
4487
|
|
|
3184
4488
|
Returns:
|
|
3185
|
-
|
|
4489
|
+
ValueResourceOutcomeOfCampaignBudgetOverrides
|
|
3186
4490
|
If the method is called asynchronously, returns the request
|
|
3187
4491
|
thread.
|
|
3188
4492
|
"""
|
|
@@ -3211,31 +4515,31 @@ class CampaignApi(object):
|
|
|
3211
4515
|
'_content_type')
|
|
3212
4516
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3213
4517
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3214
|
-
kwargs['
|
|
3215
|
-
|
|
3216
|
-
kwargs
|
|
3217
|
-
seller
|
|
3218
|
-
return self.get_api_v1_external_retailer_by_retailer_id_seller_by_seller_endpoint.call_with_http_info(**kwargs)
|
|
4518
|
+
kwargs['campaign_id'] = \
|
|
4519
|
+
campaign_id
|
|
4520
|
+
return self.get_campaign_budget_overrides_endpoint.call_with_http_info(**kwargs)
|
|
3219
4521
|
|
|
3220
|
-
def
|
|
4522
|
+
def get_insertion_order_history_change_data_capture(
|
|
3221
4523
|
self,
|
|
3222
|
-
|
|
4524
|
+
insertion_order_id,
|
|
3223
4525
|
**kwargs
|
|
3224
4526
|
):
|
|
3225
|
-
"""
|
|
4527
|
+
"""get_insertion_order_history_change_data_capture # noqa: E501
|
|
3226
4528
|
|
|
3227
|
-
Gets the
|
|
4529
|
+
Gets the balance's historical data change capture. # noqa: E501
|
|
3228
4530
|
This method makes a synchronous HTTP request by default. To make an
|
|
3229
4531
|
asynchronous HTTP request, please pass async_req=True
|
|
3230
4532
|
|
|
3231
|
-
>>> thread = api.
|
|
4533
|
+
>>> thread = api.get_insertion_order_history_change_data_capture(insertion_order_id, async_req=True)
|
|
3232
4534
|
>>> result = thread.get()
|
|
3233
4535
|
|
|
3234
4536
|
Args:
|
|
3235
|
-
|
|
4537
|
+
insertion_order_id (str): External insertion order id.
|
|
3236
4538
|
|
|
3237
4539
|
Keyword Args:
|
|
3238
|
-
|
|
4540
|
+
offset (int): The (zero-based) starting offset in the collection.. [optional] if omitted the server will use the default value of 0
|
|
4541
|
+
limit (int): The number of elements to be returned.. [optional] if omitted the server will use the default value of 25
|
|
4542
|
+
limit_to_change_types (str): Comma separated change types string that will be queried.. [optional]
|
|
3239
4543
|
_return_http_data_only (bool): response data without head status
|
|
3240
4544
|
code and headers. Default is True.
|
|
3241
4545
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3268,7 +4572,7 @@ class CampaignApi(object):
|
|
|
3268
4572
|
async_req (bool): execute request asynchronously
|
|
3269
4573
|
|
|
3270
4574
|
Returns:
|
|
3271
|
-
|
|
4575
|
+
PageOfInsertionOrderHistoryChangeDataCapture
|
|
3272
4576
|
If the method is called asynchronously, returns the request
|
|
3273
4577
|
thread.
|
|
3274
4578
|
"""
|
|
@@ -3297,26 +4601,26 @@ class CampaignApi(object):
|
|
|
3297
4601
|
'_content_type')
|
|
3298
4602
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3299
4603
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3300
|
-
kwargs['
|
|
3301
|
-
|
|
3302
|
-
return self.
|
|
4604
|
+
kwargs['insertion_order_id'] = \
|
|
4605
|
+
insertion_order_id
|
|
4606
|
+
return self.get_insertion_order_history_change_data_capture_endpoint.call_with_http_info(**kwargs)
|
|
3303
4607
|
|
|
3304
|
-
def
|
|
4608
|
+
def get_line_item_budget_overrides(
|
|
3305
4609
|
self,
|
|
3306
|
-
|
|
4610
|
+
line_item_id,
|
|
3307
4611
|
**kwargs
|
|
3308
4612
|
):
|
|
3309
|
-
"""
|
|
4613
|
+
"""get_line_item_budget_overrides # noqa: E501
|
|
3310
4614
|
|
|
3311
|
-
Gets
|
|
4615
|
+
Gets a collection of monthly and daily budget overrides for the provided line item. # noqa: E501
|
|
3312
4616
|
This method makes a synchronous HTTP request by default. To make an
|
|
3313
4617
|
asynchronous HTTP request, please pass async_req=True
|
|
3314
4618
|
|
|
3315
|
-
>>> thread = api.
|
|
4619
|
+
>>> thread = api.get_line_item_budget_overrides(line_item_id, async_req=True)
|
|
3316
4620
|
>>> result = thread.get()
|
|
3317
4621
|
|
|
3318
4622
|
Args:
|
|
3319
|
-
|
|
4623
|
+
line_item_id (str): The line item id to get budget overrides for.
|
|
3320
4624
|
|
|
3321
4625
|
Keyword Args:
|
|
3322
4626
|
_return_http_data_only (bool): response data without head status
|
|
@@ -3351,7 +4655,7 @@ class CampaignApi(object):
|
|
|
3351
4655
|
async_req (bool): execute request asynchronously
|
|
3352
4656
|
|
|
3353
4657
|
Returns:
|
|
3354
|
-
|
|
4658
|
+
ValueResourceOutcomeOfLineItemBudgetOverrides
|
|
3355
4659
|
If the method is called asynchronously, returns the request
|
|
3356
4660
|
thread.
|
|
3357
4661
|
"""
|
|
@@ -3380,31 +4684,28 @@ class CampaignApi(object):
|
|
|
3380
4684
|
'_content_type')
|
|
3381
4685
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3382
4686
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3383
|
-
kwargs['
|
|
3384
|
-
|
|
3385
|
-
return self.
|
|
4687
|
+
kwargs['line_item_id'] = \
|
|
4688
|
+
line_item_id
|
|
4689
|
+
return self.get_line_item_budget_overrides_endpoint.call_with_http_info(**kwargs)
|
|
3386
4690
|
|
|
3387
|
-
def
|
|
4691
|
+
def get_recommended_keywords(
|
|
3388
4692
|
self,
|
|
3389
|
-
|
|
4693
|
+
external_line_item_id,
|
|
3390
4694
|
**kwargs
|
|
3391
4695
|
):
|
|
3392
|
-
"""
|
|
4696
|
+
"""get_recommended_keywords # noqa: E501
|
|
3393
4697
|
|
|
3394
|
-
|
|
4698
|
+
Retrieves a collection of recommended keywords for a line item # noqa: E501
|
|
3395
4699
|
This method makes a synchronous HTTP request by default. To make an
|
|
3396
4700
|
asynchronous HTTP request, please pass async_req=True
|
|
3397
4701
|
|
|
3398
|
-
>>> thread = api.
|
|
4702
|
+
>>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True)
|
|
3399
4703
|
>>> result = thread.get()
|
|
3400
4704
|
|
|
3401
4705
|
Args:
|
|
3402
|
-
|
|
4706
|
+
external_line_item_id (str): The external line item identifier
|
|
3403
4707
|
|
|
3404
4708
|
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]
|
|
3408
4709
|
_return_http_data_only (bool): response data without head status
|
|
3409
4710
|
code and headers. Default is True.
|
|
3410
4711
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3437,7 +4738,7 @@ class CampaignApi(object):
|
|
|
3437
4738
|
async_req (bool): execute request asynchronously
|
|
3438
4739
|
|
|
3439
4740
|
Returns:
|
|
3440
|
-
|
|
4741
|
+
ValueResourceOutcomeOfRecommendedKeywordsResult
|
|
3441
4742
|
If the method is called asynchronously, returns the request
|
|
3442
4743
|
thread.
|
|
3443
4744
|
"""
|
|
@@ -3466,28 +4767,33 @@ class CampaignApi(object):
|
|
|
3466
4767
|
'_content_type')
|
|
3467
4768
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3468
4769
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3469
|
-
kwargs['
|
|
3470
|
-
|
|
3471
|
-
return self.
|
|
4770
|
+
kwargs['external_line_item_id'] = \
|
|
4771
|
+
external_line_item_id
|
|
4772
|
+
return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs)
|
|
3472
4773
|
|
|
3473
|
-
def
|
|
4774
|
+
def get_sku_by_product_id(
|
|
3474
4775
|
self,
|
|
3475
|
-
|
|
4776
|
+
account_id,
|
|
4777
|
+
retailer_id,
|
|
3476
4778
|
**kwargs
|
|
3477
4779
|
):
|
|
3478
|
-
"""
|
|
4780
|
+
"""get_sku_by_product_id # noqa: E501
|
|
3479
4781
|
|
|
3480
|
-
Gets
|
|
4782
|
+
Gets a list of SKUs based on a privided list of Product Ids # noqa: E501
|
|
3481
4783
|
This method makes a synchronous HTTP request by default. To make an
|
|
3482
4784
|
asynchronous HTTP request, please pass async_req=True
|
|
3483
4785
|
|
|
3484
|
-
>>> thread = api.
|
|
4786
|
+
>>> thread = api.get_sku_by_product_id(account_id, retailer_id, async_req=True)
|
|
3485
4787
|
>>> result = thread.get()
|
|
3486
4788
|
|
|
3487
4789
|
Args:
|
|
3488
|
-
|
|
4790
|
+
account_id (str): account id
|
|
4791
|
+
retailer_id (int): retailer id
|
|
3489
4792
|
|
|
3490
4793
|
Keyword Args:
|
|
4794
|
+
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
|
|
4795
|
+
limit (int): max number of results to return. [optional] if omitted the server will use the default value of 100
|
|
4796
|
+
sku_search_request (SkuSearchRequest): . [optional]
|
|
3491
4797
|
_return_http_data_only (bool): response data without head status
|
|
3492
4798
|
code and headers. Default is True.
|
|
3493
4799
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3520,7 +4826,7 @@ class CampaignApi(object):
|
|
|
3520
4826
|
async_req (bool): execute request asynchronously
|
|
3521
4827
|
|
|
3522
4828
|
Returns:
|
|
3523
|
-
|
|
4829
|
+
ResourceCollectionOutcomeOfSkuSearchResult
|
|
3524
4830
|
If the method is called asynchronously, returns the request
|
|
3525
4831
|
thread.
|
|
3526
4832
|
"""
|
|
@@ -3549,28 +4855,31 @@ class CampaignApi(object):
|
|
|
3549
4855
|
'_content_type')
|
|
3550
4856
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3551
4857
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3552
|
-
kwargs['
|
|
3553
|
-
|
|
3554
|
-
|
|
4858
|
+
kwargs['account_id'] = \
|
|
4859
|
+
account_id
|
|
4860
|
+
kwargs['retailer_id'] = \
|
|
4861
|
+
retailer_id
|
|
4862
|
+
return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs)
|
|
3555
4863
|
|
|
3556
|
-
def
|
|
4864
|
+
def pause_promoted_products(
|
|
3557
4865
|
self,
|
|
3558
|
-
|
|
4866
|
+
line_item_id,
|
|
3559
4867
|
**kwargs
|
|
3560
4868
|
):
|
|
3561
|
-
"""
|
|
4869
|
+
"""pause_promoted_products # noqa: E501
|
|
3562
4870
|
|
|
3563
|
-
|
|
4871
|
+
Pause a collection of promoted products associated with a line item # noqa: E501
|
|
3564
4872
|
This method makes a synchronous HTTP request by default. To make an
|
|
3565
4873
|
asynchronous HTTP request, please pass async_req=True
|
|
3566
4874
|
|
|
3567
|
-
>>> thread = api.
|
|
4875
|
+
>>> thread = api.pause_promoted_products(line_item_id, async_req=True)
|
|
3568
4876
|
>>> result = thread.get()
|
|
3569
4877
|
|
|
3570
4878
|
Args:
|
|
3571
|
-
|
|
4879
|
+
line_item_id (str): ID of the line item
|
|
3572
4880
|
|
|
3573
4881
|
Keyword Args:
|
|
4882
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
3574
4883
|
_return_http_data_only (bool): response data without head status
|
|
3575
4884
|
code and headers. Default is True.
|
|
3576
4885
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3603,7 +4912,7 @@ class CampaignApi(object):
|
|
|
3603
4912
|
async_req (bool): execute request asynchronously
|
|
3604
4913
|
|
|
3605
4914
|
Returns:
|
|
3606
|
-
|
|
4915
|
+
None
|
|
3607
4916
|
If the method is called asynchronously, returns the request
|
|
3608
4917
|
thread.
|
|
3609
4918
|
"""
|
|
@@ -3632,31 +4941,30 @@ class CampaignApi(object):
|
|
|
3632
4941
|
'_content_type')
|
|
3633
4942
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3634
4943
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3635
|
-
kwargs['
|
|
3636
|
-
|
|
3637
|
-
return self.
|
|
4944
|
+
kwargs['line_item_id'] = \
|
|
4945
|
+
line_item_id
|
|
4946
|
+
return self.pause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
3638
4947
|
|
|
3639
|
-
def
|
|
4948
|
+
def post_api202110_external_campaign_preferred_line_items_by_campaign_id(
|
|
3640
4949
|
self,
|
|
3641
|
-
|
|
4950
|
+
campaign_id,
|
|
4951
|
+
preferred_line_item_create_model_v2_request,
|
|
3642
4952
|
**kwargs
|
|
3643
4953
|
):
|
|
3644
|
-
"""
|
|
4954
|
+
"""post_api202110_external_campaign_preferred_line_items_by_campaign_id # noqa: E501
|
|
3645
4955
|
|
|
3646
|
-
|
|
4956
|
+
Creates a new preferred line item with the specified settings # noqa: E501
|
|
3647
4957
|
This method makes a synchronous HTTP request by default. To make an
|
|
3648
4958
|
asynchronous HTTP request, please pass async_req=True
|
|
3649
4959
|
|
|
3650
|
-
>>> thread = api.
|
|
4960
|
+
>>> thread = api.post_api202110_external_campaign_preferred_line_items_by_campaign_id(campaign_id, preferred_line_item_create_model_v2_request, async_req=True)
|
|
3651
4961
|
>>> result = thread.get()
|
|
3652
4962
|
|
|
3653
4963
|
Args:
|
|
3654
|
-
|
|
4964
|
+
campaign_id (str): The given campaign id
|
|
4965
|
+
preferred_line_item_create_model_v2_request (PreferredLineItemCreateModelV2Request): The line item settings to create a line item with
|
|
3655
4966
|
|
|
3656
4967
|
Keyword Args:
|
|
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]
|
|
3660
4968
|
_return_http_data_only (bool): response data without head status
|
|
3661
4969
|
code and headers. Default is True.
|
|
3662
4970
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3689,7 +4997,7 @@ class CampaignApi(object):
|
|
|
3689
4997
|
async_req (bool): execute request asynchronously
|
|
3690
4998
|
|
|
3691
4999
|
Returns:
|
|
3692
|
-
|
|
5000
|
+
PreferredLineItemV2Response
|
|
3693
5001
|
If the method is called asynchronously, returns the request
|
|
3694
5002
|
thread.
|
|
3695
5003
|
"""
|
|
@@ -3718,28 +5026,31 @@ class CampaignApi(object):
|
|
|
3718
5026
|
'_content_type')
|
|
3719
5027
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3720
5028
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3721
|
-
kwargs['
|
|
3722
|
-
|
|
3723
|
-
|
|
5029
|
+
kwargs['campaign_id'] = \
|
|
5030
|
+
campaign_id
|
|
5031
|
+
kwargs['preferred_line_item_create_model_v2_request'] = \
|
|
5032
|
+
preferred_line_item_create_model_v2_request
|
|
5033
|
+
return self.post_api202110_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
|
|
3724
5034
|
|
|
3725
|
-
def
|
|
5035
|
+
def post_api202210_external_line_item_product_buttons_create_by_line_item_id(
|
|
3726
5036
|
self,
|
|
3727
5037
|
line_item_id,
|
|
3728
5038
|
**kwargs
|
|
3729
5039
|
):
|
|
3730
|
-
"""
|
|
5040
|
+
"""post_api202210_external_line_item_product_buttons_create_by_line_item_id # noqa: E501
|
|
3731
5041
|
|
|
3732
|
-
|
|
5042
|
+
Append new product buttons to a line item # noqa: E501
|
|
3733
5043
|
This method makes a synchronous HTTP request by default. To make an
|
|
3734
5044
|
asynchronous HTTP request, please pass async_req=True
|
|
3735
5045
|
|
|
3736
|
-
>>> thread = api.
|
|
5046
|
+
>>> thread = api.post_api202210_external_line_item_product_buttons_create_by_line_item_id(line_item_id, async_req=True)
|
|
3737
5047
|
>>> result = thread.get()
|
|
3738
5048
|
|
|
3739
5049
|
Args:
|
|
3740
|
-
line_item_id (str):
|
|
5050
|
+
line_item_id (str): Long external id of the associated line item
|
|
3741
5051
|
|
|
3742
5052
|
Keyword Args:
|
|
5053
|
+
product_button_list_request (ProductButtonListRequest): List of product buttons to append to the specified line item. [optional]
|
|
3743
5054
|
_return_http_data_only (bool): response data without head status
|
|
3744
5055
|
code and headers. Default is True.
|
|
3745
5056
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3772,7 +5083,7 @@ class CampaignApi(object):
|
|
|
3772
5083
|
async_req (bool): execute request asynchronously
|
|
3773
5084
|
|
|
3774
5085
|
Returns:
|
|
3775
|
-
|
|
5086
|
+
ProductButtonListResponse
|
|
3776
5087
|
If the method is called asynchronously, returns the request
|
|
3777
5088
|
thread.
|
|
3778
5089
|
"""
|
|
@@ -3803,26 +5114,26 @@ class CampaignApi(object):
|
|
|
3803
5114
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3804
5115
|
kwargs['line_item_id'] = \
|
|
3805
5116
|
line_item_id
|
|
3806
|
-
return self.
|
|
5117
|
+
return self.post_api202210_external_line_item_product_buttons_create_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
3807
5118
|
|
|
3808
|
-
def
|
|
5119
|
+
def post_api_v1_external_catalogs_sku_retrieval(
|
|
3809
5120
|
self,
|
|
3810
|
-
external_line_item_id,
|
|
3811
5121
|
**kwargs
|
|
3812
5122
|
):
|
|
3813
|
-
"""
|
|
5123
|
+
"""post_api_v1_external_catalogs_sku_retrieval # noqa: E501
|
|
3814
5124
|
|
|
3815
|
-
|
|
5125
|
+
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
3816
5126
|
This method makes a synchronous HTTP request by default. To make an
|
|
3817
5127
|
asynchronous HTTP request, please pass async_req=True
|
|
3818
5128
|
|
|
3819
|
-
>>> thread = api.
|
|
5129
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_retrieval(async_req=True)
|
|
3820
5130
|
>>> result = thread.get()
|
|
3821
5131
|
|
|
3822
|
-
Args:
|
|
3823
|
-
external_line_item_id (str): The external line item identifier
|
|
3824
5132
|
|
|
3825
5133
|
Keyword Args:
|
|
5134
|
+
page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
5135
|
+
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
5136
|
+
request_body ([str]): The list of SKU keys to retrieve sku information. [optional]
|
|
3826
5137
|
_return_http_data_only (bool): response data without head status
|
|
3827
5138
|
code and headers. Default is True.
|
|
3828
5139
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3855,7 +5166,7 @@ class CampaignApi(object):
|
|
|
3855
5166
|
async_req (bool): execute request asynchronously
|
|
3856
5167
|
|
|
3857
5168
|
Returns:
|
|
3858
|
-
|
|
5169
|
+
SkuDataPreviewListResponse
|
|
3859
5170
|
If the method is called asynchronously, returns the request
|
|
3860
5171
|
thread.
|
|
3861
5172
|
"""
|
|
@@ -3884,33 +5195,26 @@ class CampaignApi(object):
|
|
|
3884
5195
|
'_content_type')
|
|
3885
5196
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3886
5197
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3887
|
-
kwargs
|
|
3888
|
-
external_line_item_id
|
|
3889
|
-
return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs)
|
|
5198
|
+
return self.post_api_v1_external_catalogs_sku_retrieval_endpoint.call_with_http_info(**kwargs)
|
|
3890
5199
|
|
|
3891
|
-
def
|
|
5200
|
+
def post_api_v1_external_catalogs_sku_search(
|
|
3892
5201
|
self,
|
|
3893
|
-
account_id,
|
|
3894
|
-
retailer_id,
|
|
3895
5202
|
**kwargs
|
|
3896
5203
|
):
|
|
3897
|
-
"""
|
|
5204
|
+
"""post_api_v1_external_catalogs_sku_search # noqa: E501
|
|
3898
5205
|
|
|
3899
|
-
|
|
5206
|
+
Endpoint to search skus by text, retailer and sellers/brands. # noqa: E501
|
|
3900
5207
|
This method makes a synchronous HTTP request by default. To make an
|
|
3901
5208
|
asynchronous HTTP request, please pass async_req=True
|
|
3902
5209
|
|
|
3903
|
-
>>> thread = api.
|
|
5210
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_search(async_req=True)
|
|
3904
5211
|
>>> result = thread.get()
|
|
3905
5212
|
|
|
3906
|
-
Args:
|
|
3907
|
-
account_id (str): account id
|
|
3908
|
-
retailer_id (int): retailer id
|
|
3909
5213
|
|
|
3910
5214
|
Keyword Args:
|
|
3911
|
-
|
|
3912
|
-
|
|
3913
|
-
|
|
5215
|
+
page_index (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
5216
|
+
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
5217
|
+
sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional]
|
|
3914
5218
|
_return_http_data_only (bool): response data without head status
|
|
3915
5219
|
code and headers. Default is True.
|
|
3916
5220
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -3943,7 +5247,7 @@ class CampaignApi(object):
|
|
|
3943
5247
|
async_req (bool): execute request asynchronously
|
|
3944
5248
|
|
|
3945
5249
|
Returns:
|
|
3946
|
-
|
|
5250
|
+
SkuDataPreviewListResponse
|
|
3947
5251
|
If the method is called asynchronously, returns the request
|
|
3948
5252
|
thread.
|
|
3949
5253
|
"""
|
|
@@ -3972,32 +5276,31 @@ class CampaignApi(object):
|
|
|
3972
5276
|
'_content_type')
|
|
3973
5277
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
3974
5278
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
3975
|
-
kwargs
|
|
3976
|
-
account_id
|
|
3977
|
-
kwargs['retailer_id'] = \
|
|
3978
|
-
retailer_id
|
|
3979
|
-
return self.get_sku_by_product_id_endpoint.call_with_http_info(**kwargs)
|
|
5279
|
+
return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs)
|
|
3980
5280
|
|
|
3981
|
-
def
|
|
5281
|
+
def post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id(
|
|
3982
5282
|
self,
|
|
3983
|
-
|
|
3984
|
-
|
|
5283
|
+
account_id,
|
|
5284
|
+
retailer_id,
|
|
3985
5285
|
**kwargs
|
|
3986
5286
|
):
|
|
3987
|
-
"""
|
|
5287
|
+
"""post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id # noqa: E501
|
|
3988
5288
|
|
|
3989
|
-
|
|
5289
|
+
Endpoint to search skus by text, account and retailer with an option to filter by brands id's. # noqa: E501
|
|
3990
5290
|
This method makes a synchronous HTTP request by default. To make an
|
|
3991
5291
|
asynchronous HTTP request, please pass async_req=True
|
|
3992
5292
|
|
|
3993
|
-
>>> thread = api.
|
|
5293
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id(account_id, retailer_id, async_req=True)
|
|
3994
5294
|
>>> result = thread.get()
|
|
3995
5295
|
|
|
3996
5296
|
Args:
|
|
3997
|
-
|
|
3998
|
-
|
|
5297
|
+
account_id (str): The account for which skus should be searched for.
|
|
5298
|
+
retailer_id (str): The client id/retailer id for which skus should be searched for.
|
|
3999
5299
|
|
|
4000
5300
|
Keyword Args:
|
|
5301
|
+
offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
5302
|
+
limit (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
5303
|
+
sku_search_request_slim_preview_request (SkuSearchRequestSlimPreviewRequest): . [optional]
|
|
4001
5304
|
_return_http_data_only (bool): response data without head status
|
|
4002
5305
|
code and headers. Default is True.
|
|
4003
5306
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4030,7 +5333,7 @@ class CampaignApi(object):
|
|
|
4030
5333
|
async_req (bool): execute request asynchronously
|
|
4031
5334
|
|
|
4032
5335
|
Returns:
|
|
4033
|
-
|
|
5336
|
+
SkuSlimDataPreviewListResponse
|
|
4034
5337
|
If the method is called asynchronously, returns the request
|
|
4035
5338
|
thread.
|
|
4036
5339
|
"""
|
|
@@ -4059,31 +5362,34 @@ class CampaignApi(object):
|
|
|
4059
5362
|
'_content_type')
|
|
4060
5363
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4061
5364
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4062
|
-
kwargs['
|
|
4063
|
-
|
|
4064
|
-
kwargs['
|
|
4065
|
-
|
|
4066
|
-
return self.
|
|
5365
|
+
kwargs['account_id'] = \
|
|
5366
|
+
account_id
|
|
5367
|
+
kwargs['retailer_id'] = \
|
|
5368
|
+
retailer_id
|
|
5369
|
+
return self.post_api_v1_external_catalogs_sku_search_account_id_and_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
4067
5370
|
|
|
4068
|
-
def
|
|
5371
|
+
def post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id(
|
|
4069
5372
|
self,
|
|
4070
|
-
|
|
5373
|
+
retailer_id,
|
|
4071
5374
|
**kwargs
|
|
4072
5375
|
):
|
|
4073
|
-
"""
|
|
5376
|
+
"""post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id # noqa: E501
|
|
4074
5377
|
|
|
4075
|
-
|
|
5378
|
+
Endpoint to search skus by text for a retailer with an option to filter by brands id's. # noqa: E501
|
|
4076
5379
|
This method makes a synchronous HTTP request by default. To make an
|
|
4077
5380
|
asynchronous HTTP request, please pass async_req=True
|
|
4078
5381
|
|
|
4079
|
-
>>> thread = api.
|
|
5382
|
+
>>> thread = api.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id(retailer_id, async_req=True)
|
|
4080
5383
|
>>> result = thread.get()
|
|
4081
5384
|
|
|
4082
5385
|
Args:
|
|
4083
|
-
|
|
5386
|
+
retailer_id (str): The client id/retailer id for which skus should be searched for.
|
|
4084
5387
|
|
|
4085
5388
|
Keyword Args:
|
|
4086
|
-
|
|
5389
|
+
x_origin_account (str): The account id of the initiator of the call.. [optional]
|
|
5390
|
+
offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
5391
|
+
limit (int): The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit.. [optional] if omitted the server will use the default value of 100
|
|
5392
|
+
sku_search_request_slim_v2_preview_request (SkuSearchRequestSlimV2PreviewRequest): . [optional]
|
|
4087
5393
|
_return_http_data_only (bool): response data without head status
|
|
4088
5394
|
code and headers. Default is True.
|
|
4089
5395
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4116,7 +5422,7 @@ class CampaignApi(object):
|
|
|
4116
5422
|
async_req (bool): execute request asynchronously
|
|
4117
5423
|
|
|
4118
5424
|
Returns:
|
|
4119
|
-
|
|
5425
|
+
SkuSlimDataV2ListResponse
|
|
4120
5426
|
If the method is called asynchronously, returns the request
|
|
4121
5427
|
thread.
|
|
4122
5428
|
"""
|
|
@@ -4145,28 +5451,29 @@ class CampaignApi(object):
|
|
|
4145
5451
|
'_content_type')
|
|
4146
5452
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4147
5453
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4148
|
-
kwargs['
|
|
4149
|
-
|
|
4150
|
-
return self.
|
|
5454
|
+
kwargs['retailer_id'] = \
|
|
5455
|
+
retailer_id
|
|
5456
|
+
return self.post_api_v1_external_catalogs_sku_search_retailer_by_retailer_id_endpoint.call_with_http_info(**kwargs)
|
|
4151
5457
|
|
|
4152
|
-
def
|
|
5458
|
+
def post_api_v2_external_account_creatives_by_account_id(
|
|
4153
5459
|
self,
|
|
5460
|
+
account_id,
|
|
4154
5461
|
**kwargs
|
|
4155
5462
|
):
|
|
4156
|
-
"""
|
|
5463
|
+
"""post_api_v2_external_account_creatives_by_account_id # noqa: E501
|
|
4157
5464
|
|
|
4158
|
-
|
|
5465
|
+
Create a creative for an account # noqa: E501
|
|
4159
5466
|
This method makes a synchronous HTTP request by default. To make an
|
|
4160
5467
|
asynchronous HTTP request, please pass async_req=True
|
|
4161
5468
|
|
|
4162
|
-
>>> thread = api.
|
|
5469
|
+
>>> thread = api.post_api_v2_external_account_creatives_by_account_id(account_id, async_req=True)
|
|
4163
5470
|
>>> result = thread.get()
|
|
4164
5471
|
|
|
5472
|
+
Args:
|
|
5473
|
+
account_id (str): External account id to create a creative for
|
|
4165
5474
|
|
|
4166
5475
|
Keyword Args:
|
|
4167
|
-
|
|
4168
|
-
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4169
|
-
request_body ([str]): The list of SKU keys to retrieve sku information. [optional]
|
|
5476
|
+
external_creative_create_model_v2 (ExternalCreativeCreateModelV2): The creative to create. [optional]
|
|
4170
5477
|
_return_http_data_only (bool): response data without head status
|
|
4171
5478
|
code and headers. Default is True.
|
|
4172
5479
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4199,7 +5506,7 @@ class CampaignApi(object):
|
|
|
4199
5506
|
async_req (bool): execute request asynchronously
|
|
4200
5507
|
|
|
4201
5508
|
Returns:
|
|
4202
|
-
|
|
5509
|
+
CreativeV2Response
|
|
4203
5510
|
If the method is called asynchronously, returns the request
|
|
4204
5511
|
thread.
|
|
4205
5512
|
"""
|
|
@@ -4228,26 +5535,29 @@ class CampaignApi(object):
|
|
|
4228
5535
|
'_content_type')
|
|
4229
5536
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4230
5537
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4231
|
-
|
|
5538
|
+
kwargs['account_id'] = \
|
|
5539
|
+
account_id
|
|
5540
|
+
return self.post_api_v2_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
4232
5541
|
|
|
4233
|
-
def
|
|
5542
|
+
def post_api_v2_external_account_creatives_search_by_account_id(
|
|
4234
5543
|
self,
|
|
5544
|
+
account_id,
|
|
4235
5545
|
**kwargs
|
|
4236
5546
|
):
|
|
4237
|
-
"""
|
|
5547
|
+
"""post_api_v2_external_account_creatives_search_by_account_id # noqa: E501
|
|
4238
5548
|
|
|
4239
|
-
|
|
5549
|
+
Get account creatives # noqa: E501
|
|
4240
5550
|
This method makes a synchronous HTTP request by default. To make an
|
|
4241
5551
|
asynchronous HTTP request, please pass async_req=True
|
|
4242
5552
|
|
|
4243
|
-
>>> thread = api.
|
|
5553
|
+
>>> thread = api.post_api_v2_external_account_creatives_search_by_account_id(account_id, async_req=True)
|
|
4244
5554
|
>>> result = thread.get()
|
|
4245
5555
|
|
|
5556
|
+
Args:
|
|
5557
|
+
account_id (str): External account id to retrieve creatives for
|
|
4246
5558
|
|
|
4247
5559
|
Keyword Args:
|
|
4248
|
-
|
|
4249
|
-
page_size (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4250
|
-
sku_search_request_preview_request (SkuSearchRequestPreviewRequest): . [optional]
|
|
5560
|
+
creative_ids ([str]): Creatives to filter by. [optional]
|
|
4251
5561
|
_return_http_data_only (bool): response data without head status
|
|
4252
5562
|
code and headers. Default is True.
|
|
4253
5563
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4280,7 +5590,7 @@ class CampaignApi(object):
|
|
|
4280
5590
|
async_req (bool): execute request asynchronously
|
|
4281
5591
|
|
|
4282
5592
|
Returns:
|
|
4283
|
-
|
|
5593
|
+
CreativeV2ListResponse
|
|
4284
5594
|
If the method is called asynchronously, returns the request
|
|
4285
5595
|
thread.
|
|
4286
5596
|
"""
|
|
@@ -4309,31 +5619,30 @@ class CampaignApi(object):
|
|
|
4309
5619
|
'_content_type')
|
|
4310
5620
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4311
5621
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4312
|
-
|
|
5622
|
+
kwargs['account_id'] = \
|
|
5623
|
+
account_id
|
|
5624
|
+
return self.post_api_v2_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs)
|
|
4313
5625
|
|
|
4314
|
-
def
|
|
5626
|
+
def put_api202110_external_preferred_line_item_by_line_item_id(
|
|
4315
5627
|
self,
|
|
4316
|
-
|
|
4317
|
-
|
|
5628
|
+
line_item_id,
|
|
5629
|
+
preferred_line_item_update_model_v2_request,
|
|
4318
5630
|
**kwargs
|
|
4319
5631
|
):
|
|
4320
|
-
"""
|
|
5632
|
+
"""put_api202110_external_preferred_line_item_by_line_item_id # noqa: E501
|
|
4321
5633
|
|
|
4322
|
-
|
|
5634
|
+
Updates the preferred line item for the given line item id # noqa: E501
|
|
4323
5635
|
This method makes a synchronous HTTP request by default. To make an
|
|
4324
5636
|
asynchronous HTTP request, please pass async_req=True
|
|
4325
5637
|
|
|
4326
|
-
>>> thread = api.
|
|
5638
|
+
>>> 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)
|
|
4327
5639
|
>>> result = thread.get()
|
|
4328
5640
|
|
|
4329
5641
|
Args:
|
|
4330
|
-
|
|
4331
|
-
|
|
5642
|
+
line_item_id (str): The given line item id
|
|
5643
|
+
preferred_line_item_update_model_v2_request (PreferredLineItemUpdateModelV2Request): The line item settings to create a line item with
|
|
4332
5644
|
|
|
4333
5645
|
Keyword Args:
|
|
4334
|
-
offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
4335
|
-
limit (int): The maximum number of results to return with each call. Must be greater than zero.. [optional] if omitted the server will use the default value of 100
|
|
4336
|
-
sku_search_request_slim_preview_request (SkuSearchRequestSlimPreviewRequest): . [optional]
|
|
4337
5646
|
_return_http_data_only (bool): response data without head status
|
|
4338
5647
|
code and headers. Default is True.
|
|
4339
5648
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4366,7 +5675,7 @@ class CampaignApi(object):
|
|
|
4366
5675
|
async_req (bool): execute request asynchronously
|
|
4367
5676
|
|
|
4368
5677
|
Returns:
|
|
4369
|
-
|
|
5678
|
+
PreferredLineItemV2Response
|
|
4370
5679
|
If the method is called asynchronously, returns the request
|
|
4371
5680
|
thread.
|
|
4372
5681
|
"""
|
|
@@ -4395,34 +5704,33 @@ class CampaignApi(object):
|
|
|
4395
5704
|
'_content_type')
|
|
4396
5705
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4397
5706
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4398
|
-
kwargs['
|
|
4399
|
-
|
|
4400
|
-
kwargs['
|
|
4401
|
-
|
|
4402
|
-
return self.
|
|
5707
|
+
kwargs['line_item_id'] = \
|
|
5708
|
+
line_item_id
|
|
5709
|
+
kwargs['preferred_line_item_update_model_v2_request'] = \
|
|
5710
|
+
preferred_line_item_update_model_v2_request
|
|
5711
|
+
return self.put_api202110_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4403
5712
|
|
|
4404
|
-
def
|
|
5713
|
+
def put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
|
|
4405
5714
|
self,
|
|
4406
|
-
|
|
5715
|
+
line_item_id,
|
|
5716
|
+
product_button_id,
|
|
4407
5717
|
**kwargs
|
|
4408
5718
|
):
|
|
4409
|
-
"""
|
|
5719
|
+
"""put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id # noqa: E501
|
|
4410
5720
|
|
|
4411
|
-
|
|
5721
|
+
Update a product button # noqa: E501
|
|
4412
5722
|
This method makes a synchronous HTTP request by default. To make an
|
|
4413
5723
|
asynchronous HTTP request, please pass async_req=True
|
|
4414
5724
|
|
|
4415
|
-
>>> thread = api.
|
|
5725
|
+
>>> thread = api.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(line_item_id, product_button_id, async_req=True)
|
|
4416
5726
|
>>> result = thread.get()
|
|
4417
5727
|
|
|
4418
5728
|
Args:
|
|
4419
|
-
|
|
5729
|
+
line_item_id (str): Long external id of the associated line item
|
|
5730
|
+
product_button_id (str): Sequential id of the product button
|
|
4420
5731
|
|
|
4421
5732
|
Keyword Args:
|
|
4422
|
-
|
|
4423
|
-
offset (int): The start position in the overall list of matches. Must be zero or greater.. [optional] if omitted the server will use the default value of 0
|
|
4424
|
-
limit (int): The maximum number of results to return with each call. Must be greater than zero and less than 1500. 10,000 records deep is the max limit.. [optional] if omitted the server will use the default value of 100
|
|
4425
|
-
sku_search_request_slim_v2_preview_request (SkuSearchRequestSlimV2PreviewRequest): . [optional]
|
|
5733
|
+
product_button_request (ProductButtonRequest): Details of the updated product button. [optional]
|
|
4426
5734
|
_return_http_data_only (bool): response data without head status
|
|
4427
5735
|
code and headers. Default is True.
|
|
4428
5736
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4455,7 +5763,7 @@ class CampaignApi(object):
|
|
|
4455
5763
|
async_req (bool): execute request asynchronously
|
|
4456
5764
|
|
|
4457
5765
|
Returns:
|
|
4458
|
-
|
|
5766
|
+
ProductButtonListResponse
|
|
4459
5767
|
If the method is called asynchronously, returns the request
|
|
4460
5768
|
thread.
|
|
4461
5769
|
"""
|
|
@@ -4484,30 +5792,33 @@ class CampaignApi(object):
|
|
|
4484
5792
|
'_content_type')
|
|
4485
5793
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4486
5794
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4487
|
-
kwargs['
|
|
4488
|
-
|
|
4489
|
-
|
|
5795
|
+
kwargs['line_item_id'] = \
|
|
5796
|
+
line_item_id
|
|
5797
|
+
kwargs['product_button_id'] = \
|
|
5798
|
+
product_button_id
|
|
5799
|
+
return self.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
4490
5800
|
|
|
4491
|
-
def
|
|
5801
|
+
def put_api_v2_external_account_by_account_id_creativescreative_id(
|
|
4492
5802
|
self,
|
|
4493
|
-
|
|
4494
|
-
|
|
5803
|
+
account_id,
|
|
5804
|
+
creative_id,
|
|
4495
5805
|
**kwargs
|
|
4496
5806
|
):
|
|
4497
|
-
"""
|
|
5807
|
+
"""put_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
|
|
4498
5808
|
|
|
4499
|
-
|
|
5809
|
+
Update a creative # noqa: E501
|
|
4500
5810
|
This method makes a synchronous HTTP request by default. To make an
|
|
4501
5811
|
asynchronous HTTP request, please pass async_req=True
|
|
4502
5812
|
|
|
4503
|
-
>>> thread = api.
|
|
5813
|
+
>>> thread = api.put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
|
|
4504
5814
|
>>> result = thread.get()
|
|
4505
5815
|
|
|
4506
5816
|
Args:
|
|
4507
|
-
|
|
4508
|
-
|
|
5817
|
+
account_id (str): External account id containing the creative
|
|
5818
|
+
creative_id (str): Creative to update
|
|
4509
5819
|
|
|
4510
5820
|
Keyword Args:
|
|
5821
|
+
external_creative_update_model_v2 (ExternalCreativeUpdateModelV2): The creative to create. [optional]
|
|
4511
5822
|
_return_http_data_only (bool): response data without head status
|
|
4512
5823
|
code and headers. Default is True.
|
|
4513
5824
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4540,7 +5851,7 @@ class CampaignApi(object):
|
|
|
4540
5851
|
async_req (bool): execute request asynchronously
|
|
4541
5852
|
|
|
4542
5853
|
Returns:
|
|
4543
|
-
|
|
5854
|
+
CreativeV2Response
|
|
4544
5855
|
If the method is called asynchronously, returns the request
|
|
4545
5856
|
thread.
|
|
4546
5857
|
"""
|
|
@@ -4569,33 +5880,31 @@ class CampaignApi(object):
|
|
|
4569
5880
|
'_content_type')
|
|
4570
5881
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4571
5882
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4572
|
-
kwargs['
|
|
4573
|
-
|
|
4574
|
-
kwargs['
|
|
4575
|
-
|
|
4576
|
-
return self.
|
|
5883
|
+
kwargs['account_id'] = \
|
|
5884
|
+
account_id
|
|
5885
|
+
kwargs['creative_id'] = \
|
|
5886
|
+
creative_id
|
|
5887
|
+
return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
|
|
4577
5888
|
|
|
4578
|
-
def
|
|
5889
|
+
def put_api_v2_external_line_item_bid_multipliers_by_line_item_id(
|
|
4579
5890
|
self,
|
|
4580
5891
|
line_item_id,
|
|
4581
|
-
product_button_id,
|
|
4582
5892
|
**kwargs
|
|
4583
5893
|
):
|
|
4584
|
-
"""
|
|
5894
|
+
"""put_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501
|
|
4585
5895
|
|
|
4586
|
-
|
|
5896
|
+
Updates the bid multipliers for a given line item # noqa: E501
|
|
4587
5897
|
This method makes a synchronous HTTP request by default. To make an
|
|
4588
5898
|
asynchronous HTTP request, please pass async_req=True
|
|
4589
5899
|
|
|
4590
|
-
>>> thread = api.
|
|
5900
|
+
>>> thread = api.put_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True)
|
|
4591
5901
|
>>> result = thread.get()
|
|
4592
5902
|
|
|
4593
5903
|
Args:
|
|
4594
|
-
line_item_id (str):
|
|
4595
|
-
product_button_id (str): Sequential id of the product button
|
|
5904
|
+
line_item_id (str): External LineItemId for bid multiplier retrieval
|
|
4596
5905
|
|
|
4597
5906
|
Keyword Args:
|
|
4598
|
-
|
|
5907
|
+
line_item_bid_multipliers_v2_request (LineItemBidMultipliersV2Request): New Bid Multipliers to be set. [optional]
|
|
4599
5908
|
_return_http_data_only (bool): response data without head status
|
|
4600
5909
|
code and headers. Default is True.
|
|
4601
5910
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4628,7 +5937,7 @@ class CampaignApi(object):
|
|
|
4628
5937
|
async_req (bool): execute request asynchronously
|
|
4629
5938
|
|
|
4630
5939
|
Returns:
|
|
4631
|
-
|
|
5940
|
+
LineItemBidMultipliersV2Response
|
|
4632
5941
|
If the method is called asynchronously, returns the request
|
|
4633
5942
|
thread.
|
|
4634
5943
|
"""
|
|
@@ -4659,29 +5968,27 @@ class CampaignApi(object):
|
|
|
4659
5968
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4660
5969
|
kwargs['line_item_id'] = \
|
|
4661
5970
|
line_item_id
|
|
4662
|
-
kwargs
|
|
4663
|
-
product_button_id
|
|
4664
|
-
return self.put_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint.call_with_http_info(**kwargs)
|
|
5971
|
+
return self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
|
|
4665
5972
|
|
|
4666
|
-
def
|
|
5973
|
+
def set_keyword_bids(
|
|
4667
5974
|
self,
|
|
4668
|
-
|
|
5975
|
+
id,
|
|
4669
5976
|
**kwargs
|
|
4670
5977
|
):
|
|
4671
|
-
"""
|
|
5978
|
+
"""set_keyword_bids # noqa: E501
|
|
4672
5979
|
|
|
4673
|
-
|
|
5980
|
+
Set bid overrides for associated keywords to the given line item in bulk # noqa: E501
|
|
4674
5981
|
This method makes a synchronous HTTP request by default. To make an
|
|
4675
5982
|
asynchronous HTTP request, please pass async_req=True
|
|
4676
5983
|
|
|
4677
|
-
>>> thread = api.
|
|
5984
|
+
>>> thread = api.set_keyword_bids(id, async_req=True)
|
|
4678
5985
|
>>> result = thread.get()
|
|
4679
5986
|
|
|
4680
5987
|
Args:
|
|
4681
|
-
|
|
5988
|
+
id (str): ID of the line item
|
|
4682
5989
|
|
|
4683
5990
|
Keyword Args:
|
|
4684
|
-
|
|
5991
|
+
set_bids_model_request (SetBidsModelRequest): [optional]
|
|
4685
5992
|
_return_http_data_only (bool): response data without head status
|
|
4686
5993
|
code and headers. Default is True.
|
|
4687
5994
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4714,7 +6021,7 @@ class CampaignApi(object):
|
|
|
4714
6021
|
async_req (bool): execute request asynchronously
|
|
4715
6022
|
|
|
4716
6023
|
Returns:
|
|
4717
|
-
|
|
6024
|
+
ResourceOutcome
|
|
4718
6025
|
If the method is called asynchronously, returns the request
|
|
4719
6026
|
thread.
|
|
4720
6027
|
"""
|
|
@@ -4743,29 +6050,28 @@ class CampaignApi(object):
|
|
|
4743
6050
|
'_content_type')
|
|
4744
6051
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4745
6052
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4746
|
-
kwargs['
|
|
4747
|
-
|
|
4748
|
-
return self.
|
|
6053
|
+
kwargs['id'] = \
|
|
6054
|
+
id
|
|
6055
|
+
return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
|
|
4749
6056
|
|
|
4750
|
-
def
|
|
6057
|
+
def submit_proposal(
|
|
4751
6058
|
self,
|
|
4752
6059
|
id,
|
|
4753
6060
|
**kwargs
|
|
4754
6061
|
):
|
|
4755
|
-
"""
|
|
6062
|
+
"""submit_proposal # noqa: E501
|
|
4756
6063
|
|
|
4757
|
-
|
|
6064
|
+
Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501
|
|
4758
6065
|
This method makes a synchronous HTTP request by default. To make an
|
|
4759
6066
|
asynchronous HTTP request, please pass async_req=True
|
|
4760
6067
|
|
|
4761
|
-
>>> thread = api.
|
|
6068
|
+
>>> thread = api.submit_proposal(id, async_req=True)
|
|
4762
6069
|
>>> result = thread.get()
|
|
4763
6070
|
|
|
4764
6071
|
Args:
|
|
4765
|
-
id (str):
|
|
6072
|
+
id (str): ID of the line item
|
|
4766
6073
|
|
|
4767
6074
|
Keyword Args:
|
|
4768
|
-
retail_media_externalv1_set_bids_model_request (RetailMediaExternalv1SetBidsModelRequest): Object containing a list of bid overrides for associated keywords. [optional]
|
|
4769
6075
|
_return_http_data_only (bool): response data without head status
|
|
4770
6076
|
code and headers. Default is True.
|
|
4771
6077
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4798,7 +6104,7 @@ class CampaignApi(object):
|
|
|
4798
6104
|
async_req (bool): execute request asynchronously
|
|
4799
6105
|
|
|
4800
6106
|
Returns:
|
|
4801
|
-
|
|
6107
|
+
ProposalStatusModelResponse
|
|
4802
6108
|
If the method is called asynchronously, returns the request
|
|
4803
6109
|
thread.
|
|
4804
6110
|
"""
|
|
@@ -4829,26 +6135,27 @@ class CampaignApi(object):
|
|
|
4829
6135
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4830
6136
|
kwargs['id'] = \
|
|
4831
6137
|
id
|
|
4832
|
-
return self.
|
|
6138
|
+
return self.submit_proposal_endpoint.call_with_http_info(**kwargs)
|
|
4833
6139
|
|
|
4834
|
-
def
|
|
6140
|
+
def unpause_promoted_products(
|
|
4835
6141
|
self,
|
|
4836
|
-
|
|
6142
|
+
line_item_id,
|
|
4837
6143
|
**kwargs
|
|
4838
6144
|
):
|
|
4839
|
-
"""
|
|
6145
|
+
"""unpause_promoted_products # noqa: E501
|
|
4840
6146
|
|
|
4841
|
-
|
|
6147
|
+
Un-pause a collection of promoted products associated with a line item # noqa: E501
|
|
4842
6148
|
This method makes a synchronous HTTP request by default. To make an
|
|
4843
6149
|
asynchronous HTTP request, please pass async_req=True
|
|
4844
6150
|
|
|
4845
|
-
>>> thread = api.
|
|
6151
|
+
>>> thread = api.unpause_promoted_products(line_item_id, async_req=True)
|
|
4846
6152
|
>>> result = thread.get()
|
|
4847
6153
|
|
|
4848
6154
|
Args:
|
|
4849
|
-
|
|
6155
|
+
line_item_id (str): ID of the line item
|
|
4850
6156
|
|
|
4851
6157
|
Keyword Args:
|
|
6158
|
+
promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
|
|
4852
6159
|
_return_http_data_only (bool): response data without head status
|
|
4853
6160
|
code and headers. Default is True.
|
|
4854
6161
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -4881,7 +6188,7 @@ class CampaignApi(object):
|
|
|
4881
6188
|
async_req (bool): execute request asynchronously
|
|
4882
6189
|
|
|
4883
6190
|
Returns:
|
|
4884
|
-
|
|
6191
|
+
None
|
|
4885
6192
|
If the method is called asynchronously, returns the request
|
|
4886
6193
|
thread.
|
|
4887
6194
|
"""
|
|
@@ -4910,9 +6217,9 @@ class CampaignApi(object):
|
|
|
4910
6217
|
'_content_type')
|
|
4911
6218
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4912
6219
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4913
|
-
kwargs['
|
|
4914
|
-
|
|
4915
|
-
return self.
|
|
6220
|
+
kwargs['line_item_id'] = \
|
|
6221
|
+
line_item_id
|
|
6222
|
+
return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
4916
6223
|
|
|
4917
6224
|
def update_campaign_budget_overrides(
|
|
4918
6225
|
self,
|