criteo-api-retailmedia-sdk 0.0.240118__py3-none-any.whl → 0.0.240404__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.

Files changed (86) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +2 -313
  5. criteo_api_retailmedia_preview/api/campaign_api.py +443 -974
  6. criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  9. criteo_api_retailmedia_preview/configuration.py +1 -1
  10. criteo_api_retailmedia_preview/model/{creative202210.py → async_accounts_report.py} +149 -95
  11. criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
  12. criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
  13. criteo_api_retailmedia_preview/model/async_campaigns_report.py +57 -53
  14. criteo_api_retailmedia_preview/model/async_line_items_report.py +57 -54
  15. criteo_api_retailmedia_preview/model/{customer_list_details.py → batch_accepted_response.py} +11 -11
  16. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → change_details.py} +27 -26
  17. criteo_api_retailmedia_preview/model/{color_variable_value.py → custom_attribute.py} +17 -16
  18. criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
  19. criteo_api_retailmedia_preview/model/external_account.py +4 -0
  20. criteo_api_retailmedia_preview/model/{files_variable_value.py → external_line_item_capping_v2.py} +22 -13
  21. criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
  22. criteo_api_retailmedia_preview/model/{page_type_environment.py → external_line_item_page_v2.py} +40 -29
  23. criteo_api_retailmedia_preview/model/{retail_media_audience_attributes.py → external_preferred_line_item_create_model_v2.py} +79 -25
  24. criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
  25. criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
  26. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → fail_response.py} +21 -23
  27. criteo_api_retailmedia_preview/model/input_resource_of_preferred_line_item_create_model_v2.py +273 -0
  28. criteo_api_retailmedia_preview/model/{retail_media_audience.py → insertion_order_history_change_data_capture.py} +48 -42
  29. criteo_api_retailmedia_preview/model/installment.py +273 -0
  30. criteo_api_retailmedia_preview/model/{creative202210_response.py → loyalty_points.py} +15 -25
  31. criteo_api_retailmedia_preview/model/metadata.py +273 -0
  32. criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
  33. criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
  34. criteo_api_retailmedia_preview/model/{common_status_code_response.py → preferred_line_item_update_model_v2_request.py} +9 -15
  35. criteo_api_retailmedia_preview/model/{retail_media_audience_v2_list_response.py → preferred_line_item_v2_paged_list_response.py} +21 -27
  36. criteo_api_retailmedia_preview/model/{creative202210_list_response.py → preferred_line_item_v2_response.py} +16 -16
  37. criteo_api_retailmedia_preview/model/price.py +267 -0
  38. criteo_api_retailmedia_preview/model/product.py +626 -0
  39. criteo_api_retailmedia_preview/model/{retail_media_audience_v2.py → product_importer_error.py} +37 -29
  40. criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
  41. criteo_api_retailmedia_preview/model/product_shipping.py +293 -0
  42. criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
  43. criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
  44. criteo_api_retailmedia_preview/model/product_tax.py +283 -0
  45. criteo_api_retailmedia_preview/model/{choice_variable_value.py → product_unit_pricing_base_measure.py} +13 -15
  46. criteo_api_retailmedia_preview/model/{text_variable_specification.py → product_unit_pricing_measure.py} +11 -7
  47. criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
  48. criteo_api_retailmedia_preview/model/{retail_media_audience_v2_attributes.py → products_custom_batch_request_entry.py} +43 -29
  49. criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → report_detail_error.py} +35 -15
  50. criteo_api_retailmedia_preview/model/report_detail_errors.py +281 -0
  51. criteo_api_retailmedia_preview/model/{template_variable_value.py → report_ok_response.py} +58 -43
  52. criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_preferred_line_item_update_model_v2.py} +9 -9
  53. criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_preferred_line_item_v2.py} +9 -9
  54. criteo_api_retailmedia_preview/model/retail_media_account.py +4 -0
  55. criteo_api_retailmedia_preview/model/retail_media_brand_account_creation.py +4 -0
  56. criteo_api_retailmedia_preview/model/{text_variable_value.py → retail_media_brands.py} +10 -22
  57. criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +4 -0
  58. criteo_api_retailmedia_preview/model/rm_legacy_audience_get_entity_v2.py +3 -3
  59. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +37 -37
  60. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +51 -47
  61. criteo_api_retailmedia_preview/model/sync_line_items_report.py +53 -50
  62. criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
  63. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
  64. criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → value_resource_input_of_retail_media_brands.py} +15 -22
  65. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
  66. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  67. criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
  68. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  69. criteo_api_retailmedia_preview/models/__init__.py +48 -42
  70. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/METADATA +3 -3
  71. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/RECORD +73 -66
  72. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/WHEEL +1 -1
  73. criteo_api_retailmedia_preview/model/choice_option.py +0 -281
  74. criteo_api_retailmedia_preview/model/choice_variable_specification.py +0 -283
  75. criteo_api_retailmedia_preview/model/create_user_behavior_segment_v2.py +0 -309
  76. criteo_api_retailmedia_preview/model/creative_create_model202207.py +0 -297
  77. criteo_api_retailmedia_preview/model/creative_update_model202207.py +0 -297
  78. criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
  79. criteo_api_retailmedia_preview/model/get_page_of_audiences_by_account_id_response.py +0 -295
  80. criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +0 -287
  81. criteo_api_retailmedia_preview/model/template_list_response.py +0 -281
  82. criteo_api_retailmedia_preview/model/template_response.py +0 -281
  83. criteo_api_retailmedia_preview/model/template_variable.py +0 -310
  84. criteo_api_retailmedia_preview/model/user_behavior_details.py +0 -306
  85. criteo_api_retailmedia_preview/model/user_behavior_details_v2.py +0 -279
  86. {criteo_api_retailmedia_sdk-0.0.240118.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/top_level.txt +0 -0
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class TextVariableValue(ModelNormal):
33
+ class RetailMediaBrands(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -60,13 +60,7 @@ class TextVariableValue(ModelNormal):
60
60
  validations = {
61
61
  }
62
62
 
63
- @cached_property
64
- def additional_properties_type():
65
- """
66
- This must be a method because a model may have properties that are
67
- of type self, this must run after the class is loaded
68
- """
69
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
63
+ additional_properties_type = None
70
64
 
71
65
  _nullable = False
72
66
 
@@ -81,7 +75,7 @@ class TextVariableValue(ModelNormal):
81
75
  and the value is attribute type.
82
76
  """
83
77
  return {
84
- 'text': (str,), # noqa: E501
78
+ 'brand_ids': ([int], none_type,), # noqa: E501
85
79
  }
86
80
 
87
81
  @cached_property
@@ -90,7 +84,7 @@ class TextVariableValue(ModelNormal):
90
84
 
91
85
 
92
86
  attribute_map = {
93
- 'text': 'text', # noqa: E501
87
+ 'brand_ids': 'brandIds', # noqa: E501
94
88
  }
95
89
 
96
90
  read_only_vars = {
@@ -100,11 +94,8 @@ class TextVariableValue(ModelNormal):
100
94
 
101
95
  @classmethod
102
96
  @convert_js_args_to_python_args
103
- def _from_openapi_data(cls, text, *args, **kwargs): # noqa: E501
104
- """TextVariableValue - a model defined in OpenAPI
105
-
106
- Args:
107
- text (str): The displayed text
97
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
98
+ """RetailMediaBrands - a model defined in OpenAPI
108
99
 
109
100
  Keyword Args:
110
101
  _check_type (bool): if True, values for parameters in openapi_types
@@ -137,6 +128,7 @@ class TextVariableValue(ModelNormal):
137
128
  Animal class but this time we won't travel
138
129
  through its discriminator because we passed in
139
130
  _visited_composed_classes = (Animal,)
131
+ brand_ids ([int], none_type): [optional] # noqa: E501
140
132
  """
141
133
 
142
134
  _check_type = kwargs.pop('_check_type', True)
@@ -168,7 +160,6 @@ class TextVariableValue(ModelNormal):
168
160
  self._configuration = _configuration
169
161
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
170
162
 
171
- self.text = text
172
163
  for var_name, var_value in kwargs.items():
173
164
  if var_name not in self.attribute_map and \
174
165
  self._configuration is not None and \
@@ -189,11 +180,8 @@ class TextVariableValue(ModelNormal):
189
180
  ])
