criteo-api-retailmedia-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__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.
Files changed (96) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +3 -147
  3. criteo_api_retailmedia_preview/api/analytics_api.py +1 -1
  4. criteo_api_retailmedia_preview/api/audience_api.py +1204 -135
  5. criteo_api_retailmedia_preview/api/campaign_api.py +741 -104
  6. criteo_api_retailmedia_preview/api_client.py +1 -1
  7. criteo_api_retailmedia_preview/configuration.py +1 -1
  8. criteo_api_retailmedia_preview/model/account_fees_update_request.py +4 -0
  9. criteo_api_retailmedia_preview/model/async_accounts_report.py +6 -6
  10. criteo_api_retailmedia_preview/model/async_campaigns_report.py +4 -4
  11. criteo_api_retailmedia_preview/model/async_line_items_report.py +4 -4
  12. criteo_api_retailmedia_preview/model/async_offsite_report.py +25 -18
  13. criteo_api_retailmedia_preview/model/brand_id_search_request.py +7 -1
  14. criteo_api_retailmedia_preview/model/brand_id_search_result.py +7 -1
  15. criteo_api_retailmedia_preview/model/categories_search_request_v1.py +270 -0
  16. criteo_api_retailmedia_preview/model/entity_resource_brand_id_search_result.py +8 -1
  17. criteo_api_retailmedia_preview/model/entity_resource_category202204.py +277 -0
  18. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py +8 -1
  19. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204.py +281 -0
  20. criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204_metadata.py +287 -0
  21. criteo_api_retailmedia_preview/model/entity_resource_of_sponsored_products_line_item.py +270 -0
  22. criteo_api_retailmedia_preview/model/entity_resource_outcome_of_sponsored_products_line_item.py +274 -0
  23. criteo_api_retailmedia_preview/model/{input_keywords.py → flight_leg.py} +39 -17
  24. criteo_api_retailmedia_preview/model/{recommended_keywords_result.py → flight_schedule.py} +9 -13
  25. criteo_api_retailmedia_preview/model/nillable_decimal.py +263 -0
  26. criteo_api_retailmedia_preview/model/page_of_sponsored_products_line_item.py +276 -0
  27. criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +7 -1
  28. criteo_api_retailmedia_preview/model/{grant_consent_model.py → recommended_categories_request_v1.py} +14 -21
  29. criteo_api_retailmedia_preview/model/recommended_keywords_request_v1.py +266 -0
  30. criteo_api_retailmedia_preview/model/recommended_keywords_response_v1.py +263 -0
  31. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_request.py → rm_audience_bulk_create_input_v1.py} +9 -9
  32. criteo_api_retailmedia_preview/model/{grant_consent_input.py → rm_audience_bulk_delete_input_v1.py} +8 -8
  33. criteo_api_retailmedia_preview/model/rm_audience_bulk_update_input_v1.py +269 -0
  34. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1.py +272 -0
  35. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1_resource.py +273 -0
  36. criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_input_v1.py +269 -0
  37. criteo_api_retailmedia_preview/model/rm_audience_create_entity_v1.py +291 -0
  38. criteo_api_retailmedia_preview/model/{grant_consent_model_value_resource.py → rm_audience_create_entity_v1_resource.py} +8 -8
  39. criteo_api_retailmedia_preview/model/rm_audience_delete_entity_v1_resource.py +271 -0
  40. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_recommended_keywords_result.py → rm_audience_entity_v1_list_response.py} +16 -9
  41. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1.py +282 -0
  42. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1_resource.py +273 -0
  43. criteo_api_retailmedia_preview/model/rm_audience_estimate_size_input_v1.py +269 -0
  44. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1.py +272 -0
  45. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1_resource.py +273 -0
  46. criteo_api_retailmedia_preview/model/rm_audience_segment_compute_sizes_input_v1.py +269 -0
  47. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +6 -0
  48. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1.py +282 -0
  49. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1_resource.py +273 -0
  50. criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_input_v1.py +269 -0
  51. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1.py +267 -0
  52. criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1_list_response.py +281 -0
  53. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers_v2.py → rm_audience_segment_size_entity_v1_resource.py} +11 -11
  54. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1.py +267 -0
  55. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_resource.py +273 -0
  56. criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_response.py +281 -0
  57. criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +6 -0
  58. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1.py +267 -0
  59. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_list_response.py +281 -0
  60. criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_resource.py +277 -0
  61. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1.py +267 -0
  62. criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1_resource.py +273 -0
  63. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_response.py → rm_audience_size_estimation_v1_response.py} +9 -9
  64. criteo_api_retailmedia_preview/model/rm_audience_update_entity_v1.py +279 -0
  65. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py → rm_audience_update_entity_v1_resource.py} +17 -19
  66. criteo_api_retailmedia_preview/model/rm_events_create_v1.py +305 -0
  67. criteo_api_retailmedia_preview/model/rm_events_estimation_v1.py +305 -0
  68. criteo_api_retailmedia_preview/model/rm_events_update_v1.py +307 -0
  69. criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +6 -6
  70. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +387 -0
  71. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers_v2.py → sponsored_products_line_item_create_request_model.py} +81 -33
  72. criteo_api_retailmedia_preview/model/{keywords.py → sponsored_products_line_item_update_request_model.py} +82 -44
  73. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +2 -2
  74. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +4 -4
  75. criteo_api_retailmedia_preview/model/sync_line_items_report.py +4 -4
  76. criteo_api_retailmedia_preview/model/value_resource_brand_id_search_request.py +8 -1
  77. criteo_api_retailmedia_preview/model/value_resource_categories_search_request_v1.py +273 -0
  78. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_private_market_account_fees.py → value_resource_collection_outcome_private_market_account_fees_and_metadata.py} +9 -3
  79. criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +8 -1
  80. criteo_api_retailmedia_preview/model/value_resource_input_categories_search_request_v1.py +269 -0
  81. criteo_api_retailmedia_preview/model/value_resource_input_of_sponsored_products_line_item_update_request_model.py +262 -0
  82. criteo_api_retailmedia_preview/model/value_resource_input_recommended_categories_request_v1.py +269 -0
  83. criteo_api_retailmedia_preview/model/value_resource_input_recommended_keywords_request_v1.py +262 -0
  84. criteo_api_retailmedia_preview/model/value_resource_of_sponsored_products_line_item_update_request_model.py +266 -0
  85. criteo_api_retailmedia_preview/model/value_resource_outcome_recommended_keywords_response_v1.py +274 -0
  86. criteo_api_retailmedia_preview/model/value_resource_recommended_categories_request_v1.py +273 -0
  87. criteo_api_retailmedia_preview/model/value_resource_recommended_keywords_request_v1.py +266 -0
  88. criteo_api_retailmedia_preview/model/{value_resource_of_recommended_keywords_result.py → value_resource_recommended_keywords_response_v1.py} +10 -10
  89. criteo_api_retailmedia_preview/models/__init__.py +63 -17
  90. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/METADATA +3 -3
  91. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/RECORD +93 -47
  92. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/WHEEL +1 -1
  93. criteo_api_retailmedia_preview/model/common_error.py +0 -301
  94. criteo_api_retailmedia_preview/model/common_warning.py +0 -301
  95. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +0 -307
  96. {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/top_level.txt +0 -0
@@ -29,12 +29,14 @@ from criteo_api_retailmedia_preview.model.creative2_response import Creative2Res
29
29
  from criteo_api_retailmedia_preview.model.creative_create_model2 import CreativeCreateModel2
30
30
  from criteo_api_retailmedia_preview.model.creative_update_model2 import CreativeUpdateModel2
31
31
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata import EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
32
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204 import EntityResourceCollectionOutcomeCategory202204
33
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204_metadata import EntityResourceCollectionOutcomeCategory202204Metadata
32
34
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_line_item_keyword_review_report_and_metadata import EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
33
35
  from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_catalog_status_v2 import EntityResourceOutcomeOfCatalogStatusV2
34
- from criteo_api_retailmedia_preview.model.json_api_single_response_of_line_item_bid_multipliers_v2 import JsonApiSingleResponseOfLineItemBidMultipliersV2
36
+ from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_sponsored_products_line_item import EntityResourceOutcomeOfSponsoredProductsLineItem
35
37
  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
38
+ from criteo_api_retailmedia_preview.model.outcome import Outcome
39
+ from criteo_api_retailmedia_preview.model.page_of_sponsored_products_line_item import PageOfSponsoredProductsLineItem
38
40
  from criteo_api_retailmedia_preview.model.placement_preview_list_response import PlacementPreviewListResponse
39
41
  from criteo_api_retailmedia_preview.model.preferred_line_item_create_model_v2_request import PreferredLineItemCreateModelV2Request
40
42
  from criteo_api_retailmedia_preview.model.preferred_line_item_update_model_v2_request import PreferredLineItemUpdateModelV2Request
@@ -55,13 +57,18 @@ from criteo_api_retailmedia_preview.model.sku_search_request_slim_preview_reques
55
57
  from criteo_api_retailmedia_preview.model.sku_search_request_slim_v2_preview_request import SkuSearchRequestSlimV2PreviewRequest
56
58
  from criteo_api_retailmedia_preview.model.sku_slim_data_preview_list_response import SkuSlimDataPreviewListResponse
57
59
  from criteo_api_retailmedia_preview.model.sku_slim_data_v2_list_response import SkuSlimDataV2ListResponse
60
+ from criteo_api_retailmedia_preview.model.sponsored_products_line_item_create_request_model import SponsoredProductsLineItemCreateRequestModel
58
61
  from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
62
+ from criteo_api_retailmedia_preview.model.value_resource_input_categories_search_request_v1 import ValueResourceInputCategoriesSearchRequestV1
59
63
  from criteo_api_retailmedia_preview.model.value_resource_input_cpc_min_bids_request import ValueResourceInputCpcMinBidsRequest
60
64
  from criteo_api_retailmedia_preview.model.value_resource_input_of_brand_catalog_request_v2 import ValueResourceInputOfBrandCatalogRequestV2
61
65
  from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_catalog_request_v2 import ValueResourceInputOfSellerCatalogRequestV2
66
+ from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_products_line_item_update_request_model import ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel
67
+ from criteo_api_retailmedia_preview.model.value_resource_input_recommended_categories_request_v1 import ValueResourceInputRecommendedCategoriesRequestV1
68
+ from criteo_api_retailmedia_preview.model.value_resource_input_recommended_keywords_request_v1 import ValueResourceInputRecommendedKeywordsRequestV1
62
69
  from criteo_api_retailmedia_preview.model.value_resource_input_retail_media_keywords_review import ValueResourceInputRetailMediaKeywordsReview
63
70
  from criteo_api_retailmedia_preview.model.value_resource_outcome_cpc_min_bids_response import ValueResourceOutcomeCpcMinBidsResponse
64
- from criteo_api_retailmedia_preview.model.value_resource_outcome_of_recommended_keywords_result import ValueResourceOutcomeOfRecommendedKeywordsResult
71
+ from criteo_api_retailmedia_preview.model.value_resource_outcome_recommended_keywords_response_v1 import ValueResourceOutcomeRecommendedKeywordsResponseV1
65
72
  from criteo_api_retailmedia_preview.model.value_resource_outcome_retail_media_keywords_review_result import ValueResourceOutcomeRetailMediaKeywordsReviewResult
66
73
 
67
74
 
@@ -192,6 +199,150 @@ class CampaignApi(object):
192
199
  },
