criteo-api-marketingsolutions-sdk 0.0.250911__py3-none-any.whl → 0.0.251009__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-marketingsolutions-sdk might be problematic. Click here for more details.

Files changed (29) hide show
  1. criteo_api_marketingsolutions_preview/__init__.py +1 -1
  2. criteo_api_marketingsolutions_preview/api/advertiser_api.py +15 -21
  3. criteo_api_marketingsolutions_preview/api/analytics_api.py +16 -62
  4. criteo_api_marketingsolutions_preview/api/audience_api.py +27 -94
  5. criteo_api_marketingsolutions_preview/api/campaign_api.py +263 -415
  6. criteo_api_marketingsolutions_preview/api/catalog_api.py +0 -1
  7. criteo_api_marketingsolutions_preview/api/creative_api.py +22 -63
  8. criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py +7 -10
  9. criteo_api_marketingsolutions_preview/api/reco_api.py +10 -32
  10. criteo_api_marketingsolutions_preview/api_client.py +4 -4
  11. criteo_api_marketingsolutions_preview/configuration.py +1 -1
  12. criteo_api_marketingsolutions_preview/model/adaptive_attributes.py +12 -12
  13. criteo_api_marketingsolutions_preview/model/adaptive_colors.py +1 -1
  14. criteo_api_marketingsolutions_preview/model/{error_description.py → adaptive_read_attributes.py} +76 -25
  15. criteo_api_marketingsolutions_preview/model/{error_code_response.py → creative_read.py} +66 -20
  16. criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py +12 -8
  17. criteo_api_marketingsolutions_preview/model/json_report_rows.py +3 -3
  18. criteo_api_marketingsolutions_preview/model/outcome.py +16 -5
  19. criteo_api_marketingsolutions_preview/model/placements_report_query_message.py +12 -8
  20. criteo_api_marketingsolutions_preview/model/{resource_collection_outcome_of_creative.py → resource_collection_outcome_of_creative_read.py} +8 -8
  21. criteo_api_marketingsolutions_preview/model/{api_error_response.py → resource_of_creative_read.py} +17 -11
  22. criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py +248 -8
  23. criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py +12 -8
  24. criteo_api_marketingsolutions_preview/models/__init__.py +4 -5
  25. {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/METADATA +3 -3
  26. {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/RECORD +28 -29
  27. criteo_api_marketingsolutions_preview/model/fail_response.py +0 -283
  28. {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/WHEEL +0 -0
  29. {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/top_level.txt +0 -0
@@ -83,6 +83,248 @@ class StatisticsReportQueryMessage(ModelNormal):
83
83
  'ADCHANNEL': "AdChannel",
84
84
  'SOCIALPLATFORM': "SocialPlatform",
85
85
  },
86
+ ('metrics',): {
87
+ 'CLICKS': "Clicks",
88
+ 'DISPLAYS': "Displays",
89
+ 'ADVERTISERCOST': "AdvertiserCost",
90
+ 'SALESPC30DCLIENTATTRIBUTION': "SalesPc30dClientAttribution",
91
+ 'SALESCLIENTATTRIBUTION': "SalesClientAttribution",
92
+ 'SALESPC30D': "SalesPc30d",
93
+ 'SALESALLPC30DCLIENTATTRIBUTION': "SalesAllPc30dClientAttribution",
94
+ 'SALESALLCLIENTATTRIBUTION': "SalesAllClientAttribution",
95
+ 'SALESALLPC30D': "SalesAllPc30d",
96
+ 'SALESPV24H': "SalesPv24h",
97
+ 'SALESALLPV24H': "SalesAllPv24h",
98
+ 'SALESPC30PV24': "SalesPc30Pv24",
99
+ 'SALESALLPC30PV24': "SalesAllPc30Pv24",
100
+ 'SALESPC30DPV24H': "SalesPc30dPv24h",
101
+ 'SALESALLPC30DPV24H': "SalesAllPc30dPv24h",
102
+ 'SALESPC7DPV24': "SalesPc7dPv24",
103
+ 'SALESALLPC7DPV24': "SalesAllPc7dPv24",
104
+ 'SALESPC7DPV24H': "SalesPc7dPv24h",
105
+ 'SALESALLPC7DPV24H': "SalesAllPc7dPv24h",
106
+ 'SALESLC': "SalesLc",
107
+ 'SALESALLLC': "SalesAllLc",
108
+ 'SALESPC7D': "SalesPc7d",
109
+ 'SALESALLPC7D': "SalesAllPc7d",
110
+ 'SALESPC1D': "SalesPc1d",
111
+ 'SALESALLPC1D': "SalesAllPc1d",
112
+ 'SALESPIPC': "SalesPiPc",
113
+ 'SALESPIPV': "SalesPiPv",
114
+ 'SALESPIPCPV': "SalesPiPcPv",
115
+ 'POSTINSTALLSALES': "PostInstallSales",
116
+ 'SALESOFFLINEPC': "SalesOfflinePc",
117
+ 'SALESOFFLINEPV': "SalesOfflinePv",
118
+ 'SALESOFFLINEPC30D': "SalesOfflinePc30d",
119
+ 'SALESOFFLINEPV24H': "SalesOfflinePv24h",
120
+ 'REVENUEGENERATEDPC30DCLIENTATTRIBUTION': "RevenueGeneratedPc30dClientAttribution",
121
+ 'REVENUEGENERATEDCLIENTATTRIBUTION': "RevenueGeneratedClientAttribution",
122
+ 'REVENUEGENERATEDPC30D': "RevenueGeneratedPc30d",
123
+ 'REVENUEGENERATEDALLPC30DCLIENTATTRIBUTION': "RevenueGeneratedAllPc30dClientAttribution",
124
+ 'REVENUEGENERATEDALLCLIENTATTRIBUTION': "RevenueGeneratedAllClientAttribution",
125
+ 'REVENUEGENERATEDALLPC30D': "RevenueGeneratedAllPc30d",
126
+ 'REVENUEGENERATEDPV24H': "RevenueGeneratedPv24h",
127
+ 'REVENUEGENERATEDALLPV24H': "RevenueGeneratedAllPv24h",
128
+ 'REVENUEGENERATEDPC30PV24': "RevenueGeneratedPc30Pv24",
129
+ 'REVENUEGENERATEDALLPC30PV24': "RevenueGeneratedAllPc30Pv24",
130
+ 'REVENUEGENERATEDPC30DPV24H': "RevenueGeneratedPc30dPv24h",
131
+ 'REVENUEGENERATEDALLPC30DPV24H': "RevenueGeneratedAllPc30dPv24h",
132
+ 'REVENUEGENERATEDPC7DPV24H': "RevenueGeneratedPc7dPv24h",
133
+ 'REVENUEGENERATEDALLPC7DPV24H': "RevenueGeneratedAllPc7dPv24h",
134
+ 'REVENUEGENERATEDPC7DPV24': "RevenueGeneratedPc7dPv24",
135
+ 'REVENUEGENERATEDALLPC7DPV24': "RevenueGeneratedAllPc7dPv24",
136
+ 'REVENUEGENERATEDLC': "RevenueGeneratedLc",
137
+ 'REVENUEGENERATEDALLLC': "RevenueGeneratedAllLc",
138
+ 'REVENUEGENERATEDPC7D': "RevenueGeneratedPc7d",
139
+ 'REVENUEGENERATEDALLPC7D': "RevenueGeneratedAllPc7d",
140
+ 'REVENUEGENERATEDPC1D': "RevenueGeneratedPc1d",
141
+ 'REVENUEGENERATEDALLPC1D': "RevenueGeneratedAllPc1d",
142
+ 'REVENUEGENERATEDOFFLINEPC': "RevenueGeneratedOfflinePc",
143
+ 'REVENUEGENERATEDOFFLINEPV': "RevenueGeneratedOfflinePv",
144
+ 'REVENUEGENERATEDOFFLINEPC30D': "RevenueGeneratedOfflinePc30d",
145
+ 'REVENUEGENERATEDOFFLINEPV24H': "RevenueGeneratedOfflinePv24h",
146
+ 'CONVERSIONRATEPC30DCLIENTATTRIBUTION': "ConversionRatePc30dClientAttribution",
147
+ 'CONVERSIONRATECLIENTATTRIBUTION': "ConversionRateClientAttribution",
148
+ 'CONVERSIONRATEPC30D': "ConversionRatePc30d",
149
+ 'CONVERSIONRATEALLPC30DCLIENTATTRIBUTION': "ConversionRateAllPc30dClientAttribution",
150
+ 'CONVERSIONRATEALLCLIENTATTRIBUTION': "ConversionRateAllClientAttribution",
151
+ 'CONVERSIONRATEALLPC30D': "ConversionRateAllPc30d",
152
+ 'CONVERSIONRATEPV24H': "ConversionRatePv24h",
153
+ 'CONVERSIONRATEALLPV24H': "ConversionRateAllPv24h",
154
+ 'CONVERSIONRATEPC30PV24': "ConversionRatePc30Pv24",
155
+ 'CONVERSIONRATEALLPC30PV24': "ConversionRateAllPc30Pv24",
156
+ 'CONVERSIONRATEPC30DPV24H': "ConversionRatePc30dPv24h",
157
+ 'CONVERSIONRATEALLPC30DPV24H': "ConversionRateAllPc30dPv24h",
158
+ 'CONVERSIONRATEPC7DPV24': "ConversionRatePc7dPv24",
159
+ 'CONVERSIONRATEALLPC7DPV24': "ConversionRateAllPc7dPv24",
160
+ 'CONVERSIONRATEPC7DPV24H': "ConversionRatePc7dPv24h",
161
+ 'CONVERSIONRATEALLPC7DPV24H': "ConversionRateAllPc7dPv24h",
162
+ 'CONVERSIONRATEPC7D': "ConversionRatePc7d",
163
+ 'CONVERSIONRATEALLPC7D': "ConversionRateAllPc7d",
164
+ 'CONVERSIONRATEPC1D': "ConversionRatePc1d",
165
+ 'CONVERSIONRATEALLPC1D': "ConversionRateAllPc1d",
166
+ 'CONVERSIONRATEPIPCPV': "ConversionRatePiPcPv",
167
+ 'POSTINSTALLCONVERSIONRATE': "PostInstallConversionRate",
168
+ 'ECOSPC30DCLIENTATTRIBUTION': "ECosPc30dClientAttribution",
169
+ 'ECOSCLIENTATTRIBUTION': "ECosClientAttribution",
170
+ 'ECOSPC30D': "ECosPc30d",
171
+ 'ECOSALLPC30DCLIENTATTRIBUTION': "ECosAllPc30dClientAttribution",
172
+ 'ECOSALLCLIENTATTRIBUTION': "ECosAllClientAttribution",
173
+ 'ECOSALLPC30D': "ECosAllPc30d",
174
+ 'ECOSPV24H': "ECosPv24h",
175
+ 'ECOSALLPV24H': "ECosAllPv24h",
176
+ 'ECOSPC30PV24': "ECosPc30Pv24",
177
+ 'ECOSALLPC30PV24': "ECosAllPc30Pv24",
178
+ 'ECOSPC30DPV24H': "ECosPc30dPv24h",
179
+ 'ECOSALLPC30DPV24H': "ECosAllPc30dPv24h",
180
+ 'ECOSPC7DPV24H': "ECosPc7dPv24h",
181
+ 'ECOSALLPC7DPV24H': "ECosAllPc7dPv24h",
182
+ 'ECOSPC7DPV24': "ECosPc7dPv24",
183
+ 'ECOSALLPC7DPV24': "ECosAllPc7dPv24",
184
+ 'ECOSPC7D': "ECosPc7d",
185
+ 'ECOSALLPC7D': "ECosAllPc7d",
186
+ 'ECOSPC1D': "ECosPc1d",
187
+ 'ECOSALLPC1D': "ECosAllPc1d",
188
+ 'COSTPERORDERPC30DCLIENTATTRIBUTION': "CostPerOrderPc30dClientAttribution",
189
+ 'COSTPERORDERCLIENTATTRIBUTION': "CostPerOrderClientAttribution",
190
+ 'COSTPERORDERPC30D': "CostPerOrderPc30d",
191
+ 'COSTPERORDERALLPC30DCLIENTATTRIBUTION': "CostPerOrderAllPc30dClientAttribution",
192
+ 'COSTPERORDERALLCLIENTATTRIBUTION': "CostPerOrderAllClientAttribution",
193
+ 'COSTPERORDERALLPC30D': "CostPerOrderAllPc30d",
194
+ 'COSTPERORDERPV24H': "CostPerOrderPv24h",
195
+ 'COSTPERORDERALLPV24H': "CostPerOrderAllPv24h",
196
+ 'COSTPERORDERPC30PV24': "CostPerOrderPc30Pv24",
197
+ 'COSTPERORDERALLPC30PV24': "CostPerOrderAllPc30Pv24",
198
+ 'COSTPERORDERPC30DPV24H': "CostPerOrderPc30dPv24h",
199
+ 'COSTPERORDERALLPC30DPV24H': "CostPerOrderAllPc30dPv24h",
200
+ 'COSTPERORDERPC7DPV24H': "CostPerOrderPc7dPv24h",
201
+ 'COSTPERORDERALLPC7DPV24H': "CostPerOrderAllPc7dPv24h",
202
+ 'COSTPERORDERPC7DPV24': "CostPerOrderPc7dPv24",
203
+ 'COSTPERORDERALLPC7DPV24': "CostPerOrderAllPc7dPv24",
204
+ 'COSTPERORDERPC7D': "CostPerOrderPc7d",
205
+ 'COSTPERORDERALLPC7D': "CostPerOrderAllPc7d",
206
+ 'COSTPERORDERPC1D': "CostPerOrderPc1d",
207
+ 'COSTPERORDERALLPC1D': "CostPerOrderAllPc1d",
208
+ 'EXPOSEDUSERS': "ExposedUsers",
209
+ 'AUDIENCE': "Audience",
210
+ 'REACH': "Reach",
211
+ 'AVERAGECARTPC30DCLIENTATTRIBUTION': "AverageCartPc30dClientAttribution",
212
+ 'AVERAGECARTALLPC30DCLIENTATTRIBUTION': "AverageCartAllPc30dClientAttribution",
213
+ 'AVERAGECARTCLIENTATTRIBUTION': "AverageCartClientAttribution",
214
+ 'AVERAGECARTALLCLIENTATTRIBUTION': "AverageCartAllClientAttribution",
215
+ 'AVERAGECARTPC30D': "AverageCartPc30d",
216
+ 'AVERAGECARTALLPC30D': "AverageCartAllPc30d",
217
+ 'AVERAGECARTPV24H': "AverageCartPv24h",
218
+ 'AVERAGECARTALLPV24H': "AverageCartAllPv24h",
219
+ 'AVERAGECARTPC1D': "AverageCartPc1d",
220
+ 'AVERAGECARTALLPC1D': "AverageCartAllPc1d",
221
+ 'AVERAGECARTPC7D': "AverageCartPc7d",
222
+ 'AVERAGECARTALLPC7D': "AverageCartAllPc7d",
223
+ 'AVERAGECARTPC30PV24': "AverageCartPc30Pv24",
224
+ 'AVERAGECARTALLPC30PV24': "AverageCartAllPc30Pv24",
225
+ 'AVERAGECARTPC30DPV24H': "AverageCartPc30dPv24h",
226
+ 'AVERAGECARTALLPC30DPV24H': "AverageCartAllPc30dPv24h",
227
+ 'AVERAGECARTPC7DPV24H': "AverageCartPc7dPv24h",
228
+ 'AVERAGECARTALLPC7DPV24H': "AverageCartAllPc7dPv24h",
229
+ 'AVERAGECARTPC7DPV24': "AverageCartPc7dPv24",
230
+ 'AVERAGECARTALLPC7DPV24': "AverageCartAllPc7dPv24",
231
+ 'CLICKTHROUGHRATE': "ClickThroughRate",
232
+ 'ECPC': "ECpc",
233
+ 'CPC': "Cpc",
234
+ 'ECPM': "ECpm",
235
+ 'RETURNONADVERTISINGSPENDINGCLIENTATTRIBUTION': "ReturnOnAdvertisingSpendingClientAttribution",
236
+ 'RETURNONADVERTISINGSPENDINGALLCLIENTATTRIBUTION': "ReturnOnAdvertisingSpendingAllClientAttribution",
237
+ 'ADVERTISERVALUE': "AdvertiserValue",
238
+ 'ADVERTISERALLVALUE': "AdvertiserAllValue",
239
+ 'COSTOFADVERTISERVALUE': "CostOfAdvertiserValue",
240
+ 'COSTOFADVERTISERVALUEALL': "CostOfAdvertiserValueAll",
241
+ 'APPINSTALLSPCPV': "AppInstallsPcPv",
242
+ 'APPINSTALLS': "AppInstalls",
243
+ 'QUALIFIEDVISITS': "QualifiedVisits",
244
+ 'VISITS': "Visits",
245
+ 'VISITSPV1D': "VisitsPV1D",
246
+ 'ORDERVALUEPI': "OrderValuePi",
247
+ 'POSTINSTALLORDERVALUE': "PostInstallOrderValue",
248
+ 'BOUNCERATE': "BounceRate",
249
+ 'COSTPERINSTALLPCPV': "CostPerInstallPcPv",
250
+ 'COSTPERINSTALL': "CostPerInstall",
251
+ 'COSTPERVISIT': "CostPerVisit",
252
+ 'COSTPERVISITPV1D': "CostPerVisitPV1D",
253
+ 'COSTPERQUALIFIEDVISIT': "CostPerQualifiedVisit",
254
+ 'INSTALLRATEPCPV': "InstallRatePcPv",
255
+ 'INSTALLRATE': "InstallRate",
256
+ 'OMNICHANNELROASPC30D': "OmnichannelRoasPc30d",
257
+ 'OMNICHANNELROASALLPC30D': "OmnichannelRoasAllPc30d",
258
+ 'OMNICHANNELREVENUEPC30D': "OmnichannelRevenuePc30d",
259
+ 'OMNICHANNELREVENUEALLPC30D': "OmnichannelRevenueAllPc30d",
260
+ 'OMNICHANNELSALESPC30D': "OmnichannelSalesPc30d",
261
+ 'OMNICHANNELSALESALLPC30D': "OmnichannelSalesAllPc30d",
262
+ 'OMNICHANNELROASALLPV24H': "OmnichannelRoasAllPv24h",
263
+ 'OMNICHANNELROASPV24H': "OmnichannelRoasPv24h",
264
+ 'OMNICHANNELREVENUEALLPV24H': "OmnichannelRevenueAllPv24h",
265
+ 'OMNICHANNELREVENUEPV24H': "OmnichannelRevenuePv24h",
266
+ 'OMNICHANNELSALESALLPV24H': "OmnichannelSalesAllPv24h",
267
+ 'OMNICHANNELSALESPV24H': "OmnichannelSalesPv24h",
268
+ 'OMNICHANNELROASCLIENTATTRIBUTION': "OmnichannelRoasClientAttribution",
269
+ 'OMNICHANNELREVENUECLIENTATTRIBUTION': "OmnichannelRevenueClientAttribution",
270
+ 'OMNICHANNELSALESCLIENTATTRIBUTION': "OmnichannelSalesClientAttribution",
271
+ 'ROASALLPC30DCLIENTATTRIBUTION': "RoasAllPc30dClientAttribution",
272
+ 'ROASPC30DCLIENTATTRIBUTION': "RoasPc30dClientAttribution",
273
+ 'ROASALLCLIENTATTRIBUTION': "RoasAllClientAttribution",
274
+ 'ROASCLIENTATTRIBUTION': "RoasClientAttribution",
275
+ 'ROASALLPC30D': "RoasAllPc30d",
276
+ 'ROASPC30D': "RoasPc30d",
277
+ 'ROASALLPC7D': "RoasAllPc7d",
278
+ 'ROASPC7D': "RoasPc7d",
279
+ 'ROASALLPC1D': "RoasAllPc1d",
280
+ 'ROASPC1D': "RoasPc1d",
281
+ 'ROASALLPV24H': "RoasAllPv24h",
282
+ 'ROASPV24H': "RoasPv24h",
283
+ 'ROASPC30PV24': "RoasPc30Pv24",
284
+ 'ROASALLPC30PV24': "RoasAllPc30Pv24",
285
+ 'ROASPC30DPV24H': "RoasPc30dPv24h",
286
+ 'ROASALLPC30DPV24H': "RoasAllPc30dPv24h",
287
+ 'ROASPC7DPV24': "RoasPc7dPv24",
288
+ 'ROASALLPC7DPV24': "RoasAllPc7dPv24",
289
+ 'ROASPC7DPV24H': "RoasPc7dPv24h",
290
+ 'ROASALLPC7DPV24H': "RoasAllPc7dPv24h",
291
+ 'COSTOFSALEPI': "CostOfSalePi",
292
+ 'COSTPERORDERPI': "CostPerOrderPi",
293
+ 'POSTINSTALLCOSTOFSALE': "PostInstallCostOfSale",
294
+ 'POSTINSTALLCOSTPERORDER': "PostInstallCostPerOrder",
295
+ 'RETURNONADVERTISERSPENDINGPI': "ReturnOnAdvertiserSpendingPi",
296
+ 'POSTINSTALLROAS': "PostInstallRoas",
297
+ 'RETURNONADVERTISERSPENDINGOFFLINEPC': "ReturnOnAdvertiserSpendingOfflinePc",
298
+ 'RETURNONADVERTISERSPENDINGOFFLINEPV': "ReturnOnAdvertiserSpendingOfflinePv",
299
+ 'ROASOFFLINEPC30D': "RoasOfflinePc30d",
300
+ 'ROASOFFLINEPV24H': "RoasOfflinePv24h",
301
+ 'POTENTIALDISPLAYS': "PotentialDisplays",
302
+ 'OVERALLCOMPETITIONWIN': "OverallCompetitionWin",
303
+ 'VIEWABLEDISPLAYS': "ViewableDisplays",
304
+ 'NONVIEWABLEDISPLAYS': "NonViewableDisplays",
305
+ 'UNTRACKABLEDISPLAYS': "UntrackableDisplays",
306
+ 'FREQUENCY': "Frequency",
307
+ 'INVALIDDISPLAYS': "InvalidDisplays",
308
+ 'INVALIDCLICKS': "InvalidClicks",
309
+ 'RESULTTYPE': "ResultType",
310
+ 'VIDEOSTARTED': "VideoStarted",
311
+ 'VIDEOFIRSTQUARTILE': "VideoFirstQuartile",
312
+ 'VIDEOMIDPOINT': "VideoMidpoint",
313
+ 'VIDEOTHIRDQUARTILE': "VideoThirdQuartile",
314
+ 'VIDEOCOMPLETED': "VideoCompleted",
315
+ 'VIDEOAVOC': "VideoAvoc",
316
+ 'VIDEOSTARTRATE': "VideoStartRate",
317
+ 'VIDEOCOMPLETIONRATE': "VideoCompletionRate",
318
+ 'VIDEOAVERAGEVIEWRATE': "VideoAverageViewRate",
319
+ 'VIDEOCPV': "VideoCpv",
320
+ 'VIDEOCPCV': "VideoCpcv",
321
+ },
322
+ ('format',): {
323
+ 'CSV': "csv",
324
+ 'EXCEL': "excel",
325
+ 'XML': "xml",
326
+ 'JSON': "json",
327
+ },
86
328
  }
87
329
 
88
330
  validations = {
@@ -106,13 +348,13 @@ class StatisticsReportQueryMessage(ModelNormal):
106
348
  'currency': (str,), # noqa: E501
107
349
  'dimensions': ([str],), # noqa: E501
108
350
  'end_date': (datetime,), # noqa: E501
109
- 'format': (str,), # noqa: E501
110
351
  'metrics': ([str],), # noqa: E501
111
352
  'start_date': (datetime,), # noqa: E501
112
353
  'ad_set_ids': ([str], none_type,), # noqa: E501
113
354
  'ad_set_names': ([str], none_type,), # noqa: E501
114
355
  'ad_set_status': ([str], none_type,), # noqa: E501
115
356
  'advertiser_ids': (str, none_type,), # noqa: E501
357
+ 'format': (str,), # noqa: E501
116
358
  'timezone': (str, none_type,), # noqa: E501
117
359
  }
118
360
 
@@ -125,13 +367,13 @@ class StatisticsReportQueryMessage(ModelNormal):
125
367
  'currency': 'currency', # noqa: E501
126
368
  'dimensions': 'dimensions', # noqa: E501
127
369
  'end_date': 'endDate', # noqa: E501
128
- 'format': 'format', # noqa: E501
129
370
  'metrics': 'metrics', # noqa: E501
130
371
  'start_date': 'startDate', # noqa: E501
131
372
  'ad_set_ids': 'adSetIds', # noqa: E501
132
373
  'ad_set_names': 'adSetNames', # noqa: E501
133
374
  'ad_set_status': 'adSetStatus', # noqa: E501
134
375
  'advertiser_ids': 'advertiserIds', # noqa: E501
376
+ 'format': 'format', # noqa: E501
135
377
  'timezone': 'timezone', # noqa: E501
136
378
  }
137
379
 
@@ -142,14 +384,13 @@ class StatisticsReportQueryMessage(ModelNormal):
142
384
 
143
385
  @classmethod
144
386
  @convert_js_args_to_python_args
145
- def _from_openapi_data(cls, currency, dimensions, end_date, format, metrics, start_date, *args, **kwargs): # noqa: E501
387
+ def _from_openapi_data(cls, currency, dimensions, end_date, metrics, start_date, *args, **kwargs): # noqa: E501
146
388
  """StatisticsReportQueryMessage - a model defined in OpenAPI
147
389
 
148
390
  Args:
149
391
  currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
150
392
  dimensions ([str]): The dimensions for the report.
151
393
  end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
152
- format (str): The file format of the generated report: csv, xml, excel or json.
153
394
  metrics ([str]): The list of metrics to report.
154
395
  start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
155
396
 
@@ -188,6 +429,7 @@ class StatisticsReportQueryMessage(ModelNormal):
188
429
  ad_set_names ([str], none_type): list of adSets names. If empty, all the adSets will be fetched. [optional] # noqa: E501
189
430
  ad_set_status ([str], none_type): list of adSets status. If empty, all the adSets will be fetched. [optional] # noqa: E501
190
431
  advertiser_ids (str, none_type): The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used. [optional] # noqa: E501
432
+ format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json" # noqa: E501
191
433
  timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
192
434
  """
193
435
 
@@ -223,7 +465,6 @@ class StatisticsReportQueryMessage(ModelNormal):
223
465
  self.currency = currency
224
466
  self.dimensions = dimensions
225
467
  self.end_date = end_date
226
- self.format = format
227
468
  self.metrics = metrics
228
469
  self.start_date = start_date
229
470
  for var_name, var_value in kwargs.items():
@@ -246,14 +487,13 @@ class StatisticsReportQueryMessage(ModelNormal):
246
487
  ])
