criteo-api-retailmedia-sdk 0.0.240808__py3-none-any.whl → 0.0.250129__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 (130) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +45 -198
  3. criteo_api_retailmedia_preview/api/analytics_api.py +3 -3
  4. criteo_api_retailmedia_preview/api/audience_api.py +89 -232
  5. criteo_api_retailmedia_preview/api/balance_api.py +0 -159
  6. criteo_api_retailmedia_preview/api/campaign_api.py +246 -1604
  7. criteo_api_retailmedia_preview/api/catalog_api.py +161 -0
  8. criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +186 -0
  9. criteo_api_retailmedia_preview/api_client.py +4 -4
  10. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  11. criteo_api_retailmedia_preview/configuration.py +1 -1
  12. criteo_api_retailmedia_preview/model/async_accounts_report.py +40 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +40 -0
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +40 -0
  15. criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
  16. criteo_api_retailmedia_preview/model/{creative_v2_response.py → bot_message.py} +17 -21
  17. criteo_api_retailmedia_preview/model/botmessage.py +329 -0
  18. criteo_api_retailmedia_preview/model/brand_id_search_request.py +271 -0
  19. criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
  20. criteo_api_retailmedia_preview/model/category.py +3 -3
  21. criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
  22. criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
  23. criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
  24. criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
  25. criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
  26. criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
  27. criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
  28. criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  29. criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
  30. criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
  31. criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
  32. criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
  33. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_campaign_budget_overrides.py → entity_resource_collection_outcome_brand_id_search_result.py} +16 -16
  34. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_list_response.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
  35. criteo_api_retailmedia_preview/model/{resource_of_add_funds_to_balance_v2.py → entity_resource_of_retail_media_child_account.py} +14 -14
  36. criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
  37. criteo_api_retailmedia_preview/model/{external_account.py → external_retail_media_child_account.py} +39 -56
  38. criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
  39. criteo_api_retailmedia_preview/model/http_validation_error.py +269 -0
  40. criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
  41. criteo_api_retailmedia_preview/model/inbot_discussion.py +272 -0
  42. criteo_api_retailmedia_preview/model/{external_brand.py → inbot_discussion_body_model.py} +17 -15
  43. criteo_api_retailmedia_preview/model/inbot_discussion_data_instance_model.py +279 -0
  44. criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
  45. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
  46. criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
  47. criteo_api_retailmedia_preview/model/{external_text_variable_value.py → location_inner.py} +3 -7
  48. criteo_api_retailmedia_preview/model/message.py +273 -0
  49. criteo_api_retailmedia_preview/model/message_body_model.py +275 -0
  50. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_retailer_and_retailer.py → message_data_instance_model.py} +16 -22
  51. criteo_api_retailmedia_preview/model/message_error.py +275 -0
  52. criteo_api_retailmedia_preview/model/{rm_legacy_segment_customer_list.py → offset_page_metadata.py} +21 -17
  53. criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → outcome.py} +15 -17
  54. criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  55. criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
  56. criteo_api_retailmedia_preview/model/product.py +4 -0
  57. criteo_api_retailmedia_preview/model/product_recommendation.py +305 -0
  58. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_account_and_account.py → report_detail_warning.py} +21 -21
  59. criteo_api_retailmedia_preview/model/report_detail_warnings.py +281 -0
  60. criteo_api_retailmedia_preview/model/report_ok_response.py +31 -17
  61. criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  62. criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  63. criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
  64. criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
  65. criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +275 -0
  66. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v1_resource.py → rm_audience_entity_v1.py} +45 -24
  67. criteo_api_retailmedia_preview/model/{rm_legacy_audience_get_entity_v2_resource.py → rm_audience_entity_v1_resource.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py} +14 -8
  69. criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +271 -0
  70. criteo_api_retailmedia_preview/model/{resource_of_creative_v2.py → rm_audience_search_entity_v1_resource.py} +11 -15
  71. criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → rm_audience_search_input_v1.py} +8 -8
  72. criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +271 -0
  73. criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +17 -9
  74. criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +7 -7
  75. criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +1 -1
  76. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +5 -5
  77. criteo_api_retailmedia_preview/model/{rm_user_behavior_v1.py → rm_events_v1.py} +3 -3
  78. criteo_api_retailmedia_preview/model/{retail_media_account.py → sdk_api_rest_common_problem.py} +41 -42
  79. criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
  80. criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
  81. criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
  82. criteo_api_retailmedia_preview/model/sku_min_bid.py +269 -0
  83. criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
  84. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
  85. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
  86. criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
  87. criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
  88. criteo_api_retailmedia_preview/model/text_variable_value.py +257 -0
  89. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_brand_and_brand.py → validation_error.py} +19 -17
  90. criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
  91. criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
  92. criteo_api_retailmedia_preview/model/{value_resource_of_campaign_budget_overrides.py → value_resource_cpc_min_bids_request.py} +10 -10
  93. criteo_api_retailmedia_preview/model/{value_resource_of_line_item_budget_overrides.py → value_resource_cpc_min_bids_response.py} +10 -10
  94. criteo_api_retailmedia_preview/model/{value_resource_input_of_line_item_budget_overrides.py → value_resource_input_brand_id_search_request.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_cpc_min_bids_request.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{value_resource_input_of_campaign_budget_overrides.py → value_resource_input_of_seller_search.py} +8 -8
  97. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
  98. criteo_api_retailmedia_preview/model/value_resource_of_seller_search.py +266 -0
  99. criteo_api_retailmedia_preview/model/{value_resource_outcome_of_line_item_budget_overrides.py → value_resource_outcome_cpc_min_bids_response.py} +16 -16
  100. criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  101. criteo_api_retailmedia_preview/models/__init__.py +60 -69
  102. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/METADATA +14 -5
  103. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/RECORD +105 -113
  104. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/WHEEL +1 -1
  105. criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
  106. criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
  107. criteo_api_retailmedia_preview/model/campaign_budget_overrides.py +0 -276
  108. criteo_api_retailmedia_preview/model/campaign_daily_budget_override.py +0 -283
  109. criteo_api_retailmedia_preview/model/campaign_monthly_budget_override.py +0 -283
  110. criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
  111. criteo_api_retailmedia_preview/model/daily_line_item_budget_override.py +0 -281
  112. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
  113. criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
  114. criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
  115. criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
  116. criteo_api_retailmedia_preview/model/line_item_budget_overrides.py +0 -276
  117. criteo_api_retailmedia_preview/model/monthly_line_item_budeget_override.py +0 -283
  118. criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
  119. criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
  120. criteo_api_retailmedia_preview/model/proposal_status_model_response.py +0 -274
  121. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -270
  122. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v1.py +0 -291
  123. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +0 -291
  124. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2_list_response.py +0 -281
  125. criteo_api_retailmedia_preview/model/rm_legacy_audience_user_behavior_details_v2.py +0 -279
  126. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v1.py +0 -306
  127. criteo_api_retailmedia_preview/model/rm_legacy_segment_user_behavior_v2.py +0 -311
  128. criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
  129. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +0 -262
  130. {criteo_api_retailmedia_sdk-0.0.240808.dist-info → criteo_api_retailmedia_sdk-0.0.250129.dist-info}/top_level.txt +0 -0
@@ -22,9 +22,11 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
22
22
  validate_and_convert_types
23
23
  )
