criteo-api-retailmedia-sdk 0.0.250825__py3-none-any.whl → 0.0.250902__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/campaign_api.py +4 -6
- criteo_api_retailmedia_preview/api/catalog_api.py +445 -0
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/async_accounts_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +10 -0
- criteo_api_retailmedia_preview/model/async_job_response.py +257 -0
- criteo_api_retailmedia_preview/model/async_line_items_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_offsite_report.py +3 -3
- criteo_api_retailmedia_preview/model/line_item_capping_v2.py +1 -1
- criteo_api_retailmedia_preview/model/load_sku_offers_request.py +272 -0
- criteo_api_retailmedia_preview/model/offer_load.py +289 -0
- criteo_api_retailmedia_preview/model/offer_update.py +287 -0
- criteo_api_retailmedia_preview/model/set_sku_buy_box_winners_request.py +272 -0
- criteo_api_retailmedia_preview/model/sku_buy_box_winner.py +269 -0
- criteo_api_retailmedia_preview/model/sku_offer_load.py +278 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +43 -44
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +32 -34
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +10 -0
- criteo_api_retailmedia_preview/model/update_offers_request.py +272 -0
- criteo_api_retailmedia_preview/model/value_resource_async_job_response.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_input_load_sku_offers_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_set_sku_buy_box_winners_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_update_offers_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_load_sku_offers_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_outcome_async_job_response.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_set_sku_buy_box_winners_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_update_offers_request.py +266 -0
- criteo_api_retailmedia_preview/models/__init__.py +16 -0
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/RECORD +35 -19
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/top_level.txt +0 -0
|
@@ -329,7 +329,6 @@ class CampaignApi(object):
|
|
|
329
329
|
'application/json'
|
|
330
330
|
],
|
|
331
331
|
'content_type': [
|
|
332
|
-
'application/json-patch+json',
|
|
333
332
|
'application/json',
|
|
334
333
|
'text/json',
|
|
335
334
|
'application/*+json'
|
|
@@ -1694,7 +1693,7 @@ class CampaignApi(object):
|
|
|
1694
1693
|
)
|
|
1695
1694
|
self.post_api_external_v2_campaign_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
|
|
1696
1695
|
settings={
|
|
1697
|
-
'response_type':
|
|
1696
|
+
'response_type': (PreferredLineItemV2Response,),
|
|
1698
1697
|
'auth': [
|
|
1699
1698
|
'oauth',
|
|
1700
1699
|
'oauth'
|
|
@@ -2501,7 +2500,7 @@ class CampaignApi(object):
|
|
|
2501
2500
|
},
|
|
2502
2501
|
'openapi_types': {
|
|
2503
2502
|
'line_item_id':
|
|
2504
|
-
(
|
|
2503
|
+
(int,),
|
|
2505
2504
|
'value_resource_input_of_sponsored_products_line_item_update_request_model':
|
|
2506
2505
|
(ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel,),
|
|
2507
2506
|
},
|
|
@@ -2520,7 +2519,6 @@ class CampaignApi(object):
|
|
|
2520
2519
|
'application/json'
|
|
2521
2520
|
],
|
|
2522
2521
|
'content_type': [
|
|
2523
|
-
'application/json-patch+json',
|
|
2524
2522
|
'application/json',
|
|
2525
2523
|
'text/json',
|
|
2526
2524
|
'application/*+json'
|
|
@@ -4843,7 +4841,7 @@ class CampaignApi(object):
|
|
|
4843
4841
|
async_req (bool): execute request asynchronously
|
|
4844
4842
|
|
|
4845
4843
|
Returns:
|
|
4846
|
-
|
|
4844
|
+
PreferredLineItemV2Response
|
|
4847
4845
|
If the method is called asynchronously, returns the request
|
|
4848
4846
|
thread.
|
|
4849
4847
|
"""
|
|
@@ -5814,7 +5812,7 @@ class CampaignApi(object):
|
|
|
5814
5812
|
>>> result = thread.get()
|
|
5815
5813
|
|
|
5816
5814
|
Args:
|
|
5817
|
-
line_item_id (
|
|
5815
|
+
line_item_id (int): The external line item ID of the sponsored products line item.
|
|
5818
5816
|
|
|
5819
5817
|
Keyword Args:
|
|
5820
5818
|
value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
|
|
@@ -25,6 +25,10 @@ from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAc
|
|
|
25
25
|
from criteo_api_retailmedia_preview.model.fail_response import FailResponse
|
|
26
26
|
from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest
|
|
27
27
|
from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse
|
|
28
|
+
from criteo_api_retailmedia_preview.model.value_resource_input_load_sku_offers_request import ValueResourceInputLoadSkuOffersRequest
|
|
29
|
+
from criteo_api_retailmedia_preview.model.value_resource_input_set_sku_buy_box_winners_request import ValueResourceInputSetSkuBuyBoxWinnersRequest
|
|
30
|
+
from criteo_api_retailmedia_preview.model.value_resource_input_update_offers_request import ValueResourceInputUpdateOffersRequest
|
|
31
|
+
from criteo_api_retailmedia_preview.model.value_resource_outcome_async_job_response import ValueResourceOutcomeAsyncJobResponse
|
|
28
32
|
|
|
29
33
|
|
|
30
34
|
class CatalogApi(object):
|
|
@@ -38,6 +42,195 @@ class CatalogApi(object):
|
|
|
38
42
|
if api_client is None:
|
|
39
43
|
api_client = ApiClient()
|
|
40
44
|
self.api_client = api_client
|
|
45
|
+
self.offer_load_v1_endpoint = _Endpoint(
|
|
46
|
+
settings={
|
|
47
|
+
'response_type': (ValueResourceOutcomeAsyncJobResponse,),
|
|
48
|
+
'auth': [
|
|
49
|
+
'oauth',
|
|
50
|
+
'oauth'
|
|
51
|
+
],
|
|
52
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/load',
|
|
53
|
+
'operation_id': 'offer_load_v1',
|
|
54
|
+
'http_method': 'POST',
|
|
55
|
+
'servers': None,
|
|
56
|
+
},
|
|
57
|
+
params_map={
|
|
58
|
+
'all': [
|
|
59
|
+
'retailer_id',
|
|
60
|
+
'value_resource_input_load_sku_offers_request',
|
|
61
|
+
],
|
|
62
|
+
'required': [
|
|
63
|
+
'retailer_id',
|
|
64
|
+
],
|
|
65
|
+
'nullable': [
|
|
66
|
+
],
|
|
67
|
+
'enum': [
|
|
68
|
+
],
|
|
69
|
+
'validation': [
|
|
70
|
+
]
|
|
71
|
+
},
|
|
72
|
+
root_map={
|
|
73
|
+
'validations': {
|
|
74
|
+
},
|
|
75
|
+
'allowed_values': {
|
|
76
|
+
},
|
|
77
|
+
'openapi_types': {
|
|
78
|
+
'retailer_id':
|
|
79
|
+
(int,),
|
|
80
|
+
'value_resource_input_load_sku_offers_request':
|
|
81
|
+
(ValueResourceInputLoadSkuOffersRequest,),
|
|
82
|
+
},
|
|
83
|
+
'attribute_map': {
|
|
84
|
+
'retailer_id': 'retailerId',
|
|
85
|
+
},
|
|
86
|
+
'location_map': {
|
|
87
|
+
'retailer_id': 'path',
|
|
88
|
+
'value_resource_input_load_sku_offers_request': 'body',
|
|
89
|
+
},
|
|
90
|
+
'collection_format_map': {
|
|
91
|
+
}
|
|
92
|
+
},
|
|
93
|
+
headers_map={
|
|
94
|
+
'accept': [
|
|
95
|
+
'text/plain',
|
|
96
|
+
'application/json',
|
|
97
|
+
'text/json'
|
|
98
|
+
],
|
|
99
|
+
'content_type': [
|
|
100
|
+
'application/json-patch+json',
|
|
101
|
+
'application/json',
|
|
102
|
+
'text/json',
|
|
103
|
+
'application/*+json'
|
|
104
|
+
]
|
|
105
|
+
},
|
|
106
|
+
api_client=api_client
|
|
107
|
+
)
|
|
108
|
+
self.offer_set_bbw_v1_endpoint = _Endpoint(
|
|
109
|
+
settings={
|
|
110
|
+
'response_type': (ValueResourceOutcomeAsyncJobResponse,),
|
|
111
|
+
'auth': [
|
|
112
|
+
'oauth',
|
|
113
|
+
'oauth'
|
|
114
|
+
],
|
|
115
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/set-buy-box-winners',
|
|
116
|
+
'operation_id': 'offer_set_bbw_v1',
|
|
117
|
+
'http_method': 'POST',
|
|
118
|
+
'servers': None,
|
|
119
|
+
},
|
|
120
|
+
params_map={
|
|
121
|
+
'all': [
|
|
122
|
+
'retailer_id',
|
|
123
|
+
'value_resource_input_set_sku_buy_box_winners_request',
|
|
124
|
+
],
|
|
125
|
+
'required': [
|
|
126
|
+
'retailer_id',
|
|
127
|
+
],
|
|
128
|
+
'nullable': [
|
|
129
|
+
],
|
|
130
|
+
'enum': [
|
|
131
|
+
],
|
|
132
|
+
'validation': [
|
|
133
|
+
]
|
|
134
|
+
},
|
|
135
|
+
root_map={
|
|
136
|
+
'validations': {
|
|
137
|
+
},
|
|
138
|
+
'allowed_values': {
|
|
139
|
+
},
|
|
140
|
+
'openapi_types': {
|
|
141
|
+
'retailer_id':
|
|
142
|
+
(int,),
|
|
143
|
+
'value_resource_input_set_sku_buy_box_winners_request':
|
|
144
|
+
(ValueResourceInputSetSkuBuyBoxWinnersRequest,),
|
|
145
|
+
},
|
|
146
|
+
'attribute_map': {
|
|
147
|
+
'retailer_id': 'retailerId',
|
|
148
|
+
},
|
|
149
|
+
'location_map': {
|
|
150
|
+
'retailer_id': 'path',
|
|
151
|
+
'value_resource_input_set_sku_buy_box_winners_request': 'body',
|
|
152
|
+
},
|
|
153
|
+
'collection_format_map': {
|
|
154
|
+
}
|
|
155
|
+
},
|
|
156
|
+
headers_map={
|
|
157
|
+
'accept': [
|
|
158
|
+
'text/plain',
|
|
159
|
+
'application/json',
|
|
160
|
+
'text/json'
|
|
161
|
+
],
|
|
162
|
+
'content_type': [
|
|
163
|
+
'application/json-patch+json',
|
|
164
|
+
'application/json',
|
|
165
|
+
'text/json',
|
|
166
|
+
'application/*+json'
|
|
167
|
+
]
|
|
168
|
+
},
|
|
169
|
+
api_client=api_client
|
|
170
|
+
)
|
|
171
|
+
self.offer_update_v1_endpoint = _Endpoint(
|
|
172
|
+
settings={
|
|
173
|
+
'response_type': (ValueResourceOutcomeAsyncJobResponse,),
|
|
174
|
+
'auth': [
|
|
175
|
+
'oauth',
|
|
176
|
+
'oauth'
|
|
177
|
+
],
|
|
178
|
+
'endpoint_path': '/preview/retail-media/retailers/{retailerId}/offers/update',
|
|
179
|
+
'operation_id': 'offer_update_v1',
|
|
180
|
+
'http_method': 'POST',
|
|
181
|
+
'servers': None,
|
|
182
|
+
},
|
|
183
|
+
params_map={
|
|
184
|
+
'all': [
|
|
185
|
+
'retailer_id',
|
|
186
|
+
'value_resource_input_update_offers_request',
|
|
187
|
+
],
|
|
188
|
+
'required': [
|
|
189
|
+
'retailer_id',
|
|
190
|
+
],
|
|
191
|
+
'nullable': [
|
|
192
|
+
],
|
|
193
|
+
'enum': [
|
|
194
|
+
],
|
|
195
|
+
'validation': [
|
|
196
|
+
]
|
|
197
|
+
},
|
|
198
|
+
root_map={
|
|
199
|
+
'validations': {
|
|
200
|
+
},
|
|
201
|
+
'allowed_values': {
|
|
202
|
+
},
|
|
203
|
+
'openapi_types': {
|
|
204
|
+
'retailer_id':
|
|
205
|
+
(int,),
|
|
206
|
+
'value_resource_input_update_offers_request':
|
|
207
|
+
(ValueResourceInputUpdateOffersRequest,),
|
|
208
|
+
},
|
|
209
|
+
'attribute_map': {
|
|
210
|
+
'retailer_id': 'retailerId',
|
|
211
|
+
},
|
|
212
|
+
'location_map': {
|
|
213
|
+
'retailer_id': 'path',
|
|
214
|
+
'value_resource_input_update_offers_request': 'body',
|
|
215
|
+
},
|
|
216
|
+
'collection_format_map': {
|
|
217
|
+
}
|
|
218
|
+
},
|
|
219
|
+
headers_map={
|
|
220
|
+
'accept': [
|
|
221
|
+
'text/plain',
|
|
222
|
+
'application/json',
|
|
223
|
+
'text/json'
|
|
224
|
+
],
|
|
225
|
+
'content_type': [
|
|
226
|
+
'application/json-patch+json',
|
|
227
|
+
'application/json',
|
|
228
|
+
'text/json',
|
|
229
|
+
'application/*+json'
|
|
230
|
+
]
|
|
231
|
+
},
|
|
232
|
+
api_client=api_client
|
|
233
|
+
)
|
|
41
234
|
self.preview_retail_media_catalog_products_batch_post_endpoint = _Endpoint(
|
|
42
235
|
settings={
|
|
43
236
|
'response_type': (BatchAcceptedResponse,),
|
|
@@ -144,6 +337,258 @@ class CatalogApi(object):
|
|
|
144
337
|
api_client=api_client
|
|
145
338
|
)
|
|
146
339
|
|
|
340
|
+
def offer_load_v1(
|
|
341
|
+
self,
|
|
342
|
+
retailer_id,
|
|
343
|
+
**kwargs
|
|
344
|
+
):
|
|
345
|
+
"""offer_load_v1 # noqa: E501
|
|
346
|
+
|
|
347
|
+
Replace the offers for one or more SKUs with a snapshot of the new offers for each respective SKU # noqa: E501
|
|
348
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
349
|
+
asynchronous HTTP request, please pass async_req=True
|
|
350
|
+
|
|
351
|
+
>>> thread = api.offer_load_v1(retailer_id, async_req=True)
|
|
352
|
+
>>> result = thread.get()
|
|
353
|
+
|
|
354
|
+
Args:
|
|
355
|
+
retailer_id (int): The retailer for which these offers will be loaded
|
|
356
|
+
|
|
357
|
+
Keyword Args:
|
|
358
|
+
value_resource_input_load_sku_offers_request (ValueResourceInputLoadSkuOffersRequest): [optional]
|
|
359
|
+
_return_http_data_only (bool): response data without head status
|
|
360
|
+
code and headers. Default is True.
|
|
361
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
362
|
+
will be returned without reading/decoding response data.
|
|
363
|
+
Default is True.
|
|
364
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
365
|
+
one number provided, it will be total request timeout. It can also
|
|
366
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
367
|
+
Default is None.
|
|
368
|
+
_check_input_type (bool): specifies if type checking
|
|
369
|
+
should be done one the data sent to the server.
|
|
370
|
+
Default is True.
|
|
371
|
+
_check_return_type (bool): specifies if type checking
|
|
372
|
+
should be done one the data received from the server.
|
|
373
|
+
Default is True.
|
|
374
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
375
|
+
are serialized names, as specified in the OpenAPI document.
|
|
376
|
+
False if the variable names in the input data
|
|
377
|
+
are pythonic names, e.g. snake case (default)
|
|
378
|
+
_content_type (str/None): force body content-type.
|
|
379
|
+
Default is None and content-type will be predicted by allowed
|
|
380
|
+
content-types and body.
|
|
381
|
+
_host_index (int/None): specifies the index of the server
|
|
382
|
+
that we want to use.
|
|
383
|
+
Default is read from the configuration.
|
|
384
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
385
|
+
request; this effectively ignores the authentication
|
|
386
|
+
in the spec for a single request.
|
|
387
|
+
Default is None
|
|
388
|
+
async_req (bool): execute request asynchronously
|
|
389
|
+
|
|
390
|
+
Returns:
|
|
391
|
+
ValueResourceOutcomeAsyncJobResponse
|
|
392
|
+
If the method is called asynchronously, returns the request
|
|
393
|
+
thread.
|
|
394
|
+
"""
|
|
395
|
+
kwargs['async_req'] = kwargs.get(
|
|
396
|
+
'async_req', False
|
|
397
|
+
)
|
|
398
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
399
|
+
'_return_http_data_only', True
|
|
400
|
+
)
|
|
401
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
402
|
+
'_preload_content', True
|
|
403
|
+
)
|
|
404
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
405
|
+
'_request_timeout', None
|
|
406
|
+
)
|
|
407
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
408
|
+
'_check_input_type', True
|
|
409
|
+
)
|
|
410
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
411
|
+
'_check_return_type', True
|
|
412
|
+
)
|
|
413
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
414
|
+
'_spec_property_naming', False
|
|
415
|
+
)
|
|
416
|
+
kwargs['_content_type'] = kwargs.get(
|
|
417
|
+
'_content_type')
|
|
418
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
419
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
420
|
+
kwargs['retailer_id'] = \
|
|
421
|
+
retailer_id
|
|
422
|
+
return self.offer_load_v1_endpoint.call_with_http_info(**kwargs)
|
|
423
|
+
|
|
424
|
+
def offer_set_bbw_v1(
|
|
425
|
+
self,
|
|
426
|
+
retailer_id,
|
|
427
|
+
**kwargs
|
|
428
|
+
):
|
|
429
|
+
"""offer_set_bbw_v1 # noqa: E501
|
|
430
|
+
|
|
431
|
+
Update the buy box winner for one or more SKUs # noqa: E501
|
|
432
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
433
|
+
asynchronous HTTP request, please pass async_req=True
|
|
434
|
+
|
|
435
|
+
>>> thread = api.offer_set_bbw_v1(retailer_id, async_req=True)
|
|
436
|
+
>>> result = thread.get()
|
|
437
|
+
|
|
438
|
+
Args:
|
|
439
|
+
retailer_id (int): The retailer for which these buy box winners will be set
|
|
440
|
+
|
|
441
|
+
Keyword Args:
|
|
442
|
+
value_resource_input_set_sku_buy_box_winners_request (ValueResourceInputSetSkuBuyBoxWinnersRequest): [optional]
|
|
443
|
+
_return_http_data_only (bool): response data without head status
|
|
444
|
+
code and headers. Default is True.
|
|
445
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
446
|
+
will be returned without reading/decoding response data.
|
|
447
|
+
Default is True.
|
|
448
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
449
|
+
one number provided, it will be total request timeout. It can also
|
|
450
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
451
|
+
Default is None.
|
|
452
|
+
_check_input_type (bool): specifies if type checking
|
|
453
|
+
should be done one the data sent to the server.
|
|
454
|
+
Default is True.
|
|
455
|
+
_check_return_type (bool): specifies if type checking
|
|
456
|
+
should be done one the data received from the server.
|
|
457
|
+
Default is True.
|
|
458
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
459
|
+
are serialized names, as specified in the OpenAPI document.
|
|
460
|
+
False if the variable names in the input data
|
|
461
|
+
are pythonic names, e.g. snake case (default)
|
|
462
|
+
_content_type (str/None): force body content-type.
|
|
463
|
+
Default is None and content-type will be predicted by allowed
|
|
464
|
+
content-types and body.
|
|
465
|
+
_host_index (int/None): specifies the index of the server
|
|
466
|
+
that we want to use.
|
|
467
|
+
Default is read from the configuration.
|
|
468
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
469
|
+
request; this effectively ignores the authentication
|
|
470
|
+
in the spec for a single request.
|
|
471
|
+
Default is None
|
|
472
|
+
async_req (bool): execute request asynchronously
|
|
473
|
+
|
|
474
|
+
Returns:
|
|
475
|
+
ValueResourceOutcomeAsyncJobResponse
|
|
476
|
+
If the method is called asynchronously, returns the request
|
|
477
|
+
thread.
|
|
478
|
+
"""
|
|
479
|
+
kwargs['async_req'] = kwargs.get(
|
|
480
|
+
'async_req', False
|
|
481
|
+
)
|
|
482
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
483
|
+
'_return_http_data_only', True
|
|
484
|
+
)
|
|
485
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
486
|
+
'_preload_content', True
|
|
487
|
+
)
|
|
488
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
489
|
+
'_request_timeout', None
|
|
490
|
+
)
|
|
491
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
492
|
+
'_check_input_type', True
|
|
493
|
+
)
|
|
494
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
495
|
+
'_check_return_type', True
|
|
496
|
+
)
|
|
497
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
498
|
+
'_spec_property_naming', False
|
|
499
|
+
)
|
|
500
|
+
kwargs['_content_type'] = kwargs.get(
|
|
501
|
+
'_content_type')
|
|
502
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
503
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
504
|
+
kwargs['retailer_id'] = \
|
|
505
|
+
retailer_id
|
|
506
|
+
return self.offer_set_bbw_v1_endpoint.call_with_http_info(**kwargs)
|
|
507
|
+
|
|
508
|
+
def offer_update_v1(
|
|
509
|
+
self,
|
|
510
|
+
retailer_id,
|
|
511
|
+
**kwargs
|
|
512
|
+
):
|
|
513
|
+
"""offer_update_v1 # noqa: E501
|
|
514
|
+
|
|
515
|
+
Update one or more offers by replacing each offer's price and availability with the given values # noqa: E501
|
|
516
|
+
This method makes a synchronous HTTP request by default. To make an
|
|
517
|
+
asynchronous HTTP request, please pass async_req=True
|
|
518
|
+
|
|
519
|
+
>>> thread = api.offer_update_v1(retailer_id, async_req=True)
|
|
520
|
+
>>> result = thread.get()
|
|
521
|
+
|
|
522
|
+
Args:
|
|
523
|
+
retailer_id (int): The retailer for which these offers will be updated
|
|
524
|
+
|
|
525
|
+
Keyword Args:
|
|
526
|
+
value_resource_input_update_offers_request (ValueResourceInputUpdateOffersRequest): [optional]
|
|
527
|
+
_return_http_data_only (bool): response data without head status
|
|
528
|
+
code and headers. Default is True.
|
|
529
|
+
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
530
|
+
will be returned without reading/decoding response data.
|
|
531
|
+
Default is True.
|
|
532
|
+
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
533
|
+
one number provided, it will be total request timeout. It can also
|
|
534
|
+
be a pair (tuple) of (connection, read) timeouts.
|
|
535
|
+
Default is None.
|
|
536
|
+
_check_input_type (bool): specifies if type checking
|
|
537
|
+
should be done one the data sent to the server.
|
|
538
|
+
Default is True.
|
|
539
|
+
_check_return_type (bool): specifies if type checking
|
|
540
|
+
should be done one the data received from the server.
|
|
541
|
+
Default is True.
|
|
542
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
543
|
+
are serialized names, as specified in the OpenAPI document.
|
|
544
|
+
False if the variable names in the input data
|
|
545
|
+
are pythonic names, e.g. snake case (default)
|
|
546
|
+
_content_type (str/None): force body content-type.
|
|
547
|
+
Default is None and content-type will be predicted by allowed
|
|
548
|
+
content-types and body.
|
|
549
|
+
_host_index (int/None): specifies the index of the server
|
|
550
|
+
that we want to use.
|
|
551
|
+
Default is read from the configuration.
|
|
552
|
+
_request_auths (list): set to override the auth_settings for an a single
|
|
553
|
+
request; this effectively ignores the authentication
|
|
554
|
+
in the spec for a single request.
|
|
555
|
+
Default is None
|
|
556
|
+
async_req (bool): execute request asynchronously
|
|
557
|
+
|
|
558
|
+
Returns:
|
|
559
|
+
ValueResourceOutcomeAsyncJobResponse
|
|
560
|
+
If the method is called asynchronously, returns the request
|
|
561
|
+
thread.
|
|
562
|
+
"""
|
|
563
|
+
kwargs['async_req'] = kwargs.get(
|
|
564
|
+
'async_req', False
|
|
565
|
+
)
|
|
566
|
+
kwargs['_return_http_data_only'] = kwargs.get(
|
|
567
|
+
'_return_http_data_only', True
|
|
568
|
+
)
|
|
569
|
+
kwargs['_preload_content'] = kwargs.get(
|
|
570
|
+
'_preload_content', True
|
|
571
|
+
)
|
|
572
|
+
kwargs['_request_timeout'] = kwargs.get(
|
|
573
|
+
'_request_timeout', None
|
|
574
|
+
)
|
|
575
|
+
kwargs['_check_input_type'] = kwargs.get(
|
|
576
|
+
'_check_input_type', True
|
|
577
|
+
)
|
|
578
|
+
kwargs['_check_return_type'] = kwargs.get(
|
|
579
|
+
'_check_return_type', True
|
|
580
|
+
)
|
|
581
|
+
kwargs['_spec_property_naming'] = kwargs.get(
|
|
582
|
+
'_spec_property_naming', False
|
|
583
|
+
)
|
|
584
|
+
kwargs['_content_type'] = kwargs.get(
|
|
585
|
+
'_content_type')
|
|
586
|
+
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
587
|
+
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
588
|
+
kwargs['retailer_id'] = \
|
|
589
|
+
retailer_id
|
|
590
|
+
return self.offer_update_v1_endpoint.call_with_http_info(**kwargs)
|
|
591
|
+
|
|
147
592
|
def preview_retail_media_catalog_products_batch_post(
|
|
148
593
|
self,
|
|
149
594
|
products_custom_batch_request,
|
|
@@ -76,7 +76,7 @@ class ApiClient(object):
|
|
|
76
76
|
self.default_headers[header_name] = header_value
|
|
77
77
|
self.cookie = cookie
|
|
78
78
|
# Set default User-Agent.
|
|
79
|
-
self.user_agent = 'OpenAPI-Generator/0.0.
|
|
79
|
+
self.user_agent = 'OpenAPI-Generator/0.0.250902/python'
|
|
80
80
|
|
|
81
81
|
def __enter__(self):
|
|
82
82
|
return self
|
|
@@ -395,7 +395,7 @@ class Configuration(object):
|
|
|
395
395
|
"OS: {env}\n"\
|
|
396
396
|
"Python Version: {pyversion}\n"\
|
|
397
397
|
"Version of the API: Preview\n"\
|
|
398
|
-
"SDK Package Version: 0.0.
|
|
398
|
+
"SDK Package Version: 0.0.250902".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -88,6 +88,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
88
88
|
'ADVPRODUCTID': "advProductId",
|
|
89
89
|
'ADVPRODUCTNAME': "advProductName",
|
|
90
90
|
'SALESCHANNEL': "salesChannel",
|
|
91
|
+
'MEDIATYPE': "mediaType",
|
|
91
92
|
'ENVIRONMENT': "environment",
|
|
92
93
|
'PAGETYPENAME': "pageTypeName",
|
|
93
94
|
'PAGECATEGORY': "pageCategory",
|
|
@@ -111,6 +112,12 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
111
112
|
'JSON-NEWLINE': "json-newline",
|
|
112
113
|
'CSV': "csv",
|
|
113
114
|
},
|
|
115
|
+
('media_type',): {
|
|
116
|
+
'UNKNOWN': "unknown",
|
|
117
|
+
'VIDEO': "video",
|
|
118
|
+
'DISPLAY': "display",
|
|
119
|
+
'ALL': "all",
|
|
120
|
+
},
|
|
114
121
|
('metrics',): {
|
|
115
122
|
'IMPRESSIONS': "impressions",
|
|
116
123
|
'CLICKS': "clicks",
|
|
@@ -149,6 +156,9 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
149
156
|
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
150
157
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
151
158
|
'FREQUENCY': "frequency",
|
|
159
|
+
'WINRATE': "winRate",
|
|
160
|
+
'SAMPLEDBIDSWON': "sampledBidsWon",
|
|
161
|
+
'SAMPLEDBIDSPARTICIPATED': "sampledBidsParticipated",
|
|
152
162
|
},
|
|
153
163
|
('report_type',): {
|
|
154
164
|
'SUMMARY': "summary",
|
|
@@ -223,6 +233,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
223
233
|
'click_attribution_window': (str,), # noqa: E501
|
|
224
234
|
'dimensions': ([str],), # noqa: E501
|
|
225
235
|
'format': (str,), # noqa: E501
|
|
236
|
+
'media_type': (str,), # noqa: E501
|
|
226
237
|
'metrics': ([str],), # noqa: E501
|
|
227
238
|
'report_type': (str,), # noqa: E501
|
|
228
239
|
'sales_channel': (str,), # noqa: E501
|
|
@@ -247,6 +258,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
247
258
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
248
259
|
'dimensions': 'dimensions', # noqa: E501
|
|
249
260
|
'format': 'format', # noqa: E501
|
|
261
|
+
'media_type': 'mediaType', # noqa: E501
|
|
250
262
|
'metrics': 'metrics', # noqa: E501
|
|
251
263
|
'report_type': 'reportType', # noqa: E501
|
|
252
264
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
@@ -308,6 +320,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
308
320
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
309
321
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
310
322
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
323
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
311
324
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
312
325
|
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
313
326
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
@@ -414,6 +427,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
414
427
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
415
428
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
416
429
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
430
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
417
431
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
418
432
|
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
419
433
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
@@ -84,6 +84,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
84
84
|
'ADVPRODUCTID': "advProductId",
|
|
85
85
|
'ADVPRODUCTNAME': "advProductName",
|
|
86
86
|
'SALESCHANNEL': "salesChannel",
|
|
87
|
+
'MEDIATYPE': "mediaType",
|
|
87
88
|
'ENVIRONMENT': "environment",
|
|
88
89
|
'PAGETYPENAME': "pageTypeName",
|
|
89
90
|
'PAGECATEGORY': "pageCategory",
|
|
@@ -107,6 +108,12 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
107
108
|
'JSON-NEWLINE': "json-newline",
|
|
108
109
|
'CSV': "csv",
|
|
109
110
|
},
|
|
111
|
+
('media_type',): {
|
|
112
|
+
'UNKNOWN': "unknown",
|
|
113
|
+
'VIDEO': "video",
|
|
114
|
+
'DISPLAY': "display",
|
|
115
|
+
'ALL': "all",
|
|
116
|
+
},
|
|
110
117
|
('metrics',): {
|
|
111
118
|
'IMPRESSIONS': "impressions",
|
|
112
119
|
'CLICKS': "clicks",
|
|
@@ -145,6 +152,9 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
145
152
|
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
146
153
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
147
154
|
'FREQUENCY': "frequency",
|
|
155
|
+
'WINRATE': "winRate",
|
|
156
|
+
'SAMPLEDBIDSWON': "sampledBidsWon",
|
|
157
|
+
'SAMPLEDBIDSPARTICIPATED': "sampledBidsParticipated",
|
|
148
158
|
},
|
|
149
159
|
('report_type',): {
|
|
150
160
|
'SUMMARY': "summary",
|
|
@@ -219,6 +229,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
219
229
|
'format': (str,), # noqa: E501
|
|
220
230
|
'id': (str,), # noqa: E501
|
|
221
231
|
'ids': ([str],), # noqa: E501
|
|
232
|
+
'media_type': (str,), # noqa: E501
|
|
222
233
|
'metrics': ([str],), # noqa: E501
|
|
223
234
|
'report_type': (str,), # noqa: E501
|
|
224
235
|
'sales_channel': (str,), # noqa: E501
|
|
@@ -243,6 +254,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
243
254
|
'format': 'format', # noqa: E501
|
|
244
255
|
'id': 'id', # noqa: E501
|
|
245
256
|
'ids': 'ids', # noqa: E501
|
|
257
|
+
'media_type': 'mediaType', # noqa: E501
|
|
246
258
|
'metrics': 'metrics', # noqa: E501
|
|
247
259
|
'report_type': 'reportType', # noqa: E501
|
|
248
260
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
@@ -304,6 +316,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
304
316
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
305
317
|
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
306
318
|
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
319
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
307
320
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
308
321
|
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
309
322
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
@@ -409,6 +422,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
409
422
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
410
423
|
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
411
424
|
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
425
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
412
426
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
413
427
|
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
414
428
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|