criteo-api-retailmedia-sdk 2023.7.0.240207__py3-none-any.whl → 2023.7.0.240515__py3-none-any.whl

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

Potentially problematic release.

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

Files changed (35) hide show
  1. {criteo_api_retailmedia_sdk-2023.7.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240515.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2023.7.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240515.dist-info}/RECORD +33 -29
  3. {criteo_api_retailmedia_sdk-2023.7.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240515.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_v2023_07/__init__.py +1 -1
  5. criteo_api_retailmedia_v2023_07/api/campaign_api.py +38 -48
  6. criteo_api_retailmedia_v2023_07/api_client.py +1 -1
  7. criteo_api_retailmedia_v2023_07/configuration.py +1 -1
  8. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
  9. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_set_bids_model.py → add_remove_keywords_model.py} +9 -18
  10. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_set_bids_model_request.py → add_remove_keywords_model_request.py} +9 -16
  11. criteo_api_retailmedia_v2023_07/model/add_remove_keywords_model_resource.py +270 -0
  12. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_proposal_status_model_resource.py → approval_status_model.py} +86 -77
  13. criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py +74 -59
  14. criteo_api_retailmedia_v2023_07/model/async_line_items_report.py +74 -60
  15. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
  16. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
  17. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
  18. criteo_api_retailmedia_v2023_07/model/keywords_model_resource.py +270 -0
  19. criteo_api_retailmedia_v2023_07/model/keywords_model_response.py +274 -0
  20. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_keywords_model_resource.py → match_type_model.py} +85 -77
  21. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_set_bids_model_resource.py → negotiation_state_model.py} +87 -77
  22. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
  23. criteo_api_retailmedia_v2023_07/model/proposal_status_model_resource.py +270 -0
  24. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_resource_outcome.py → proposal_status_model_response.py} +18 -23
  25. criteo_api_retailmedia_v2023_07/model/resource_outcome.py +268 -0
  26. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → review_state_model.py} +88 -77
  27. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
  28. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
  29. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_add_remove_keywords_model.py → set_bids_model.py} +9 -18
  30. criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_add_remove_keywords_model_request.py → set_bids_model_request.py} +9 -16
  31. criteo_api_retailmedia_v2023_07/model/set_bids_model_resource.py +270 -0
  32. criteo_api_retailmedia_v2023_07/models/__init__.py +22 -18
  33. criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_keywords_model_response.py +0 -285
  34. criteo_api_retailmedia_v2023_07/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
  35. {criteo_api_retailmedia_sdk-2023.7.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240515.dist-info}/top_level.txt +0 -0
criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py CHANGED
@@ -55,50 +55,15 @@ class AsyncCampaignsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('metrics',): {
59
- 'None': None,
60
- 'IMPRESSIONS': "impressions",
61
- 'CLICKS': "clicks",
62
- 'SPEND': "spend",
63
- 'ATTRIBUTEDSALES': "attributedSales",
64
- 'ATTRIBUTEDUNITS': "attributedUnits",
65
- 'ATTRIBUTEDORDERS': "attributedOrders",
66
- 'CTR': "ctr",
67
- 'CPC': "cpc",
68
- 'CPO': "cpo",
69
- 'CPM': "cpm",
70
- 'ROAS': "roas",
71
- 'UNIQUEVISITORS': "uniqueVisitors",
72
- 'FREQUENCY': "frequency",
73
- 'ASSISTEDUNITS': "assistedUnits",
74
- 'ASSISTEDSALES': "assistedSales",
75
- },
76
- ('dimensions',): {
77
- 'None': None,
78
- 'DATE': "date",
79
- 'HOUR': "hour",
80
- 'CAMPAIGNID': "campaignId",
81
- 'CAMPAIGNNAME': "campaignName",
82
- 'CAMPAIGNTYPENAME': "campaignTypeName",
83
- 'ADVPRODUCTCATEGORY': "advProductCategory",
84
- 'ADVPRODUCTID': "advProductId",
85
- 'ADVPRODUCTNAME': "advProductName",
86
- 'BRANDID': "brandId",
87
- 'BRANDNAME': "brandName",
88
- 'PAGETYPENAME': "pageTypeName",
89
- 'ENVIRONMENT': "environment",
90
- 'KEYWORD': "keyword",
91
- 'SALESCHANNEL': "salesChannel",
92
- 'RETAILERID': "retailerId",
93
- 'RETAILERNAME': "retailerName",
94
- },
95
58
  ('campaign_type',): {
96
59
  'None': None,
60
+ 'ALL': "all",
97
61
  'SPONSOREDPRODUCTS': "sponsoredProducts",
98
62
  'ONSITEDISPLAYS': "onSiteDisplays",
99
63
  },