24
24
  from criteo_api_retailmedia_preview.model.batch_accepted_response import BatchAcceptedResponse
25
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_brand_id_search_result import EntityResourceCollectionOutcomeBrandIdSearchResult
25
26
  from criteo_api_retailmedia_preview.model.fail_response import FailResponse
26
27
  from criteo_api_retailmedia_preview.model.products_custom_batch_request import ProductsCustomBatchRequest
27
28
  from criteo_api_retailmedia_preview.model.report_ok_response import ReportOkResponse
29
+ from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
28
30
 
29
31
 
30
32
  class CatalogApi(object):
@@ -143,6 +145,84 @@ class CatalogApi(object):
143
145
  },
144
146
  api_client=api_client
145
147
  )
148
+ self.search_brands_by_name_async_v1_endpoint = _Endpoint(
149
+ settings={
150
+ 'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResult,),
151
+ 'auth': [
152
+ 'oauth',
153
+ 'oauth'
154
+ ],
155
+ 'endpoint_path': '/preview/retail-media/brands/search',
156
+ 'operation_id': 'search_brands_by_name_async_v1',
157
+ 'http_method': 'POST',
158
+ 'servers': None,
159
+ },
160
+ params_map={
161
+ 'all': [
162
+ 'offset',
163
+ 'limit',
164
+ 'value_resource_input_brand_id_search_request',
165
+ ],
166
+ 'required': [],
167
+ 'nullable': [
168
+ ],
169
+ 'enum': [
170
+ ],
171
+ 'validation': [
172
+ 'offset',
173
+ 'limit',
174
+ ]
175
+ },
176
+ root_map={
177
+ 'validations': {
178
+ ('offset',): {
179
+
180
+ 'inclusive_maximum': 2147483647,
181
+ 'inclusive_minimum': 0,
182
+ },
183
+ ('limit',): {
184
+
185
+ 'inclusive_maximum': 100,
186
+ 'inclusive_minimum': 1,
187
+ },
188
+ },
189
+ 'allowed_values': {
190
+ },
191
+ 'openapi_types': {
192
+ 'offset':
193
+ (int,),
194
+ 'limit':
195
+ (int,),
196
+ 'value_resource_input_brand_id_search_request':
197
+ (ValueResourceInputBrandIdSearchRequest,),
198
+ },
199
+ 'attribute_map': {
200
+ 'offset': 'offset',
201
+ 'limit': 'limit',
202
+ },
203
+ 'location_map': {
204
+ 'offset': 'query',
205
+ 'limit': 'query',
206
+ 'value_resource_input_brand_id_search_request': 'body',
207
+ },
208
+ 'collection_format_map': {
209
+ }
210
+ },
211
+ headers_map={
212
+ 'accept': [
213
+ 'text/plain',
214
+ 'application/json',
215
+ 'text/json'
216
+ ],
217
+ 'content_type': [
218
+ 'application/json-patch+json',
219
+ 'application/json',
220
+ 'text/json',
221
+ 'application/*+json'
222
+ ]
223
+ },
224
+ api_client=api_client
225
+ )
146
226
 
