criteo-api-retailmedia-sdk 0.0.240207__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.
- criteo_api_retailmedia_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
- criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
- criteo_api_retailmedia_preview/api/campaign_api.py +443 -974
- criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/{creative202210.py → async_accounts_report.py} +149 -95
- criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
- criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +57 -53
- criteo_api_retailmedia_preview/model/async_line_items_report.py +57 -54
- criteo_api_retailmedia_preview/model/{text_variable_value.py → batch_accepted_response.py} +11 -11
- criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → change_details.py} +27 -26
- criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → custom_attribute.py} +17 -11
- criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
- criteo_api_retailmedia_preview/model/{files_variable_value.py → external_line_item_capping_v2.py} +22 -13
- criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
- criteo_api_retailmedia_preview/model/{page_type_environment.py → external_line_item_page_v2.py} +40 -29
- criteo_api_retailmedia_preview/model/{creative_create_model202207.py → external_preferred_line_item_create_model_v2.py} +79 -31
- criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
- criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
- criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → fail_response.py} +21 -23
- criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → input_resource_of_preferred_line_item_create_model_v2.py} +12 -18
- criteo_api_retailmedia_preview/model/{choice_variable_specification.py → insertion_order_history_change_data_capture.py} +49 -29
- criteo_api_retailmedia_preview/model/installment.py +273 -0
- criteo_api_retailmedia_preview/model/loyalty_points.py +271 -0
- criteo_api_retailmedia_preview/model/metadata.py +273 -0
- criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
- criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
- criteo_api_retailmedia_preview/model/preferred_line_item_update_model_v2_request.py +269 -0
- criteo_api_retailmedia_preview/model/{creative202210_response.py → preferred_line_item_v2_paged_list_response.py} +22 -16
- criteo_api_retailmedia_preview/model/{creative202210_list_response.py → preferred_line_item_v2_response.py} +16 -16
- criteo_api_retailmedia_preview/model/price.py +267 -0
- criteo_api_retailmedia_preview/model/product.py +626 -0
- criteo_api_retailmedia_preview/model/{template_variable.py → product_importer_error.py} +37 -48
- criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
- criteo_api_retailmedia_preview/model/{template_list_response.py → product_shipping.py} +33 -21
- criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
- criteo_api_retailmedia_preview/model/{color_variable_value.py → product_shipping_weight.py} +13 -20
- criteo_api_retailmedia_preview/model/product_tax.py +283 -0
- criteo_api_retailmedia_preview/model/{choice_variable_value.py → product_unit_pricing_base_measure.py} +13 -15
- criteo_api_retailmedia_preview/model/{text_variable_specification.py → product_unit_pricing_measure.py} +11 -7
- criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
- criteo_api_retailmedia_preview/model/{creative_update_model202207.py → products_custom_batch_request_entry.py} +43 -35
- criteo_api_retailmedia_preview/model/{choice_option.py → report_detail_error.py} +41 -23
- criteo_api_retailmedia_preview/model/report_detail_errors.py +281 -0
- criteo_api_retailmedia_preview/model/{template_variable_value.py → report_ok_response.py} +58 -43
- criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_preferred_line_item_update_model_v2.py} +9 -9
- criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_preferred_line_item_v2.py} +9 -9
- criteo_api_retailmedia_preview/model/retail_media_brands.py +257 -0
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +37 -37
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +51 -47
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +53 -50
- criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
- criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
- criteo_api_retailmedia_preview/models/__init__.py +48 -31
- {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/RECORD +67 -49
- {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
- criteo_api_retailmedia_preview/model/json_api_single_response_of_catalog_status.py +0 -287
- criteo_api_retailmedia_preview/model/template_response.py +0 -281
- {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240404.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,273 @@
|
|
|
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.model_utils import ( # noqa: F401
|
|
15
|
+
ApiTypeError,
|
|
16
|
+
ModelComposed,
|
|
17
|
+
ModelNormal,
|
|
18
|
+
ModelSimple,
|
|
19
|
+
cached_property,
|
|
20
|
+
change_keys_js_to_python,
|
|
21
|
+
convert_js_args_to_python_args,
|
|
22
|
+
date,
|
|
23
|
+
datetime,
|
|
24
|
+
file_type,
|
|
25
|
+
none_type,
|
|
26
|
+
validate_get_composed_info,
|
|
27
|
+
OpenApiModel
|
|
28
|
+
)
|
|
29
|
+
from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
def lazy_import():
|
|
33
|
+
from criteo_api_retailmedia_preview.model.async_accounts_report import AsyncAccountsReport
|
|
34
|
+
globals()['AsyncAccountsReport'] = AsyncAccountsReport
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class AsyncAccountsReportResource(ModelNormal):
|
|
38
|
+
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
39
|
+
Ref: https://openapi-generator.tech
|
|
40
|
+
|
|
41
|
+
Do not edit the class manually.
|
|
42
|
+
|
|
43
|
+
Attributes:
|
|
44
|
+
allowed_values (dict): The key is the tuple path to the attribute
|
|
45
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
46
|
+
with a capitalized key describing the allowed value and an allowed
|
|
47
|
+
value. These dicts store the allowed enum values.
|
|
48
|
+
attribute_map (dict): The key is attribute name
|
|
49
|
+
and the value is json key in definition.
|
|
50
|
+
discriminator_value_class_map (dict): A dict to go from the discriminator
|
|
51
|
+
variable value to the discriminator class name.
|
|
52
|
+
validations (dict): The key is the tuple path to the attribute
|
|
53
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
54
|
+
that stores validations for max_length, min_length, max_items,
|
|
55
|
+
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
|
|
56
|
+
inclusive_minimum, and regex.
|
|
57
|
+
additional_properties_type (tuple): A tuple of classes accepted
|
|
58
|
+
as additional properties values.
|
|
59
|
+
"""
|
|
60
|
+
|
|
61
|
+
allowed_values = {
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
validations = {
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
@cached_property
|
|
68
|
+
def additional_properties_type():
|
|
69
|
+
"""
|
|
70
|
+
This must be a method because a model may have properties that are
|
|
71
|
+
of type self, this must run after the class is loaded
|
|
72
|
+
"""
|
|
73
|
+
lazy_import()
|
|
74
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
75
|
+
|
|
76
|
+
_nullable = False
|
|
77
|
+
|
|
78
|
+
@cached_property
|
|
79
|
+
def openapi_types():
|
|
80
|
+
"""
|
|
81
|
+
This must be a method because a model may have properties that are
|
|
82
|
+
of type self, this must run after the class is loaded
|
|
83
|
+
|
|
84
|
+
Returns
|
|
85
|
+
openapi_types (dict): The key is attribute name
|
|
86
|
+
and the value is attribute type.
|
|
87
|
+
"""
|
|
88
|
+
lazy_import()
|
|
89
|
+
return {
|
|
90
|
+
'type': (str, none_type,), # noqa: E501
|
|
91
|
+
'attributes': (AsyncAccountsReport,), # noqa: E501
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
@cached_property
|
|
95
|
+
def discriminator():
|
|
96
|
+
return None
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
attribute_map = {
|
|
100
|
+
'type': 'type', # noqa: E501
|
|
101
|
+
'attributes': 'attributes', # noqa: E501
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
read_only_vars = {
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
_composed_schemas = {}
|
|
108
|
+
|
|
109
|
+
@classmethod
|
|
110
|
+
@convert_js_args_to_python_args
|
|
111
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
112
|
+
"""AsyncAccountsReportResource - a model defined in OpenAPI
|
|
113
|
+
|
|
114
|
+
Keyword Args:
|
|
115
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
116
|
+
will be type checked and a TypeError will be
|
|
117
|
+
raised if the wrong type is input.
|
|
118
|
+
Defaults to True
|
|
119
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
120
|
+
drill down to the model in received_data
|
|
121
|
+
when deserializing a response
|
|
122
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
123
|
+
are serialized names, as specified in the OpenAPI document.
|
|
124
|
+
False if the variable names in the input data
|
|
125
|
+
are pythonic names, e.g. snake case (default)
|
|
126
|
+
_configuration (Configuration): the instance to use when
|
|
127
|
+
deserializing a file_type parameter.
|
|
128
|
+
If passed, type conversion is attempted
|
|
129
|
+
If omitted no type conversion is done.
|
|
130
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
131
|
+
classes that we have traveled through so that
|
|
132
|
+
if we see that class again we will not use its
|
|
133
|
+
discriminator again.
|
|
134
|
+
When traveling through a discriminator, the
|
|
135
|
+
composed schema that is
|
|
136
|
+
is traveled through is added to this set.
|
|
137
|
+
For example if Animal has a discriminator
|
|
138
|
+
petType and we pass in "Dog", and the class Dog
|
|
139
|
+
allOf includes Animal, we move through Animal
|
|
140
|
+
once using the discriminator, and pick Dog.
|
|
141
|
+
Then in Dog, we will make an instance of the
|
|
142
|
+
Animal class but this time we won't travel
|
|
143
|
+
through its discriminator because we passed in
|
|
144
|
+
_visited_composed_classes = (Animal,)
|
|
145
|
+
type (str, none_type): [optional] # noqa: E501
|
|
146
|
+
attributes (AsyncAccountsReport): [optional] # noqa: E501
|
|
147
|
+
"""
|
|
148
|
+
|
|
149
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
150
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
151
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
152
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
153
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
154
|
+
|
|
155
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
156
|
+
|
|
157
|
+
if args:
|
|
158
|
+
for arg in args:
|
|
159
|
+
if isinstance(arg, dict):
|
|
160
|
+
kwargs.update(arg)
|
|
161
|
+
else:
|
|
162
|
+
raise ApiTypeError(
|
|
163
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
164
|
+
args,
|
|
165
|
+
self.__class__.__name__,
|
|
166
|
+
),
|
|
167
|
+
path_to_item=_path_to_item,
|
|
168
|
+
valid_classes=(self.__class__,),
|
|
169
|
+
)
|
|
170
|
+
|
|
171
|
+
self._data_store = {}
|
|
172
|
+
self._check_type = _check_type
|
|
173
|
+
self._spec_property_naming = _spec_property_naming
|
|
174
|
+
self._path_to_item = _path_to_item
|
|
175
|
+
self._configuration = _configuration
|
|
176
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
177
|
+
|
|
178
|
+
for var_name, var_value in kwargs.items():
|
|
179
|
+
if var_name not in self.attribute_map and \
|
|
180
|
+
self._configuration is not None and \
|
|
181
|
+
self._configuration.discard_unknown_keys and \
|
|
182
|
+
self.additional_properties_type is None:
|
|
183
|
+
# discard variable.
|
|
184
|
+
continue
|
|
185
|
+
setattr(self, var_name, var_value)
|
|
186
|
+
return self
|
|
187
|
+
|
|
188
|
+
required_properties = set([
|
|
189
|
+
'_data_store',
|
|
190
|
+
'_check_type',
|
|
191
|
+
'_spec_property_naming',
|
|
192
|
+
'_path_to_item',
|
|
193
|
+
'_configuration',
|
|
194
|
+
'_visited_composed_classes',
|
|
195
|
+
])
|
|
196
|
+
|
|
197
|
+
@convert_js_args_to_python_args
|
|
198
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
199
|
+
"""AsyncAccountsReportResource - a model defined in OpenAPI
|
|
200
|
+
|
|
201
|
+
Keyword Args:
|
|
202
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
203
|
+
will be type checked and a TypeError will be
|
|
204
|
+
raised if the wrong type is input.
|
|
205
|
+
Defaults to True
|
|
206
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
207
|
+
drill down to the model in received_data
|
|
208
|
+
when deserializing a response
|
|
209
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
210
|
+
are serialized names, as specified in the OpenAPI document.
|
|
211
|
+
False if the variable names in the input data
|
|
212
|
+
are pythonic names, e.g. snake case (default)
|
|
213
|
+
_configuration (Configuration): the instance to use when
|
|
214
|
+
deserializing a file_type parameter.
|
|
215
|
+
If passed, type conversion is attempted
|
|
216
|
+
If omitted no type conversion is done.
|
|
217
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
218
|
+
classes that we have traveled through so that
|
|
219
|
+
if we see that class again we will not use its
|
|
220
|
+
discriminator again.
|
|
221
|
+
When traveling through a discriminator, the
|
|
222
|
+
composed schema that is
|
|
223
|
+
is traveled through is added to this set.
|
|
224
|
+
For example if Animal has a discriminator
|
|
225
|
+
petType and we pass in "Dog", and the class Dog
|
|
226
|
+
allOf includes Animal, we move through Animal
|
|
227
|
+
once using the discriminator, and pick Dog.
|
|
228
|
+
Then in Dog, we will make an instance of the
|
|
229
|
+
Animal class but this time we won't travel
|
|
230
|
+
through its discriminator because we passed in
|
|
231
|
+
_visited_composed_classes = (Animal,)
|
|
232
|
+
type (str, none_type): [optional] # noqa: E501
|
|
233
|
+
attributes (AsyncAccountsReport): [optional] # noqa: E501
|
|
234
|
+
"""
|
|
235
|
+
|
|
236
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
237
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
238
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
239
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
240
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
241
|
+
|
|
242
|
+
if args:
|
|
243
|
+
for arg in args:
|
|
244
|
+
if isinstance(arg, dict):
|
|
245
|
+
kwargs.update(arg)
|
|
246
|
+
else:
|
|
247
|
+
raise ApiTypeError(
|
|
248
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
249
|
+
args,
|
|
250
|
+
self.__class__.__name__,
|
|
251
|
+
),
|
|
252
|
+
path_to_item=_path_to_item,
|
|
253
|
+
valid_classes=(self.__class__,),
|
|
254
|
+
)
|
|
255
|
+
|
|
256
|
+
self._data_store = {}
|
|
257
|
+
self._check_type = _check_type
|
|
258
|
+
self._spec_property_naming = _spec_property_naming
|
|
259
|
+
self._path_to_item = _path_to_item
|
|
260
|
+
self._configuration = _configuration
|
|
261
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
262
|
+
|
|
263
|
+
for var_name, var_value in kwargs.items():
|
|
264
|
+
if var_name not in self.attribute_map and \
|
|
265
|
+
self._configuration is not None and \
|
|
266
|
+
self._configuration.discard_unknown_keys and \
|
|
267
|
+
self.additional_properties_type is None:
|
|
268
|
+
# discard variable.
|
|
269
|
+
continue
|
|
270
|
+
setattr(self, var_name, var_value)
|
|
271
|
+
if var_name in self.read_only_vars:
|
|
272
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
273
|
+
f"class with read only attributes.")
|
|
@@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
-
('metrics',): {
|
|
59
|
-
'None': None,
|
|
60
|
-
'IMPRESSIONS': "impressions",
|
|
61
|
-
'CLICKS': "clicks",
|
|
62
|
-
'SPEND': "spend",
|
|
63
|
-
'ATTRIBUTEDSALES': "attributedSales",
|
|
64
|
-
'ATTRIBUTEDUNITS': "attributedUnits",
|
|
65
|
-
'ATTRIBUTEDORDERS': "attributedOrders",
|
|
66
|
-
'CTR': "ctr",
|
|
67
|
-
'CPC': "cpc",
|
|
68
|
-
'CPO': "cpo",
|
|
69
|
-
'CPM': "cpm",
|
|
70
|
-
'ROAS': "roas",
|
|
71
|
-
'UNIQUEVISITORS': "uniqueVisitors",
|
|
72
|
-
'FREQUENCY': "frequency",
|
|
73
|
-
'ASSISTEDUNITS': "assistedUnits",
|
|
74
|
-
'ASSISTEDSALES': "assistedSales",
|
|
75
|
-
},
|
|
76
|
-
('dimensions',): {
|
|
77
|
-
'None': None,
|
|
78
|
-
'DATE': "date",
|
|
79
|
-
'HOUR': "hour",
|
|
80
|
-
'CAMPAIGNID': "campaignId",
|
|
81
|
-
'CAMPAIGNNAME': "campaignName",
|
|
82
|
-
'CAMPAIGNTYPENAME': "campaignTypeName",
|
|
83
|
-
'ADVPRODUCTCATEGORY': "advProductCategory",
|
|
84
|
-
'ADVPRODUCTID': "advProductId",
|
|
85
|
-
'ADVPRODUCTNAME': "advProductName",
|
|
86
|
-
'BRANDID': "brandId",
|
|
87
|
-
'BRANDNAME': "brandName",
|
|
88
|
-
'PAGETYPENAME': "pageTypeName",
|
|
89
|
-
'ENVIRONMENT': "environment",
|
|
90
|
-
'KEYWORD': "keyword",
|
|
91
|
-
'SALESCHANNEL': "salesChannel",
|
|
92
|
-
'RETAILERID': "retailerId",
|
|
93
|
-
'RETAILERNAME': "retailerName",
|
|
94
|
-
},
|
|
95
58
|
('campaign_type',): {
|
|
96
59
|
'None': None,
|
|
97
60
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
@@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
135
98
|
'30D': "30D",
|
|
136
99
|
'NONE': "none",
|
|
137
100
|
},
|
|
101
|
+
('dimensions',): {
|
|
102
|
+
'None': None,
|
|
103
|
+
'DATE': "date",
|
|
104
|
+
'HOUR': "hour",
|
|
105
|
+
'ACCOUNTID': "accountId",
|
|
106
|
+
'ACCOUNTNAME': "accountName",
|
|
107
|
+
'CAMPAIGNID': "campaignId",
|
|
108
|
+
'CAMPAIGNNAME': "campaignName",
|
|
109
|
+
'CAMPAIGNTYPENAME': "campaignTypeName",
|
|
110
|
+
'ADVPRODUCTCATEGORY': "advProductCategory",
|
|
111
|
+
'ADVPRODUCTID': "advProductId",
|
|
112
|
+
'ADVPRODUCTNAME': "advProductName",
|
|
113
|
+
'BRANDID': "brandId",
|
|
114
|
+
'BRANDNAME': "brandName",
|
|
115
|
+
'LINEITEMID': "lineItemId",
|
|
116
|
+
'LINEITEMNAME': "lineItemName",
|
|
117
|
+
'RETAILERID': "retailerId",
|
|
118
|
+
'RETAILERNAME': "retailerName",
|
|
119
|
+
'KEYWORD': "keyword",
|
|
120
|
+
'PAGETYPENAME': "pageTypeName",
|
|
121
|
+
'SALESCHANNEL': "salesChannel",
|
|
122
|
+
'ENVIRONMENT': "environment",
|
|
123
|
+
},
|
|
124
|
+
('metrics',): {
|
|
125
|
+
'None': None,
|
|
126
|
+
'IMPRESSIONS': "impressions",
|
|
127
|
+
'CLICKS': "clicks",
|
|
128
|
+
'SPEND': "spend",
|
|
129
|
+
'ATTRIBUTEDSALES': "attributedSales",
|
|
130
|
+
'ATTRIBUTEDUNITS': "attributedUnits",
|
|
131
|
+
'ATTRIBUTEDORDERS': "attributedOrders",
|
|
132
|
+
'ASSISTEDSALES': "assistedSales",
|
|
133
|
+
'ASSISTEDUNITS': "assistedUnits",
|
|
134
|
+
'CTR': "ctr",
|
|
135
|
+
'CPC': "cpc",
|
|
136
|
+
'CPO': "cpo",
|
|
137
|
+
'CPM': "cpm",
|
|
138
|
+
'ROAS': "roas",
|
|
139
|
+
'UNIQUEVISITORS': "uniqueVisitors",
|
|
140
|
+
'FREQUENCY': "frequency",
|
|
141
|
+
},
|
|
138
142
|
}
|
|
139
143
|
|
|
140
144
|
validations = {
|
|
@@ -163,16 +167,16 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
163
167
|
return {
|
|
164
168
|
'start_date': (datetime,), # noqa: E501
|
|
165
169
|
'end_date': (datetime,), # noqa: E501
|
|
166
|
-
'
|
|
167
|
-
'
|
|
170
|
+
'ids': ([str], none_type,), # noqa: E501
|
|
171
|
+
'id': (str, none_type,), # noqa: E501
|
|
168
172
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
169
173
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
170
174
|
'format': (str, none_type,), # noqa: E501
|
|
171
175
|
'report_type': (str, none_type,), # noqa: E501
|
|
172
176
|
'click_attribution_window': (str, none_type,), # noqa: E501
|
|
173
177
|
'view_attribution_window': (str, none_type,), # noqa: E501
|
|
174
|
-
'
|
|
175
|
-
'
|
|
178
|
+
'dimensions': ([str], none_type,), # noqa: E501
|
|
179
|
+
'metrics': ([str], none_type,), # noqa: E501
|
|
176
180
|
'timezone': (str, none_type,), # noqa: E501
|
|
177
181
|
}
|
|
178
182
|
|
|
@@ -184,16 +188,16 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
184
188
|
attribute_map = {
|
|
185
189
|
'start_date': 'startDate', # noqa: E501
|
|
186
190
|
'end_date': 'endDate', # noqa: E501
|
|
187
|
-
'
|
|
188
|
-
'
|
|
191
|
+
'ids': 'ids', # noqa: E501
|
|
192
|
+
'id': 'id', # noqa: E501
|
|
189
193
|
'campaign_type': 'campaignType', # noqa: E501
|
|
190
194
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
191
195
|
'format': 'format', # noqa: E501
|
|
192
196
|
'report_type': 'reportType', # noqa: E501
|
|
193
197
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
194
198
|
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
195
|
-
'
|
|
196
|
-
'
|
|
199
|
+
'dimensions': 'dimensions', # noqa: E501
|
|
200
|
+
'metrics': 'metrics', # noqa: E501
|
|
197
201
|
'timezone': 'timezone', # noqa: E501
|
|
198
202
|
}
|
|
199
203
|
|
|
@@ -242,16 +246,16 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
242
246
|
Animal class but this time we won't travel
|
|
243
247
|
through its discriminator because we passed in
|
|
244
248
|
_visited_composed_classes = (Animal,)
|
|
245
|
-
|
|
246
|
-
|
|
249
|
+
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
250
|
+
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
247
251
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
|
|
248
252
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
|
|
249
253
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
250
254
|
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
|
|
251
255
|
click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
252
256
|
view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
253
|
-
|
|
254
|
-
|
|
257
|
+
dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
|
|
258
|
+
metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
|
|
255
259
|
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
|
|
256
260
|
"""
|
|
257
261
|
|
|
@@ -344,16 +348,16 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
344
348
|
Animal class but this time we won't travel
|
|
345
349
|
through its discriminator because we passed in
|
|
346
350
|
_visited_composed_classes = (Animal,)
|
|
347
|
-
|
|
348
|
-
|
|
351
|
+
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
352
|
+
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
349
353
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
|
|
350
354
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
|
|
351
355
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
352
356
|
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
|
|
353
357
|
click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
354
358
|
view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
355
|
-
|
|
356
|
-
|
|
359
|
+
dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
|
|
360
|
+
metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
|
|
357
361
|
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
|
|
358
362
|
"""
|
|
359
363
|
|
|
@@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
-
('metrics',): {
|
|
59
|
-
'None': None,
|
|
60
|
-
'IMPRESSIONS': "impressions",
|
|
61
|
-
'CLICKS': "clicks",
|
|
62
|
-
'SPEND': "spend",
|
|
63
|
-
'ATTRIBUTEDSALES': "attributedSales",
|
|
64
|
-
'ATTRIBUTEDUNITS': "attributedUnits",
|
|
65
|
-
'ATTRIBUTEDORDERS': "attributedOrders",
|
|
66
|
-
'CTR': "ctr",
|
|
67
|
-
'CPC': "cpc",
|
|
68
|
-
'CPO': "cpo",
|
|
69
|
-
'ROAS': "roas",
|
|
70
|
-
'ASSISTEDUNITS': "assistedUnits",
|
|
71
|
-
'ASSISTEDSALES': "assistedSales",
|
|
72
|
-
'UNIQUEVISITORS': "uniqueVisitors",
|
|
73
|
-
'FREQUENCY': "frequency",
|
|
74
|
-
},
|
|
75
|
-
('dimensions',): {
|
|
76
|
-
'None': None,
|
|
77
|
-
'DATE': "date",
|
|
78
|
-
'HOUR': "hour",
|
|
79
|
-
'CAMPAIGNID': "campaignId",
|
|
80
|
-
'CAMPAIGNNAME': "campaignName",
|
|
81
|
-
'CAMPAIGNTYPENAME': "campaignTypeName",
|
|
82
|
-
'ADVPRODUCTCATEGORY': "advProductCategory",
|
|
83
|
-
'ADVPRODUCTID': "advProductId",
|
|
84
|
-
'ADVPRODUCTNAME': "advProductName",
|
|
85
|
-
'BRANDID': "brandId",
|
|
86
|
-
'BRANDNAME': "brandName",
|
|
87
|
-
'LINEITEMID': "lineItemId",
|
|
88
|
-
'LINEITEMNAME': "lineItemName",
|
|
89
|
-
'RETAILERID': "retailerId",
|
|
90
|
-
'RETAILERNAME': "retailerName",
|
|
91
|
-
'KEYWORD': "keyword",
|
|
92
|
-
'PAGETYPENAME': "pageTypeName",
|
|
93
|
-
'SALESCHANNEL': "salesChannel",
|
|
94
|
-
'ENVIRONMENT': "environment",
|
|
95
|
-
},
|
|
96
58
|
('campaign_type',): {
|
|
97
59
|
'None': None,
|
|
98
60
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
@@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
136
98
|
'30D': "30D",
|
|
137
99
|
'NONE': "none",
|
|
138
100
|
},
|
|
101
|
+
('dimensions',): {
|
|
102
|
+
'None': None,
|
|
103
|
+
'DATE': "date",
|
|
104
|
+
'HOUR': "hour",
|
|
105
|
+
'ACCOUNTID': "accountId",
|
|
106
|
+
'ACCOUNTNAME': "accountName",
|
|
107
|
+
'CAMPAIGNID': "campaignId",
|
|
108
|
+
'CAMPAIGNNAME': "campaignName",
|
|
109
|
+
'CAMPAIGNTYPENAME': "campaignTypeName",
|
|
110
|
+
'ADVPRODUCTCATEGORY': "advProductCategory",
|
|
111
|
+
'ADVPRODUCTID': "advProductId",
|
|
112
|
+
'ADVPRODUCTNAME': "advProductName",
|
|
113
|
+
'BRANDID': "brandId",
|
|
114
|
+
'BRANDNAME': "brandName",
|
|
115
|
+
'LINEITEMID': "lineItemId",
|
|
116
|
+
'LINEITEMNAME': "lineItemName",
|
|
117
|
+
'RETAILERID': "retailerId",
|
|
118
|
+
'RETAILERNAME': "retailerName",
|
|
119
|
+
'KEYWORD': "keyword",
|
|
120
|
+
'PAGETYPENAME': "pageTypeName",
|
|
121
|
+
'SALESCHANNEL': "salesChannel",
|
|
122
|
+
'ENVIRONMENT': "environment",
|
|
123
|
+
},
|
|
124
|
+
('metrics',): {
|
|
125
|
+
'None': None,
|
|
126
|
+
'IMPRESSIONS': "impressions",
|
|
127
|
+
'CLICKS': "clicks",
|
|
128
|
+
'SPEND': "spend",
|
|
129
|
+
'ATTRIBUTEDSALES': "attributedSales",
|
|
130
|
+
'ATTRIBUTEDUNITS': "attributedUnits",
|
|
131
|
+
'ATTRIBUTEDORDERS': "attributedOrders",
|
|
132
|
+
'ASSISTEDSALES': "assistedSales",
|
|
133
|
+
'ASSISTEDUNITS': "assistedUnits",
|
|
134
|
+
'CTR': "ctr",
|
|
135
|
+
'CPC': "cpc",
|
|
136
|
+
'CPO': "cpo",
|
|
137
|
+
'CPM': "cpm",
|
|
138
|
+
'ROAS': "roas",
|
|
139
|
+
'UNIQUEVISITORS': "uniqueVisitors",
|
|
140
|
+
'FREQUENCY': "frequency",
|
|
141
|
+
},
|
|
139
142
|
}
|
|
140
143
|
|
|
141
144
|
validations = {
|
|
@@ -164,16 +167,16 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
164
167
|
return {
|
|
165
168
|
'start_date': (datetime,), # noqa: E501
|
|
166
169
|
'end_date': (datetime,), # noqa: E501
|
|
167
|
-
'
|
|
168
|
-
'
|
|
170
|
+
'ids': ([str], none_type,), # noqa: E501
|
|
171
|
+
'id': (str, none_type,), # noqa: E501
|
|
169
172
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
170
173
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
171
174
|
'format': (str, none_type,), # noqa: E501
|
|
172
175
|
'report_type': (str, none_type,), # noqa: E501
|
|
173
176
|
'click_attribution_window': (str, none_type,), # noqa: E501
|
|
174
177
|
'view_attribution_window': (str, none_type,), # noqa: E501
|
|
175
|
-
'
|
|
176
|
-
'
|
|
178
|
+
'dimensions': ([str], none_type,), # noqa: E501
|
|
179
|
+
'metrics': ([str], none_type,), # noqa: E501
|
|
177
180
|
'timezone': (str, none_type,), # noqa: E501
|
|
178
181
|
}
|
|
179
182
|
|
|
@@ -185,16 +188,16 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
185
188
|
attribute_map = {
|
|
186
189
|
'start_date': 'startDate', # noqa: E501
|
|
187
190
|
'end_date': 'endDate', # noqa: E501
|
|
188
|
-
'
|
|
189
|
-
'
|
|
191
|
+
'ids': 'ids', # noqa: E501
|
|
192
|
+
'id': 'id', # noqa: E501
|
|
190
193
|
'campaign_type': 'campaignType', # noqa: E501
|
|
191
194
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
192
195
|
'format': 'format', # noqa: E501
|
|
193
196
|
'report_type': 'reportType', # noqa: E501
|
|
194
197
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
195
198
|
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
196
|
-
'
|
|
197
|
-
'
|
|
199
|
+
'dimensions': 'dimensions', # noqa: E501
|
|
200
|
+
'metrics': 'metrics', # noqa: E501
|
|
198
201
|
'timezone': 'timezone', # noqa: E501
|
|
199
202
|
}
|
|
200
203
|
|
|
@@ -243,16 +246,16 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
243
246
|
Animal class but this time we won't travel
|
|
244
247
|
through its discriminator because we passed in
|
|
245
248
|
_visited_composed_classes = (Animal,)
|
|
246
|
-
|
|
247
|
-
|
|
249
|
+
ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
|
|
250
|
+
id (str, none_type): Line Item id to report on. [optional] # noqa: E501
|
|
248
251
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
|
|
249
252
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
|
|
250
253
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
251
254
|
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
|
|
252
255
|
click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
253
256
|
view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
254
|
-
|
|
255
|
-
|
|
257
|
+
dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
|
|
258
|
+
metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
|
|
256
259
|
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
|
|
257
260
|
"""
|
|
258
261
|
|
|
@@ -345,16 +348,16 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
345
348
|
Animal class but this time we won't travel
|
|
346
349
|
through its discriminator because we passed in
|
|
347
350
|
_visited_composed_classes = (Animal,)
|
|
348
|
-
|
|
349
|
-
|
|
351
|
+
ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
|
|
352
|
+
id (str, none_type): Line Item id to report on. [optional] # noqa: E501
|
|
350
353
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
|
|
351
354
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
|
|
352
355
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
353
356
|
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
|
|
354
357
|
click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
355
358
|
view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
356
|
-
|
|
357
|
-
|
|
359
|
+
dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
|
|
360
|
+
metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
|
|
358
361
|
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
|
|
359
362
|
"""
|
|
360
363
|
|