247
488
 
248
489
  @convert_js_args_to_python_args
249
- def __init__(self, currency, dimensions, end_date, format, metrics, start_date, *args, **kwargs): # noqa: E501
490
+ def __init__(self, currency, dimensions, end_date, metrics, start_date, *args, **kwargs): # noqa: E501
250
491
  """StatisticsReportQueryMessage - a model defined in OpenAPI
251
492
 
252
493
  Args:
253
494
  currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
254
495
  dimensions ([str]): The dimensions for the report.
255
496
  end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
256
- format (str): The file format of the generated report: csv, xml, excel or json.
257
497
  metrics ([str]): The list of metrics to report.
258
498
  start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
259
499
 
@@ -292,6 +532,7 @@ class StatisticsReportQueryMessage(ModelNormal):
292
532
  ad_set_names ([str], none_type): list of adSets names. If empty, all the adSets will be fetched. [optional] # noqa: E501
293
533
  ad_set_status ([str], none_type): list of adSets status. If empty, all the adSets will be fetched. [optional] # noqa: E501
294
534
  advertiser_ids (str, none_type): The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used. [optional] # noqa: E501
535
+ format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json" # noqa: E501
295
536
  timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
296
537
  """
297
538
 
@@ -325,7 +566,6 @@ class StatisticsReportQueryMessage(ModelNormal):
325
566
  self.currency = currency