100
64
  ('sales_channel',): {
101
65
  'None': None,
66
+ 'ALL': "all",
102
67
  'OFFLINE': "offline",
103
68
  'ONLINE': "online",
104
69
  },
@@ -122,18 +87,68 @@ class AsyncCampaignsReport(ModelNormal):
122
87
  },
123
88
  ('click_attribution_window',): {
124
89
  'None': None,
90
+ 'NONE': "none",
125
91
  '7D': "7D",
126
92
  '14D': "14D",
127
93
  '30D': "30D",
128
- 'NONE': "none",
129
94
  },
130
95
  ('view_attribution_window',): {
131
96
  'None': None,
97
+ 'NONE': "none",
132
98
  '1D': "1D",
133
99
  '7D': "7D",
134
100
  '14D': "14D",
135
101
  '30D': "30D",
136
- 'NONE': "none",
102
+ },
103
+ ('dimensions',): {
104
+ 'None': None,
105
+ 'DATE': "date",
106
+ 'HOUR': "hour",
107
+ 'ACCOUNTID': "accountId",
108
+ 'ACCOUNTNAME': "accountName",
109
+ 'CAMPAIGNID': "campaignId",
110
+ 'CAMPAIGNNAME': "campaignName",
111
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
112
+ 'LINEITEMID': "lineItemId",
113
+ 'LINEITEMNAME': "lineItemName",
114
+ 'RETAILERID': "retailerId",
115
+ 'RETAILERNAME': "retailerName",
116
+ 'BRANDID': "brandId",
117
+ 'BRANDNAME': "brandName",
118
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
119
+ 'ADVPRODUCTID': "advProductId",
120
+ 'ADVPRODUCTNAME': "advProductName",
121
+ 'SALESCHANNEL': "salesChannel",
122
+ 'ENVIRONMENT': "environment",
123
+ 'PAGETYPENAME': "pageTypeName",
124
+ 'KEYWORD': "keyword",
125
+ 'SEARCHTERM': "searchTerm",
126
+ },
127
+ ('metrics',): {
128
+ 'None': None,
129
+ 'IMPRESSIONS': "impressions",
130
+ 'CLICKS': "clicks",
131
+ 'SPEND': "spend",
132
+ 'ATTRIBUTEDSALES': "attributedSales",
133
+ 'ATTRIBUTEDUNITS': "attributedUnits",
134
+ 'ATTRIBUTEDORDERS': "attributedOrders",
135
+ 'ASSISTEDSALES': "assistedSales",
136
+ 'ASSISTEDUNITS': "assistedUnits",
137
+ 'CTR': "ctr",
138
+ 'CPC': "cpc",
139
+ 'CPO': "cpo",
140
+ 'CPM': "cpm",
141
+ 'ROAS': "roas",
142
+ 'VIDEOVIEWS': "videoViews",
143
+ 'VIDEOSSTARTED': "videosStarted",
144
+ 'VIDEOSPLAYEDTO25': "videosPlayedTo25",
145
+ 'VIDEOSPLAYEDTO50': "videosPlayedTo50",
146
+ 'VIDEOSPLAYEDTO75': "videosPlayedTo75",
147
+ 'VIDEOSPLAYEDTO100': "videosPlayedTo100",
148
+ 'VIDEOPLAYINGRATE': "videoPlayingRate",
149
+ 'VIDEOCOMPLETIONRATE': "videoCompletionRate",
150
+ 'UNIQUEVISITORS': "uniqueVisitors",
151
+ 'FREQUENCY': "frequency",
137
152
  },