190
181
 
191
182
  @convert_js_args_to_python_args
192
- def __init__(self, text, *args, **kwargs): # noqa: E501
193
- """TextVariableValue - a model defined in OpenAPI
194
-
195
- Args:
196
- text (str): The displayed text
183
+ def __init__(self, *args, **kwargs): # noqa: E501
184
+ """RetailMediaBrands - a model defined in OpenAPI
197
185
 
198
186
  Keyword Args:
199
187
  _check_type (bool): if True, values for parameters in openapi_types
@@ -226,6 +214,7 @@ class TextVariableValue(ModelNormal):
226
214
  Animal class but this time we won't travel
227
215
  through its discriminator because we passed in
228
216
  _visited_composed_classes = (Animal,)
217
+ brand_ids ([int], none_type): [optional] # noqa: E501
229
218
  """
230
219
 
231
220
  _check_type = kwargs.pop('_check_type', True)
@@ -255,7 +244,6 @@ class TextVariableValue(ModelNormal):
255
244
  self._configuration = _configuration
256
245
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
257
246
 
258
- self.text = text
259
247
  for var_name, var_value in kwargs.items():
260
248
  if var_name not in self.attribute_map and \
261
249
  self._configuration is not None and \
@@ -81,6 +81,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
81
81
  lazy_import()
82
82
  return {
83
83
  'name': (str, none_type,), # noqa: E501
84
+ 'company_name': (str, none_type,), # noqa: E501
84
85
  'sellers': ([RetailMediaSeller], none_type,), # noqa: E501
85
86
  }
86
87
 
@@ -91,6 +92,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
91
92
 
92
93
  attribute_map = {
93
94
  'name': 'name', # noqa: E501
95
+ 'company_name': 'companyName', # noqa: E501
94
96
  'sellers': 'sellers', # noqa: E501
95
97
  }
96
98
 
@@ -136,6 +138,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
136
138
  through its discriminator because we passed in
137
139
  _visited_composed_classes = (Animal,)
138
140
  name (str, none_type): the name of the account, must be unique across all accounts. [optional] # noqa: E501
141
+ company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501
139
142
  sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional] # noqa: E501
140
143
  """