193
200
  api_client=api_client
194
201
  )
202
+ self.categories_search_v1_endpoint = _Endpoint(
203
+ settings={
204
+ 'response_type': (EntityResourceCollectionOutcomeCategory202204Metadata,),
205
+ 'auth': [
206
+ 'oauth',
207
+ 'oauth'
208
+ ],
209
+ 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/categories/search',
210
+ 'operation_id': 'categories_search_v1',
211
+ 'http_method': 'POST',
212
+ 'servers': None,
213
+ },
214
+ params_map={
215
+ 'all': [
216
+ 'retailer_id',
217
+ 'limit',
218
+ 'offset',
219
+ 'value_resource_input_categories_search_request_v1',
220
+ ],
221
+ 'required': [
222
+ 'retailer_id',
223
+ ],
224
+ 'nullable': [
225
+ ],
226
+ 'enum': [
227
+ ],
228
+ 'validation': [
229
+ 'limit',
230
+ 'offset',
231
+ ]
232
+ },
233
+ root_map={
234
+ 'validations': {
235
+ ('limit',): {
236
+
237
+ 'inclusive_maximum': 2147483647,
238
+ 'inclusive_minimum': 1,
239
+ },
240
+ ('offset',): {
241
+
242
+ 'inclusive_maximum': 2147483647,
243
+ 'inclusive_minimum': 0,
244
+ },
245
+ },
246
+ 'allowed_values': {
247
+ },
248
+ 'openapi_types': {
249
+ 'retailer_id':
250
+ (int,),
251
+ 'limit':
252
+ (int,),
253
+ 'offset':
254
+ (int,),
255
+ 'value_resource_input_categories_search_request_v1':
256
+ (ValueResourceInputCategoriesSearchRequestV1,),
257
+ },
258
+ 'attribute_map': {
259
+ 'retailer_id': 'retailerId',
260
+ 'limit': 'limit',
261
+ 'offset': 'offset',
262
+ },
263
+ 'location_map': {
264
+ 'retailer_id': 'path',
265
+ 'limit': 'query',
266
+ 'offset': 'query',
267
+ 'value_resource_input_categories_search_request_v1': 'body',
268
+ },
269
+ 'collection_format_map': {
270
+ }
271
+ },
272
+ headers_map={
273
+ 'accept': [
274
+ 'application/json'
275
+ ],
276
+ 'content_type': [
277
+ 'application/json-patch+json',
278
+ 'application/json',
279
+ 'text/json',
280
+ 'application/*+json'
281
+ ]
282
+ },
283
+ api_client=api_client
284
+ )
285
+ self.create_auction_line_item_v2_endpoint = _Endpoint(
286
+ settings={
287
+ 'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
288
+ 'auth': [
289
+ 'oauth',
290
+ 'oauth'
291
+ ],
292
+ 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/auction-line-items',
293
+ 'operation_id': 'create_auction_line_item_v2',
294
+ 'http_method': 'POST',
295
+ 'servers': None,
296
+ },
297
+ params_map={
298
+ 'all': [
299
+ 'campaign_id',
300
+ 'sponsored_products_line_item_create_request_model',
301
+ ],
302
+ 'required': [
303
+ 'campaign_id',
304
+ ],
305
+ 'nullable': [
306
+ ],
307
+ 'enum': [
308
+ ],
309
+ 'validation': [
310
+ ]
311
+ },
312
+ root_map={
313
+ 'validations': {
314
+ },
315
+ 'allowed_values': {
316
+ },
317
+ 'openapi_types': {
318
+ 'campaign_id':
319
+ (str,),
320
+ 'sponsored_products_line_item_create_request_model':
321
+ (SponsoredProductsLineItemCreateRequestModel,),
322
+ },
323
+ 'attribute_map': {
324
+ 'campaign_id': 'campaignId',
325
+ },
326
+ 'location_map': {
327
+ 'campaign_id': 'path',
328
+ 'sponsored_products_line_item_create_request_model': 'body',
329
+ },
330
+ 'collection_format_map': {
331
+ }
332
+ },
333
+ headers_map={
334
+ 'accept': [
335
+ 'application/json'
336
+ ],
337
+ 'content_type': [
338
+ 'application/json-patch+json',
339
+ 'application/json',
340
+ 'text/json',
341
+ 'application/*+json'
342
+ ]
343
+ },
344
+ api_client=api_client
345
+ )
195
346
  self.delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id_endpoint = _Endpoint(
196
347
  settings={
197
348
  'response_type': None,
@@ -961,15 +1112,15 @@ class CampaignApi(object):
961
1112
  },
962
1113
  api_client=api_client
963
1114
  )