138
153
  }
139
154
 
@@ -163,16 +178,16 @@ class AsyncCampaignsReport(ModelNormal):
163
178
  return {
164
179
  'start_date': (datetime,), # noqa: E501
165
180
  'end_date': (datetime,), # noqa: E501
166
- 'metrics': ([str], none_type,), # noqa: E501
167
- 'dimensions': ([str], none_type,), # noqa: E501
181
+ 'ids': ([str], none_type,), # noqa: E501
182
+ 'id': (str, none_type,), # noqa: E501
168
183
  'campaign_type': (str, none_type,), # noqa: E501
169
184
  'sales_channel': (str, none_type,), # noqa: E501
170
185
  'format': (str, none_type,), # noqa: E501
171
186
  'report_type': (str, none_type,), # noqa: E501
172
187
  'click_attribution_window': (str, none_type,), # noqa: E501
173
188
  'view_attribution_window': (str, none_type,), # noqa: E501
174
- 'ids': ([str], none_type,), # noqa: E501
175
- 'id': (str, none_type,), # noqa: E501
189
+ 'dimensions': ([str], none_type,), # noqa: E501
190
+ 'metrics': ([str], none_type,), # noqa: E501
176
191
  'timezone': (str, none_type,), # noqa: E501
177
192
  }
178
193
 
@@ -184,16 +199,16 @@ class AsyncCampaignsReport(ModelNormal):
184
199
  attribute_map = {
185
200
  'start_date': 'startDate', # noqa: E501
186
201
  'end_date': 'endDate', # noqa: E501
187
- 'metrics': 'metrics', # noqa: E501
188
- 'dimensions': 'dimensions', # noqa: E501
202
+ 'ids': 'ids', # noqa: E501
203
+ 'id': 'id', # noqa: E501
189
204
  'campaign_type': 'campaignType', # noqa: E501
190
205
  'sales_channel': 'salesChannel', # noqa: E501
191
206
  'format': 'format', # noqa: E501
192
207
  'report_type': 'reportType', # noqa: E501
193
208
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
194
209
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
195
- 'ids': 'ids', # noqa: E501
196
- 'id': 'id', # noqa: E501
210
+ 'dimensions': 'dimensions', # noqa: E501
211
+ 'metrics': 'metrics', # noqa: E501
197
212
  'timezone': 'timezone', # noqa: E501
198
213
  }
199
214
 
@@ -242,16 +257,16 @@ class AsyncCampaignsReport(ModelNormal):
242
257
  Animal class but this time we won't travel
243
258
  through its discriminator because we passed in
244
259
  _visited_composed_classes = (Animal,)
245
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
246
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
247
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
248
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
260
+ ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
261
+ id (str, none_type): Campaign id to report on. [optional] # noqa: E501
262
+ campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
263
+ sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
249
264
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
250
265
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
251
266
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
252
267
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
253
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
254
- id (str, none_type): Id to report on. [optional] # noqa: E501
268
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
269
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
255
270
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
256
271
  """
257
272
 
@@ -344,16 +359,16 @@ class AsyncCampaignsReport(ModelNormal):
344
359
  Animal class but this time we won't travel
345
360
  through its discriminator because we passed in
346
361
  _visited_composed_classes = (Animal,)
347
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
348
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
349
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
350
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
362
+ ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
363
+ id (str, none_type): Campaign id to report on. [optional] # noqa: E501
364
+ campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
365
+ sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
351
366
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
352
367
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
353
368
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
354
369
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
355
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
356
- id (str, none_type): Id to report on. [optional] # noqa: E501
370
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
371
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
357
372
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
358
373
  """
359
374
 