326
567
  self.dimensions = dimensions
327
568
  self.end_date = end_date
328
- self.format = format
329
569
  self.metrics = metrics
330
570
  self.start_date = start_date
331
571
  for var_name, var_value in kwargs.items():
@@ -55,6 +55,12 @@ class TransactionsReportQueryMessage(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
+ ('format',): {
59
+ 'CSV': "csv",
60
+ 'EXCEL': "excel",
61
+ 'XML': "xml",
62
+ 'JSON': "json",
63
+ },
58
64
  }
59
65
 
60
66
  validations = {
@@ -77,10 +83,10 @@ class TransactionsReportQueryMessage(ModelNormal):
77
83
  return {
78
84
  'currency': (str,), # noqa: E501
79
85
  'end_date': (datetime,), # noqa: E501
80
- 'format': (str,), # noqa: E501
81
86
  'start_date': (datetime,), # noqa: E501
82
87
  'advertiser_ids': (str, none_type,), # noqa: E501
83
88
  'event_type': (str, none_type,), # noqa: E501
89
+ 'format': (str,), # noqa: E501
84
90
  'timezone': (str, none_type,), # noqa: E501
85
91
  }
86
92
 
@@ -92,10 +98,10 @@ class TransactionsReportQueryMessage(ModelNormal):
92
98
  attribute_map = {
93
99
  'currency': 'currency', # noqa: E501
94
100
  'end_date': 'endDate', # noqa: E501
95
- 'format': 'format', # noqa: E501
96
101
  'start_date': 'startDate', # noqa: E501
97
102
  'advertiser_ids': 'advertiserIds', # noqa: E501
98
103
  'event_type': 'eventType', # noqa: E501
104
+ 'format': 'format', # noqa: E501
99
105
  'timezone': 'timezone', # noqa: E501
100
106
  }
101
107
 
@@ -106,13 +112,12 @@ class TransactionsReportQueryMessage(ModelNormal):
106
112
 
107
113
  @classmethod
108
114
  @convert_js_args_to_python_args
109
- def _from_openapi_data(cls, currency, end_date, format, start_date, *args, **kwargs): # noqa: E501
115
+ def _from_openapi_data(cls, currency, end_date, start_date, *args, **kwargs): # noqa: E501
110
116
  """TransactionsReportQueryMessage - a model defined in OpenAPI
111
117
 
112
118
  Args:
113
119
  currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
114
120
  end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
115
- format (str): The file format of the generated report: csv, xml, excel or json.
116
121
  start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
117
122
 
118
123
  Keyword Args:
@@ -148,6 +153,7 @@ class TransactionsReportQueryMessage(ModelNormal):
148
153
  _visited_composed_classes = (Animal,)
149
154
  advertiser_ids (str, none_type): The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used. [optional] # noqa: E501
150
155
  event_type (str, none_type): Apply a filter on Event type .. [optional] # noqa: E501
156
+ format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json" # noqa: E501
151
157
  timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
152
158
  """
153
159
 
@@ -182,7 +188,6 @@ class TransactionsReportQueryMessage(ModelNormal):
182
188
 
183
189
  self.currency = currency
184
190
  self.end_date = end_date
185
- self.format = format
186
191
  self.start_date = start_date
187
192
  for var_name, var_value in kwargs.items():
188
193
  if var_name not in self.attribute_map and \
@@ -204,13 +209,12 @@ class TransactionsReportQueryMessage(ModelNormal):
204
209
  ])