964
- self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint(
1115
+ self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
965
1116
  settings={
966
- 'response_type': (JsonApiSingleResponseOfLineItemBidMultipliersV2,),
1117
+ 'response_type': (PreferredLineItemV2Response,),
967
1118
  'auth': [
968
1119
  'oauth',
969
1120
  'oauth'
970
1121
  ],
971
- 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers',
972
- 'operation_id': 'get_api_v2_external_line_item_bid_multipliers_by_line_item_id',
1122
+ 'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
1123
+ 'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id',
973
1124
  'http_method': 'GET',
974
1125
  'servers': None,
975
1126
  },
@@ -1007,23 +1158,21 @@ class CampaignApi(object):
1007
1158
  },
1008
1159
  headers_map={
1009
1160
  'accept': [
1010
- 'text/plain',
1011
- 'application/json',
1012
- 'text/json'
1161
+ 'application/json'
1013
1162
  ],
1014
1163
  'content_type': [],
1015
1164
  },
1016
1165
  api_client=api_client
1017
1166
  )
1018
- self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint = _Endpoint(
1167
+ self.get_auction_line_item_v2_endpoint = _Endpoint(
1019
1168
  settings={
1020
- 'response_type': (PreferredLineItemV2Response,),
1169
+ 'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
1021
1170
  'auth': [
1022
1171
  'oauth',
1023
1172
  'oauth'
1024
1173
  ],
1025
- 'endpoint_path': '/preview/retail-media/preferred-line-items/{line-item-id}',
1026
- 'operation_id': 'get_api_v2_external_preferred_line_item_by_line_item_id',
1174
+ 'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
1175
+ 'operation_id': 'get_auction_line_item_v2',
1027
1176
  'http_method': 'GET',
1028
1177
  'servers': None,
1029
1178
  },
@@ -1051,7 +1200,7 @@ class CampaignApi(object):
1051
1200
  (str,),
1052
1201
  },
1053
1202
  'attribute_map': {
1054
- 'line_item_id': 'line-item-id',
1203
+ 'line_item_id': 'lineItemId',
1055
1204
  },
1056
1205
  'location_map': {
1057
1206
  'line_item_id': 'path',
@@ -1067,6 +1216,86 @@ class CampaignApi(object):
1067
1216
  },
1068
1217
  api_client=api_client
1069
1218
  )
1219
+ self.get_auction_line_items_by_campaign_id_v2_endpoint = _Endpoint(
1220
+ settings={
1221
+ 'response_type': (PageOfSponsoredProductsLineItem,),
1222
+ 'auth': [
1223
+ 'oauth',
1224
+ 'oauth'
1225
+ ],
1226
+ 'endpoint_path': '/preview/retail-media/campaigns/{campaignId}/auction-line-items',
1227
+ 'operation_id': 'get_auction_line_items_by_campaign_id_v2',
1228
+ 'http_method': 'GET',
1229
+ 'servers': None,
1230
+ },
1231
+ params_map={
1232
+ 'all': [
1233
+ 'campaign_id',
1234
+ 'limit_to_id',
1235
+ 'page_index',
1236
+ 'page_size',
1237
+ ],
1238
+ 'required': [
1239
+ 'campaign_id',
1240
+ ],
1241
+ 'nullable': [
1242
+ ],
1243
+ 'enum': [
1244
+ ],
1245
+ 'validation': [
1246
+ 'page_index',
1247
+ 'page_size',
1248
+ ]
1249
+ },
1250
+ root_map={
1251
+ 'validations': {
1252
+ ('page_index',): {
1253
+
1254
+ 'inclusive_maximum': 2147483647,
1255
+ 'inclusive_minimum': 0,
1256
+ },
1257
+ ('page_size',): {
1258
+
1259
+ 'inclusive_maximum': 2147483647,
1260
+ 'inclusive_minimum': 1,
1261
+ },
1262
+ },
1263
+ 'allowed_values': {
1264
+ },
1265
+ 'openapi_types': {
1266
+ 'campaign_id':
1267
+ (str,),
1268
+ 'limit_to_id':
1269
+ ([str],),
1270
+ 'page_index':
1271
+ (int,),
1272
+ 'page_size':
1273
+ (int,),
1274
+ },
1275
+ 'attribute_map': {
1276
+ 'campaign_id': 'campaignId',
1277
+ 'limit_to_id': 'limitToId',
1278
+ 'page_index': 'pageIndex',
1279
+ 'page_size': 'pageSize',
1280
+ },
1281
+ 'location_map': {
1282
+ 'campaign_id': 'path',
1283
+ 'limit_to_id': 'query',
1284
+ 'page_index': 'query',
1285
+ 'page_size': 'query',
1286
+ },
1287
+ 'collection_format_map': {
1288
+ 'limit_to_id': 'multi',
1289
+ }
1290
+ },
1291
+ headers_map={
1292
+ 'accept': [
1293
+ 'application/json'
1294
+ ],
1295
+ 'content_type': [],
1296
+ },
1297
+ api_client=api_client
1298
+ )
1070
1299
  self.get_cpc_min_bids_by_sku_ids_v1_endpoint = _Endpoint(
1071
1300
  settings={
1072
1301
  'response_type': (ValueResourceOutcomeCpcMinBidsResponse,),
@@ -1130,24 +1359,25 @@ class CampaignApi(object):
1130
1359
  },
1131
1360
  api_client=api_client
1132
1361
  )