141
144
 
@@ -223,6 +226,7 @@ class RetailMediaSellerAccountCreation(ModelNormal):
223
226
  through its discriminator because we passed in
224
227
  _visited_composed_classes = (Animal,)
225
228
  name (str, none_type): the name of the account, must be unique across all accounts. [optional] # noqa: E501
229
+ company_name (str, none_type): Display name for reporting the owning entity of ads for the Digital Services Act in the European Union. [optional] # noqa: E501
226
230
  sellers ([RetailMediaSeller], none_type): list of sellers to associate to the new account. [optional] # noqa: E501
227
231
  """
228
232
 
@@ -89,7 +89,7 @@ class RmLegacyAudienceGetEntityV2(ModelNormal):
89
89
  """
90
90
  lazy_import()
91
91
  return {
92
- 'retailer_id': (int,), # noqa: E501
92
+ 'retailer_id': (str,), # noqa: E501
93
93
  'name': (str,), # noqa: E501
94
94
  'user_behavior_details': (RmLegacyAudienceUserBehaviorDetailsV2,), # noqa: E501
95
95
  'customer_list_details': (RmLegacySegmentCustomerList,), # noqa: E501
@@ -118,7 +118,7 @@ class RmLegacyAudienceGetEntityV2(ModelNormal):
118
118
  """RmLegacyAudienceGetEntityV2 - a model defined in OpenAPI
119
119
 
120
120
  Args:
121
- retailer_id (int): ID of the retailer associated with this audience
121
+ retailer_id (str): ID of the retailer associated with this audience
122
122
  name (str): Name of the audience
123
123
 
124
124
  Keyword Args:
@@ -211,7 +211,7 @@ class RmLegacyAudienceGetEntityV2(ModelNormal):
211
211
  """RmLegacyAudienceGetEntityV2 - a model defined in OpenAPI
212
212
 
213
213
  Args:
214
- retailer_id (int): ID of the retailer associated with this audience
214
+ retailer_id (str): ID of the retailer associated with this audience
215
215
  name (str): Name of the audience
216
216
 
217
217
  Keyword Args:
@@ -55,6 +55,31 @@ class SyncAttributedTransactionsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
+ ('click_attribution_window',): {
59
+ 'None': None,
60
+ '7D': "7D",
61
+ '14D': "14D",
62
+ '30D': "30D",
63
+ 'NONE': "none",
64
+ },
65
+ ('view_attribution_window',): {
66
+ 'None': None,
67
+ '1D': "1D",
68
+ '7D': "7D",
69
+ '14D': "14D",
70
+ '30D': "30D",
71
+ 'NONE': "none",
72
+ },
73
+ ('campaign_type',): {
74
+ 'None': None,
75
+ 'SPONSOREDPRODUCTS': "sponsoredProducts",
76
+ 'ONSITEDISPLAYS': "onSiteDisplays",
77
+ },
78
+ ('sales_channel',): {
79
+ 'None': None,
80
+ 'OFFLINE': "offline",
81
+ 'ONLINE': "online",
82
+ },
58
83
  ('dimensions',): {
59
84
  'None': None,
60
85
  'CAMPAIGNNAME': "campaignName",
@@ -89,31 +114,6 @@ class SyncAttributedTransactionsReport(ModelNormal):
89
114
  'ATTRIBUTEDUNITS': "attributedUnits",
90
115
  'ATTRIBUTEDSALES': "attributedSales",
91
116
  },
92
- ('click_attribution_window',): {
93
- 'None': None,
94
- '7D': "7D",
95
- '14D': "14D",
96
- '30D': "30D",
97
- 'NONE': "none",
98
- },
99
- ('view_attribution_window',): {
100
- 'None': None,
101
- '1D': "1D",
102
- '7D': "7D",
103
- '14D': "14D",
104
- '30D': "30D",
105
- 'NONE': "none",
106
- },
107
- ('campaign_type',): {
108
- 'None': None,
109
- 'SPONSOREDPRODUCTS': "sponsoredProducts",
110
- 'ONSITEDISPLAYS': "onSiteDisplays",
111
- },
112
- ('sales_channel',): {
113
- 'None': None,
114
- 'OFFLINE': "offline",
115
- 'ONLINE': "online",
116
- },
117
117
  }