205
210
 
206
211
  @convert_js_args_to_python_args
207
- def __init__(self, currency, end_date, format, start_date, *args, **kwargs): # noqa: E501
212
+ def __init__(self, currency, end_date, start_date, *args, **kwargs): # noqa: E501
208
213
  """TransactionsReportQueryMessage - a model defined in OpenAPI
209
214
 
210
215
  Args:
211
216
  currency (str): The currency used for the report. ISO 4217 code (three-letter capitals).
212
217
  end_date (datetime): End date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
213
- format (str): The file format of the generated report: csv, xml, excel or json.
214
218
  start_date (datetime): Start date of the report. Date component of ISO 8061 format, any time or timezone component is ignored.
215
219
 
216
220
  Keyword Args:
@@ -246,6 +250,7 @@ class TransactionsReportQueryMessage(ModelNormal):
246
250
  _visited_composed_classes = (Animal,)
247
251
  advertiser_ids (str, none_type): The comma-separated list of advertiser ids. If empty, all the advertisers in the portfolio will be used. [optional] # noqa: E501
248
252
  event_type (str, none_type): Apply a filter on Event type .. [optional] # noqa: E501
253
+ format (str): The file format of the generated report. [optional] if omitted the server will use the default value of "json" # noqa: E501
249
254
  timezone (str, none_type): The timezone used for the report. Timezone Database format (Tz).. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
250
255
  """
