criteo-api-retailmedia-sdk 2023.10.0.240404__py3-none-any.whl → 2023.10.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 (36) hide show
  1. {criteo_api_retailmedia_sdk-2023.10.0.240404.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2023.10.0.240404.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/RECORD +34 -30
  3. criteo_api_retailmedia_v2023_10/__init__.py +1 -1
  4. criteo_api_retailmedia_v2023_10/api/campaign_api.py +38 -48
  5. criteo_api_retailmedia_v2023_10/api_client.py +1 -1
  6. criteo_api_retailmedia_v2023_10/configuration.py +1 -1
  7. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
  8. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model.py → add_remove_keywords_model.py} +9 -18
  9. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model_request.py → add_remove_keywords_model_request.py} +9 -16
  10. criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py +270 -0
  11. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_proposal_status_model_resource.py → approval_status_model.py} +86 -77
  12. criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py +24 -13
  13. criteo_api_retailmedia_v2023_10/model/async_line_items_report.py +24 -13
  14. criteo_api_retailmedia_v2023_10/model/async_revenue_report.py +120 -45
  15. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
  16. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
  17. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
  18. criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py +270 -0
  19. criteo_api_retailmedia_v2023_10/model/keywords_model_response.py +274 -0
  20. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keywords_model_resource.py → match_type_model.py} +85 -77
  21. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model_resource.py → negotiation_state_model.py} +87 -77
  22. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
  23. criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py +270 -0
  24. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_resource_outcome.py → proposal_status_model_response.py} +18 -23
  25. criteo_api_retailmedia_v2023_10/model/resource_outcome.py +268 -0
  26. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → review_state_model.py} +88 -77
  27. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
  28. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
  29. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model.py → set_bids_model.py} +9 -18
  30. criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model_request.py → set_bids_model_request.py} +9 -16
  31. criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py +270 -0
  32. criteo_api_retailmedia_v2023_10/models/__init__.py +22 -18
  33. criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py +0 -285
  34. criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
  35. {criteo_api_retailmedia_sdk-2023.10.0.240404.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/WHEEL +0 -0
  36. {criteo_api_retailmedia_sdk-2023.10.0.240404.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/top_level.txt +0 -0
criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py CHANGED
@@ -57,11 +57,13 @@ class AsyncCampaignsReport(ModelNormal):
57
57
  allowed_values = {
58
58
  ('campaign_type',): {
59
59
  'None': None,
60
+ 'ALL': "all",
60
61
  'SPONSOREDPRODUCTS': "sponsoredProducts",
61
62
  'ONSITEDISPLAYS': "onSiteDisplays",
62
63
  },
63
64
  ('sales_channel',): {
64
65
  'None': None,
66
+ 'ALL': "all",
65
67
  'OFFLINE': "offline",
66
68
  'ONLINE': "online",
67
69
  },
@@ -85,18 +87,18 @@ class AsyncCampaignsReport(ModelNormal):
85
87
  },
86
88
  ('click_attribution_window',): {
87
89
  'None': None,
90
+ 'NONE': "none",
88
91
  '7D': "7D",
89
92
  '14D': "14D",
90
93
  '30D': "30D",
91
- 'NONE': "none",
92
94
  },
93
95
  ('view_attribution_window',): {
94
96
  'None': None,
97
+ 'NONE': "none",
95
98
  '1D': "1D",
96
99
  '7D': "7D",
97
100
  '14D': "14D",
98
101
  '30D': "30D",
99
- 'NONE': "none",
100
102
  },
101
103
  ('dimensions',): {
102
104
  'None': None,
@@ -107,19 +109,20 @@ class AsyncCampaignsReport(ModelNormal):
107
109
  'CAMPAIGNID': "campaignId",
108
110
  'CAMPAIGNNAME': "campaignName",
109
111
  'CAMPAIGNTYPENAME': "campaignTypeName",
110
- 'ADVPRODUCTCATEGORY': "advProductCategory",
111
- 'ADVPRODUCTID': "advProductId",
112
- 'ADVPRODUCTNAME': "advProductName",
113
- 'BRANDID': "brandId",
114
- 'BRANDNAME': "brandName",
115
112
  'LINEITEMID': "lineItemId",
116
113
  'LINEITEMNAME': "lineItemName",
117
114
  'RETAILERID': "retailerId",
118
115
  'RETAILERNAME': "retailerName",
119
- 'KEYWORD': "keyword",
120
- 'PAGETYPENAME': "pageTypeName",
116
+ 'BRANDID': "brandId",
117
+ 'BRANDNAME': "brandName",
118
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
119
+ 'ADVPRODUCTID': "advProductId",
120
+ 'ADVPRODUCTNAME': "advProductName",
121
121
  'SALESCHANNEL': "salesChannel",
122
122
  'ENVIRONMENT': "environment",
123
+ 'PAGETYPENAME': "pageTypeName",
124
+ 'KEYWORD': "keyword",
125
+ 'SEARCHTERM': "searchTerm",
123
126
  },
124
127
  ('metrics',): {
125
128
  'None': None,
@@ -136,6 +139,14 @@ class AsyncCampaignsReport(ModelNormal):
136
139
  'CPO': "cpo",
137
140
  'CPM': "cpm",
138
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",
139
150
  'UNIQUEVISITORS': "uniqueVisitors",
140
151
  'FREQUENCY': "frequency",
141
152
  },
@@ -248,8 +259,8 @@ class AsyncCampaignsReport(ModelNormal):
248
259
  _visited_composed_classes = (Animal,)
249
260
  ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
250
261
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
251
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
252
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [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
253
264
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
254
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
255
266
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -350,8 +361,8 @@ class AsyncCampaignsReport(ModelNormal):
350
361
  _visited_composed_classes = (Animal,)
351
362
  ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
352
363
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
353
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
354
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [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
355
366
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
356
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
357
368
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
criteo_api_retailmedia_v2023_10/model/async_line_items_report.py CHANGED
@@ -57,11 +57,13 @@ class AsyncLineItemsReport(ModelNormal):
57
57
  allowed_values = {
58
58
  ('campaign_type',): {
59
59
  'None': None,
60
+ 'ALL': "all",
60
61
  'SPONSOREDPRODUCTS': "sponsoredProducts",
61
62
  'ONSITEDISPLAYS': "onSiteDisplays",
62
63
  },
63
64
  ('sales_channel',): {
64
65
  'None': None,
66
+ 'ALL': "all",
65
67
  'OFFLINE': "offline",
66
68
  'ONLINE': "online",
67
69
  },
@@ -85,18 +87,18 @@ class AsyncLineItemsReport(ModelNormal):
85
87
  },
86
88
  ('click_attribution_window',): {
87
89
  'None': None,
90
+ 'NONE': "none",
88
91
  '7D': "7D",
89
92
  '14D': "14D",
90
93
  '30D': "30D",
91
- 'NONE': "none",
92
94
  },
93
95
  ('view_attribution_window',): {
94
96
  'None': None,
97
+ 'NONE': "none",
95
98
  '1D': "1D",
96
99
  '7D': "7D",
97
100
  '14D': "14D",
98
101
  '30D': "30D",
99
- 'NONE': "none",
100
102
  },
101
103
  ('dimensions',): {
102
104
  'None': None,
@@ -107,19 +109,20 @@ class AsyncLineItemsReport(ModelNormal):
107
109
  'CAMPAIGNID': "campaignId",
108
110
  'CAMPAIGNNAME': "campaignName",
109
111
  'CAMPAIGNTYPENAME': "campaignTypeName",
110
- 'ADVPRODUCTCATEGORY': "advProductCategory",
111
- 'ADVPRODUCTID': "advProductId",
112
- 'ADVPRODUCTNAME': "advProductName",
113
- 'BRANDID': "brandId",
114
- 'BRANDNAME': "brandName",
115
112
  'LINEITEMID': "lineItemId",
116
113
  'LINEITEMNAME': "lineItemName",
117
114
  'RETAILERID': "retailerId",
118
115
  'RETAILERNAME': "retailerName",
119
- 'KEYWORD': "keyword",
120
- 'PAGETYPENAME': "pageTypeName",
116
+ 'BRANDID': "brandId",
117
+ 'BRANDNAME': "brandName",
118
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
119
+ 'ADVPRODUCTID': "advProductId",
120
+ 'ADVPRODUCTNAME': "advProductName",
121
121
  'SALESCHANNEL': "salesChannel",
122
122
  'ENVIRONMENT': "environment",
123
+ 'PAGETYPENAME': "pageTypeName",
124
+ 'KEYWORD': "keyword",
125
+ 'SEARCHTERM': "searchTerm",
123
126
  },
124
127
  ('metrics',): {
125
128
  'None': None,
@@ -136,6 +139,14 @@ class AsyncLineItemsReport(ModelNormal):
136
139
  'CPO': "cpo",
137
140
  'CPM': "cpm",
138
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",
139
150
  'UNIQUEVISITORS': "uniqueVisitors",
140
151
  'FREQUENCY': "frequency",
141
152
  },
@@ -248,8 +259,8 @@ class AsyncLineItemsReport(ModelNormal):
248
259
  _visited_composed_classes = (Animal,)
249
260
  ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
250
261
  id (str, none_type): Line Item id to report on. [optional] # noqa: E501
251
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
252
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [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
253
264
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
254
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
255
266
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
@@ -350,8 +361,8 @@ class AsyncLineItemsReport(ModelNormal):
350
361
  _visited_composed_classes = (Animal,)
351
362
  ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
352
363
  id (str, none_type): Line Item id to report on. [optional] # noqa: E501
353
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
354
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [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
355
366
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
356
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
357
368
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
criteo_api_retailmedia_v2023_10/model/async_revenue_report.py CHANGED
@@ -68,6 +68,26 @@ class AsyncRevenueReport(ModelNormal):
68
68
  'AUCTION': "auction",
69
69
  'PREFERRED': "preferred",
70
70
  },
71
+ ('sold_by',): {
72
+ 'None': None,
73
+ 'DIRECTSOLD': "directSold",
74
+ 'INDIRECTSOLD': "indirectSold",
75
+ 'PRIVATEMARKET': "privateMarket",
76
+ },
77
+ ('buy_type',): {
78
+ 'None': None,
79
+ 'AUCTION': "auction",
80
+ 'PREFERREDDEALS': "preferredDeals",
81
+ 'SPONSORSHIP': "sponsorship",
82
+ },
83
+ ('sku_relations',): {
84
+ 'None': None,
85
+ 'SAMESKU': "sameSku",
86
+ 'SAMEPARENTSKU': "sameParentSku",
87
+ 'SAMECATEGORY': "sameCategory",
88
+ 'SAMEBRAND': "sameBrand",
89
+ 'SAMESELLER': "sameSeller",
90
+ },
71
91
  ('format',): {
72
92
  'None': None,
73
93
  'JSON': "json",
@@ -75,72 +95,123 @@ class AsyncRevenueReport(ModelNormal):
75
95
  'JSON-NEWLINE': "json-newline",
76
96
  'CSV': "csv",
77
97
  },
78
- ('sold_by',): {
98
+ ('campaign_type',): {
79
99
  'None': None,
80
- 'DIRECTSOLD': "directSold",
81
- 'INDIRECTSOLD': "indirectSold",
82
- 'PRIVATEMARKET': "privateMarket",
100
+ 'ALL': "all",
101
+ 'SPONSOREDPRODUCTS': "sponsoredProducts",
102
+ 'ONSITEDISPLAYS': "onSiteDisplays",
83
103
  },
84
- ('campaign_sub_type',): {
104
+ ('sales_channel',): {
85
105
  'None': None,
86
- 'AUCTIONANDPREFERRED': "auctionAndPreferred",
87
- 'LOCKOUT': "lockout",
106
+ 'ALL': "all",
107
+ 'OFFLINE': "offline",
108
+ 'ONLINE': "online",
88
109
  },
89
110
  ('click_attribution_window',): {
90
111
  'None': None,
112
+ 'NONE': "none",
91
113
  '7D': "7D",
92
114
  '14D': "14D",
93
115
  '30D': "30D",
94
- 'NONE': "none",
95
116
  },
96
117
  ('view_attribution_window',): {
97
118
  'None': None,
119
+ 'NONE': "none",
98
120
  '1D': "1D",
99
121
  '7D': "7D",
100
122
  '14D': "14D",
101
123
  '30D': "30D",
102
- 'NONE': "none",
103
- },
104
- ('campaign_type',): {
105
- 'None': None,
106
- 'SPONSOREDPRODUCTS': "sponsoredProducts",
107
- 'ONSITEDISPLAYS': "onSiteDisplays",
108
- },
109
- ('sales_channel',): {
110
- 'None': None,
111
- 'OFFLINE': "offline",
112
- 'ONLINE': "online",
113
124
  },
114
125
  ('dimensions',): {
115
126
  'None': None,
116
127
  'DATE': "date",
117
- 'CAMPAIGNID': "campaignId",
118
- 'CAMPAIGNNAME': "campaignName",
128
+ 'HOUR': "hour",
129
+ 'PARENTACCOUNT': "parentAccount",
119
130
  'ACCOUNTID': "accountId",
120
131
  'ACCOUNTNAME': "accountName",
121
- 'ENVIRONMENT': "environment",
122
- 'ADVPRODUCTCATEGORY': "advProductCategory",
132
+ 'ACCOUNTTYPENAME': "accountTypeName",
133
+ 'CAMPAIGNID': "campaignId",
134
+ 'CAMPAIGNNAME': "campaignName",
135
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
136
+ 'CAMPAIGNSTARTDATE': "campaignStartDate",
137
+ 'CAMPAIGNENDDATE': "campaignEndDate",
138
+ 'LINEITEMID': "lineItemId",
139
+ 'LINEITEMNAME': "lineItemName",
140
+ 'LINEITEMSTARTDATE': "lineItemStartDate",
141
+ 'LINEITEMENDDATE': "lineItemEndDate",
142
+ 'LINEITEMSTATUS': "lineItemStatus",
143
+ 'RETAILERID': "retailerId",
144
+ 'RETAILERNAME': "retailerName",
123
145
  'BRANDID': "brandId",
124
146
  'BRANDNAME': "brandName",
147
+ 'PLACEMENTID': "placementId",
148
+ 'PLACEMENTNAME': "placementName",
125
149
  'PAGETYPENAME': "pageTypeName",
150
+ 'ENVIRONMENT': "environment",
151
+ 'PAGECATEGORY': "pageCategory",
152
+ 'ADVPRODUCTID': "advProductId",
126
153
  'ADVPRODUCTNAME': "advProductName",
127
154
  'ADVPRODUCTGTIN': "advProductGtin",
128
155
  'ADVPRODUCTMPN': "advProductMpn",
129
- 'ADVPRODUCTID': "advProductId",
156
+ 'SOLDBY': "soldBy",
157
+ 'SALECHANNEL': "saleChannel",
158
+ 'ATTRIBUTIONSETTINGS': "attributionSettings",
159
+ 'ACTIVITYTYPE': "activityType",
160
+ 'KEYWORD': "keyword",
161
+ 'SKURELATION': "skuRelation",
162
+ 'RETAILERCATEGORYID': "retailerCategoryId",
163
+ 'RETAILERCATEGORYNAME': "retailerCategoryName",
164
+ 'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
165
+ 'TAXONOMY1ID': "taxonomy1Id",
166
+ 'TAXONOMY1NAME': "taxonomy1Name",
167
+ 'TAXONOMY2ID': "taxonomy2Id",
168
+ 'TAXONOMY2NAME': "taxonomy2Name",
169
+ 'TAXONOMY3ID': "taxonomy3Id",
170
+ 'TAXONOMY3NAME': "taxonomy3Name",
171
+ 'TAXONOMY4ID': "taxonomy4Id",
172
+ 'TAXONOMY4NAME': "taxonomy4Name",
173
+ 'TAXONOMY5ID': "taxonomy5Id",
174
+ 'TAXONOMY5NAME': "taxonomy5Name",
175
+ 'TAXONOMY6ID': "taxonomy6Id",
176
+ 'TAXONOMY6NAME': "taxonomy6Name",
177
+ 'TAXONOMY7ID': "taxonomy7Id",
178
+ 'TAXONOMY7NAME': "taxonomy7Name",
130
179
  },
131
180
  ('metrics',): {
132
181
  'None': None,
182
+ 'NUMBEROFCAMPAIGNS': "numberOfCampaigns",
183
+ 'NUMBEROFLINEITEMS': "numberOfLineItems",
184
+ 'NUMBEROFSKUS': "numberOfSkus",
185
+ 'SKUPRICE': "skuPrice",
186
+ 'PAGEVIEWS': "pageViews",
133
187
  'IMPRESSIONS': "impressions",
188
+ 'PRODUCTCLICKS': "productClicks",
189
+ 'PLACEMENTCLICKS': "placementClicks",
134
190
  'CLICKS': "clicks",
135
- 'SPEND': "spend",
136
191
  'SALES': "sales",
137
192
  'UNITS': "units",
138
- 'CPO': "cpo",
139
- 'ROAS': "roas",
193
+ 'TRANSACTIONS': "transactions",
194
+ 'ASSISTEDSALES': "assistedSales",
195
+ 'ASSISTEDUNITS': "assistedUnits",
140
196
  'OPENAUCTIONREVENUE': "openAuctionRevenue",
141
197
  'PREFERREDDEALSREVENUE': "preferredDealsRevenue",
142
- 'AVGCPC': "avgCpc",
143
- 'AVGCPM': "avgCpm",
198
+ 'CTR': "ctr",
199
+ 'CR': "cr",
200
+ 'CPC': "cpc",
201
+ 'CPM': "cpm",
202
+ 'ROAS': "roas",
203
+ 'WORKINGMEDIA': "workingMedia",
204
+ 'NETREVENUE': "netRevenue",
205
+ 'VIDEOVIEWS': "videoViews",
206
+ 'VIDEOSSTARTED': "videosStarted",
207
+ 'VIDEOSPLAYEDTO25': "videosPlayedTo25",
208
+ 'VIDEOSPLAYEDTO50': "videosPlayedTo50",
209
+ 'VIDEOSPLAYEDTO75': "videosPlayedTo75",
210
+ 'VIDEOSPLAYEDTO100': "videosPlayedTo100",
211
+ 'VIDEOPLAYINGRATE': "videoPlayingRate",
212
+ 'VIDEOCOMPLETIONRATE': "videoCompletionRate",
213
+ 'UNIQUEVISITORS': "uniqueVisitors",
214
+ 'FREQUENCY': "frequency",
144
215
  },
145
216
  }
146
217
 
@@ -174,13 +245,14 @@ class AsyncRevenueReport(ModelNormal):
174
245
  'id': (str, none_type,), # noqa: E501
175
246
  'report_type': (str, none_type,), # noqa: E501
176
247
  'revenue_type': (str, none_type,), # noqa: E501
177
- 'format': (str, none_type,), # noqa: E501
178
248
  'sold_by': (str, none_type,), # noqa: E501
179
- 'campaign_sub_type': (str, none_type,), # noqa: E501
180
- 'click_attribution_window': (str, none_type,), # noqa: E501
181
- 'view_attribution_window': (str, none_type,), # noqa: E501
249
+ 'buy_type': (str, none_type,), # noqa: E501
250
+ 'sku_relations': ([str], none_type,), # noqa: E501
251
+ 'format': (str, none_type,), # noqa: E501
182
252
  'campaign_type': (str, none_type,), # noqa: E501
183
253
  'sales_channel': (str, none_type,), # noqa: E501
254
+ 'click_attribution_window': (str, none_type,), # noqa: E501
255
+ 'view_attribution_window': (str, none_type,), # noqa: E501
184
256
  'dimensions': ([str], none_type,), # noqa: E501
185
257
  'metrics': ([str], none_type,), # noqa: E501
186
258
  'timezone': (str, none_type,), # noqa: E501
@@ -198,13 +270,14 @@ class AsyncRevenueReport(ModelNormal):
198
270
  'id': 'id', # noqa: E501
199
271
  'report_type': 'reportType', # noqa: E501
200
272
  'revenue_type': 'revenueType', # noqa: E501
201
- 'format': 'format', # noqa: E501
202
273
  'sold_by': 'soldBy', # noqa: E501
203
- 'campaign_sub_type': 'campaignSubType', # noqa: E501
204
- 'click_attribution_window': 'clickAttributionWindow', # noqa: E501
205
- 'view_attribution_window': 'viewAttributionWindow', # noqa: E501
274
+ 'buy_type': 'buyType', # noqa: E501
275
+ 'sku_relations': 'skuRelations', # noqa: E501
276
+ 'format': 'format', # noqa: E501
206
277
  'campaign_type': 'campaignType', # noqa: E501
207
278
  'sales_channel': 'salesChannel', # noqa: E501
279
+ 'click_attribution_window': 'clickAttributionWindow', # noqa: E501
280
+ 'view_attribution_window': 'viewAttributionWindow', # noqa: E501
208
281
  'dimensions': 'dimensions', # noqa: E501
209
282
  'metrics': 'metrics', # noqa: E501
210
283
  'timezone': 'timezone', # noqa: E501
@@ -259,13 +332,14 @@ class AsyncRevenueReport(ModelNormal):
259
332
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
260
333
  report_type (str, none_type): Type of report. [optional] # noqa: E501
261
334
  revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501
335
+ sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501
336
+ buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501
337
+ sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional] # noqa: E501
262
338
  format (str, none_type): Format of the output. [optional] # noqa: E501
263
- sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501
264
- campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501
339
+ 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
340
+ 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
265
341
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
266
342
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
267
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
268
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
269
343
  dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
270
344
  metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
271
345
  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
@@ -364,13 +438,14 @@ class AsyncRevenueReport(ModelNormal):
364
438
  id (str, none_type): Campaign id to report on. [optional] # noqa: E501
365
439
  report_type (str, none_type): Type of report. [optional] # noqa: E501
366
440
  revenue_type (str, none_type): Type of revenue. [optional] # noqa: E501
441
+ sold_by (str, none_type): Filter on the seller: Indirect Sold, Direct Sold or Private Market. [optional] # noqa: E501
442
+ buy_type (str, none_type): Filter on buy type: Auction, Preferred Deals or Sponsorship. [optional] # noqa: E501
443
+ sku_relations ([str], none_type): Filter on sku relations: Same SKU, Same Parent SKU, Same Category, Same Brand or Same Seller. [optional] # noqa: E501
367
444
  format (str, none_type): Format of the output. [optional] # noqa: E501
368
- sold_by (str, none_type): Filter on the seller: indirect, direct or private market. [optional] # noqa: E501
369
- campaign_sub_type (str, none_type): Filter on campaign subType : Auction and Preferred Deals or Lockout campaign. [optional] # noqa: E501
445
+ 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
446
+ 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
370
447
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
371
448
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
372
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
373
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
374
449
  dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
375
450
  metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
376
451
  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
criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} RENAMED
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2023_10.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_10/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} RENAMED
@@ -30,11 +30,15 @@ from criteo_api_retailmedia_v2023_10.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_v2023_10.model.retail_media_externalv1_input_keywords_model import RetailMediaExternalv1InputKeywordsModel
34
- globals()['RetailMediaExternalv1InputKeywordsModel'] = RetailMediaExternalv1InputKeywordsModel
33
+ from criteo_api_retailmedia_v2023_10.model.input_keywords_model import InputKeywordsModel
34
+ from criteo_api_retailmedia_v2023_10.model.match_type_model import MatchTypeModel
35
+ from criteo_api_retailmedia_v2023_10.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
  """