criteo_api_retailmedia_v2023_07/model/async_line_items_report.py CHANGED
@@ -55,51 +55,15 @@ class AsyncLineItemsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('metrics',): {
59
- 'None': None,
60
- 'IMPRESSIONS': "impressions",
61
- 'CLICKS': "clicks",
62
- 'SPEND': "spend",
63
- 'ATTRIBUTEDSALES': "attributedSales",
64
- 'ATTRIBUTEDUNITS': "attributedUnits",
65
- 'ATTRIBUTEDORDERS': "attributedOrders",
66
- 'CTR': "ctr",
67
- 'CPC': "cpc",
68
- 'CPO': "cpo",
69
- 'ROAS': "roas",
70
- 'ASSISTEDUNITS': "assistedUnits",
71
- 'ASSISTEDSALES': "assistedSales",
72
- 'UNIQUEVISITORS': "uniqueVisitors",
73
- 'FREQUENCY': "frequency",
74
- },
75
- ('dimensions',): {
76
- 'None': None,
77
- 'DATE': "date",
78
- 'HOUR': "hour",
79
- 'CAMPAIGNID': "campaignId",
80
- 'CAMPAIGNNAME': "campaignName",
81
- 'CAMPAIGNTYPENAME': "campaignTypeName",
82
- 'ADVPRODUCTCATEGORY': "advProductCategory",
83
- 'ADVPRODUCTID': "advProductId",
84
- 'ADVPRODUCTNAME': "advProductName",
85
- 'BRANDID': "brandId",
86
- 'BRANDNAME': "brandName",
87
- 'LINEITEMID': "lineItemId",
88
- 'LINEITEMNAME': "lineItemName",
89
- 'RETAILERID': "retailerId",
90
- 'RETAILERNAME': "retailerName",
91
- 'KEYWORD': "keyword",
92
- 'PAGETYPENAME': "pageTypeName",
93
- 'SALESCHANNEL': "salesChannel",
94
- 'ENVIRONMENT': "environment",
95
- },
96
58
  ('campaign_type',): {
97
59
  'None': None,
60
+ 'ALL': "all",
98
61
  'SPONSOREDPRODUCTS': "sponsoredProducts",
99
62
  'ONSITEDISPLAYS': "onSiteDisplays",
100
63
  },
101
64
  ('sales_channel',): {
102
65
  'None': None,
66
+ 'ALL': "all",
103
67
  'OFFLINE': "offline",
104
68
  'ONLINE': "online",
105
69
  },
@@ -123,18 +87,68 @@ class AsyncLineItemsReport(ModelNormal):
123
87
  },
124
88
  ('click_attribution_window',): {
125
89
  'None': None,
90
+ 'NONE': "none",
126
91
  '7D': "7D",
127
92
  '14D': "14D",
128
93
  '30D': "30D",
129
- 'NONE': "none",
130
94
  },
131
95
  ('view_attribution_window',): {
132
96
  'None': None,
97
+ 'NONE': "none",
133
98
  '1D': "1D",
134
99
  '7D': "7D",
135
100
  '14D': "14D",
136
101
  '30D': "30D",
137
- 'NONE': "none",
102
+ },
103
+ ('dimensions',): {
104
+ 'None': None,
105
+ 'DATE': "date",
106
+ 'HOUR': "hour",
107
+ 'ACCOUNTID': "accountId",
108
+ 'ACCOUNTNAME': "accountName",
109
+ 'CAMPAIGNID': "campaignId",
110
+ 'CAMPAIGNNAME': "campaignName",
111
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
112
+ 'LINEITEMID': "lineItemId",
113
+ 'LINEITEMNAME': "lineItemName",
114
+ 'RETAILERID': "retailerId",
115
+ 'RETAILERNAME': "retailerName",
116
+ 'BRANDID': "brandId",
117
+ 'BRANDNAME': "brandName",
118
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
119
+ 'ADVPRODUCTID': "advProductId",
120
+ 'ADVPRODUCTNAME': "advProductName",
121
+ 'SALESCHANNEL': "salesChannel",
122
+ 'ENVIRONMENT': "environment",
123
+ 'PAGETYPENAME': "pageTypeName",
124
+ 'KEYWORD': "keyword",
125
+ 'SEARCHTERM': "searchTerm",
126
+ },
127
+ ('metrics',): {
128
+ 'None': None,
129
+ 'IMPRESSIONS': "impressions",
130
+ 'CLICKS': "clicks",
131
+ 'SPEND': "spend",
132
+ 'ATTRIBUTEDSALES': "attributedSales",
133
+ 'ATTRIBUTEDUNITS': "attributedUnits",
134
+ 'ATTRIBUTEDORDERS': "attributedOrders",
135
+ 'ASSISTEDSALES': "assistedSales",
136
+ 'ASSISTEDUNITS': "assistedUnits",
137
+ 'CTR': "ctr",
138
+ 'CPC': "cpc",
139
+ 'CPO': "cpo",
140
+ 'CPM': "cpm",
141
+ 'ROAS': "roas",
142
+ 'VIDEOVIEWS': "videoViews",
143
+ 'VIDEOSSTARTED': "videosStarted",
144
+ 'VIDEOSPLAYEDTO25': "videosPlayedTo25",
145
+ 'VIDEOSPLAYEDTO50': "videosPlayedTo50",
146
+ 'VIDEOSPLAYEDTO75': "videosPlayedTo75",
147
+ 'VIDEOSPLAYEDTO100': "videosPlayedTo100",
148
+ 'VIDEOPLAYINGRATE': "videoPlayingRate",
149
+ 'VIDEOCOMPLETIONRATE': "videoCompletionRate",
150
+ 'UNIQUEVISITORS': "uniqueVisitors",
151
+ 'FREQUENCY': "frequency",
138
152
  },