251
256
 
@@ -278,7 +283,6 @@ class TransactionsReportQueryMessage(ModelNormal):
278
283
 
279
284
  self.currency = currency
280
285
  self.end_date = end_date
281
- self.format = format
282
286
  self.start_date = start_date
283
287
  for var_name, var_value in kwargs.items():
284
288
  if var_name not in self.attribute_map and \
@@ -45,10 +45,10 @@ from criteo_api_marketingsolutions_preview.model.ad_set_targeting_video_position
45
45
  from criteo_api_marketingsolutions_preview.model.ad_write import AdWrite
46
46
  from criteo_api_marketingsolutions_preview.model.adaptive_attributes import AdaptiveAttributes
47
47
  from criteo_api_marketingsolutions_preview.model.adaptive_colors import AdaptiveColors
48
+ from criteo_api_marketingsolutions_preview.model.adaptive_read_attributes import AdaptiveReadAttributes
48
49
  from criteo_api_marketingsolutions_preview.model.adaptive_write_attributes import AdaptiveWriteAttributes
49
50
  from criteo_api_marketingsolutions_preview.model.advertiser_dataset_list_response import AdvertiserDatasetListResponse
50
51
  from criteo_api_marketingsolutions_preview.model.algebra_node_v1 import AlgebraNodeV1