147
227
  def preview_retail_media_catalog_products_batch_post(
148
228
  self,
@@ -310,3 +390,84 @@ class CatalogApi(object):
310
390
  operation_token
311
391
  return self.preview_retail_media_catalog_products_batch_report_operation_token_get_endpoint.call_with_http_info(**kwargs)
312
392
 
393
+ def search_brands_by_name_async_v1(
394
+ self,
395
+ **kwargs
396
+ ):
397
+ """search_brands_by_name_async_v1 # noqa: E501
398
+
399
+ Search for brands given a retailer ID and search term. # noqa: E501
400
+ This method makes a synchronous HTTP request by default. To make an
401
+ asynchronous HTTP request, please pass async_req=True
402
+
403
+ >>> thread = api.search_brands_by_name_async_v1(async_req=True)
404
+ >>> result = thread.get()
405
+
406
+
407
+ Keyword Args:
408
+ offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
409
+ limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
410
+ value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
411
+ _return_http_data_only (bool): response data without head status
412
+ code and headers. Default is True.
413
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
414
+ will be returned without reading/decoding response data.
415
+ Default is True.
416
+ _request_timeout (int/float/tuple): timeout setting for this request. If
417
+ one number provided, it will be total request timeout. It can also
418
+ be a pair (tuple) of (connection, read) timeouts.
419
+ Default is None.
420
+ _check_input_type (bool): specifies if type checking
421
+ should be done one the data sent to the server.
422
+ Default is True.
423
+ _check_return_type (bool): specifies if type checking
424
+ should be done one the data received from the server.
425
+ Default is True.
426
+ _spec_property_naming (bool): True if the variable names in the input data
427
+ are serialized names, as specified in the OpenAPI document.
428
+ False if the variable names in the input data
429
+ are pythonic names, e.g. snake case (default)
430
+ _content_type (str/None): force body content-type.
431
+ Default is None and content-type will be predicted by allowed
432
+ content-types and body.
433
+ _host_index (int/None): specifies the index of the server
434
+ that we want to use.
435
+ Default is read from the configuration.
436
+ _request_auths (list): set to override the auth_settings for an a single
437
+ request; this effectively ignores the authentication
438
+ in the spec for a single request.
439
+ Default is None
440
+ async_req (bool): execute request asynchronously
441
+
442
+ Returns:
443
+ EntityResourceCollectionOutcomeBrandIdSearchResult
444
+ If the method is called asynchronously, returns the request
445
+ thread.
446
+ """
447
+ kwargs['async_req'] = kwargs.get(
448
+ 'async_req', False
449
+ )
450
+ kwargs['_return_http_data_only'] = kwargs.get(
451
+ '_return_http_data_only', True
452
+ )
453
+ kwargs['_preload_content'] = kwargs.get(
454
+ '_preload_content', True
455
+ )
456
+ kwargs['_request_timeout'] = kwargs.get(
457
+ '_request_timeout', None
458
+ )
459
+ kwargs['_check_input_type'] = kwargs.get(
460
+ '_check_input_type', True
461
+ )
462
+ kwargs['_check_return_type'] = kwargs.get(
463
+ '_check_return_type', True
464
+ )
465
+ kwargs['_spec_property_naming'] = kwargs.get(
466
+ '_spec_property_naming', False
467
+ )
468
+ kwargs['_content_type'] = kwargs.get(
469
+ '_content_type')
470
+ kwargs['_host_index'] = kwargs.get('_host_index')
471
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
472
+ return self.search_brands_by_name_async_v1_endpoint.call_with_http_info(**kwargs)
473
+
@@ -0,0 +1,186 @@
1
+ """
2
+ Criteo API
3
+
4
+ Criteo API - RetailMedia # noqa: E501
5
+
6
+ The version of the OpenAPI document: Preview
7
+ Generated by: https://openapi-generator.tech
8
+ """
9
+
10
+
11
+ import re # noqa: F401
12
+ import sys # noqa: F401
13
+
14
+ from criteo_api_retailmedia_preview.api_client import ApiClient, Endpoint as _Endpoint
15
+ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
16
+ check_allowed_values,
17
+ check_validations,
18
+ date,
19
+ datetime,
20
+ file_type,
21
+ none_type,
22
+ validate_and_convert_types
23
+ )
24
+ from criteo_api_retailmedia_preview.model.http_validation_error import HttpValidationError
25
+ from criteo_api_retailmedia_preview.model.inbot_discussion_body_model import InbotDiscussionBodyModel
26
+ from criteo_api_retailmedia_preview.model.message_body_model import MessageBodyModel
27
+
28
+
29
+ class OnSiteRecommendationApi(object):
30
+ """NOTE: This class is auto generated by OpenAPI Generator
31
+ Ref: https://openapi-generator.tech
32
+
33
+ Do not edit the class manually.
34
+ """
35
+
36
+ def __init__(self, api_client=None):
37
+ if api_client is None:
38
+ api_client = ApiClient()
39
+ self.api_client = api_client
40
+ self.chatbot_product_recommendations_endpoint = _Endpoint(
41
+ settings={
42
+ 'response_type': (MessageBodyModel,),
43
+ 'auth': [
44
+ 'oauth',
45
+ 'oauth'
46
+ ],
47
+ 'endpoint_path': '/preview/retail-media/chatbot-catalogs/{catalogid}/product-recommendations',
48
+ 'operation_id': 'chatbot_product_recommendations',
49
+ 'http_method': 'POST',
50
+ 'servers': None,
51
+ },
52
+ params_map={
53
+ 'all': [
54
+ 'catalogid',
55
+ 'inbot_discussion_body_model',
56
+ ],
57
+ 'required': [
58
+ 'catalogid',
59
+ 'inbot_discussion_body_model',
60
+ ],
61
+ 'nullable': [
62
+ ],
63
+ 'enum': [
64
+ ],
65
+ 'validation': [
66
+ ]
67
+ },
68
+ root_map={
69
+ 'validations': {
70
+ },
71
+ 'allowed_values': {
72
+ },
73
+ 'openapi_types': {
74
+ 'catalogid':
75
+ (int,),
76
+ 'inbot_discussion_body_model':
77
+ (InbotDiscussionBodyModel,),
78
+ },
79
+ 'attribute_map': {
80
+ 'catalogid': 'catalogid',
81
+ },
82
+ 'location_map': {
83
+ 'catalogid': 'path',
84
+ 'inbot_discussion_body_model': 'body',
85
+ },
86
+ 'collection_format_map': {
87
+ }
88
+ },
89
+ headers_map={
90
+ 'accept': [
91
+ 'application/json'
92
+ ],
93
+ 'content_type': [
94
+ 'application/json'
95
+ ]
96
+ },
97
+ api_client=api_client
98
+ )
99
+
100
+ def chatbot_product_recommendations(
101
+ self,
102
+ catalogid,
103
+ inbot_discussion_body_model,
104
+ **kwargs
105
+ ):
106
+ """chatbot_product_recommendations # noqa: E501
107
+
108
+ Ask a chatbot for a product recommendation # noqa: E501
109
+ This method makes a synchronous HTTP request by default. To make an
110
+ asynchronous HTTP request, please pass async_req=True
111
+
112
+ >>> thread = api.chatbot_product_recommendations(catalogid, inbot_discussion_body_model, async_req=True)
113
+ >>> result = thread.get()
114
+
115
+ Args:
116
+ catalogid (int): the identifier of the catalog to query
117
+ inbot_discussion_body_model (InbotDiscussionBodyModel):
118
+
119
+ Keyword Args:
120
+ _return_http_data_only (bool): response data without head status
121
+ code and headers. Default is True.
122
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
123
+ will be returned without reading/decoding response data.
124
+ Default is True.
125
+ _request_timeout (int/float/tuple): timeout setting for this request. If
126
+ one number provided, it will be total request timeout. It can also
127
+ be a pair (tuple) of (connection, read) timeouts.
128
+ Default is None.
129
+ _check_input_type (bool): specifies if type checking
130
+ should be done one the data sent to the server.
131
+ Default is True.
132
+ _check_return_type (bool): specifies if type checking
133
+ should be done one the data received from the server.
134
+ Default is True.
135
+ _spec_property_naming (bool): True if the variable names in the input data
136
+ are serialized names, as specified in the OpenAPI document.
137
+ False if the variable names in the input data
138
+ are pythonic names, e.g. snake case (default)
139
+ _content_type (str/None): force body content-type.
140
+ Default is None and content-type will be predicted by allowed
141
+ content-types and body.
142
+ _host_index (int/None): specifies the index of the server
143
+ that we want to use.
144
+ Default is read from the configuration.
145
+ _request_auths (list): set to override the auth_settings for an a single
146
+ request; this effectively ignores the authentication
147
+ in the spec for a single request.
148
+ Default is None
149
+ async_req (bool): execute request asynchronously
150
+
151
+ Returns:
152
+ MessageBodyModel
153
+ If the method is called asynchronously, returns the request
154
+ thread.
155
+ """
156
+ kwargs['async_req'] = kwargs.get(
157
+ 'async_req', False
158
+ )
159
+ kwargs['_return_http_data_only'] = kwargs.get(
160
+ '_return_http_data_only', True
161
+ )
162
+ kwargs['_preload_content'] = kwargs.get(
163
+ '_preload_content', True
164
+ )
165
+ kwargs['_request_timeout'] = kwargs.get(
166
+ '_request_timeout', None
167
+ )
168
+ kwargs['_check_input_type'] = kwargs.get(
169
+ '_check_input_type', True
170
+ )
171
+ kwargs['_check_return_type'] = kwargs.get(
172
+ '_check_return_type', True
173
+ )
174
+ kwargs['_spec_property_naming'] = kwargs.get(
175
+ '_spec_property_naming', False
176
+ )
177
+ kwargs['_content_type'] = kwargs.get(
178
+ '_content_type')
179
+ kwargs['_host_index'] = kwargs.get('_host_index')
180
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
181
+ kwargs['catalogid'] = \
182
+ catalogid
183
+ kwargs['inbot_discussion_body_model'] = \
184
+ inbot_discussion_body_model
185
+ return self.chatbot_product_recommendations_endpoint.call_with_http_info(**kwargs)
186
+
@@ -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.240808/python'
79
+ self.user_agent = 'OpenAPI-Generator/0.0.250129/python'
80
80
 
