criteo-api-retailmedia-sdk 2025.1.0.250218__py3-none-any.whl → 2025.1.0.250320__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-2025.1.0.250218.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250320.dist-info}/METADATA +4 -4
- {criteo_api_retailmedia_sdk-2025.1.0.250218.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250320.dist-info}/RECORD +121 -120
- {criteo_api_retailmedia_sdk-2025.1.0.250218.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250320.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_v2025_01/__init__.py +1 -1
- criteo_api_retailmedia_v2025_01/api/accounts_api.py +1 -5
- criteo_api_retailmedia_v2025_01/api_client.py +1 -1
- criteo_api_retailmedia_v2025_01/configuration.py +1 -1
- criteo_api_retailmedia_v2025_01/model/add_remove_keyword_model.py +3 -3
- criteo_api_retailmedia_v2025_01/model/application_summary_model.py +1 -1
- criteo_api_retailmedia_v2025_01/model/application_summary_model_resource.py +1 -1
- criteo_api_retailmedia_v2025_01/model/asset.py +1 -1
- criteo_api_retailmedia_v2025_01/model/asset_resource.py +1 -1
- criteo_api_retailmedia_v2025_01/model/async_campaigns_report.py +39 -49
- criteo_api_retailmedia_v2025_01/model/async_campaigns_report_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/async_line_items_report.py +39 -49
- criteo_api_retailmedia_v2025_01/model/async_line_items_report_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/async_revenue_report.py +60 -73
- criteo_api_retailmedia_v2025_01/model/async_revenue_report_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/balance_response_v2.py +1 -1
- criteo_api_retailmedia_v2025_01/model/campaign_budget_overrides.py +1 -1
- criteo_api_retailmedia_v2025_01/model/choice_variable_specification.py +1 -1
- criteo_api_retailmedia_v2025_01/model/choice_variable_value.py +1 -1
- criteo_api_retailmedia_v2025_01/model/common_error.py +26 -31
- criteo_api_retailmedia_v2025_01/model/common_warning.py +26 -31
- criteo_api_retailmedia_v2025_01/model/create_balance_v2.py +3 -3
- criteo_api_retailmedia_v2025_01/model/creative2.py +5 -1
- criteo_api_retailmedia_v2025_01/model/creative202110.py +1 -1
- criteo_api_retailmedia_v2025_01/model/creative202210.py +1 -1
- criteo_api_retailmedia_v2025_01/model/creative_update_model202207.py +3 -3
- criteo_api_retailmedia_v2025_01/model/entity_resource_of_retail_media_account.py +5 -12
- criteo_api_retailmedia_v2025_01/model/entity_resource_outcome_of_retail_media_account.py +10 -17
- criteo_api_retailmedia_v2025_01/model/external_account.py +2 -8
- criteo_api_retailmedia_v2025_01/model/external_auction_line_item.py +4 -0
- criteo_api_retailmedia_v2025_01/model/external_auction_line_item_create_model.py +3 -3
- criteo_api_retailmedia_v2025_01/model/external_auction_line_item_update_model.py +3 -3
- criteo_api_retailmedia_v2025_01/model/external_brand.py +2 -8
- criteo_api_retailmedia_v2025_01/model/external_line_item_bid_multipliers_v2.py +4 -0
- criteo_api_retailmedia_v2025_01/model/external_line_item_page_v2.py +3 -3
- criteo_api_retailmedia_v2025_01/model/external_preferred_line_item_v2.py +4 -0
- criteo_api_retailmedia_v2025_01/model/external_retail_media_account.py +19 -25
- criteo_api_retailmedia_v2025_01/model/external_retail_media_brand_account_creation.py +9 -15
- criteo_api_retailmedia_v2025_01/model/external_retail_media_brands.py +12 -12
- criteo_api_retailmedia_v2025_01/model/external_retail_media_seller.py +15 -13
- criteo_api_retailmedia_v2025_01/model/external_retail_media_seller_account_creation.py +20 -21
- criteo_api_retailmedia_v2025_01/model/external_retailer.py +6 -11
- criteo_api_retailmedia_v2025_01/model/files_variable_value.py +1 -1
- criteo_api_retailmedia_v2025_01/model/files_variables_specification.py +1 -1
- criteo_api_retailmedia_v2025_01/model/grant_consent_model.py +3 -3
- criteo_api_retailmedia_v2025_01/model/grant_consent_model_value_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/json_api_body_with_id_of_int64_and_account_and_account.py +1 -8
- criteo_api_retailmedia_v2025_01/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +1 -8
- criteo_api_retailmedia_v2025_01/model/json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py +2 -8
- criteo_api_retailmedia_v2025_01/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +1 -8
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_account.py +7 -14
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_brand.py +7 -14
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_retailer.py +7 -14
- criteo_api_retailmedia_v2025_01/model/keyword_data_model.py +6 -6
- criteo_api_retailmedia_v2025_01/model/keywords.py +12 -14
- criteo_api_retailmedia_v2025_01/model/keywords_model.py +1 -1
- criteo_api_retailmedia_v2025_01/model/keywords_model_resource.py +1 -1
- criteo_api_retailmedia_v2025_01/model/line_item_budget_overrides.py +1 -1
- criteo_api_retailmedia_v2025_01/model/line_item_product_status.py +2 -1
- criteo_api_retailmedia_v2025_01/model/nillable_string.py +1 -1
- criteo_api_retailmedia_v2025_01/model/page_metadata.py +7 -13
- criteo_api_retailmedia_v2025_01/model/product_metadata.py +1 -1
- criteo_api_retailmedia_v2025_01/model/promoted_product.py +1 -1
- criteo_api_retailmedia_v2025_01/model/promoted_product_resource_collection_input.py +3 -3
- criteo_api_retailmedia_v2025_01/model/recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_v2025_01/model/resource_of_add_funds_to_balance_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_auction_line_item_update_model.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_balance_response_v2.py +1 -1
- criteo_api_retailmedia_v2025_01/model/resource_of_change_dates_of_balance_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_create_balance_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_preferred_line_item_update_model_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_update_balance_model_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_amendment.py +3 -3
- criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_amendment_attributes.py +3 -4
- criteo_api_retailmedia_v2025_01/model/rm_algebra_node_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_audience_entity_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_entity_v1.py +9 -9
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_bulk_create_input_v1.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_bulk_delete_input_v1.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_bulk_update_input_v1.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_create_entity_v1.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_create_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_delete_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_entity_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_id_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_entity_v1.py +9 -10
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_update_entity_v1.py +3 -3
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_update_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_create_v1.py +3 -4
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_statistics_entity_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_statistics_entity_v1_resource.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/rm_events_v1.py +1 -1
- criteo_api_retailmedia_v2025_01/model/sdk_api_rest_common_problem.py +296 -0
- criteo_api_retailmedia_v2025_01/model/seller_catalog_request.py +3 -3
- criteo_api_retailmedia_v2025_01/model/status_response.py +1 -1
- criteo_api_retailmedia_v2025_01/model/status_response_resource.py +1 -1
- criteo_api_retailmedia_v2025_01/model/template.py +1 -1
- criteo_api_retailmedia_v2025_01/model/value_resource_collection_input_of_retail_media_seller.py +5 -12
- criteo_api_retailmedia_v2025_01/model/value_resource_collection_outcome_of_retail_media_seller.py +10 -17
- criteo_api_retailmedia_v2025_01/model/value_resource_input_of_retail_media_brand_account_creation.py +1 -8
- criteo_api_retailmedia_v2025_01/model/value_resource_input_of_retail_media_brands.py +2 -9
- criteo_api_retailmedia_v2025_01/model/value_resource_input_of_retail_media_seller_account_creation.py +2 -9
- criteo_api_retailmedia_v2025_01/model/value_resource_of_campaign_budget_overrides.py +1 -1
- criteo_api_retailmedia_v2025_01/model/value_resource_of_line_item_budget_overrides.py +1 -1
- criteo_api_retailmedia_v2025_01/model/value_resource_of_recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_brand_account_creation.py +3 -10
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_brands.py +3 -10
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_seller.py +4 -11
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_seller_account_creation.py +4 -11
- criteo_api_retailmedia_v2025_01/model/value_resource_outcome_of_retail_media_brands.py +10 -17
- criteo_api_retailmedia_v2025_01/model/video_variable_value.py +1 -1
- criteo_api_retailmedia_v2025_01/models/__init__.py +1 -0
- {criteo_api_retailmedia_sdk-2025.1.0.250218.dist-info → criteo_api_retailmedia_sdk-2025.1.0.250320.dist-info}/top_level.txt +0 -0
|
@@ -56,38 +56,32 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
58
|
('search_term_types',): {
|
|
59
|
-
'None': None,
|
|
60
59
|
'UNKNOWN': "unknown",
|
|
61
60
|
'SEARCHED': "searched",
|
|
62
61
|
'ENTERED': "entered",
|
|
63
62
|
},
|
|
64
63
|
('search_term_targetings',): {
|
|
65
|
-
'None': None,
|
|
66
64
|
'UNKNOWN': "unknown",
|
|
67
65
|
'AUTOMATIC': "automatic",
|
|
68
66
|
'MANUAL': "manual",
|
|
69
67
|
},
|
|
70
68
|
('campaign_type',): {
|
|
71
|
-
'None': None,
|
|
72
69
|
'ALL': "all",
|
|
73
70
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
74
71
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
75
72
|
},
|
|
76
73
|
('sales_channel',): {
|
|
77
|
-
'None': None,
|
|
78
74
|
'ALL': "all",
|
|
79
75
|
'OFFLINE': "offline",
|
|
80
76
|
'ONLINE': "online",
|
|
81
77
|
},
|
|
82
78
|
('format',): {
|
|
83
|
-
'None': None,
|
|
84
79
|
'JSON': "json",
|
|
85
80
|
'JSON-COMPACT': "json-compact",
|
|
86
81
|
'JSON-NEWLINE': "json-newline",
|
|
87
82
|
'CSV': "csv",
|
|
88
83
|
},
|
|
89
84
|
('report_type',): {
|
|
90
|
-
'None': None,
|
|
91
85
|
'SUMMARY': "summary",
|
|
92
86
|
'PAGETYPE': "pageType",
|
|
93
87
|
'KEYWORD': "keyword",
|
|
@@ -99,14 +93,12 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
99
93
|
'CAPOUT': "capout",
|
|
100
94
|
},
|
|
101
95
|
('click_attribution_window',): {
|
|
102
|
-
'None': None,
|
|
103
96
|
'NONE': "none",
|
|
104
97
|
'7D': "7D",
|
|
105
98
|
'14D': "14D",
|
|
106
99
|
'30D': "30D",
|
|
107
100
|
},
|
|
108
101
|
('view_attribution_window',): {
|
|
109
|
-
'None': None,
|
|
110
102
|
'NONE': "none",
|
|
111
103
|
'1D': "1D",
|
|
112
104
|
'7D': "7D",
|
|
@@ -114,7 +106,6 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
114
106
|
'30D': "30D",
|
|
115
107
|
},
|
|
116
108
|
('dimensions',): {
|
|
117
|
-
'None': None,
|
|
118
109
|
'DATE': "date",
|
|
119
110
|
'HOUR': "hour",
|
|
120
111
|
'ACCOUNTID': "accountId",
|
|
@@ -149,7 +140,6 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
149
140
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
150
141
|
},
|
|
151
142
|
('metrics',): {
|
|
152
|
-
'None': None,
|
|
153
143
|
'IMPRESSIONS': "impressions",
|
|
154
144
|
'CLICKS': "clicks",
|
|
155
145
|
'SPEND': "spend",
|
|
@@ -216,19 +206,19 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
216
206
|
return {
|
|
217
207
|
'start_date': (datetime,), # noqa: E501
|
|
218
208
|
'end_date': (datetime,), # noqa: E501
|
|
219
|
-
'ids': ([str],
|
|
220
|
-
'id': (str,
|
|
221
|
-
'search_term_types': ([str],
|
|
222
|
-
'search_term_targetings': ([str],
|
|
223
|
-
'campaign_type': (str,
|
|
224
|
-
'sales_channel': (str,
|
|
225
|
-
'format': (str,
|
|
226
|
-
'report_type': (str,
|
|
227
|
-
'click_attribution_window': (str,
|
|
228
|
-
'view_attribution_window': (str,
|
|
229
|
-
'dimensions': ([str],
|
|
230
|
-
'metrics': ([str],
|
|
231
|
-
'timezone': (str,
|
|
209
|
+
'ids': ([str],), # noqa: E501
|
|
210
|
+
'id': (str,), # noqa: E501
|
|
211
|
+
'search_term_types': ([str],), # noqa: E501
|
|
212
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
213
|
+
'campaign_type': (str,), # noqa: E501
|
|
214
|
+
'sales_channel': (str,), # noqa: E501
|
|
215
|
+
'format': (str,), # noqa: E501
|
|
216
|
+
'report_type': (str,), # noqa: E501
|
|
217
|
+
'click_attribution_window': (str,), # noqa: E501
|
|
218
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
219
|
+
'dimensions': ([str],), # noqa: E501
|
|
220
|
+
'metrics': ([str],), # noqa: E501
|
|
221
|
+
'timezone': (str,), # noqa: E501
|
|
232
222
|
}
|
|
233
223
|
|
|
234
224
|
@cached_property
|
|
@@ -299,19 +289,19 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
299
289
|
Animal class but this time we won't travel
|
|
300
290
|
through its discriminator because we passed in
|
|
301
291
|
_visited_composed_classes = (Animal,)
|
|
302
|
-
ids ([str]
|
|
303
|
-
id (str
|
|
304
|
-
search_term_types ([str]
|
|
305
|
-
search_term_targetings ([str]
|
|
306
|
-
campaign_type (str
|
|
307
|
-
sales_channel (str
|
|
308
|
-
format (str
|
|
309
|
-
report_type (str
|
|
310
|
-
click_attribution_window (str
|
|
311
|
-
view_attribution_window (str
|
|
312
|
-
dimensions ([str]
|
|
313
|
-
metrics ([str]
|
|
314
|
-
timezone (str
|
|
292
|
+
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
293
|
+
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
294
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
295
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
296
|
+
campaign_type (str): 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
|
|
297
|
+
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
298
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
299
|
+
report_type (str): 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
|
|
300
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
301
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
302
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
303
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
304
|
+
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|
|
315
305
|
"""
|
|
316
306
|
|
|
317
307
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -403,19 +393,19 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
403
393
|
Animal class but this time we won't travel
|
|
404
394
|
through its discriminator because we passed in
|
|
405
395
|
_visited_composed_classes = (Animal,)
|
|
406
|
-
ids ([str]
|
|
407
|
-
id (str
|
|
408
|
-
search_term_types ([str]
|
|
409
|
-
search_term_targetings ([str]
|
|
410
|
-
campaign_type (str
|
|
411
|
-
sales_channel (str
|
|
412
|
-
format (str
|
|
413
|
-
report_type (str
|
|
414
|
-
click_attribution_window (str
|
|
415
|
-
view_attribution_window (str
|
|
416
|
-
dimensions ([str]
|
|
417
|
-
metrics ([str]
|
|
418
|
-
timezone (str
|
|
396
|
+
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
397
|
+
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
398
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
399
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
400
|
+
campaign_type (str): 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
|
|
401
|
+
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
402
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
403
|
+
report_type (str): 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
|
|
404
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
405
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
406
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
407
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
408
|
+
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|
|
419
409
|
"""
|
|
420
410
|
|
|
421
411
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -87,7 +87,7 @@ class AsyncCampaignsReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,
|
|
90
|
+
'type': (str,), # noqa: E501
|
|
91
91
|
'attributes': (AsyncCampaignsReport,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
@@ -142,7 +142,7 @@ class AsyncCampaignsReportResource(ModelNormal):
|
|
|
142
142
|
Animal class but this time we won't travel
|
|
143
143
|
through its discriminator because we passed in
|
|
144
144
|
_visited_composed_classes = (Animal,)
|
|
145
|
-
type (str
|
|
145
|
+
type (str): [optional] # noqa: E501
|
|
146
146
|
attributes (AsyncCampaignsReport): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
@@ -229,7 +229,7 @@ class AsyncCampaignsReportResource(ModelNormal):
|
|
|
229
229
|
Animal class but this time we won't travel
|
|
230
230
|
through its discriminator because we passed in
|
|
231
231
|
_visited_composed_classes = (Animal,)
|
|
232
|
-
type (str
|
|
232
|
+
type (str): [optional] # noqa: E501
|
|
233
233
|
attributes (AsyncCampaignsReport): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|
|
@@ -56,38 +56,32 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
58
|
('search_term_types',): {
|
|
59
|
-
'None': None,
|
|
60
59
|
'UNKNOWN': "unknown",
|
|
61
60
|
'SEARCHED': "searched",
|
|
62
61
|
'ENTERED': "entered",
|
|
63
62
|
},
|
|
64
63
|
('search_term_targetings',): {
|
|
65
|
-
'None': None,
|
|
66
64
|
'UNKNOWN': "unknown",
|
|
67
65
|
'AUTOMATIC': "automatic",
|
|
68
66
|
'MANUAL': "manual",
|
|
69
67
|
},
|
|
70
68
|
('campaign_type',): {
|
|
71
|
-
'None': None,
|
|
72
69
|
'ALL': "all",
|
|
73
70
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
74
71
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
75
72
|
},
|
|
76
73
|
('sales_channel',): {
|
|
77
|
-
'None': None,
|
|
78
74
|
'ALL': "all",
|
|
79
75
|
'OFFLINE': "offline",
|
|
80
76
|
'ONLINE': "online",
|
|
81
77
|
},
|
|
82
78
|
('format',): {
|
|
83
|
-
'None': None,
|
|
84
79
|
'JSON': "json",
|
|
85
80
|
'JSON-COMPACT': "json-compact",
|
|
86
81
|
'JSON-NEWLINE': "json-newline",
|
|
87
82
|
'CSV': "csv",
|
|
88
83
|
},
|
|
89
84
|
('report_type',): {
|
|
90
|
-
'None': None,
|
|
91
85
|
'SUMMARY': "summary",
|
|
92
86
|
'PAGETYPE': "pageType",
|
|
93
87
|
'KEYWORD': "keyword",
|
|
@@ -99,14 +93,12 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
99
93
|
'CAPOUT': "capout",
|
|
100
94
|
},
|
|
101
95
|
('click_attribution_window',): {
|
|
102
|
-
'None': None,
|
|
103
96
|
'NONE': "none",
|
|
104
97
|
'7D': "7D",
|
|
105
98
|
'14D': "14D",
|
|
106
99
|
'30D': "30D",
|
|
107
100
|
},
|
|
108
101
|
('view_attribution_window',): {
|
|
109
|
-
'None': None,
|
|
110
102
|
'NONE': "none",
|
|
111
103
|
'1D': "1D",
|
|
112
104
|
'7D': "7D",
|
|
@@ -114,7 +106,6 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
114
106
|
'30D': "30D",
|
|
115
107
|
},
|
|
116
108
|
('dimensions',): {
|
|
117
|
-
'None': None,
|
|
118
109
|
'DATE': "date",
|
|
119
110
|
'HOUR': "hour",
|
|
120
111
|
'ACCOUNTID': "accountId",
|
|
@@ -149,7 +140,6 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
149
140
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
150
141
|
},
|
|
151
142
|
('metrics',): {
|
|
152
|
-
'None': None,
|
|
153
143
|
'IMPRESSIONS': "impressions",
|
|
154
144
|
'CLICKS': "clicks",
|
|
155
145
|
'SPEND': "spend",
|
|
@@ -216,19 +206,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
216
206
|
return {
|
|
217
207
|
'start_date': (datetime,), # noqa: E501
|
|
218
208
|
'end_date': (datetime,), # noqa: E501
|
|
219
|
-
'ids': ([str],
|
|
220
|
-
'id': (str,
|
|
221
|
-
'search_term_types': ([str],
|
|
222
|
-
'search_term_targetings': ([str],
|
|
223
|
-
'campaign_type': (str,
|
|
224
|
-
'sales_channel': (str,
|
|
225
|
-
'format': (str,
|
|
226
|
-
'report_type': (str,
|
|
227
|
-
'click_attribution_window': (str,
|
|
228
|
-
'view_attribution_window': (str,
|
|
229
|
-
'dimensions': ([str],
|
|
230
|
-
'metrics': ([str],
|
|
231
|
-
'timezone': (str,
|
|
209
|
+
'ids': ([str],), # noqa: E501
|
|
210
|
+
'id': (str,), # noqa: E501
|
|
211
|
+
'search_term_types': ([str],), # noqa: E501
|
|
212
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
213
|
+
'campaign_type': (str,), # noqa: E501
|
|
214
|
+
'sales_channel': (str,), # noqa: E501
|
|
215
|
+
'format': (str,), # noqa: E501
|
|
216
|
+
'report_type': (str,), # noqa: E501
|
|
217
|
+
'click_attribution_window': (str,), # noqa: E501
|
|
218
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
219
|
+
'dimensions': ([str],), # noqa: E501
|
|
220
|
+
'metrics': ([str],), # noqa: E501
|
|
221
|
+
'timezone': (str,), # noqa: E501
|
|
232
222
|
}
|
|
233
223
|
|
|
234
224
|
@cached_property
|
|
@@ -299,19 +289,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
299
289
|
Animal class but this time we won't travel
|
|
300
290
|
through its discriminator because we passed in
|
|
301
291
|
_visited_composed_classes = (Animal,)
|
|
302
|
-
ids ([str]
|
|
303
|
-
id (str
|
|
304
|
-
search_term_types ([str]
|
|
305
|
-
search_term_targetings ([str]
|
|
306
|
-
campaign_type (str
|
|
307
|
-
sales_channel (str
|
|
308
|
-
format (str
|
|
309
|
-
report_type (str
|
|
310
|
-
click_attribution_window (str
|
|
311
|
-
view_attribution_window (str
|
|
312
|
-
dimensions ([str]
|
|
313
|
-
metrics ([str]
|
|
314
|
-
timezone (str
|
|
292
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
293
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
294
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
295
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
296
|
+
campaign_type (str): 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
|
|
297
|
+
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
298
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
299
|
+
report_type (str): 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
|
|
300
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
301
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
302
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
303
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
304
|
+
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|
|
315
305
|
"""
|
|
316
306
|
|
|
317
307
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -403,19 +393,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
403
393
|
Animal class but this time we won't travel
|
|
404
394
|
through its discriminator because we passed in
|
|
405
395
|
_visited_composed_classes = (Animal,)
|
|
406
|
-
ids ([str]
|
|
407
|
-
id (str
|
|
408
|
-
search_term_types ([str]
|
|
409
|
-
search_term_targetings ([str]
|
|
410
|
-
campaign_type (str
|
|
411
|
-
sales_channel (str
|
|
412
|
-
format (str
|
|
413
|
-
report_type (str
|
|
414
|
-
click_attribution_window (str
|
|
415
|
-
view_attribution_window (str
|
|
416
|
-
dimensions ([str]
|
|
417
|
-
metrics ([str]
|
|
418
|
-
timezone (str
|
|
396
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
397
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
398
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
399
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
400
|
+
campaign_type (str): 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
|
|
401
|
+
sales_channel (str): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
402
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
403
|
+
report_type (str): 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
|
|
404
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
405
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
406
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
407
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
408
|
+
timezone (str): Time zone : see criteo developer portal for supported time zones. [optional] if omitted the server will use the default value of "UTC" # noqa: E501
|
|
419
409
|
"""
|
|
420
410
|
|
|
421
411
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -87,7 +87,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,
|
|
90
|
+
'type': (str,), # noqa: E501
|
|
91
91
|
'attributes': (AsyncLineItemsReport,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
@@ -142,7 +142,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
142
142
|
Animal class but this time we won't travel
|
|
143
143
|
through its discriminator because we passed in
|
|
144
144
|
_visited_composed_classes = (Animal,)
|
|
145
|
-
type (str
|
|
145
|
+
type (str): [optional] # noqa: E501
|
|
146
146
|
attributes (AsyncLineItemsReport): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
@@ -229,7 +229,7 @@ class AsyncLineItemsReportResource(ModelNormal):
|
|
|
229
229
|
Animal class but this time we won't travel
|
|
230
230
|
through its discriminator because we passed in
|
|
231
231
|
_visited_composed_classes = (Animal,)
|
|
232
|
-
type (str
|
|
232
|
+
type (str): [optional] # noqa: E501
|
|
233
233
|
attributes (AsyncLineItemsReport): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|