51
- from criteo_api_marketingsolutions_preview.model.api_error_response import ApiErrorResponse
52
52
  from criteo_api_marketingsolutions_preview.model.api_request_of_targeting_entity import ApiRequestOfTargetingEntity
53
53
  from criteo_api_marketingsolutions_preview.model.api_response_of_targeting_entity import ApiResponseOfTargetingEntity
54
54
  from criteo_api_marketingsolutions_preview.model.application_summary_model import ApplicationSummaryModel
@@ -163,6 +163,7 @@ from criteo_api_marketingsolutions_preview.model.create_image_slide import Creat
163
163
  from criteo_api_marketingsolutions_preview.model.create_product_filter_request import CreateProductFilterRequest
164
164
  from criteo_api_marketingsolutions_preview.model.create_product_set_request import CreateProductSetRequest
165
165
  from criteo_api_marketingsolutions_preview.model.creative import Creative
166
+ from criteo_api_marketingsolutions_preview.model.creative_read import CreativeRead
166
167
  from criteo_api_marketingsolutions_preview.model.creative_write import CreativeWrite
167
168
  from criteo_api_marketingsolutions_preview.model.criteo_api_error import CriteoApiError
168
169
  from criteo_api_marketingsolutions_preview.model.criteo_api_warning import CriteoApiWarning