139
153
  }
140
154
 
@@ -164,16 +178,16 @@ class AsyncLineItemsReport(ModelNormal):
164
178
  return {
165
179
  'start_date': (datetime,), # noqa: E501
166
180
  'end_date': (datetime,), # noqa: E501
167
- 'metrics': ([str], none_type,), # noqa: E501
168
- 'dimensions': ([str], none_type,), # noqa: E501
181
+ 'ids': ([str], none_type,), # noqa: E501
182
+ 'id': (str, none_type,), # noqa: E501
169
183
  'campaign_type': (str, none_type,), # noqa: E501
170
184
  'sales_channel': (str, none_type,), # noqa: E501
171
185
  'format': (str, none_type,), # noqa: E501
172
186
  'report_type': (str, none_type,), # noqa: E501
173
187
  'click_attribution_window': (str, none_type,), # noqa: E501
174
188
  'view_attribution_window': (str, none_type,), # noqa: E501
175
- 'ids': ([str], none_type,), # noqa: E501
176
- 'id': (str, none_type,), # noqa: E501
189
+ 'dimensions': ([str], none_type,), # noqa: E501
190
+ 'metrics': ([str], none_type,), # noqa: E501
177
191
  'timezone': (str, none_type,), # noqa: E501
178
192
  }
179
193
 
@@ -185,16 +199,16 @@ class AsyncLineItemsReport(ModelNormal):
185
199
  attribute_map = {
186
200
  'start_date': 'startDate', # noqa: E501
187
201
  'end_date': 'endDate', # noqa: E501
188
- 'metrics': 'metrics', # noqa: E501
189
- 'dimensions': 'dimensions', # noqa: E501
202
+ 'ids': 'ids', # noqa: E501
203
+ 'id': 'id', # noqa: E501
190
204
  'campaign_type': 'campaignType', # noqa: E501
191
205
  'sales_channel': 'salesChannel', # noqa: E501
192
206
  'format': 'format', # noqa: E501
193
207
  'report_type': 'reportType', # noqa: E501
194
208
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
195
209
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
196
- 'ids': 'ids', # noqa: E501
197
- 'id': 'id', # noqa: E501
210
+ 'dimensions': 'dimensions', # noqa: E501
211
+ 'metrics': 'metrics', # noqa: E501
198
212
  'timezone': 'timezone', # noqa: E501
199
213
  }
200
214
 
@@ -243,16 +257,16 @@ class AsyncLineItemsReport(ModelNormal):
243
257
  Animal class but this time we won't travel
244
258
  through its discriminator because we passed in
245
259
  _visited_composed_classes = (Animal,)