118
118
 
119
119
  validations = {
@@ -145,12 +145,12 @@ class SyncAttributedTransactionsReport(ModelNormal):
145
145
  'end_date': (datetime,), # noqa: E501
146
146
  'campaign_ids': ([str], none_type,), # noqa: E501
147
147
  'line_item_ids': ([str], none_type,), # noqa: E501
148
- 'dimensions': ([str], none_type,), # noqa: E501
149
- 'metrics': ([str], none_type,), # noqa: E501
150
148
  'click_attribution_window': (str, none_type,), # noqa: E501
151
149
  'view_attribution_window': (str, none_type,), # noqa: E501
152
150
  'campaign_type': (str, none_type,), # noqa: E501
153
151
  'sales_channel': (str, none_type,), # noqa: E501
152
+ 'dimensions': ([str], none_type,), # noqa: E501
153
+ 'metrics': ([str], none_type,), # noqa: E501
154
154
  'timezone': (str, none_type,), # noqa: E501
155
155
  }
156
156
 
@@ -165,12 +165,12 @@ class SyncAttributedTransactionsReport(ModelNormal):
165
165
  'end_date': 'endDate', # noqa: E501
166
166
  'campaign_ids': 'campaignIds', # noqa: E501
167
167
  'line_item_ids': 'lineItemIds', # noqa: E501