@@ -178,13 +179,10 @@ from criteo_api_marketingsolutions_preview.model.entity_of_portfolio_message imp
178
179
  from criteo_api_marketingsolutions_preview.model.entity_v2_of_dataset import EntityV2OfDataset
179
180
  from criteo_api_marketingsolutions_preview.model.entity_v2_of_object import EntityV2OfObject
180
181
  from criteo_api_marketingsolutions_preview.model.entity_wrapper_of_targeting_entity import EntityWrapperOfTargetingEntity
181
- from criteo_api_marketingsolutions_preview.model.error_code_response import ErrorCodeResponse
182
- from criteo_api_marketingsolutions_preview.model.error_description import ErrorDescription
183
182
  from criteo_api_marketingsolutions_preview.model.export_column import ExportColumn
184
183
  from criteo_api_marketingsolutions_preview.model.export_meta_data import ExportMetaData
185
184
  from criteo_api_marketingsolutions_preview.model.export_result import ExportResult
186
185
  from criteo_api_marketingsolutions_preview.model.export_result_data import ExportResultData
187
- from criteo_api_marketingsolutions_preview.model.fail_response import FailResponse
188
186
  from criteo_api_marketingsolutions_preview.model.generate_audience_performance_report import GenerateAudiencePerformanceReport