246
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
247
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
248
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
249
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
260
+ ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
261
+ id (str, none_type): Line Item id to report on. [optional] # noqa: E501
262
+ campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
263
+ sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
250
264
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
251
265
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
252
266
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
253
267
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
254
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
255
- id (str, none_type): Id to report on. [optional] # noqa: E501
268
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
269
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
256
270
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
257
271
  """
258
272
 
@@ -345,16 +359,16 @@ class AsyncLineItemsReport(ModelNormal):
345
359
  Animal class but this time we won't travel
346
360
  through its discriminator because we passed in
347
361
  _visited_composed_classes = (Animal,)
348
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
349
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
350
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
351
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
362
+ ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
363
+ id (str, none_type): Line Item id to report on. [optional] # noqa: E501
364
+ campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
365
+ sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
352
366
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
353
367
  report_type (str, none_type): Type of report, if no dimensions/metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
354
368
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
355
369
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
356
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
357
- id (str, none_type): Id to report on. [optional] # noqa: E501
370
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
371
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
358
372
  timezone (str, none_type): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
359
373
  """
360
374
 
criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} RENAMED
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
33
+ class InputKeywordsModel(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -58,21 +58,9 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
58
58
  }
59
59
 
60
60
  validations = {
61
- ('negative_broad',): {
62
- },
63
- ('negative_exact',): {
64
- },
65
- ('positive_exact',): {
66
- },
67
61
  }
68
62
 
69
- @cached_property
70
- def additional_properties_type():
71
- """
72
- This must be a method because a model may have properties that are
73
- of type self, this must run after the class is loaded
74
- """
75
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
63
+ additional_properties_type = None
76
64
 
77
65
  _nullable = False
78
66
 
@@ -111,7 +99,7 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
111
99
  @classmethod
112
100
  @convert_js_args_to_python_args
113
101
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
114
- """RetailMediaExternalv1InputKeywordsModel - a model defined in OpenAPI
102
+ """InputKeywordsModel - a model defined in OpenAPI
115
103
 
116
104
  Keyword Args:
117
105
  _check_type (bool): if True, values for parameters in openapi_types
@@ -199,7 +187,7 @@ class RetailMediaExternalv1InputKeywordsModel(ModelNormal):
199
187
 
200
188
  @convert_js_args_to_python_args
201
189
  def __init__(self, *args, **kwargs): # noqa: E501
202
- """RetailMediaExternalv1InputKeywordsModel - a model defined in OpenAPI
190
+ """InputKeywordsModel - a model defined in OpenAPI
203
191
 
204
192
  Keyword Args:
205
193
  _check_type (bool): if True, values for parameters in openapi_types
criteo_api_retailmedia_v2023_07/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} RENAMED
@@ -30,11 +30,15 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_v2023_07.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel
34
- globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel
33
+ from criteo_api_retailmedia_v2023_07.model.input_keywords_model import InputKeywordsModel
34
+ from criteo_api_retailmedia_v2023_07.model.match_type_model import MatchTypeModel
35
+ from criteo_api_retailmedia_v2023_07.model.review_state_model import ReviewStateModel
36
+ globals()['InputKeywordsModel'] = InputKeywordsModel
37
+ globals()['MatchTypeModel'] = MatchTypeModel
38
+ globals()['ReviewStateModel'] = ReviewStateModel
35
39
 
36
40
 
37
- class RetailMediaExternalv1KeywordDataModel(ModelNormal):
41
+ class KeywordDataModel(ModelNormal):
38
42
  """NOTE: This class is auto generated by OpenAPI Generator.
39
43
  Ref: https://openapi-generator.tech
40
44
 
@@ -59,34 +63,12 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
59
63
  """
60
64
 
61
65
  allowed_values = {
62
- ('review_state',): {
63
- 'None': None,
64
- 'INREVIEW': "InReview",
65
- 'RECOMMENDED': "Recommended",
66
- 'APPROVED': "Approved",
67
- 'AUTOAPPROVED': "AutoApproved",
68
- 'REJECTED': "Rejected",
69
- 'AUTOREJECTED': "AutoRejected",
70
- },
71
- ('match_type',): {
72
- 'None': None,
73
- 'POSITIVEEXACTMATCH': "PositiveExactMatch",
74
- 'NEGATIVEEXACTMATCH': "NegativeExactMatch",
75
- 'NEGATIVEBROADMATCH': "NegativeBroadMatch",
76
- },
77
66
  }