1133
- self.get_recommended_keywords_endpoint = _Endpoint(
1362
+ self.get_recommended_categories_endpoint = _Endpoint(
1134
1363
  settings={
1135
- 'response_type': (ValueResourceOutcomeOfRecommendedKeywordsResult,),
1364
+ 'response_type': (EntityResourceCollectionOutcomeCategory202204,),
1136
1365
  'auth': [
1137
1366
  'oauth',
1138
1367
  'oauth'
1139
1368
  ],
1140
- 'endpoint_path': '/preview/retail-media/line-items/{externalLineItemId}/keywords/recommended',
1141
- 'operation_id': 'get_recommended_keywords',
1142
- 'http_method': 'GET',
1369
+ 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-categories',
1370
+ 'operation_id': 'get_recommended_categories',
1371
+ 'http_method': 'POST',
1143
1372
  'servers': None,
1144
1373
  },
1145
1374
  params_map={
1146
1375
  'all': [
1147
- 'external_line_item_id',
1376
+ 'retailer_id',
1377
+ 'value_resource_input_recommended_categories_request_v1',
1148
1378
  ],
1149
1379
  'required': [
1150
- 'external_line_item_id',
1380
+ 'retailer_id',
1151
1381
  ],
1152
1382
  'nullable': [
1153
1383
  ],
@@ -1162,14 +1392,17 @@ class CampaignApi(object):
1162
1392
  'allowed_values': {
1163
1393
  },
1164
1394
  'openapi_types': {
1165
- 'external_line_item_id':
1166
- (str,),
1395
+ 'retailer_id':
1396
+ (int,),
1397
+ 'value_resource_input_recommended_categories_request_v1':
1398
+ (ValueResourceInputRecommendedCategoriesRequestV1,),
1167
1399
  },
1168
1400
  'attribute_map': {
1169
- 'external_line_item_id': 'externalLineItemId',
1401
+ 'retailer_id': 'retailerId',
1170
1402
  },
1171
1403
  'location_map': {
1172
- 'external_line_item_id': 'path',
1404
+ 'retailer_id': 'path',
1405
+ 'value_resource_input_recommended_categories_request_v1': 'body',
1173
1406
  },
1174
1407
  'collection_format_map': {
1175
1408
  }
@@ -1178,7 +1411,12 @@ class CampaignApi(object):
1178
1411
  'accept': [
1179
1412
  'application/json'
1180
1413
  ],
1181
- 'content_type': [],
1414
+ 'content_type': [
1415
+ 'application/json-patch+json',
1416
+ 'application/json',
1417
+ 'text/json',
1418
+ 'application/*+json'
1419
+ ]
1182
1420
  },
1183
1421
  api_client=api_client
1184
1422
  )
@@ -2173,28 +2411,27 @@ class CampaignApi(object):
2173
2411
  },
2174
2412
  api_client=api_client
2175
2413
  )
