criteo-api-retailmedia-sdk 0.0.250825__py3-none-any.whl → 0.0.250902__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/campaign_api.py +4 -6
- criteo_api_retailmedia_preview/api/catalog_api.py +445 -0
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/async_accounts_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +10 -0
- criteo_api_retailmedia_preview/model/async_job_response.py +257 -0
- criteo_api_retailmedia_preview/model/async_line_items_report.py +14 -0
- criteo_api_retailmedia_preview/model/async_offsite_report.py +3 -3
- criteo_api_retailmedia_preview/model/line_item_capping_v2.py +1 -1
- criteo_api_retailmedia_preview/model/load_sku_offers_request.py +272 -0
- criteo_api_retailmedia_preview/model/offer_load.py +289 -0
- criteo_api_retailmedia_preview/model/offer_update.py +287 -0
- criteo_api_retailmedia_preview/model/set_sku_buy_box_winners_request.py +272 -0
- criteo_api_retailmedia_preview/model/sku_buy_box_winner.py +269 -0
- criteo_api_retailmedia_preview/model/sku_offer_load.py +278 -0
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +43 -44
- criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +32 -34
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +10 -0
- criteo_api_retailmedia_preview/model/update_offers_request.py +272 -0
- criteo_api_retailmedia_preview/model/value_resource_async_job_response.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_input_load_sku_offers_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_set_sku_buy_box_winners_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_update_offers_request.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_load_sku_offers_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_outcome_async_job_response.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_set_sku_buy_box_winners_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_update_offers_request.py +266 -0
- criteo_api_retailmedia_preview/models/__init__.py +16 -0
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/RECORD +35 -19
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/WHEEL +0 -0
- {criteo_api_retailmedia_sdk-0.0.250825.dist-info → criteo_api_retailmedia_sdk-0.0.250902.dist-info}/top_level.txt +0 -0
|
@@ -0,0 +1,278 @@
|
|
|
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.offer_load import OfferLoad
|
|
34
|
+
globals()['OfferLoad'] = OfferLoad
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
class SkuOfferLoad(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
|
+
'offers': ([OfferLoad],), # noqa: E501
|
|
84
|
+
'sku_id': (str,), # noqa: E501
|
|
85
|
+
'buy_box_winner': (str,), # noqa: E501
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
@cached_property
|
|
89
|
+
def discriminator():
|
|
90
|
+
return None
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
attribute_map = {
|
|
94
|
+
'offers': 'offers', # noqa: E501
|
|
95
|
+
'sku_id': 'skuId', # noqa: E501
|
|
96
|
+
'buy_box_winner': 'buyBoxWinner', # noqa: E501
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
read_only_vars = {
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
_composed_schemas = {}
|
|
103
|
+
|
|
104
|
+
@classmethod
|
|
105
|
+
@convert_js_args_to_python_args
|
|
106
|
+
def _from_openapi_data(cls, offers, sku_id, *args, **kwargs): # noqa: E501
|
|
107
|
+
"""SkuOfferLoad - a model defined in OpenAPI
|
|
108
|
+
|
|
109
|
+
Args:
|
|
110
|
+
offers ([OfferLoad]):
|
|
111
|
+
sku_id (str):
|
|
112
|
+
|
|
113
|
+
Keyword Args:
|
|
114
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
115
|
+
will be type checked and a TypeError will be
|
|
116
|
+
raised if the wrong type is input.
|
|
117
|
+
Defaults to True
|
|
118
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
119
|
+
drill down to the model in received_data
|
|
120
|
+
when deserializing a response
|
|
121
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
122
|
+
are serialized names, as specified in the OpenAPI document.
|
|
123
|
+
False if the variable names in the input data
|
|
124
|
+
are pythonic names, e.g. snake case (default)
|
|
125
|
+
_configuration (Configuration): the instance to use when
|
|
126
|
+
deserializing a file_type parameter.
|
|
127
|
+
If passed, type conversion is attempted
|
|
128
|
+
If omitted no type conversion is done.
|
|
129
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
130
|
+
classes that we have traveled through so that
|
|
131
|
+
if we see that class again we will not use its
|
|
132
|
+
discriminator again.
|
|
133
|
+
When traveling through a discriminator, the
|
|
134
|
+
composed schema that is
|
|
135
|
+
is traveled through is added to this set.
|
|
136
|
+
For example if Animal has a discriminator
|
|
137
|
+
petType and we pass in "Dog", and the class Dog
|
|
138
|
+
allOf includes Animal, we move through Animal
|
|
139
|
+
once using the discriminator, and pick Dog.
|
|
140
|
+
Then in Dog, we will make an instance of the
|
|
141
|
+
Animal class but this time we won't travel
|
|
142
|
+
through its discriminator because we passed in
|
|
143
|
+
_visited_composed_classes = (Animal,)
|
|
144
|
+
buy_box_winner (str): [optional] # noqa: E501
|
|
145
|
+
"""
|
|
146
|
+
|
|
147
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
148
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
149
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
150
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
151
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
152
|
+
|
|
153
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
154
|
+
|
|
155
|
+
if args:
|
|
156
|
+
for arg in args:
|
|
157
|
+
if isinstance(arg, dict):
|
|
158
|
+
kwargs.update(arg)
|
|
159
|
+
else:
|
|
160
|
+
raise ApiTypeError(
|
|
161
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
162
|
+
args,
|
|
163
|
+
self.__class__.__name__,
|
|
164
|
+
),
|
|
165
|
+
path_to_item=_path_to_item,
|
|
166
|
+
valid_classes=(self.__class__,),
|
|
167
|
+
)
|
|
168
|
+
|
|
169
|
+
self._data_store = {}
|
|
170
|
+
self._check_type = _check_type
|
|
171
|
+
self._spec_property_naming = _spec_property_naming
|
|
172
|
+
self._path_to_item = _path_to_item
|
|
173
|
+
self._configuration = _configuration
|
|
174
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
175
|
+
|
|
176
|
+
self.offers = offers
|
|
177
|
+
self.sku_id = sku_id
|
|
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, offers, sku_id, *args, **kwargs): # noqa: E501
|
|
199
|
+
"""SkuOfferLoad - a model defined in OpenAPI
|
|
200
|
+
|
|
201
|
+
Args:
|
|
202
|
+
offers ([OfferLoad]):
|
|
203
|
+
sku_id (str):
|
|
204
|
+
|
|
205
|
+
Keyword Args:
|
|
206
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
207
|
+
will be type checked and a TypeError will be
|
|
208
|
+
raised if the wrong type is input.
|
|
209
|
+
Defaults to True
|
|
210
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
211
|
+
drill down to the model in received_data
|
|
212
|
+
when deserializing a response
|
|
213
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
214
|
+
are serialized names, as specified in the OpenAPI document.
|
|
215
|
+
False if the variable names in the input data
|
|
216
|
+
are pythonic names, e.g. snake case (default)
|
|
217
|
+
_configuration (Configuration): the instance to use when
|
|
218
|
+
deserializing a file_type parameter.
|
|
219
|
+
If passed, type conversion is attempted
|
|
220
|
+
If omitted no type conversion is done.
|
|
221
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
222
|
+
classes that we have traveled through so that
|
|
223
|
+
if we see that class again we will not use its
|
|
224
|
+
discriminator again.
|
|
225
|
+
When traveling through a discriminator, the
|
|
226
|
+
composed schema that is
|
|
227
|
+
is traveled through is added to this set.
|
|
228
|
+
For example if Animal has a discriminator
|
|
229
|
+
petType and we pass in "Dog", and the class Dog
|
|
230
|
+
allOf includes Animal, we move through Animal
|
|
231
|
+
once using the discriminator, and pick Dog.
|
|
232
|
+
Then in Dog, we will make an instance of the
|
|
233
|
+
Animal class but this time we won't travel
|
|
234
|
+
through its discriminator because we passed in
|
|
235
|
+
_visited_composed_classes = (Animal,)
|
|
236
|
+
buy_box_winner (str): [optional] # noqa: E501
|
|
237
|
+
"""
|
|
238
|
+
|
|
239
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
240
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
241
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
242
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
243
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
244
|
+
|
|
245
|
+
if args:
|
|
246
|
+
for arg in args:
|
|
247
|
+
if isinstance(arg, dict):
|
|
248
|
+
kwargs.update(arg)
|
|
249
|
+
else:
|
|
250
|
+
raise ApiTypeError(
|
|
251
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
252
|
+
args,
|
|
253
|
+
self.__class__.__name__,
|
|
254
|
+
),
|
|
255
|
+
path_to_item=_path_to_item,
|
|
256
|
+
valid_classes=(self.__class__,),
|
|
257
|
+
)
|
|
258
|
+
|
|
259
|
+
self._data_store = {}
|
|
260
|
+
self._check_type = _check_type
|
|
261
|
+
self._spec_property_naming = _spec_property_naming
|
|
262
|
+
self._path_to_item = _path_to_item
|
|
263
|
+
self._configuration = _configuration
|
|
264
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
265
|
+
|
|
266
|
+
self.offers = offers
|
|
267
|
+
self.sku_id = sku_id
|
|
268
|
+
for var_name, var_value in kwargs.items():
|
|
269
|
+
if var_name not in self.attribute_map and \
|
|
270
|
+
self._configuration is not None and \
|
|
271
|
+
self._configuration.discard_unknown_keys and \
|
|
272
|
+
self.additional_properties_type is None:
|
|
273
|
+
# discard variable.
|
|
274
|
+
continue
|
|
275
|
+
setattr(self, var_name, var_value)
|
|
276
|
+
if var_name in self.read_only_vars:
|
|
277
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
278
|
+
f"class with read only attributes.")
|
|
@@ -66,6 +66,13 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
66
66
|
'CLICKS': "clicks",
|
|
67
67
|
'REVENUE': "revenue",
|
|
68
68
|
},
|
|
69
|
+
('keyword_strategy',): {
|
|
70
|
+
'None': None,
|
|
71
|
+
'UNKNOWN': "unknown",
|
|
72
|
+
'CONQUESTING': "conquesting",
|
|
73
|
+
'GENERICANDBRANDED': "genericAndBranded",
|
|
74
|
+
'GENERICBRANDEDANDCONQUESTING': "genericBrandedAndConquesting",
|
|
75
|
+
},
|
|
69
76
|
('status',): {
|
|
70
77
|
'None': None,
|
|
71
78
|
'UNKNOWN': "unknown",
|
|
@@ -113,15 +120,13 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
113
120
|
'bid_strategy': (str, none_type,), # noqa: E501
|
|
114
121
|
'budget': (float, none_type,), # noqa: E501
|
|
115
122
|
'budget_spent': (float, none_type,), # noqa: E501
|
|
116
|
-
'conquesting_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
117
123
|
'daily_pacing': (float, none_type,), # noqa: E501
|
|
118
|
-
'defensive_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
119
124
|
'end_date': (datetime, none_type,), # noqa: E501
|
|
120
125
|
'flight_schedule': (FlightSchedule,), # noqa: E501
|
|
121
126
|
'is_auto_daily_pacing': (bool, none_type,), # noqa: E501
|
|
127
|
+
'keyword_strategy': (str, none_type,), # noqa: E501
|
|
122
128
|
'max_bid': (float, none_type,), # noqa: E501
|
|
123
129
|
'monthly_pacing': (float, none_type,), # noqa: E501
|
|
124
|
-
'neutral_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
125
130
|
'status': (str, none_type,), # noqa: E501
|
|
126
131
|
'target_bid': (float, none_type,), # noqa: E501
|
|
127
132
|
}
|
|
@@ -142,15 +147,13 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
142
147
|
'bid_strategy': 'bidStrategy', # noqa: E501
|
|
143
148
|
'budget': 'budget', # noqa: E501
|
|
144
149
|
'budget_spent': 'budgetSpent', # noqa: E501
|
|
145
|
-
'conquesting_adstrategy_enabled': 'conquestingAdstrategyEnabled', # noqa: E501
|
|
146
150
|
'daily_pacing': 'dailyPacing', # noqa: E501
|
|
147
|
-
'defensive_adstrategy_enabled': 'defensiveAdstrategyEnabled', # noqa: E501
|
|
148
151
|
'end_date': 'endDate', # noqa: E501
|
|
149
152
|
'flight_schedule': 'flightSchedule', # noqa: E501
|
|
150
153
|
'is_auto_daily_pacing': 'isAutoDailyPacing', # noqa: E501
|
|
154
|
+
'keyword_strategy': 'keywordStrategy', # noqa: E501
|
|
151
155
|
'max_bid': 'maxBid', # noqa: E501
|
|
152
156
|
'monthly_pacing': 'monthlyPacing', # noqa: E501
|
|
153
|
-
'neutral_adstrategy_enabled': 'neutralAdstrategyEnabled', # noqa: E501
|
|
154
157
|
'status': 'status', # noqa: E501
|
|
155
158
|
'target_bid': 'targetBid', # noqa: E501
|
|
156
159
|
}
|
|
@@ -166,13 +169,13 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
166
169
|
"""SponsoredProductsLineItem - a model defined in OpenAPI
|
|
167
170
|
|
|
168
171
|
Args:
|
|
169
|
-
budget_remaining (float, none_type):
|
|
170
|
-
campaign_id (str):
|
|
171
|
-
created_at (datetime):
|
|
172
|
-
name (str):
|
|
173
|
-
start_date (datetime):
|
|
172
|
+
budget_remaining (float, none_type): The amount of the budget that remains available.
|
|
173
|
+
campaign_id (str): The ID of the campaign this line item belongs to.
|
|
174
|
+
created_at (datetime): The date and time when the line item was created.
|
|
175
|
+
name (str): The name of the line item.
|
|
176
|
+
start_date (datetime): The date and time when the line item starts running.
|
|
174
177
|
target_retailer_id (str):
|
|
175
|
-
updated_at (datetime):
|
|
178
|
+
updated_at (datetime): The date and time when the line item was last updated.
|
|
176
179
|
|
|
177
180
|
Keyword Args:
|
|
178
181
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -205,20 +208,18 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
205
208
|
Animal class but this time we won't travel
|
|
206
209
|
through its discriminator because we passed in
|
|
207
210
|
_visited_composed_classes = (Animal,)
|
|
208
|
-
bid_strategy (str, none_type): [optional] # noqa: E501
|
|
209
|
-
budget (float, none_type): [optional] # noqa: E501
|
|
210
|
-
budget_spent (float, none_type): [optional] # noqa: E501
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
defensive_adstrategy_enabled (bool, none_type): [optional] # noqa: E501
|
|
214
|
-
end_date (datetime, none_type): [optional] # noqa: E501
|
|
211
|
+
bid_strategy (str, none_type): Optional field.. [optional] # noqa: E501
|
|
212
|
+
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
213
|
+
budget_spent (float, none_type): The amount of the budget that has been spent so far.. [optional] # noqa: E501
|
|
214
|
+
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
215
|
+
end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
|
|
215
216
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
216
|
-
is_auto_daily_pacing (bool, none_type): [optional] # noqa: E501
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
status (str, none_type):
|
|
221
|
-
target_bid (float, none_type): [optional] # noqa: E501
|
|
217
|
+
is_auto_daily_pacing (bool, none_type): Indicates whether automatic daily pacing is enabled.. [optional] # noqa: E501
|
|
218
|
+
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
219
|
+
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
220
|
+
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
221
|
+
status (str, none_type): The current status of the line item.. [optional] # noqa: E501
|
|
222
|
+
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
222
223
|
"""
|
|
223
224
|
|
|
224
225
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -281,13 +282,13 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
281
282
|
"""SponsoredProductsLineItem - a model defined in OpenAPI
|
|
282
283
|
|
|
283
284
|
Args:
|
|
284
|
-
budget_remaining (float, none_type):
|
|
285
|
-
campaign_id (str):
|
|
286
|
-
created_at (datetime):
|
|
287
|
-
name (str):
|
|
288
|
-
start_date (datetime):
|
|
285
|
+
budget_remaining (float, none_type): The amount of the budget that remains available.
|
|
286
|
+
campaign_id (str): The ID of the campaign this line item belongs to.
|
|
287
|
+
created_at (datetime): The date and time when the line item was created.
|
|
288
|
+
name (str): The name of the line item.
|
|
289
|
+
start_date (datetime): The date and time when the line item starts running.
|
|
289
290
|
target_retailer_id (str):
|
|
290
|
-
updated_at (datetime):
|
|
291
|
+
updated_at (datetime): The date and time when the line item was last updated.
|
|
291
292
|
|
|
292
293
|
Keyword Args:
|
|
293
294
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -320,20 +321,18 @@ class SponsoredProductsLineItem(ModelNormal):
|
|
|
320
321
|
Animal class but this time we won't travel
|
|
321
322
|
through its discriminator because we passed in
|
|
322
323
|
_visited_composed_classes = (Animal,)
|
|
323
|
-
bid_strategy (str, none_type): [optional] # noqa: E501
|
|
324
|
-
budget (float, none_type): [optional] # noqa: E501
|
|
325
|
-
budget_spent (float, none_type): [optional] # noqa: E501
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
defensive_adstrategy_enabled (bool, none_type): [optional] # noqa: E501
|
|
329
|
-
end_date (datetime, none_type): [optional] # noqa: E501
|
|
324
|
+
bid_strategy (str, none_type): Optional field.. [optional] # noqa: E501
|
|
325
|
+
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
326
|
+
budget_spent (float, none_type): The amount of the budget that has been spent so far.. [optional] # noqa: E501
|
|
327
|
+
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
328
|
+
end_date (datetime, none_type): The date and time when the line item stops running.. [optional] # noqa: E501
|
|
330
329
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
331
|
-
is_auto_daily_pacing (bool, none_type): [optional] # noqa: E501
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
status (str, none_type):
|
|
336
|
-
target_bid (float, none_type): [optional] # noqa: E501
|
|
330
|
+
is_auto_daily_pacing (bool, none_type): Indicates whether automatic daily pacing is enabled.. [optional] # noqa: E501
|
|
331
|
+
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
332
|
+
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
333
|
+
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
334
|
+
status (str, none_type): The current status of the line item.. [optional] # noqa: E501
|
|
335
|
+
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
337
336
|
"""
|
|
338
337
|
|
|
339
338
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -65,6 +65,12 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
65
65
|
'CLICKS': "clicks",
|
|
66
66
|
'REVENUE': "revenue",
|
|
67
67
|
},
|
|
68
|
+
('keyword_strategy',): {
|
|
69
|
+
'None': None,
|
|
70
|
+
'CONQUESTING': "conquesting",
|
|
71
|
+
'GENERICANDBRANDED': "genericAndBranded",
|
|
72
|
+
'GENERICBRANDEDANDCONQUESTING': "genericBrandedAndConquesting",
|
|
73
|
+
},
|
|
68
74
|
}
|
|
69
75
|
|
|
70
76
|
validations = {
|
|
@@ -95,15 +101,13 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
95
101
|
'target_retailer_id': (str,), # noqa: E501
|
|
96
102
|
'bid_strategy': (str,), # noqa: E501
|
|
97
103
|
'budget': (float, none_type,), # noqa: E501
|
|
98
|
-
'conquesting_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
99
104
|
'daily_pacing': (float, none_type,), # noqa: E501
|
|
100
|
-
'defensive_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
101
105
|
'end_date': (datetime, none_type,), # noqa: E501
|
|
102
106
|
'flight_schedule': (FlightSchedule,), # noqa: E501
|
|
103
107
|
'is_auto_daily_pacing': (bool,), # noqa: E501
|
|
108
|
+
'keyword_strategy': (str, none_type,), # noqa: E501
|
|
104
109
|
'max_bid': (float, none_type,), # noqa: E501
|
|
105
110
|
'monthly_pacing': (float, none_type,), # noqa: E501
|
|
106
|
-
'neutral_adstrategy_enabled': (bool, none_type,), # noqa: E501
|
|
107
111
|
'target_bid': (float, none_type,), # noqa: E501
|
|
108
112
|
}
|
|
109
113
|
|
|
@@ -118,15 +122,13 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
118
122
|
'target_retailer_id': 'targetRetailerId', # noqa: E501
|
|
119
123
|
'bid_strategy': 'bidStrategy', # noqa: E501
|
|
120
124
|
'budget': 'budget', # noqa: E501
|
|
121
|
-
'conquesting_adstrategy_enabled': 'conquestingAdstrategyEnabled', # noqa: E501
|
|
122
125
|
'daily_pacing': 'dailyPacing', # noqa: E501
|
|
123
|
-
'defensive_adstrategy_enabled': 'defensiveAdstrategyEnabled', # noqa: E501
|
|
124
126
|
'end_date': 'endDate', # noqa: E501
|
|
125
127
|
'flight_schedule': 'flightSchedule', # noqa: E501
|
|
126
128
|
'is_auto_daily_pacing': 'isAutoDailyPacing', # noqa: E501
|
|
129
|
+
'keyword_strategy': 'keywordStrategy', # noqa: E501
|
|
127
130
|
'max_bid': 'maxBid', # noqa: E501
|
|
128
131
|
'monthly_pacing': 'monthlyPacing', # noqa: E501
|
|
129
|
-
'neutral_adstrategy_enabled': 'neutralAdstrategyEnabled', # noqa: E501
|
|
130
132
|
'target_bid': 'targetBid', # noqa: E501
|
|
131
133
|
}
|
|
132
134
|
|
|
@@ -141,9 +143,9 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
141
143
|
"""SponsoredProductsLineItemCreateRequestModel - a model defined in OpenAPI
|
|
142
144
|
|
|
143
145
|
Args:
|
|
144
|
-
name (str):
|
|
145
|
-
start_date (datetime):
|
|
146
|
-
target_retailer_id (str):
|
|
146
|
+
name (str): The name of the line item.
|
|
147
|
+
start_date (datetime): The date and time when the line item should start running.
|
|
148
|
+
target_retailer_id (str): The ID of the retailer to target for this line item.
|
|
147
149
|
|
|
148
150
|
Keyword Args:
|
|
149
151
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -176,18 +178,16 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
176
178
|
Animal class but this time we won't travel
|
|
177
179
|
through its discriminator because we passed in
|
|
178
180
|
_visited_composed_classes = (Animal,)
|
|
179
|
-
bid_strategy (str): [optional] if omitted the server will use the default value of "conversion" # noqa: E501
|
|
180
|
-
budget (float, none_type): [optional] # noqa: E501
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
defensive_adstrategy_enabled (bool, none_type): [optional] # noqa: E501
|
|
184
|
-
end_date (datetime, none_type): [optional] # noqa: E501
|
|
181
|
+
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
|
|
182
|
+
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
183
|
+
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
184
|
+
end_date (datetime, none_type): The date and time when the line item should stop running.. [optional] # noqa: E501
|
|
185
185
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
186
|
-
is_auto_daily_pacing (bool): [optional] if omitted the server will use the default value of False # noqa: E501
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
target_bid (float, none_type): [optional] # noqa: E501
|
|
186
|
+
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
|
|
187
|
+
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
188
|
+
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
189
|
+
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
190
|
+
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
191
191
|
"""
|
|
192
192
|
|
|
193
193
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -246,9 +246,9 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
246
246
|
"""SponsoredProductsLineItemCreateRequestModel - a model defined in OpenAPI
|
|
247
247
|
|
|
248
248
|
Args:
|
|
249
|
-
name (str):
|
|
250
|
-
start_date (datetime):
|
|
251
|
-
target_retailer_id (str):
|
|
249
|
+
name (str): The name of the line item.
|
|
250
|
+
start_date (datetime): The date and time when the line item should start running.
|
|
251
|
+
target_retailer_id (str): The ID of the retailer to target for this line item.
|
|
252
252
|
|
|
253
253
|
Keyword Args:
|
|
254
254
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -281,18 +281,16 @@ class SponsoredProductsLineItemCreateRequestModel(ModelNormal):
|
|
|
281
281
|
Animal class but this time we won't travel
|
|
282
282
|
through its discriminator because we passed in
|
|
283
283
|
_visited_composed_classes = (Animal,)
|
|
284
|
-
bid_strategy (str): [optional] if omitted the server will use the default value of "conversion" # noqa: E501
|
|
285
|
-
budget (float, none_type): [optional] # noqa: E501
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
defensive_adstrategy_enabled (bool, none_type): [optional] # noqa: E501
|
|
289
|
-
end_date (datetime, none_type): [optional] # noqa: E501
|
|
284
|
+
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
|
|
285
|
+
budget (float, none_type): The total budget allocated for this line item.. [optional] # noqa: E501
|
|
286
|
+
daily_pacing (float, none_type): The daily pacing limit for budget spending.. [optional] # noqa: E501
|
|
287
|
+
end_date (datetime, none_type): The date and time when the line item should stop running.. [optional] # noqa: E501
|
|
290
288
|
flight_schedule (FlightSchedule): [optional] # noqa: E501
|
|
291
|
-
is_auto_daily_pacing (bool): [optional] if omitted the server will use the default value of False # noqa: E501
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
target_bid (float, none_type): [optional] # noqa: E501
|
|
289
|
+
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
|
|
290
|
+
keyword_strategy (str, none_type): The keyword targeting strategy for this line item.. [optional] # noqa: E501
|
|
291
|
+
max_bid (float, none_type): The maximum bid amount allowed for this line item.. [optional] # noqa: E501
|
|
292
|
+
monthly_pacing (float, none_type): The monthly pacing limit for budget spending.. [optional] # noqa: E501
|
|
293
|
+
target_bid (float, none_type): The target bid amount for the line item.. [optional] # noqa: E501
|
|
296
294
|
"""
|
|
297
295
|
|
|
298
296
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -98,6 +98,12 @@ class SyncAttributedTransactionsReport(ModelNormal):
|
|
|
98
98
|
'ACTIVITYSELLERID': "activitySellerId",
|
|
99
99
|
'ACTIVITYSELLERNAME': "activitySellerName",
|
|
100
100
|
},
|
|
101
|
+
('media_type',): {
|
|
102
|
+
'UNKNOWN': "unknown",
|
|
103
|
+
'VIDEO': "video",
|
|
104
|
+
'DISPLAY': "display",
|
|
105
|
+
'ALL': "all",
|
|
106
|
+
},
|
|
101
107
|
('metrics',): {
|
|
102
108
|
'ATTRIBUTEDUNITS': "attributedUnits",
|
|
103
109
|
'ATTRIBUTEDSALES': "attributedSales",
|
|
@@ -148,6 +154,7 @@ class SyncAttributedTransactionsReport(ModelNormal):
|
|
|
148
154
|
'click_attribution_window': (str,), # noqa: E501
|
|
149
155
|
'dimensions': ([str],), # noqa: E501
|
|
150
156
|
'line_item_ids': ([str],), # noqa: E501
|
|
157
|
+
'media_type': (str,), # noqa: E501
|
|
151
158
|
'metrics': ([str],), # noqa: E501
|
|
152
159
|
'sales_channel': (str,), # noqa: E501
|
|
153
160
|
'timezone': (str,), # noqa: E501
|
|
@@ -168,6 +175,7 @@ class SyncAttributedTransactionsReport(ModelNormal):
|
|
|
168
175
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
169
176
|
'dimensions': 'dimensions', # noqa: E501
|
|
170
177
|
'line_item_ids': 'lineItemIds', # noqa: E501
|
|
178
|
+
'media_type': 'mediaType', # noqa: E501
|
|
171
179
|
'metrics': 'metrics', # noqa: E501
|
|
172
180
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
173
181
|
'timezone': 'timezone', # noqa: E501
|
|
@@ -225,6 +233,7 @@ class SyncAttributedTransactionsReport(ModelNormal):
|
|
|
225
233
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
226
234
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
227
235
|
line_item_ids ([str]): Line item ids to filter. [optional] # noqa: E501
|
|
236
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
228
237
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
229
238
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
230
239
|
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|
|
@@ -327,6 +336,7 @@ class SyncAttributedTransactionsReport(ModelNormal):
|
|
|
327
336
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
328
337
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
329
338
|
line_item_ids ([str]): Line item ids to filter. [optional] # noqa: E501
|
|
339
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
330
340
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
331
341
|
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
332
342
|
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|