criteo-api-retailmedia-sdk 0.0.251014__py3-none-any.whl → 0.0.251021__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 +1 -1
- criteo_api_retailmedia_preview/api/campaign_api.py +316 -24
- criteo_api_retailmedia_preview/api/third_party_accounts_api.py +757 -0
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/campaign_availability.py +3 -3
- criteo_api_retailmedia_preview/model/display_auction_min_bid_request.py +268 -0
- criteo_api_retailmedia_preview/model/display_auction_min_bid_result.py +280 -0
- criteo_api_retailmedia_preview/model/entity_resource_of_retail_media_account_v2.py +270 -0
- criteo_api_retailmedia_preview/model/entity_resource_outcome_of_retail_media_account_v2.py +274 -0
- criteo_api_retailmedia_preview/model/external_retail_media_account_v2.py +301 -0
- criteo_api_retailmedia_preview/model/external_retail_media_brand_account_creation_v2.py +269 -0
- criteo_api_retailmedia_preview/model/external_retail_media_brands.py +263 -0
- criteo_api_retailmedia_preview/model/external_retail_media_seller.py +269 -0
- criteo_api_retailmedia_preview/model/external_retail_media_seller_account_creation_v2.py +280 -0
- criteo_api_retailmedia_preview/model/line_item_budget_cap_out_history.py +266 -0
- criteo_api_retailmedia_preview/model/line_item_budget_cap_out_history_capout_times.py +269 -0
- criteo_api_retailmedia_preview/model/line_item_budget_cap_out_history_request.py +278 -0
- criteo_api_retailmedia_preview/model/line_item_budget_cap_out_history_response.py +262 -0
- criteo_api_retailmedia_preview/model/page_type_combination.py +2 -2
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +4 -3
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +9 -10
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +0 -1
- criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_collection_outcome_display_auction_min_bid_result.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_display_auction_min_bid_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_display_auction_min_bid_result.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_input_display_auction_min_bid_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_line_item_budget_cap_out_history_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation_v2.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_v2.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_line_item_budget_cap_out_history_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_line_item_budget_cap_out_history_response.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation_v2.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brands.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation_v2.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_outcome_line_item_budget_cap_out_history_response.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_outcome_of_retail_media_brands.py +274 -0
- criteo_api_retailmedia_preview/models/__init__.py +31 -0
- {criteo_api_retailmedia_sdk-0.0.251014.dist-info → criteo_api_retailmedia_sdk-0.0.251021.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.251014.dist-info → criteo_api_retailmedia_sdk-0.0.251021.dist-info}/RECORD +48 -16
- {criteo_api_retailmedia_sdk-0.0.251014.dist-info → criteo_api_retailmedia_sdk-0.0.251021.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.251014.dist-info → criteo_api_retailmedia_sdk-0.0.251021.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,262 @@
|
|
|
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.line_item_budget_cap_out_history import LineItemBudgetCapOutHistory
|
|
34
|
+
globals()['LineItemBudgetCapOutHistory'] = LineItemBudgetCapOutHistory
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class LineItemBudgetCapOutHistoryResponse(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
|
+
additional_properties_type = None
|
|
68
|
+
|
|
69
|
+
_nullable = True
|
|
70
|
+
|
|
71
|
+
@cached_property
|
|
72
|
+
def openapi_types():
|
|
73
|
+
"""
|
|
74
|
+
This must be a method because a model may have properties that are
|
|
75
|
+
of type self, this must run after the class is loaded
|
|
76
|
+
|
|
77
|
+
Returns
|
|
78
|
+
openapi_types (dict): The key is attribute name
|
|
79
|
+
and the value is attribute type.
|
|
80
|
+
"""
|
|
81
|
+
lazy_import()
|
|
82
|
+
return {
|
|
83
|
+
'line_item_budget_cap_out_histories': ([LineItemBudgetCapOutHistory], none_type,), # noqa: E501
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
@cached_property
|
|
87
|
+
def discriminator():
|
|
88
|
+
return None
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
attribute_map = {
|
|
92
|
+
'line_item_budget_cap_out_histories': 'lineItemBudgetCapOutHistories', # noqa: E501
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
read_only_vars = {
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
_composed_schemas = {}
|
|
99
|
+
|
|
100
|
+
@classmethod
|
|
101
|
+
@convert_js_args_to_python_args
|
|
102
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
103
|
+
"""LineItemBudgetCapOutHistoryResponse - a model defined in OpenAPI
|
|
104
|
+
|
|
105
|
+
Keyword Args:
|
|
106
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
107
|
+
will be type checked and a TypeError will be
|
|
108
|
+
raised if the wrong type is input.
|
|
109
|
+
Defaults to True
|
|
110
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
111
|
+
drill down to the model in received_data
|
|
112
|
+
when deserializing a response
|
|
113
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
114
|
+
are serialized names, as specified in the OpenAPI document.
|
|
115
|
+
False if the variable names in the input data
|
|
116
|
+
are pythonic names, e.g. snake case (default)
|
|
117
|
+
_configuration (Configuration): the instance to use when
|
|
118
|
+
deserializing a file_type parameter.
|
|
119
|
+
If passed, type conversion is attempted
|
|
120
|
+
If omitted no type conversion is done.
|
|
121
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
122
|
+
classes that we have traveled through so that
|
|
123
|
+
if we see that class again we will not use its
|
|
124
|
+
discriminator again.
|
|
125
|
+
When traveling through a discriminator, the
|
|
126
|
+
composed schema that is
|
|
127
|
+
is traveled through is added to this set.
|
|
128
|
+
For example if Animal has a discriminator
|
|
129
|
+
petType and we pass in "Dog", and the class Dog
|
|
130
|
+
allOf includes Animal, we move through Animal
|
|
131
|
+
once using the discriminator, and pick Dog.
|
|
132
|
+
Then in Dog, we will make an instance of the
|
|
133
|
+
Animal class but this time we won't travel
|
|
134
|
+
through its discriminator because we passed in
|
|
135
|
+
_visited_composed_classes = (Animal,)
|
|
136
|
+
line_item_budget_cap_out_histories ([LineItemBudgetCapOutHistory], none_type): The list of line item budget cap out histories. [optional] # noqa: E501
|
|
137
|
+
"""
|
|
138
|
+
|
|
139
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
140
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
141
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
142
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
143
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
144
|
+
|
|
145
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
146
|
+
|
|
147
|
+
if args:
|
|
148
|
+
for arg in args:
|
|
149
|
+
if isinstance(arg, dict):
|
|
150
|
+
kwargs.update(arg)
|
|
151
|
+
else:
|
|
152
|
+
raise ApiTypeError(
|
|
153
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
154
|
+
args,
|
|
155
|
+
self.__class__.__name__,
|
|
156
|
+
),
|
|
157
|
+
path_to_item=_path_to_item,
|
|
158
|
+
valid_classes=(self.__class__,),
|
|
159
|
+
)
|
|
160
|
+
|
|
161
|
+
self._data_store = {}
|
|
162
|
+
self._check_type = _check_type
|
|
163
|
+
self._spec_property_naming = _spec_property_naming
|
|
164
|
+
self._path_to_item = _path_to_item
|
|
165
|
+
self._configuration = _configuration
|
|
166
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
167
|
+
|
|
168
|
+
for var_name, var_value in kwargs.items():
|
|
169
|
+
if var_name not in self.attribute_map and \
|
|
170
|
+
self._configuration is not None and \
|
|
171
|
+
self._configuration.discard_unknown_keys and \
|
|
172
|
+
self.additional_properties_type is None:
|
|
173
|
+
# discard variable.
|
|
174
|
+
continue
|
|
175
|
+
setattr(self, var_name, var_value)
|
|
176
|
+
return self
|
|
177
|
+
|
|
178
|
+
required_properties = set([
|
|
179
|
+
'_data_store',
|
|
180
|
+
'_check_type',
|
|
181
|
+
'_spec_property_naming',
|
|
182
|
+
'_path_to_item',
|
|
183
|
+
'_configuration',
|
|
184
|
+
'_visited_composed_classes',
|
|
185
|
+
])
|
|
186
|
+
|
|
187
|
+
@convert_js_args_to_python_args
|
|
188
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
189
|
+
"""LineItemBudgetCapOutHistoryResponse - a model defined in OpenAPI
|
|
190
|
+
|
|
191
|
+
Keyword Args:
|
|
192
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
193
|
+
will be type checked and a TypeError will be
|
|
194
|
+
raised if the wrong type is input.
|
|
195
|
+
Defaults to True
|
|
196
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
197
|
+
drill down to the model in received_data
|
|
198
|
+
when deserializing a response
|
|
199
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
200
|
+
are serialized names, as specified in the OpenAPI document.
|
|
201
|
+
False if the variable names in the input data
|
|
202
|
+
are pythonic names, e.g. snake case (default)
|
|
203
|
+
_configuration (Configuration): the instance to use when
|
|
204
|
+
deserializing a file_type parameter.
|
|
205
|
+
If passed, type conversion is attempted
|
|
206
|
+
If omitted no type conversion is done.
|
|
207
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
208
|
+
classes that we have traveled through so that
|
|
209
|
+
if we see that class again we will not use its
|
|
210
|
+
discriminator again.
|
|
211
|
+
When traveling through a discriminator, the
|
|
212
|
+
composed schema that is
|
|
213
|
+
is traveled through is added to this set.
|
|
214
|
+
For example if Animal has a discriminator
|
|
215
|
+
petType and we pass in "Dog", and the class Dog
|
|
216
|
+
allOf includes Animal, we move through Animal
|
|
217
|
+
once using the discriminator, and pick Dog.
|
|
218
|
+
Then in Dog, we will make an instance of the
|
|
219
|
+
Animal class but this time we won't travel
|
|
220
|
+
through its discriminator because we passed in
|
|
221
|
+
_visited_composed_classes = (Animal,)
|
|
222
|
+
line_item_budget_cap_out_histories ([LineItemBudgetCapOutHistory], none_type): The list of line item budget cap out histories. [optional] # noqa: E501
|
|
223
|
+
"""
|
|
224
|
+
|
|
225
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
226
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
227
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
228
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
229
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
230
|
+
|
|
231
|
+
if args:
|
|
232
|
+
for arg in args:
|
|
233
|
+
if isinstance(arg, dict):
|
|
234
|
+
kwargs.update(arg)
|
|
235
|
+
else:
|
|
236
|
+
raise ApiTypeError(
|
|
237
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
238
|
+
args,
|
|
239
|
+
self.__class__.__name__,
|
|
240
|
+
),
|
|
241
|
+
path_to_item=_path_to_item,
|
|
242
|
+
valid_classes=(self.__class__,),
|
|
243
|
+
)
|
|
244
|
+
|
|
245
|
+
self._data_store = {}
|
|
246
|
+
self._check_type = _check_type
|
|
247
|
+
self._spec_property_naming = _spec_property_naming
|
|
248
|
+
self._path_to_item = _path_to_item
|
|
249
|
+
self._configuration = _configuration
|
|
250
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
251
|
+
|
|
252
|
+
for var_name, var_value in kwargs.items():
|
|
253
|
+
if var_name not in self.attribute_map and \
|
|
254
|
+
self._configuration is not None and \
|
|
255
|
+
self._configuration.discard_unknown_keys and \
|
|
256
|
+
self.additional_properties_type is None:
|
|
257
|
+
# discard variable.
|
|
258
|
+
continue
|
|
259
|
+
setattr(self, var_name, var_value)
|
|
260
|
+
if var_name in self.read_only_vars:
|
|
261
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
262
|
+
f"class with read only attributes.")
|
|
@@ -73,13 +73,13 @@ class PageTypeCombination(ModelNormal):
|
|
|
73
73
|
'HOME': "home",
|
|
74
74
|
'CHECKOUT': "checkout",
|
|
75
75
|
'CATEGORY': "category",
|
|
76
|
-
'PRODUCTDETAIL': "
|
|
76
|
+
'PRODUCTDETAIL': "productDetail",
|
|
77
77
|
'CONFIRMATION': "confirmation",
|
|
78
78
|
'MERCHANDISING': "merchandising",
|
|
79
79
|
'DEALS': "deals",
|
|
80
80
|
'FAVORITES': "favorites",
|
|
81
81
|
'SEARCHBAR': "searchbar",
|
|
82
|
-
'CATEGORYMENU': "
|
|
82
|
+
'CATEGORYMENU': "categoryMenu",
|
|
83
83
|
},
|
|
84
84
|
}
|
|
85
85
|
|
|
@@ -61,10 +61,10 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
61
61
|
allowed_values = {
|
|
62
62
|
('bid_strategy',): {
|
|
63
63
|
'None': None,
|
|
64
|
-
'UNKNOWN': "unknown",
|
|
65
64
|
'CONVERSION': "conversion",
|
|
66
65
|
'CLICKS': "clicks",
|
|
67
66
|
'REVENUE': "revenue",
|
|
67
|
+
'UNKNOWN': "unknown",
|
|
68
68
|
},
|
|
69
69
|
('keyword_strategy',): {
|
|
70
70
|
'None': None,
|
|
@@ -77,6 +77,7 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
77
77
|
'None': None,
|
|
78
78
|
'MANUAL': "manual",
|
|
79
79
|
'AUTOMATED': "automated",
|
|
80
|
+
'UNKNOWN': "unknown",
|
|
80
81
|
},
|
|
81
82
|
('status',): {
|
|
82
83
|
'None': None,
|
|
@@ -225,7 +226,7 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
225
226
|
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
226
227
|
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
227
228
|
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
228
|
-
optimization_strategy (str, none_type): [optional] # noqa: E501
|
|
229
|
+
optimization_strategy (str, none_type): Optimization strategy for the line item.. [optional] # noqa: E501
|
|
229
230
|
status (str, none_type): The current status of the line item.. [optional] # noqa: E501
|
|
230
231
|
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
231
232
|
"""
|
|
@@ -339,7 +340,7 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
339
340
|
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
340
341
|
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
341
342
|
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
342
|
-
optimization_strategy (str, none_type): [optional] # noqa: E501
|
|
343
|
+
optimization_strategy (str, none_type): Optimization strategy for the line item.. [optional] # noqa: E501
|
|
343
344
|
status (str, none_type): The current status of the line item.. [optional] # noqa: E501
|
|
344
345
|
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
345
346
|
"""
|
|
@@ -60,7 +60,6 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
60
60
|
|
|
61
61
|
allowed_values = {
|
|
62
62
|
('bid_strategy',): {
|
|
63
|
-
'UNKNOWN': "unknown",
|
|
64
63
|
'CONVERSION': "conversion",
|
|
65
64
|
'CLICKS': "clicks",
|
|
66
65
|
'REVENUE': "revenue",
|
|
@@ -71,7 +70,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
71
70
|
'GENERICANDBRANDED': "genericAndBranded",
|
|
72
71
|
'GENERICBRANDEDANDCONQUESTING': "genericBrandedAndConquesting",
|
|
73
72
|
},
|
|
74
|
-
('
|
|
73
|
+
('optimization_strategy',): {
|
|
75
74
|
'MANUAL': "manual",
|
|
76
75
|
'AUTOMATED': "automated",
|
|
77
76
|
},
|
|
@@ -112,7 +111,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
112
111
|
'keyword_strategy': (str, none_type,), # noqa: E501
|
|
113
112
|
'max_bid': (float, none_type,), # noqa: E501
|
|
114
113
|
'monthly_pacing': (float, none_type,), # noqa: E501
|
|
115
|
-
'
|
|
114
|
+
'optimization_strategy': (str,), # noqa: E501
|
|
116
115
|
'target_bid': (float, none_type,), # noqa: E501
|
|
117
116
|
}
|
|
118
117
|
|
|
@@ -134,7 +133,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
134
133
|
'keyword_strategy': 'keywordStrategy', # noqa: E501
|
|
135
134
|
'max_bid': 'maxBid', # noqa: E501
|
|
136
135
|
'monthly_pacing': 'monthlyPacing', # noqa: E501
|
|
137
|
-
'
|
|
136
|
+
'optimization_strategy': 'optimizationStrategy', # noqa: E501
|
|
138
137
|
'target_bid': 'targetBid', # noqa: E501
|
|
139
138
|
}
|
|
140
139
|
|
|
@@ -150,7 +149,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
150
149
|
|
|
151
150
|
Args:
|
|
152
151
|
name (str): The name of the line item.
|
|
153
|
-
start_date (datetime): The date and time when the line item
|
|
152
|
+
start_date (datetime): The date and time when the line item starts running.
|
|
154
153
|
target_retailer_id (str): The ID of the retailer to target for this line item.
|
|
155
154
|
|
|
156
155
|
Keyword Args:
|
|
@@ -187,13 +186,13 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
187
186
|
bid_strategy (str): The bidding strategy to use for this line item. Default value is Conversion.. [optional] if omitted the server will use the default value of "conversion" # noqa: E501
|
|
188
187
|
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
189
188
|
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
190
|
-
end_date (datetime, none_type): The date and time when the line item
|
|
189
|
+
end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
|
|
191
190
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
192
191
|
is_auto_daily_pacing (bool): Indicates whether automatic daily pacing is enabled. Default value is false.. [optional] if omitted the server will use the default value of False # noqa: E501
|
|
193
192
|
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
194
193
|
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
195
194
|
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
196
|
-
|
|
195
|
+
optimization_strategy (str): [optional] if omitted the server will use the default value of "manual" # noqa: E501
|
|
197
196
|
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
198
197
|
"""
|
|
199
198
|
|
|
@@ -254,7 +253,7 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
254
253
|
|
|
255
254
|
Args:
|
|
256
255
|
name (str): The name of the line item.
|
|
257
|
-
start_date (datetime): The date and time when the line item
|
|
256
|
+
start_date (datetime): The date and time when the line item starts running.
|
|
258
257
|
target_retailer_id (str): The ID of the retailer to target for this line item.
|
|
259
258
|
|
|
260
259
|
Keyword Args:
|
|
@@ -291,13 +290,13 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
291
290
|
bid_strategy (str): The bidding strategy to use for this line item. Default value is Conversion.. [optional] if omitted the server will use the default value of "conversion" # noqa: E501
|
|
292
291
|
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
293
292
|
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
294
|
-
end_date (datetime, none_type): The date and time when the line item
|
|
293
|
+
end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
|
|
295
294
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
296
295
|
is_auto_daily_pacing (bool): Indicates whether automatic daily pacing is enabled. Default value is false.. [optional] if omitted the server will use the default value of False # noqa: E501
|
|
297
296
|
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
298
297
|
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
299
298
|
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
300
|
-
|
|
299
|
+
optimization_strategy (str): [optional] if omitted the server will use the default value of "manual" # noqa: E501
|
|
301
300
|
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
302
301
|
"""
|
|
303
302
|
|
criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py
ADDED
|
@@ -0,0 +1,262 @@
|
|
|
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.value_resource_of_retail_media_seller import ValueResourceOfRetailMediaSeller
|
|
34
|
+
globals()['ValueResourceOfRetailMediaSeller'] = ValueResourceOfRetailMediaSeller
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class ValueResourceCollectionInputOfRetailMediaSeller(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
|
+
additional_properties_type = None
|
|
68
|
+
|
|
69
|
+
_nullable = False
|
|
70
|
+
|
|
71
|
+
@cached_property
|
|
72
|
+
def openapi_types():
|
|
73
|
+
"""
|
|
74
|
+
This must be a method because a model may have properties that are
|
|
75
|
+
of type self, this must run after the class is loaded
|
|
76
|
+
|
|
77
|
+
Returns
|
|
78
|
+
openapi_types (dict): The key is attribute name
|
|
79
|
+
and the value is attribute type.
|
|
80
|
+
"""
|
|
81
|
+
lazy_import()
|
|
82
|
+
return {
|
|
83
|
+
'data': ([ValueResourceOfRetailMediaSeller], none_type,), # noqa: E501
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
@cached_property
|
|
87
|
+
def discriminator():
|
|
88
|
+
return None
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
attribute_map = {
|
|
92
|
+
'data': 'data', # noqa: E501
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
read_only_vars = {
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
_composed_schemas = {}
|
|
99
|
+
|
|
100
|
+
@classmethod
|
|
101
|
+
@convert_js_args_to_python_args
|
|
102
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
103
|
+
"""ValueResourceCollectionInputOfRetailMediaSeller - a model defined in OpenAPI
|
|
104
|
+
|
|
105
|
+
Keyword Args:
|
|
106
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
107
|
+
will be type checked and a TypeError will be
|
|
108
|
+
raised if the wrong type is input.
|
|
109
|
+
Defaults to True
|
|
110
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
111
|
+
drill down to the model in received_data
|
|
112
|
+
when deserializing a response
|
|
113
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
114
|
+
are serialized names, as specified in the OpenAPI document.
|
|
115
|
+
False if the variable names in the input data
|
|
116
|
+
are pythonic names, e.g. snake case (default)
|
|
117
|
+
_configuration (Configuration): the instance to use when
|
|
118
|
+
deserializing a file_type parameter.
|
|
119
|
+
If passed, type conversion is attempted
|
|
120
|
+
If omitted no type conversion is done.
|
|
121
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
122
|
+
classes that we have traveled through so that
|
|
123
|
+
if we see that class again we will not use its
|
|
124
|
+
discriminator again.
|
|
125
|
+
When traveling through a discriminator, the
|
|
126
|
+
composed schema that is
|
|
127
|
+
is traveled through is added to this set.
|
|
128
|
+
For example if Animal has a discriminator
|
|
129
|
+
petType and we pass in "Dog", and the class Dog
|
|
130
|
+
allOf includes Animal, we move through Animal
|
|
131
|
+
once using the discriminator, and pick Dog.
|
|
132
|
+
Then in Dog, we will make an instance of the
|
|
133
|
+
Animal class but this time we won't travel
|
|
134
|
+
through its discriminator because we passed in
|
|
135
|
+
_visited_composed_classes = (Animal,)
|
|
136
|
+
data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501
|
|
137
|
+
"""
|
|
138
|
+
|
|
139
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
140
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
141
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
142
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
143
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
144
|
+
|
|
145
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
146
|
+
|
|
147
|
+
if args:
|
|
148
|
+
for arg in args:
|
|
149
|
+
if isinstance(arg, dict):
|
|
150
|
+
kwargs.update(arg)
|
|
151
|
+
else:
|
|
152
|
+
raise ApiTypeError(
|
|
153
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
154
|
+
args,
|
|
155
|
+
self.__class__.__name__,
|
|
156
|
+
),
|
|
157
|
+
path_to_item=_path_to_item,
|
|
158
|
+
valid_classes=(self.__class__,),
|
|
159
|
+
)
|
|
160
|
+
|
|
161
|
+
self._data_store = {}
|
|
162
|
+
self._check_type = _check_type
|
|
163
|
+
self._spec_property_naming = _spec_property_naming
|
|
164
|
+
self._path_to_item = _path_to_item
|
|
165
|
+
self._configuration = _configuration
|
|
166
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
167
|
+
|
|
168
|
+
for var_name, var_value in kwargs.items():
|
|
169
|
+
if var_name not in self.attribute_map and \
|
|
170
|
+
self._configuration is not None and \
|
|
171
|
+
self._configuration.discard_unknown_keys and \
|
|
172
|
+
self.additional_properties_type is None:
|
|
173
|
+
# discard variable.
|
|
174
|
+
continue
|
|
175
|
+
setattr(self, var_name, var_value)
|
|
176
|
+
return self
|
|
177
|
+
|
|
178
|
+
required_properties = set([
|
|
179
|
+
'_data_store',
|
|
180
|
+
'_check_type',
|
|
181
|
+
'_spec_property_naming',
|
|
182
|
+
'_path_to_item',
|
|
183
|
+
'_configuration',
|
|
184
|
+
'_visited_composed_classes',
|
|
185
|
+
])
|
|
186
|
+
|
|
187
|
+
@convert_js_args_to_python_args
|
|
188
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
189
|
+
"""ValueResourceCollectionInputOfRetailMediaSeller - a model defined in OpenAPI
|
|
190
|
+
|
|
191
|
+
Keyword Args:
|
|
192
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
193
|
+
will be type checked and a TypeError will be
|
|
194
|
+
raised if the wrong type is input.
|
|
195
|
+
Defaults to True
|
|
196
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
197
|
+
drill down to the model in received_data
|
|
198
|
+
when deserializing a response
|
|
199
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
200
|
+
are serialized names, as specified in the OpenAPI document.
|
|
201
|
+
False if the variable names in the input data
|
|
202
|
+
are pythonic names, e.g. snake case (default)
|
|
203
|
+
_configuration (Configuration): the instance to use when
|
|
204
|
+
deserializing a file_type parameter.
|
|
205
|
+
If passed, type conversion is attempted
|
|
206
|
+
If omitted no type conversion is done.
|
|
207
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
208
|
+
classes that we have traveled through so that
|
|
209
|
+
if we see that class again we will not use its
|
|
210
|
+
discriminator again.
|
|
211
|
+
When traveling through a discriminator, the
|
|
212
|
+
composed schema that is
|
|
213
|
+
is traveled through is added to this set.
|
|
214
|
+
For example if Animal has a discriminator
|
|
215
|
+
petType and we pass in "Dog", and the class Dog
|
|
216
|
+
allOf includes Animal, we move through Animal
|
|
217
|
+
once using the discriminator, and pick Dog.
|
|
218
|
+
Then in Dog, we will make an instance of the
|
|
219
|
+
Animal class but this time we won't travel
|
|
220
|
+
through its discriminator because we passed in
|
|
221
|
+
_visited_composed_classes = (Animal,)
|
|
222
|
+
data ([ValueResourceOfRetailMediaSeller], none_type): [optional] # noqa: E501
|
|
223
|
+
"""
|
|
224
|
+
|
|
225
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
226
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
227
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
228
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
229
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
230
|
+
|
|
231
|
+
if args:
|
|
232
|
+
for arg in args:
|
|
233
|
+
if isinstance(arg, dict):
|
|
234
|
+
kwargs.update(arg)
|
|
235
|
+
else:
|
|
236
|
+
raise ApiTypeError(
|
|
237
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
238
|
+
args,
|
|
239
|
+
self.__class__.__name__,
|
|
240
|
+
),
|
|
241
|
+
path_to_item=_path_to_item,
|
|
242
|
+
valid_classes=(self.__class__,),
|
|
243
|
+
)
|
|
244
|
+
|
|
245
|
+
self._data_store = {}
|
|
246
|
+
self._check_type = _check_type
|
|
247
|
+
self._spec_property_naming = _spec_property_naming
|
|
248
|
+
self._path_to_item = _path_to_item
|
|
249
|
+
self._configuration = _configuration
|
|
250
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
251
|
+
|
|
252
|
+
for var_name, var_value in kwargs.items():
|
|
253
|
+
if var_name not in self.attribute_map and \
|
|
254
|
+
self._configuration is not None and \
|
|
255
|
+
self._configuration.discard_unknown_keys and \
|
|
256
|
+
self.additional_properties_type is None:
|
|
257
|
+
# discard variable.
|
|
258
|
+
continue
|
|
259
|
+
setattr(self, var_name, var_value)
|
|
260
|
+
if var_name in self.read_only_vars:
|
|
261
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
262
|
+
f"class with read only attributes.")
|