168
- 'dimensions': 'dimensions', # noqa: E501
169
- 'metrics': 'metrics', # noqa: E501
170
168
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
171
169
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
172
170
  'campaign_type': 'campaignType', # noqa: E501
173
171
  'sales_channel': 'salesChannel', # noqa: E501
172
+ 'dimensions': 'dimensions', # noqa: E501
173
+ 'metrics': 'metrics', # noqa: E501
174
174
  'timezone': 'timezone', # noqa: E501
175
175
  }
176
176
 
@@ -220,14 +220,14 @@ class SyncAttributedTransactionsReport(ModelNormal):
220
220
  Animal class but this time we won't travel
221
221
  through its discriminator because we passed in
222
222
  _visited_composed_classes = (Animal,)
223
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
224
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
225
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
226
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
223
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
224
+ line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501
227
225
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
228
226
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
229
227
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
230
228
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
229
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
230
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
231
231
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
232
232
  """
233
233
 
@@ -322,14 +322,14 @@ class SyncAttributedTransactionsReport(ModelNormal):
322
322
  Animal class but this time we won't travel
323
323
  through its discriminator because we passed in
324
324
  _visited_composed_classes = (Animal,)
325
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
326
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
327
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
328
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
325
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
326
+ line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501
329
327
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
330
328
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
331
329
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
332
330
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
331
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
332
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
333
333
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
334
334
  """
335
335
 
@@ -65,43 +65,6 @@ class SyncCampaignsReport(ModelNormal):
65
65
  'ENVIRONMENT': "environment",
66
66
  'SERVEDCATEGORY': "servedCategory",
67
67
  },
68
- ('metrics',): {
69
- 'None': None,
70
- 'IMPRESSIONS': "impressions",
71
- 'CLICKS': "clicks",
72
- 'SPEND': "spend",
73
- 'ATTRIBUTEDSALES': "attributedSales",
74
- 'ATTRIBUTEDUNITS': "attributedUnits",
75
- 'ATTRIBUTEDORDERS': "attributedOrders",
76
- 'CTR': "ctr",
77
- 'CPC': "cpc",
78
- 'CPO': "cpo",
79
- 'CPM': "cpm",
80
- 'ROAS': "roas",
81
- 'UNIQUEVISITORS': "uniqueVisitors",
82
- 'FREQUENCY': "frequency",
83
- 'ASSISTEDUNITS': "assistedUnits",
84
- 'ASSISTEDSALES': "assistedSales",
85
- },
86
- ('dimensions',): {
87
- 'None': None,
88
- 'DATE': "date",
89
- 'HOUR': "hour",
90
- 'CAMPAIGNID': "campaignId",
91
- 'CAMPAIGNNAME': "campaignName",
92
- 'CAMPAIGNTYPENAME': "campaignTypeName",
93
- 'ADVPRODUCTCATEGORY': "advProductCategory",
94
- 'ADVPRODUCTID': "advProductId",
95
- 'ADVPRODUCTNAME': "advProductName",
96
- 'BRANDID': "brandId",
97
- 'BRANDNAME': "brandName",
98
- 'PAGETYPENAME': "pageTypeName",
99
- 'ENVIRONMENT': "environment",
100
- 'KEYWORD': "keyword",
101
- 'SALESCHANNEL': "salesChannel",
102
- 'RETAILERID': "retailerId",
103
- 'RETAILERNAME': "retailerName",
104
- },
105
68
  ('click_attribution_window',): {
106
69
  'None': None,
107
70
  '7D': "7D",
@@ -127,6 +90,47 @@ class SyncCampaignsReport(ModelNormal):
127
90
  'OFFLINE': "offline",
128
91
  'ONLINE': "online",
129
92
  },