189
187
  from criteo_api_marketingsolutions_preview.model.generate_audience_performance_report_request import GenerateAudiencePerformanceReportRequest
190
188
  from criteo_api_marketingsolutions_preview.model.generate_audience_performance_report_resource import GenerateAudiencePerformanceReportResource
@@ -312,7 +310,7 @@ from criteo_api_marketingsolutions_preview.model.requests_ad_set_id import Reque
312
310
  from criteo_api_marketingsolutions_preview.model.requests_patch_ad_set_v24_q3 import RequestsPatchAdSetV24Q3
313
311
  from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_ad import ResourceCollectionOutcomeOfAd
314
312
  from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_coupon import ResourceCollectionOutcomeOfCoupon
315
- from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_creative import ResourceCollectionOutcomeOfCreative
313
+ from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_creative_read import ResourceCollectionOutcomeOfCreativeRead
316
314
  from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_product_set import ResourceCollectionOutcomeOfProductSet
317
315
  from criteo_api_marketingsolutions_preview.model.resource_input_of_ad_write import ResourceInputOfAdWrite
318
316
  from criteo_api_marketingsolutions_preview.model.resource_input_of_create_coupon import ResourceInputOfCreateCoupon
@@ -324,6 +322,7 @@ from criteo_api_marketingsolutions_preview.model.resource_of_coupon import Resou
324
322
  from criteo_api_marketingsolutions_preview.model.resource_of_coupon_supported_sizes import ResourceOfCouponSupportedSizes
325
323
  from criteo_api_marketingsolutions_preview.model.resource_of_create_coupon import ResourceOfCreateCoupon
326
324
  from criteo_api_marketingsolutions_preview.model.resource_of_creative import ResourceOfCreative
325
+ from criteo_api_marketingsolutions_preview.model.resource_of_creative_read import ResourceOfCreativeRead
327
326
  from criteo_api_marketingsolutions_preview.model.resource_of_creative_write import ResourceOfCreativeWrite
328
327
  from criteo_api_marketingsolutions_preview.model.resource_of_product_set import ResourceOfProductSet
329
328
  from criteo_api_marketingsolutions_preview.model.resource_of_update_coupon import ResourceOfUpdateCoupon
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: criteo-api-marketingsolutions-sdk
3
- Version: 0.0.250911
3
+ Version: 0.0.251009
4
4
  Summary: Criteo API SDK
5
5
  Home-page: https://github.com/criteo/criteo-api-python-sdk
6
6
  Author: Criteo
@@ -35,9 +35,9 @@ IMPORTANT: This Python package links to Criteo production environment. Any test
35
35
 
36
36
 
37
37
  ```sh
38
- pip install criteo-api-marketingsolutions-sdk==0.0.250911
38
+ pip install criteo-api-marketingsolutions-sdk==0.0.251009
39
39
  ```
40
- (you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.250911`)
40
+ (you may need to run `pip` with root permission: `sudo pip install criteo-api-marketingsolutions-sdk==0.0.251009`)
41
41
 
42
42
  Then import the package:
43
43
  ```python