2176
- self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint = _Endpoint(
2414
+ self.recommended_keywords_endpoint = _Endpoint(
2177
2415
  settings={
2178
- 'response_type': (LineItemBidMultipliersV2Response,),
2416
+ 'response_type': (ValueResourceOutcomeRecommendedKeywordsResponseV1,),
2179
2417
  'auth': [
2180
2418
  'oauth',
2181
2419
  'oauth'
2182
2420
  ],
2183
- 'endpoint_path': '/preview/retail-media/line-items/{line-item-id}/bid-multipliers',
2184
- 'operation_id': 'put_api_v2_external_line_item_bid_multipliers_by_line_item_id',
2185
- 'http_method': 'PUT',
2421
+ 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-keywords',
2422
+ 'operation_id': 'recommended_keywords',
2423
+ 'http_method': 'POST',
2186
2424
  'servers': None,
2187
2425
  },
2188
2426
  params_map={
2189
2427
  'all': [
2190
- 'line_item_id',
2191
- 'line_item_bid_multipliers_v2_request',
2428
+ 'retailer_id',
2429
+ 'value_resource_input_recommended_keywords_request_v1',
2192
2430
  ],
2193
2431
  'required': [
2194
- 'line_item_id',
2432
+ 'retailer_id',
2195
2433
  ],
2196
2434
  'nullable': [
2197
- 'line_item_bid_multipliers_v2_request',
2198
2435
  ],
2199
2436
  'enum': [
2200
2437
  ],
@@ -2207,26 +2444,24 @@ class CampaignApi(object):
2207
2444
  'allowed_values': {
2208
2445
  },
2209
2446
  'openapi_types': {
2210
- 'line_item_id':
2211
- (str,),
2212
- 'line_item_bid_multipliers_v2_request':
2213
- (LineItemBidMultipliersV2Request,),
2447
+ 'retailer_id':
2448
+ (int,),
2449
+ 'value_resource_input_recommended_keywords_request_v1':
2450
+ (ValueResourceInputRecommendedKeywordsRequestV1,),
2214
2451
  },
2215
2452
  'attribute_map': {
2216
- 'line_item_id': 'line-item-id',
2453
+ 'retailer_id': 'retailerId',
2217
2454
  },
2218
2455
  'location_map': {
2219
- 'line_item_id': 'path',
2220
- 'line_item_bid_multipliers_v2_request': 'body',
2456
+ 'retailer_id': 'path',
2457
+ 'value_resource_input_recommended_keywords_request_v1': 'body',
2221
2458
  },
2222
2459
  'collection_format_map': {
2223
2460
  }
2224
2461
  },
2225
2462
  headers_map={
2226
2463
  'accept': [
2227
- 'text/plain',
2228
- 'application/json',
2229
- 'text/json'
2464
+ 'application/json'
2230
2465
  ],
2231
2466
  'content_type': [
2232
2467
  'application/json'
@@ -2428,6 +2663,67 @@ class CampaignApi(object):
2428
2663
  },
2429
2664
  api_client=api_client
2430
2665
  )
2666
+ self.update_auction_line_item_v2_endpoint = _Endpoint(
2667
+ settings={
2668
+ 'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
2669
+ 'auth': [
2670
+ 'oauth',
2671
+ 'oauth'
2672
+ ],
2673
+ 'endpoint_path': '/preview/retail-media/auction-line-items/{lineItemId}',
2674
+ 'operation_id': 'update_auction_line_item_v2',
2675
+ 'http_method': 'PUT',
2676
+ 'servers': None,
2677
+ },
2678
+ params_map={
2679
+ 'all': [
2680
+ 'line_item_id',
2681
+ 'value_resource_input_of_sponsored_products_line_item_update_request_model',
2682
+ ],
2683
+ 'required': [
2684
+ 'line_item_id',
2685
+ ],
2686
+ 'nullable': [
2687
+ ],
2688
+ 'enum': [
2689
+ ],
2690
+ 'validation': [
2691
+ ]
2692
+ },
2693
+ root_map={
2694
+ 'validations': {
2695
+ },
2696
+ 'allowed_values': {
2697
+ },
2698
+ 'openapi_types': {
2699
+ 'line_item_id':
2700
+ (str,),
2701
+ 'value_resource_input_of_sponsored_products_line_item_update_request_model':
2702
+ (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel,),
2703
+ },
2704
+ 'attribute_map': {
2705
+ 'line_item_id': 'lineItemId',
2706
+ },
2707
+ 'location_map': {
2708
+ 'line_item_id': 'path',
2709
+ 'value_resource_input_of_sponsored_products_line_item_update_request_model': 'body',
2710
+ },
2711
+ 'collection_format_map': {
2712
+ }
2713
+ },
2714
+ headers_map={
2715
+ 'accept': [
2716
+ 'application/json'
2717
+ ],
2718
+ 'content_type': [
2719
+ 'application/json-patch+json',
2720
+ 'application/json',
2721
+ 'text/json',
2722
+ 'application/*+json'
2723
+ ]
2724
+ },
2725
+ api_client=api_client
2726
+ )
2431
2727
  self.update_keyword_reviews_v1_endpoint = _Endpoint(
2432
2728
  settings={
2433
2729
  'response_type': (ValueResourceOutcomeRetailMediaKeywordsReviewResult,),
@@ -2492,25 +2788,195 @@ class CampaignApi(object):
2492
2788
  api_client=api_client
2493
2789
  )
2494
2790
 
2495
- def add_remove_keywords(
2791
+ def add_remove_keywords(
2792
+ self,
2793
+ id,
2794
+ **kwargs
2795
+ ):
2796
+ """add_remove_keywords # noqa: E501
2797
+
2798
+ Add or Remove keywords from the line item in bulk # noqa: E501
2799
+ This method makes a synchronous HTTP request by default. To make an
2800
+ asynchronous HTTP request, please pass async_req=True
2801
+
2802
+ >>> thread = api.add_remove_keywords(id, async_req=True)
2803
+ >>> result = thread.get()
2804
+
2805
+ Args:
2806
+ id (str): ID of the line item
2807
+
2808
+ Keyword Args:
2809
+ add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [optional]
2810
+ _return_http_data_only (bool): response data without head status
2811
+ code and headers. Default is True.
2812
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2813
+ will be returned without reading/decoding response data.
2814
+ Default is True.
2815
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2816
+ one number provided, it will be total request timeout. It can also
2817
+ be a pair (tuple) of (connection, read) timeouts.
2818
+ Default is None.
2819
+ _check_input_type (bool): specifies if type checking
2820
+ should be done one the data sent to the server.
2821
+ Default is True.
2822
+ _check_return_type (bool): specifies if type checking
2823
+ should be done one the data received from the server.
2824
+ Default is True.
2825
+ _spec_property_naming (bool): True if the variable names in the input data
2826
+ are serialized names, as specified in the OpenAPI document.
2827
+ False if the variable names in the input data
2828
+ are pythonic names, e.g. snake case (default)
2829
+ _content_type (str/None): force body content-type.
2830
+ Default is None and content-type will be predicted by allowed
2831
+ content-types and body.
2832
+ _host_index (int/None): specifies the index of the server
2833
+ that we want to use.
2834
+ Default is read from the configuration.
2835
+ _request_auths (list): set to override the auth_settings for an a single
2836
+ request; this effectively ignores the authentication
2837
+ in the spec for a single request.
2838
+ Default is None
2839
+ async_req (bool): execute request asynchronously
2840
+
2841
+ Returns:
2842
+ ResourceOutcome
2843
+ If the method is called asynchronously, returns the request
2844
+ thread.
2845
+ """
2846
+ kwargs['async_req'] = kwargs.get(
2847
+ 'async_req', False
2848
+ )
2849
+ kwargs['_return_http_data_only'] = kwargs.get(
2850
+ '_return_http_data_only', True
2851
+ )
2852
+ kwargs['_preload_content'] = kwargs.get(
2853
+ '_preload_content', True
2854
+ )
2855
+ kwargs['_request_timeout'] = kwargs.get(
2856
+ '_request_timeout', None
2857
+ )
2858
+ kwargs['_check_input_type'] = kwargs.get(
2859
+ '_check_input_type', True
2860
+ )
2861
+ kwargs['_check_return_type'] = kwargs.get(
2862
+ '_check_return_type', True
2863
+ )
2864
+ kwargs['_spec_property_naming'] = kwargs.get(
2865
+ '_spec_property_naming', False
2866
+ )
2867
+ kwargs['_content_type'] = kwargs.get(
2868
+ '_content_type')
2869
+ kwargs['_host_index'] = kwargs.get('_host_index')
2870
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2871
+ kwargs['id'] = \
2872
+ id
2873
+ return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs)
2874
+
2875
+ def append_promoted_products(
2876
+ self,
2877
+ line_item_id,
2878
+ **kwargs
2879
+ ):
2880
+ """append_promoted_products # noqa: E501
2881
+
2882
+ Append a collection of promoted products to a line item # noqa: E501
2883
+ This method makes a synchronous HTTP request by default. To make an
2884
+ asynchronous HTTP request, please pass async_req=True
2885
+
2886
+ >>> thread = api.append_promoted_products(line_item_id, async_req=True)
2887
+ >>> result = thread.get()
2888
+
2889
+ Args:
2890
+ line_item_id (str): ID of the line item
2891
+
2892
+ Keyword Args:
2893
+ promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
2894
+ _return_http_data_only (bool): response data without head status
2895
+ code and headers. Default is True.
2896
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2897
+ will be returned without reading/decoding response data.
2898
+ Default is True.
2899
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2900
+ one number provided, it will be total request timeout. It can also
2901
+ be a pair (tuple) of (connection, read) timeouts.
2902
+ Default is None.
2903
+ _check_input_type (bool): specifies if type checking
2904
+ should be done one the data sent to the server.
2905
+ Default is True.
2906
+ _check_return_type (bool): specifies if type checking
2907
+ should be done one the data received from the server.
2908
+ Default is True.
2909
+ _spec_property_naming (bool): True if the variable names in the input data
2910
+ are serialized names, as specified in the OpenAPI document.
2911
+ False if the variable names in the input data
2912
+ are pythonic names, e.g. snake case (default)
2913
+ _content_type (str/None): force body content-type.
2914
+ Default is None and content-type will be predicted by allowed
2915
+ content-types and body.
2916
+ _host_index (int/None): specifies the index of the server
2917
+ that we want to use.
2918
+ Default is read from the configuration.
2919
+ _request_auths (list): set to override the auth_settings for an a single
2920
+ request; this effectively ignores the authentication
2921
+ in the spec for a single request.
2922
+ Default is None
2923
+ async_req (bool): execute request asynchronously
2924
+
2925
+ Returns:
2926
+ ProductResourceOutcome
2927
+ If the method is called asynchronously, returns the request
2928
+ thread.
2929
+ """
2930
+ kwargs['async_req'] = kwargs.get(
2931
+ 'async_req', False
2932
+ )
2933
+ kwargs['_return_http_data_only'] = kwargs.get(
2934
+ '_return_http_data_only', True
2935
+ )
2936
+ kwargs['_preload_content'] = kwargs.get(
2937
+ '_preload_content', True
2938
+ )
2939
+ kwargs['_request_timeout'] = kwargs.get(
2940
+ '_request_timeout', None
2941
+ )
2942
+ kwargs['_check_input_type'] = kwargs.get(
2943
+ '_check_input_type', True
2944
+ )
2945
+ kwargs['_check_return_type'] = kwargs.get(
2946
+ '_check_return_type', True
2947
+ )
2948
+ kwargs['_spec_property_naming'] = kwargs.get(
2949
+ '_spec_property_naming', False
2950
+ )
2951
+ kwargs['_content_type'] = kwargs.get(
2952
+ '_content_type')
2953
+ kwargs['_host_index'] = kwargs.get('_host_index')
2954
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2955
+ kwargs['line_item_id'] = \
2956
+ line_item_id
2957
+ return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
2958
+
2959
+ def categories_search_v1(
2496
2960
  self,
2497
- id,
2961
+ retailer_id,
2498
2962
  **kwargs
2499
2963
  ):
2500
- """add_remove_keywords # noqa: E501
2964
+ """categories_search_v1 # noqa: E501
2501
2965
 
2502
- Add or Remove keywords from the line item in bulk # noqa: E501
2966
+ Search a retailer categories by given text substring and category ids. # noqa: E501
2503
2967
  This method makes a synchronous HTTP request by default. To make an
2504
2968
  asynchronous HTTP request, please pass async_req=True
2505
2969
 
2506
- >>> thread = api.add_remove_keywords(id, async_req=True)
2970
+ >>> thread = api.categories_search_v1(retailer_id, async_req=True)
2507
2971
  >>> result = thread.get()
2508
2972
 
2509
2973
  Args:
2510
- id (str): ID of the line item
2974
+ retailer_id (int): Retailer id.
2511
2975
 
2512
2976
  Keyword Args:
2513
- add_remove_keywords_model_request (AddRemoveKeywordsModelRequest): [optional]
2977
+ limit (int): Limit of the search result.. [optional] if omitted the server will use the default value of 50
2978
+ offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
2979
+ value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
2514
2980
  _return_http_data_only (bool): response data without head status
2515
2981
  code and headers. Default is True.
2516
2982
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -2543,7 +3009,7 @@ class CampaignApi(object):
2543
3009
  async_req (bool): execute request asynchronously
2544
3010
 
2545
3011
  Returns:
2546
- ResourceOutcome
3012
+ EntityResourceCollectionOutcomeCategory202204Metadata
2547
3013
  If the method is called asynchronously, returns the request
2548
3014
  thread.
2549
3015
  """
@@ -2572,29 +3038,29 @@ class CampaignApi(object):
2572
3038
  '_content_type')
2573
3039
  kwargs['_host_index'] = kwargs.get('_host_index')
2574
3040
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2575
- kwargs['id'] = \
2576
- id
2577
- return self.add_remove_keywords_endpoint.call_with_http_info(**kwargs)
3041
+ kwargs['retailer_id'] = \
3042
+ retailer_id
3043
+ return self.categories_search_v1_endpoint.call_with_http_info(**kwargs)
2578
3044
 
2579
- def append_promoted_products(
3045
+ def create_auction_line_item_v2(
2580
3046
  self,
2581
- line_item_id,
3047
+ campaign_id,
2582
3048
  **kwargs
2583
3049
  ):
2584
- """append_promoted_products # noqa: E501
3050
+ """create_auction_line_item_v2 # noqa: E501
2585
3051
 
2586
- Append a collection of promoted products to a line item # noqa: E501
3052
+ Creates new auction line item with the specified settings # noqa: E501
2587
3053
  This method makes a synchronous HTTP request by default. To make an
2588
3054
  asynchronous HTTP request, please pass async_req=True
2589
3055
 
2590
- >>> thread = api.append_promoted_products(line_item_id, async_req=True)
3056
+ >>> thread = api.create_auction_line_item_v2(campaign_id, async_req=True)
2591
3057
  >>> result = thread.get()
2592
3058
 
2593
3059
  Args:
2594
- line_item_id (str): ID of the line item
3060
+ campaign_id (str): The given campaign id
2595
3061
 
2596
3062
  Keyword Args:
2597
- promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
3063
+ sponsored_products_line_item_create_request_model (SponsoredProductsLineItemCreateRequestModel): The line item settings to create a line item with. [optional]
2598
3064
  _return_http_data_only (bool): response data without head status
2599
3065
  code and headers. Default is True.
2600
3066
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -2627,7 +3093,7 @@ class CampaignApi(object):
2627
3093
  async_req (bool): execute request asynchronously
2628
3094
 
2629
3095
  Returns:
2630
- ProductResourceOutcome
3096
+ EntityResourceOutcomeOfSponsoredProductsLineItem
2631
3097
  If the method is called asynchronously, returns the request
2632
3098
  thread.
2633
3099
  """
@@ -2656,9 +3122,9 @@ class CampaignApi(object):
2656
3122
  '_content_type')
2657
3123
  kwargs['_host_index'] = kwargs.get('_host_index')
2658
3124
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2659
- kwargs['line_item_id'] = \
2660
- line_item_id
2661
- return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
3125
+ kwargs['campaign_id'] = \
3126
+ campaign_id
3127
+ return self.create_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
2662
3128
 
2663
3129
  def delete_api202210_external_line_item_product_buttons_by_line_item_id_product_button_id(
2664
3130
  self,
@@ -3765,22 +4231,22 @@ class CampaignApi(object):
3765
4231
  campaign_id
3766
4232
  return self.get_api_v2_external_campaign_preferred_line_items_by_campaign_id_endpoint.call_with_http_info(**kwargs)
3767
4233
 
3768
- def get_api_v2_external_line_item_bid_multipliers_by_line_item_id(
4234
+ def get_api_v2_external_preferred_line_item_by_line_item_id(
3769
4235
  self,
3770
4236
  line_item_id,
3771
4237
  **kwargs
3772
4238
  ):
3773
- """get_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501
4239
+ """get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501
3774
4240
 
3775
- Fetch all bid multipliers for a given line item # noqa: E501
4241
+ Gets the preferred line item for the given line item id # noqa: E501
3776
4242
  This method makes a synchronous HTTP request by default. To make an
3777
4243
  asynchronous HTTP request, please pass async_req=True
3778
4244
 
3779
- >>> thread = api.get_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True)
4245
+ >>> thread = api.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
3780
4246
  >>> result = thread.get()
3781
4247
 
3782
4248
  Args:
3783
- line_item_id (str): External LineItemId for bid multiplier retrieval
4249
+ line_item_id (str): The given line item id
3784
4250
 
3785
4251
  Keyword Args:
3786
4252
  _return_http_data_only (bool): response data without head status
@@ -3815,7 +4281,7 @@ class CampaignApi(object):
3815
4281
  async_req (bool): execute request asynchronously
3816
4282
 
3817
4283
  Returns:
3818
- JsonApiSingleResponseOfLineItemBidMultipliersV2
4284
+ PreferredLineItemV2Response
3819
4285
  If the method is called asynchronously, returns the request
3820
4286
  thread.
3821
4287
  """
@@ -3846,24 +4312,24 @@ class CampaignApi(object):
3846
4312
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3847
4313
  kwargs['line_item_id'] = \
3848
4314
  line_item_id
3849
- return self.get_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
4315
+ return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
3850
4316
 
3851
- def get_api_v2_external_preferred_line_item_by_line_item_id(
4317
+ def get_auction_line_item_v2(
3852
4318
  self,
3853
4319
  line_item_id,
3854
4320
  **kwargs
3855
4321
  ):
3856
- """get_api_v2_external_preferred_line_item_by_line_item_id # noqa: E501
4322
+ """get_auction_line_item_v2 # noqa: E501
3857
4323
 
3858
- Gets the preferred line item for the given line item id # noqa: E501
4324
+ Gets a sponsored product line item by its id. # noqa: E501
3859
4325
  This method makes a synchronous HTTP request by default. To make an
3860
4326
  asynchronous HTTP request, please pass async_req=True
3861
4327
 
3862
- >>> thread = api.get_api_v2_external_preferred_line_item_by_line_item_id(line_item_id, async_req=True)
4328
+ >>> thread = api.get_auction_line_item_v2(line_item_id, async_req=True)
3863
4329
  >>> result = thread.get()
3864
4330
 
3865
4331
  Args:
3866
- line_item_id (str): The given line item id
4332
+ line_item_id (str): The id of the line item
3867
4333
 
3868
4334
  Keyword Args:
3869
4335
  _return_http_data_only (bool): response data without head status
@@ -3898,7 +4364,7 @@ class CampaignApi(object):
3898
4364
  async_req (bool): execute request asynchronously
3899
4365
 
3900
4366
  Returns:
3901
- PreferredLineItemV2Response
4367
+ EntityResourceOutcomeOfSponsoredProductsLineItem
3902
4368
  If the method is called asynchronously, returns the request
3903
4369
  thread.
3904
4370
  """
@@ -3929,7 +4395,93 @@ class CampaignApi(object):
3929
4395
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3930
4396
  kwargs['line_item_id'] = \
3931
4397
  line_item_id
3932
- return self.get_api_v2_external_preferred_line_item_by_line_item_id_endpoint.call_with_http_info(**kwargs)
4398
+ return self.get_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
4399
+
4400
+ def get_auction_line_items_by_campaign_id_v2(
4401
+ self,
4402
+ campaign_id,
4403
+ **kwargs
4404
+ ):
4405
+ """get_auction_line_items_by_campaign_id_v2 # noqa: E501
4406
+
4407
+ Gets a page of sponsored product line items by campaign id. # noqa: E501
4408
+ This method makes a synchronous HTTP request by default. To make an
4409
+ asynchronous HTTP request, please pass async_req=True
4410
+
4411
+ >>> thread = api.get_auction_line_items_by_campaign_id_v2(campaign_id, async_req=True)
4412
+ >>> result = thread.get()
4413
+
4414
+ Args:
4415
+ campaign_id (str): The id of the campaign
4416
+
4417
+ Keyword Args:
4418
+ limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
4419
+ page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
4420
+ page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
4421
+ _return_http_data_only (bool): response data without head status
4422
+ code and headers. Default is True.
4423
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
4424
+ will be returned without reading/decoding response data.
4425
+ Default is True.
4426
+ _request_timeout (int/float/tuple): timeout setting for this request. If
4427
+ one number provided, it will be total request timeout. It can also
4428
+ be a pair (tuple) of (connection, read) timeouts.
4429
+ Default is None.
4430
+ _check_input_type (bool): specifies if type checking
4431
+ should be done one the data sent to the server.
4432
+ Default is True.
4433
+ _check_return_type (bool): specifies if type checking
4434
+ should be done one the data received from the server.
4435
+ Default is True.
4436
+ _spec_property_naming (bool): True if the variable names in the input data
4437
+ are serialized names, as specified in the OpenAPI document.
4438
+ False if the variable names in the input data
4439
+ are pythonic names, e.g. snake case (default)
4440
+ _content_type (str/None): force body content-type.
4441
+ Default is None and content-type will be predicted by allowed
4442
+ content-types and body.
4443
+ _host_index (int/None): specifies the index of the server
4444
+ that we want to use.
4445
+ Default is read from the configuration.
4446
+ _request_auths (list): set to override the auth_settings for an a single
4447
+ request; this effectively ignores the authentication
4448
+ in the spec for a single request.
4449
+ Default is None
4450
+ async_req (bool): execute request asynchronously
4451
+
4452
+ Returns:
4453
+ PageOfSponsoredProductsLineItem
4454
+ If the method is called asynchronously, returns the request
4455
+ thread.
4456
+ """
4457
+ kwargs['async_req'] = kwargs.get(
4458
+ 'async_req', False
4459
+ )
4460
+ kwargs['_return_http_data_only'] = kwargs.get(
4461
+ '_return_http_data_only', True
4462
+ )
4463
+ kwargs['_preload_content'] = kwargs.get(
4464
+ '_preload_content', True
4465
+ )
4466
+ kwargs['_request_timeout'] = kwargs.get(
4467
+ '_request_timeout', None
4468
+ )
4469
+ kwargs['_check_input_type'] = kwargs.get(
4470
+ '_check_input_type', True
4471
+ )
4472
+ kwargs['_check_return_type'] = kwargs.get(
4473
+ '_check_return_type', True
4474
+ )
4475
+ kwargs['_spec_property_naming'] = kwargs.get(
4476
+ '_spec_property_naming', False
4477
+ )
4478
+ kwargs['_content_type'] = kwargs.get(
4479
+ '_content_type')
4480
+ kwargs['_host_index'] = kwargs.get('_host_index')
4481
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4482
+ kwargs['campaign_id'] = \
4483
+ campaign_id
4484
+ return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
3933
4485
 
3934
4486
  def get_cpc_min_bids_by_sku_ids_v1(
3935
4487
  self,
@@ -4015,24 +4567,25 @@ class CampaignApi(object):
4015
4567
  retailer_id
4016
4568
  return self.get_cpc_min_bids_by_sku_ids_v1_endpoint.call_with_http_info(**kwargs)
4017
4569
 
4018
- def get_recommended_keywords(
4570
+ def get_recommended_categories(
4019
4571
  self,
4020
- external_line_item_id,
4572
+ retailer_id,
4021
4573
  **kwargs
4022
4574
  ):
4023
- """get_recommended_keywords # noqa: E501
4575
+ """get_recommended_categories # noqa: E501
4024
4576
 
4025
- Retrieves a collection of recommended keywords for a line item # noqa: E501
4577
+ Endpoint to get recommended categories by given retailer id and sku id list. # noqa: E501
4026
4578
  This method makes a synchronous HTTP request by default. To make an
4027
4579
  asynchronous HTTP request, please pass async_req=True
4028
4580
 
4029
- >>> thread = api.get_recommended_keywords(external_line_item_id, async_req=True)
4581
+ >>> thread = api.get_recommended_categories(retailer_id, async_req=True)
4030
4582
  >>> result = thread.get()
4031
4583
 
4032
4584
  Args:
4033
- external_line_item_id (str): The external line item identifier
4585
+ retailer_id (int): Retailer id.
4034
4586
 
4035
4587
  Keyword Args:
4588
+ value_resource_input_recommended_categories_request_v1 (ValueResourceInputRecommendedCategoriesRequestV1): Request of recommended categories.. [optional]
4036
4589
  _return_http_data_only (bool): response data without head status
4037
4590
  code and headers. Default is True.
4038
4591
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -4065,7 +4618,7 @@ class CampaignApi(object):
4065
4618
  async_req (bool): execute request asynchronously
4066
4619
 
4067
4620
  Returns:
4068
- ValueResourceOutcomeOfRecommendedKeywordsResult
4621
+ EntityResourceCollectionOutcomeCategory202204
4069
4622
  If the method is called asynchronously, returns the request
4070
4623
  thread.
4071
4624
  """
@@ -4094,9 +4647,9 @@ class CampaignApi(object):
4094
4647
  '_content_type')
4095
4648
  kwargs['_host_index'] = kwargs.get('_host_index')
4096
4649
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4097
- kwargs['external_line_item_id'] = \
4098
- external_line_item_id
4099
- return self.get_recommended_keywords_endpoint.call_with_http_info(**kwargs)
4650
+ kwargs['retailer_id'] = \
4651
+ retailer_id
4652
+ return self.get_recommended_categories_endpoint.call_with_http_info(**kwargs)
4100
4653
 
4101
4654
  def in_review_report_v1(
4102
4655
  self,
@@ -5376,25 +5929,25 @@ class CampaignApi(object):
5376
5929
  creative_id
5377
5930
  return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
5378
5931
 
5379
- def put_api_v2_external_line_item_bid_multipliers_by_line_item_id(
5932
+ def recommended_keywords(
5380
5933
  self,
5381
- line_item_id,
5934
+ retailer_id,
5382
5935
  **kwargs
5383
5936
  ):
5384
- """put_api_v2_external_line_item_bid_multipliers_by_line_item_id # noqa: E501
5937
+ """recommended_keywords # noqa: E501
5385
5938
 
5386
- Updates the bid multipliers for a given line item # noqa: E501
5939
+ Recommend keywords by given retailer id and sku ids. # noqa: E501
5387
5940
  This method makes a synchronous HTTP request by default. To make an
5388
5941
  asynchronous HTTP request, please pass async_req=True
5389
5942
 
5390
- >>> thread = api.put_api_v2_external_line_item_bid_multipliers_by_line_item_id(line_item_id, async_req=True)
5943
+ >>> thread = api.recommended_keywords(retailer_id, async_req=True)
5391
5944
  >>> result = thread.get()
5392
5945
 
5393
5946
  Args:
5394
- line_item_id (str): External LineItemId for bid multiplier retrieval
5947
+ retailer_id (int): Retailer id.
5395
5948
 
5396
5949
  Keyword Args:
5397
- line_item_bid_multipliers_v2_request (LineItemBidMultipliersV2Request): New Bid Multipliers to be set. [optional]
5950
+ value_resource_input_recommended_keywords_request_v1 (ValueResourceInputRecommendedKeywordsRequestV1): Request of recommended keywords.. [optional]
5398
5951
  _return_http_data_only (bool): response data without head status
5399
5952
  code and headers. Default is True.
5400
5953
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5427,7 +5980,7 @@ class CampaignApi(object):
5427
5980
  async_req (bool): execute request asynchronously
5428
5981
 
5429
5982
  Returns:
5430
- LineItemBidMultipliersV2Response
5983
+ ValueResourceOutcomeRecommendedKeywordsResponseV1
5431
5984
  If the method is called asynchronously, returns the request
5432
5985
  thread.
5433
5986
  """
@@ -5456,9 +6009,9 @@ class CampaignApi(object):
5456
6009
  '_content_type')
5457
6010
  kwargs['_host_index'] = kwargs.get('_host_index')
5458
6011
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5459
- kwargs['line_item_id'] = \
5460
- line_item_id
5461
- return self.put_api_v2_external_line_item_bid_multipliers_by_line_item_id_endpoint.call_with_http_info(**kwargs)
6012
+ kwargs['retailer_id'] = \
6013
+ retailer_id
6014
+ return self.recommended_keywords_endpoint.call_with_http_info(**kwargs)
5462
6015
 
5463
6016
  def search_brands_by_name_async_v1(
5464
6017
  self,
@@ -5709,6 +6262,90 @@ class CampaignApi(object):
5709
6262
  line_item_id
5710
6263
  return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
5711
6264
 
6265
+ def update_auction_line_item_v2(
6266
+ self,
6267
+ line_item_id,
6268
+ **kwargs
6269
+ ):
6270
+ """update_auction_line_item_v2 # noqa: E501
6271
+
6272
+ Updates a Sponsored Products Line Item given a line item id and a request. # noqa: E501
6273
+ This method makes a synchronous HTTP request by default. To make an
6274
+ asynchronous HTTP request, please pass async_req=True
6275
+
6276
+ >>> thread = api.update_auction_line_item_v2(line_item_id, async_req=True)
6277
+ >>> result = thread.get()
6278
+
6279
+ Args:
6280
+ line_item_id (str): The line item ID of the sponsored products line item.
6281
+
6282
+ Keyword Args:
6283
+ value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
6284
+ _return_http_data_only (bool): response data without head status
6285
+ code and headers. Default is True.
6286
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
6287
+ will be returned without reading/decoding response data.
6288
+ Default is True.
6289
+ _request_timeout (int/float/tuple): timeout setting for this request. If
6290
+ one number provided, it will be total request timeout. It can also
6291
+ be a pair (tuple) of (connection, read) timeouts.
6292
+ Default is None.
6293
+ _check_input_type (bool): specifies if type checking
6294
+ should be done one the data sent to the server.
6295
+ Default is True.
6296
+ _check_return_type (bool): specifies if type checking
6297
+ should be done one the data received from the server.
6298
+ Default is True.
6299
+ _spec_property_naming (bool): True if the variable names in the input data
6300
+ are serialized names, as specified in the OpenAPI document.
6301
+ False if the variable names in the input data
6302
+ are pythonic names, e.g. snake case (default)
6303
+ _content_type (str/None): force body content-type.
6304
+ Default is None and content-type will be predicted by allowed
6305
+ content-types and body.
6306
+ _host_index (int/None): specifies the index of the server
6307
+ that we want to use.
6308
+ Default is read from the configuration.
6309
+ _request_auths (list): set to override the auth_settings for an a single
6310
+ request; this effectively ignores the authentication
6311
+ in the spec for a single request.
6312
+ Default is None
6313
+ async_req (bool): execute request asynchronously
6314
+
6315
+ Returns:
6316
+ EntityResourceOutcomeOfSponsoredProductsLineItem
6317
+ If the method is called asynchronously, returns the request
6318
+ thread.
6319
+ """
6320
+ kwargs['async_req'] = kwargs.get(
6321
+ 'async_req', False
6322
+ )
6323
+ kwargs['_return_http_data_only'] = kwargs.get(
6324
+ '_return_http_data_only', True
6325
+ )
6326
+ kwargs['_preload_content'] = kwargs.get(
6327
+ '_preload_content', True
6328
+ )
6329
+ kwargs['_request_timeout'] = kwargs.get(
6330
+ '_request_timeout', None
6331
+ )
6332
+ kwargs['_check_input_type'] = kwargs.get(
6333
+ '_check_input_type', True
6334
+ )
6335
+ kwargs['_check_return_type'] = kwargs.get(
6336
+ '_check_return_type', True
6337
+ )
6338
+ kwargs['_spec_property_naming'] = kwargs.get(
6339
+ '_spec_property_naming', False
6340
+ )
6341
+ kwargs['_content_type'] = kwargs.get(
6342
+ '_content_type')
6343
+ kwargs['_host_index'] = kwargs.get('_host_index')
6344
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
6345
+ kwargs['line_item_id'] = \
6346
+ line_item_id
6347
+ return self.update_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
6348
+
5712
6349
  def update_keyword_reviews_v1(
5713
6350
  self,
5714
6351
  line_item_id,