93
+ ('dimensions',): {
94
+ 'None': None,
95
+ 'DATE': "date",
96
+ 'HOUR': "hour",
97
+ 'ACCOUNTID': "accountId",
98
+ 'ACCOUNTNAME': "accountName",
99
+ 'CAMPAIGNID': "campaignId",
100
+ 'CAMPAIGNNAME': "campaignName",
101
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
102
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
103
+ 'ADVPRODUCTID': "advProductId",
104
+ 'ADVPRODUCTNAME': "advProductName",
105
+ 'BRANDID': "brandId",
106
+ 'BRANDNAME': "brandName",
107
+ 'LINEITEMID': "lineItemId",
108
+ 'LINEITEMNAME': "lineItemName",
109
+ 'RETAILERID': "retailerId",
110
+ 'RETAILERNAME': "retailerName",
111
+ 'KEYWORD': "keyword",
112
+ 'PAGETYPENAME': "pageTypeName",
113
+ 'SALESCHANNEL': "salesChannel",
114
+ 'ENVIRONMENT': "environment",
115
+ },
116
+ ('metrics',): {
117
+ 'None': None,
118
+ 'IMPRESSIONS': "impressions",
119
+ 'CLICKS': "clicks",
120
+ 'SPEND': "spend",
121
+ 'ATTRIBUTEDSALES': "attributedSales",
122
+ 'ATTRIBUTEDUNITS': "attributedUnits",
123
+ 'ATTRIBUTEDORDERS': "attributedOrders",
124
+ 'ASSISTEDSALES': "assistedSales",
125
+ 'ASSISTEDUNITS': "assistedUnits",
126
+ 'CTR': "ctr",
127
+ 'CPC': "cpc",
128
+ 'CPO': "cpo",
129
+ 'CPM': "cpm",
130
+ 'ROAS': "roas",
131
+ 'UNIQUEVISITORS': "uniqueVisitors",
132
+ 'FREQUENCY': "frequency",
133
+ },
130
134
  }
131
135
 
132
136
  validations = {
@@ -158,12 +162,12 @@ class SyncCampaignsReport(ModelNormal):
158
162
  'end_date': (datetime,), # noqa: E501
159
163
  'report_type': (str, none_type,), # noqa: E501
160
164
  'campaign_ids': ([str], none_type,), # noqa: E501
161
- 'metrics': ([str], none_type,), # noqa: E501
162
- 'dimensions': ([str], none_type,), # noqa: E501
163
165
  'click_attribution_window': (str, none_type,), # noqa: E501
164
166
  'view_attribution_window': (str, none_type,), # noqa: E501
165
167
  'campaign_type': (str, none_type,), # noqa: E501
166
168
  'sales_channel': (str, none_type,), # noqa: E501
169
+ 'dimensions': ([str], none_type,), # noqa: E501
170
+ 'metrics': ([str], none_type,), # noqa: E501
167
171
  'timezone': (str, none_type,), # noqa: E501
168
172
  }
169
173
 
@@ -178,12 +182,12 @@ class SyncCampaignsReport(ModelNormal):
178
182
  'end_date': 'endDate', # noqa: E501
179
183
  'report_type': 'reportType', # noqa: E501
180
184
  'campaign_ids': 'campaignIds', # noqa: E501
181
- 'metrics': 'metrics', # noqa: E501
182
- 'dimensions': 'dimensions', # noqa: E501
183
185
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
184
186
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
185
187
  'campaign_type': 'campaignType', # noqa: E501
186
188
  'sales_channel': 'salesChannel', # noqa: E501
189
+ 'dimensions': 'dimensions', # noqa: E501
190
+ 'metrics': 'metrics', # noqa: E501
187
191
  'timezone': 'timezone', # noqa: E501