78
67
 
79
68
  validations = {
80
69
  }
81
70
 
82
- @cached_property
83
- def additional_properties_type():
84
- """
85
- This must be a method because a model may have properties that are
86
- of type self, this must run after the class is loaded
87
- """
88
- lazy_import()
89
- return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
71
+ additional_properties_type = None
90
72
 
91
73
  _nullable = False
92
74
 
@@ -102,10 +84,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
102
84
  """
103
85
  lazy_import()
104
86
  return {
105
- 'review_state': (str, none_type,), # noqa: E501
106
- 'match_type': (str, none_type,), # noqa: E501
87
+ 'review_state': (ReviewStateModel,), # noqa: E501
88
+ 'match_type': (MatchTypeModel,), # noqa: E501
107
89
  'bid': (float, none_type,), # noqa: E501
108
- 'input_keywords': (RetailMediaExternalv1InputKeywordsModel,), # noqa: E501
90
+ 'input_keywords': (InputKeywordsModel,), # noqa: E501
109
91
  'created_at': (datetime, none_type,), # noqa: E501
110
92
  'updated_at': (datetime, none_type,), # noqa: E501
111
93
  }
@@ -132,7 +114,7 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
132
114
  @classmethod
133
115
  @convert_js_args_to_python_args
134
116
  def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
135
- """RetailMediaExternalv1KeywordDataModel - a model defined in OpenAPI
117
+ """KeywordDataModel - a model defined in OpenAPI
136
118
 
137
119
  Keyword Args:
138
120
  _check_type (bool): if True, values for parameters in openapi_types
@@ -165,10 +147,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
165
147
  Animal class but this time we won't travel
166
148
  through its discriminator because we passed in
167
149
  _visited_composed_classes = (Animal,)
168
- review_state (str, none_type): [optional] # noqa: E501
169
- match_type (str, none_type): [optional] # noqa: E501
150
+ review_state (ReviewStateModel): [optional] # noqa: E501
151
+ match_type (MatchTypeModel): [optional] # noqa: E501
170
152
  bid (float, none_type): [optional] # noqa: E501
171
- input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501
153
+ input_keywords (InputKeywordsModel): [optional] # noqa: E501
172
154
  created_at (datetime, none_type): [optional] # noqa: E501
173
155
  updated_at (datetime, none_type): [optional] # noqa: E501
174
156
  """
@@ -223,7 +205,7 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
223
205
 
224
206
  @convert_js_args_to_python_args
225
207
  def __init__(self, *args, **kwargs): # noqa: E501
226
- """RetailMediaExternalv1KeywordDataModel - a model defined in OpenAPI
208
+ """KeywordDataModel - a model defined in OpenAPI
227
209
 
228
210
  Keyword Args:
229
211
  _check_type (bool): if True, values for parameters in openapi_types
@@ -256,10 +238,10 @@ class RetailMediaExternalv1KeywordDataModel(ModelNormal):
256
238
  Animal class but this time we won't travel
257
239
  through its discriminator because we passed in
258
240
  _visited_composed_classes = (Animal,)
259
- review_state (str, none_type): [optional] # noqa: E501
260
- match_type (str, none_type): [optional] # noqa: E501
241
+ review_state (ReviewStateModel): [optional] # noqa: E501
242
+ match_type (MatchTypeModel): [optional] # noqa: E501
261
243
  bid (float, none_type): [optional] # noqa: E501
262
- input_keywords (RetailMediaExternalv1InputKeywordsModel): [optional] # noqa: E501
244
+ input_keywords (InputKeywordsModel): [optional] # noqa: E501
263
245
  created_at (datetime, none_type): [optional] # noqa: E501
264
246
  updated_at (datetime, none_type): [optional] # noqa: E501
265
247
  """