criteo-api-retailmedia-sdk 2023.10.0.240207__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.
- {criteo_api_retailmedia_sdk-2023.10.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-2023.10.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/RECORD +34 -30
- {criteo_api_retailmedia_sdk-2023.10.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_v2023_10/__init__.py +1 -1
- criteo_api_retailmedia_v2023_10/api/campaign_api.py +38 -48
- criteo_api_retailmedia_v2023_10/api_client.py +1 -1
- criteo_api_retailmedia_v2023_10/configuration.py +1 -1
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model.py → add_remove_keywords_model.py} +9 -18
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model_request.py → add_remove_keywords_model_request.py} +9 -16
- criteo_api_retailmedia_v2023_10/model/add_remove_keywords_model_resource.py +270 -0
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_proposal_status_model_resource.py → approval_status_model.py} +86 -77
- criteo_api_retailmedia_v2023_10/model/async_campaigns_report.py +74 -59
- criteo_api_retailmedia_v2023_10/model/async_line_items_report.py +74 -60
- criteo_api_retailmedia_v2023_10/model/async_revenue_report.py +149 -75
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
- criteo_api_retailmedia_v2023_10/model/keywords_model_resource.py +270 -0
- criteo_api_retailmedia_v2023_10/model/keywords_model_response.py +274 -0
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_keywords_model_resource.py → match_type_model.py} +85 -77
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bids_model_resource.py → negotiation_state_model.py} +87 -77
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
- criteo_api_retailmedia_v2023_10/model/proposal_status_model_resource.py +270 -0
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_resource_outcome.py → proposal_status_model_response.py} +18 -23
- criteo_api_retailmedia_v2023_10/model/resource_outcome.py +268 -0
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → review_state_model.py} +88 -77
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model.py → set_bids_model.py} +9 -18
- criteo_api_retailmedia_v2023_10/model/{retail_media_externalv1_add_remove_keywords_model_request.py → set_bids_model_request.py} +9 -16
- criteo_api_retailmedia_v2023_10/model/set_bids_model_resource.py +270 -0
- criteo_api_retailmedia_v2023_10/models/__init__.py +22 -18
- criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_keywords_model_response.py +0 -285
- criteo_api_retailmedia_v2023_10/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
- {criteo_api_retailmedia_sdk-2023.10.0.240207.dist-info → criteo_api_retailmedia_sdk-2023.10.0.240515.dist-info}/top_level.txt +0 -0
|
@@ -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
|
-
|
|
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
|
-
'
|
|
167
|
-
'
|
|
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
|
-
'
|
|
175
|
-
'
|
|
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
|
-
'
|
|
188
|
-
'
|
|
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
|
-
'
|
|
196
|
-
'
|
|
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
|
-
|
|
246
|
-
|
|
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
|
-
|
|
254
|
-
|
|
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
|
-
|
|
348
|
-
|
|
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
|
-
|
|
356
|
-
|
|
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
|
|
|
@@ -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
|
-
|
|
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
|
-
'
|
|
168
|
-
'
|
|
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
|
-
'
|
|
176
|
-
'
|
|
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
|
-
'
|
|
189
|
-
'
|
|
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
|
-
'
|
|
197
|
-
'
|
|
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
|
-
|
|
247
|
-
|
|
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
|
-
|
|
255
|
-
|
|
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
|
-
|
|
349
|
-
|
|
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
|
-
|
|
357
|
-
|
|
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
|
|