188
192
  }
189
193
 
@@ -234,13 +238,13 @@ class SyncCampaignsReport(ModelNormal):
234
238
  through its discriminator because we passed in
235
239
  _visited_composed_classes = (Animal,)
236
240
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
237
- campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501
238
- metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501
239
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
241
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
240
242
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
241
243
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
242
244
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
243
245
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
246
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
247
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
244
248
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
245
249
  """
246
250
 
@@ -336,13 +340,13 @@ class SyncCampaignsReport(ModelNormal):
336
340
  through its discriminator because we passed in
337
341
  _visited_composed_classes = (Animal,)
338
342
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
339
- campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501
340
- metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501
341
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
343
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
342
344
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
343
345
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
344
346
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
345
347
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
348
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
349
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
346
350
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
347
351
  """
348
352
 
@@ -65,44 +65,6 @@ class SyncLineItemsReport(ModelNormal):
65
65
  'ENVIRONMENT': "environment",
66
66
  'SERVEDCATEGORY': "servedCategory",
67
67
  },
68
- ('metrics',): {
69
- 'None': None,
70
- 'IMPRESSIONS': "impressions",
71
- 'CLICKS': "clicks",
72
- 'SPEND': "spend",
73
- 'ATTRIBUTEDSALES': "attributedSales",
74
- 'ATTRIBUTEDUNITS': "attributedUnits",
75
- 'ATTRIBUTEDORDERS': "attributedOrders",
76
- 'CTR': "ctr",
77
- 'CPC': "cpc",
78
- 'CPO': "cpo",
79
- 'ROAS': "roas",
80
- 'ASSISTEDUNITS': "assistedUnits",
81
- 'ASSISTEDSALES': "assistedSales",
82
- 'UNIQUEVISITORS': "uniqueVisitors",
83
- 'FREQUENCY': "frequency",
84
- },
85
- ('dimensions',): {
86
- 'None': None,
87
- 'DATE': "date",
88
- 'HOUR': "hour",
89
- 'CAMPAIGNID': "campaignId",
90
- 'CAMPAIGNNAME': "campaignName",
91
- 'CAMPAIGNTYPENAME': "campaignTypeName",
92
- 'ADVPRODUCTCATEGORY': "advProductCategory",
93
- 'ADVPRODUCTID': "advProductId",
94
- 'ADVPRODUCTNAME': "advProductName",
95
- 'BRANDID': "brandId",
96
- 'BRANDNAME': "brandName",
97
- 'LINEITEMID': "lineItemId",
98
- 'LINEITEMNAME': "lineItemName",
99
- 'RETAILERID': "retailerId",
100
- 'RETAILERNAME': "retailerName",
101
- 'KEYWORD': "keyword",
102
- 'PAGETYPENAME': "pageTypeName",
103
- 'SALESCHANNEL': "salesChannel",
104
- 'ENVIRONMENT': "environment",
105
- },
106
68
  ('click_attribution_window',): {
107
69
  'None': None,
108
70
  '7D': "7D",
@@ -128,6 +90,47 @@ class SyncLineItemsReport(ModelNormal):
128
90
  'OFFLINE': "offline",
129
91
  'ONLINE': "online",
130
92
  },