81
81
  def __enter__(self):
82
82
  return self
@@ -804,10 +804,10 @@ class Endpoint(object):
804
804
  Example:
805
805
 
806
806
  api_instance = AccountsApi()
807
- api_instance.create_private_market_demand_seller_account # this is an instance of the class Endpoint
808
- api_instance.create_private_market_demand_seller_account() # this invokes api_instance.create_private_market_demand_seller_account.__call__()
807
+ api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id # this is an instance of the class Endpoint
808
+ api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id() # this invokes api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.__call__()
809
809
  which then invokes the callable functions stored in that endpoint at
810
- api_instance.create_private_market_demand_seller_account.callable or self.callable in this class
810
+ api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.callable or self.callable in this class
811
811
 
812
812
  """
813
813
  return self.callable(self, *args, **kwargs)
@@ -21,3 +21,4 @@ from criteo_api_retailmedia_preview.api.balance_api import BalanceApi
21
21
  from criteo_api_retailmedia_preview.api.campaign_api import CampaignApi
22
22
  from criteo_api_retailmedia_preview.api.catalog_api import CatalogApi
23
23
  from criteo_api_retailmedia_preview.api.gateway_api import GatewayApi
24
+ from criteo_api_retailmedia_preview.api.on_site_recommendation_api import OnSiteRecommendationApi
@@ -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.240808".\
398
+ "SDK Package Version: 0.0.250129".\
399
399
  format(env=sys.platform, pyversion=sys.version)
400
400
 
401
401
  def get_host_settings(self):
@@ -60,6 +60,18 @@ class AsyncAccountsReport(ModelNormal):
60
60
  'CAMPAIGN': "campaign",
61
61
  'LINEITEM': "lineItem",
62
62
  },
63
+ ('search_term_types',): {
64
+ 'None': None,
65
+ 'UNKNOWN': "unknown",
66
+ 'SEARCHED': "searched",
67
+ 'ENTERED': "entered",
68
+ },
69
+ ('search_term_targetings',): {
70
+ 'None': None,
71
+ 'UNKNOWN': "unknown",
72
+ 'AUTOMATIC': "automatic",
73
+ 'MANUAL': "manual",
74
+ },
63
75
  ('campaign_type',): {
64
76
  'None': None,
65
77
  'ALL': "all",
@@ -89,6 +101,7 @@ class AsyncAccountsReport(ModelNormal):
89
101
  'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
90
102
  'ENVIRONMENT': "environment",
91
103
  'SERVEDCATEGORY': "servedCategory",
104
+ 'CAPOUT': "capout",
92
105
  },
93
106
  ('click_attribution_window',): {
94
107
  'None': None,
@@ -127,9 +140,18 @@ class AsyncAccountsReport(ModelNormal):
127
140
  'ENVIRONMENT': "environment",
128
141
  'PAGETYPENAME': "pageTypeName",
129
142
  'PAGECATEGORY': "pageCategory",
143
+ 'SERVEDCATEGORY': "servedCategory",
130
144
  'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
131
145
  'KEYWORD': "keyword",
132
146
  'SEARCHTERM': "searchTerm",
147
+ 'SEARCHTERMTYPE': "searchTermType",
148
+ 'SEARCHTERMTARGETING': "searchTermTargeting",
149
+ 'CREATIVEID': "creativeId",
150
+ 'CREATIVENAME': "creativeName",
151
+ 'CREATIVETYPEID': "creativeTypeId",
152
+ 'CREATIVETYPENAME': "creativeTypeName",
153
+ 'CREATIVETEMPLATEID': "creativeTemplateId",
154
+ 'CREATIVETEMPLATENAME': "creativeTemplateName",
133
155
  },
134
156
  ('metrics',): {
135
157
  'None': None,
@@ -154,6 +176,16 @@ class AsyncAccountsReport(ModelNormal):
154
176
  'VIDEOSPLAYEDTO100': "videosPlayedTo100",
155
177
  'VIDEOPLAYINGRATE': "videoPlayingRate",
156
178
  'VIDEOCOMPLETIONRATE': "videoCompletionRate",
179
+ 'VIDEOIMPRESSIONS': "videoImpressions",
180
+ 'VIDEOMUTED': "videoMuted",
181
+ 'VIDEOUNMUTED': "videoUnmuted",
182
+ 'VIDEOPAUSED': "videoPaused",
183
+ 'VIDEORESUMED': "videoResumed",
184
+ 'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
185
+ 'VIDEOVIEWABILITY': "videoViewability",
186
+ 'VIDEOSTARTINGRATE': "videoStartingRate",
187
+ 'VIDEOCPC': "videoCPC",
188
+ 'VIDEOCPCV': "videoCPCV",
157
189
  'UNIQUEVISITORS': "uniqueVisitors",
158
190
  'FREQUENCY': "frequency",
159
191
  },
@@ -187,6 +219,8 @@ class AsyncAccountsReport(ModelNormal):
187
219
  'start_date': (datetime,), # noqa: E501
188
220
  'end_date': (datetime,), # noqa: E501
189
221
  'aggregation_level': (str, none_type,), # noqa: E501
222
+ 'search_term_types': ([str], none_type,), # noqa: E501
223
+ 'search_term_targetings': ([str], none_type,), # noqa: E501
190
224
  'campaign_type': (str, none_type,), # noqa: E501
191
225
  'sales_channel': (str, none_type,), # noqa: E501
192
226
  'format': (str, none_type,), # noqa: E501
@@ -208,6 +242,8 @@ class AsyncAccountsReport(ModelNormal):
208
242
  'start_date': 'startDate', # noqa: E501
209
243
  'end_date': 'endDate', # noqa: E501
210
244
  'aggregation_level': 'aggregationLevel', # noqa: E501
245
+ 'search_term_types': 'searchTermTypes', # noqa: E501
246
+ 'search_term_targetings': 'searchTermTargetings', # noqa: E501
211
247
  'campaign_type': 'campaignType', # noqa: E501
212
248
  'sales_channel': 'salesChannel', # noqa: E501
213
249
  'format': 'format', # noqa: E501
@@ -266,6 +302,8 @@ class AsyncAccountsReport(ModelNormal):
266
302
  through its discriminator because we passed in
267
303
  _visited_composed_classes = (Animal,)
268
304
  aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
305
+ search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
306
+ search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
269
307
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
270
308
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
271
309
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
@@ -369,6 +407,8 @@ class AsyncAccountsReport(ModelNormal):
369
407
  through its discriminator because we passed in
370
408
  _visited_composed_classes = (Animal,)
371
409
  aggregation_level (str, none_type): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
410
+ search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
411
+ search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
372
412
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
373
413
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
374
414
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
@@ -55,6 +55,18 @@ class AsyncCampaignsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
+ ('search_term_types',): {
59
+ 'None': None,
60
+ 'UNKNOWN': "unknown",
61
+ 'SEARCHED': "searched",
62
+ 'ENTERED': "entered",
63
+ },
64
+ ('search_term_targetings',): {
65
+ 'None': None,
66
+ 'UNKNOWN': "unknown",
67
+ 'AUTOMATIC': "automatic",
68
+ 'MANUAL': "manual",
69
+ },
58
70
  ('campaign_type',): {
59
71
  'None': None,
60
72
  'ALL': "all",
@@ -84,6 +96,7 @@ class AsyncCampaignsReport(ModelNormal):
84
96
  'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
85
97
  'ENVIRONMENT': "environment",
86
98
  'SERVEDCATEGORY': "servedCategory",
99
+ 'CAPOUT': "capout",
87
100
  },
88
101
  ('click_attribution_window',): {
89
102
  'None': None,
@@ -122,9 +135,18 @@ class AsyncCampaignsReport(ModelNormal):
122
135
  'ENVIRONMENT': "environment",
123
136
  'PAGETYPENAME': "pageTypeName",
124
137
  'PAGECATEGORY': "pageCategory",
138
+ 'SERVEDCATEGORY': "servedCategory",
125
139
  'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
126
140
  'KEYWORD': "keyword",
127
141
  'SEARCHTERM': "searchTerm",
142
+ 'SEARCHTERMTYPE': "searchTermType",
143
+ 'SEARCHTERMTARGETING': "searchTermTargeting",
144
+ 'CREATIVEID': "creativeId",
145
+ 'CREATIVENAME': "creativeName",
146
+ 'CREATIVETYPEID': "creativeTypeId",
147
+ 'CREATIVETYPENAME': "creativeTypeName",
148
+ 'CREATIVETEMPLATEID': "creativeTemplateId",
149
+ 'CREATIVETEMPLATENAME': "creativeTemplateName",
128
150
  },
129
151
  ('metrics',): {
130
152
  'None': None,
@@ -149,6 +171,16 @@ class AsyncCampaignsReport(ModelNormal):
149
171
  'VIDEOSPLAYEDTO100': "videosPlayedTo100",
150
172
  'VIDEOPLAYINGRATE': "videoPlayingRate",
151
173
  'VIDEOCOMPLETIONRATE': "videoCompletionRate",
174
+ 'VIDEOIMPRESSIONS': "videoImpressions",
175
+ 'VIDEOMUTED': "videoMuted",
176
+ 'VIDEOUNMUTED': "videoUnmuted",
177
+ 'VIDEOPAUSED': "videoPaused",
178
+ 'VIDEORESUMED': "videoResumed",
179
+ 'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
180
+ 'VIDEOVIEWABILITY': "videoViewability",
181
+ 'VIDEOSTARTINGRATE': "videoStartingRate",
182
+ 'VIDEOCPC': "videoCPC",
183
+ 'VIDEOCPCV': "videoCPCV",
152
184
  'UNIQUEVISITORS': "uniqueVisitors",
153
185
  'FREQUENCY': "frequency",
154
186
  },
@@ -182,6 +214,8 @@ class AsyncCampaignsReport(ModelNormal):
182
214
  'end_date': (datetime,), # noqa: E501
183
215
  'ids': ([str], none_type,), # noqa: E501
184
216
  'id': (str, none_type,), # noqa: E501
217
+ 'search_term_types': ([str], none_type,), # noqa: E501
218
+ 'search_term_targetings': ([str], none_type,), # noqa: E501
185
219
  'campaign_type': (str, none_type,), # noqa: E501
186
220
  'sales_channel': (str, none_type,), # noqa: E501
187
221
  'format': (str, none_type,), # noqa: E501
@@ -203,6 +237,8 @@ class AsyncCampaignsReport(ModelNormal):
203
237
  'end_date': 'endDate', # noqa: E501
204
238
  'ids': 'ids', # noqa: E501
205
239
  'id': 'id', # noqa: E501
240
+ 'search_term_types': 'searchTermTypes', # noqa: E501
241
+ 'search_term_targetings': 'searchTermTargetings', # noqa: E501
206
242
  'campaign_type': 'campaignType', # noqa: E501
207
243
  'sales_channel': 'salesChannel', # noqa: E501
208
244
  'format': 'format', # noqa: E501
@@ -261,6 +297,8 @@ class AsyncCampaignsReport(ModelNormal):
261
297
  _visited_composed_classes = (Animal,)
262
298
  ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
263
299
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
300
+ search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
301
+ search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
264
302
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
265
303
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
266
304
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
@@ -363,6 +401,8 @@ class AsyncCampaignsReport(ModelNormal):
363
401
  _visited_composed_classes = (Animal,)
364
402
  ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
365
403
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
404
+ search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
405
+ search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
366
406
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
367
407
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
368
408
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501