93
+ ('dimensions',): {
94
+ 'None': None,
95
+ 'DATE': "date",
96
+ 'HOUR': "hour",
97
+ 'ACCOUNTID': "accountId",
98
+ 'ACCOUNTNAME': "accountName",
99
+ 'CAMPAIGNID': "campaignId",
100
+ 'CAMPAIGNNAME': "campaignName",
101
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
102
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
103
+ 'ADVPRODUCTID': "advProductId",
104
+ 'ADVPRODUCTNAME': "advProductName",
105
+ 'BRANDID': "brandId",
106
+ 'BRANDNAME': "brandName",
107
+ 'LINEITEMID': "lineItemId",
108
+ 'LINEITEMNAME': "lineItemName",
109
+ 'RETAILERID': "retailerId",
110
+ 'RETAILERNAME': "retailerName",
111
+ 'KEYWORD': "keyword",
112
+ 'PAGETYPENAME': "pageTypeName",
113
+ 'SALESCHANNEL': "salesChannel",
114
+ 'ENVIRONMENT': "environment",
115
+ },
116
+ ('metrics',): {
117
+ 'None': None,
118
+ 'IMPRESSIONS': "impressions",
119
+ 'CLICKS': "clicks",
120
+ 'SPEND': "spend",
121
+ 'ATTRIBUTEDSALES': "attributedSales",
122
+ 'ATTRIBUTEDUNITS': "attributedUnits",
123
+ 'ATTRIBUTEDORDERS': "attributedOrders",
124
+ 'ASSISTEDSALES': "assistedSales",
125
+ 'ASSISTEDUNITS': "assistedUnits",
126
+ 'CTR': "ctr",
127
+ 'CPC': "cpc",
128
+ 'CPO': "cpo",
129
+ 'CPM': "cpm",
130
+ 'ROAS': "roas",
131
+ 'UNIQUEVISITORS': "uniqueVisitors",
132
+ 'FREQUENCY': "frequency",
133
+ },
131
134
  }
132
135
 
133
136
  validations = {
@@ -160,12 +163,12 @@ class SyncLineItemsReport(ModelNormal):
160
163
  'report_type': (str, none_type,), # noqa: E501
161
164
  'line_item_ids': ([str], none_type,), # noqa: E501
162
165
  'campaign_ids': ([str], none_type,), # noqa: E501
163
- 'metrics': ([str], none_type,), # noqa: E501
164
- 'dimensions': ([str], none_type,), # noqa: E501
165
166
  'click_attribution_window': (str, none_type,), # noqa: E501
166
167
  'view_attribution_window': (str, none_type,), # noqa: E501
167
168
  'campaign_type': (str, none_type,), # noqa: E501
168
169
  'sales_channel': (str, none_type,), # noqa: E501
170
+ 'dimensions': ([str], none_type,), # noqa: E501
171
+ 'metrics': ([str], none_type,), # noqa: E501
169
172
  'timezone': (str, none_type,), # noqa: E501
170
173
  }
171
174
 
@@ -181,12 +184,12 @@ class SyncLineItemsReport(ModelNormal):
181
184
  'report_type': 'reportType', # noqa: E501
182
185
  'line_item_ids': 'lineItemIds', # noqa: E501
183
186
  'campaign_ids': 'campaignIds', # noqa: E501
184
- 'metrics': 'metrics', # noqa: E501
185
- 'dimensions': 'dimensions', # noqa: E501
186
187
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
187
188
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
188
189
  'campaign_type': 'campaignType', # noqa: E501
189
190
  'sales_channel': 'salesChannel', # noqa: E501
191
+ 'dimensions': 'dimensions', # noqa: E501
192
+ 'metrics': 'metrics', # noqa: E501
190
193
  'timezone': 'timezone', # noqa: E501
191
194
  }
192
195
 
@@ -237,14 +240,14 @@ class SyncLineItemsReport(ModelNormal):
237
240
  through its discriminator because we passed in
238
241
  _visited_composed_classes = (Animal,)
239
242
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
240
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
241
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
242
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
243
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
243
+ line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501
244
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
244
245
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
245
246
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
246
247
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
247
248
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
249
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
250
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
248
251
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
249
252
  """
250
253
 
@@ -340,14 +343,14 @@ class SyncLineItemsReport(ModelNormal):
340
343
  through its discriminator because we passed in
341
344
  _visited_composed_classes = (Animal,)
342
345
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
343
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
344
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
345
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
346
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
346
+ line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501
347
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
347
348
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
348
349
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
349
350
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
350
351
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
352
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
353
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
351
354
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
352
355
  """
353
356