criteo-api-retailmedia-sdk 0.0.250218__py3-none-any.whl → 0.0.250317__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_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +3 -3
- criteo_api_retailmedia_preview/api/billing_api.py +445 -0
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/apis/__init__.py +1 -0
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/add_remove_keyword_model.py +3 -3
- criteo_api_retailmedia_preview/model/application_summary_model.py +1 -1
- criteo_api_retailmedia_preview/model/application_summary_model_resource.py +1 -1
- criteo_api_retailmedia_preview/model/async_accounts_report.py +36 -47
- criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +39 -49
- criteo_api_retailmedia_preview/model/async_campaigns_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_fill_rate_report.py +21 -14
- criteo_api_retailmedia_preview/model/async_fill_rate_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/async_line_items_report.py +39 -49
- criteo_api_retailmedia_preview/model/async_line_items_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/balance_response_v2.py +1 -1
- criteo_api_retailmedia_preview/model/bot_message.py +1 -1
- criteo_api_retailmedia_preview/model/brand_id_search_request.py +3 -4
- criteo_api_retailmedia_preview/model/brand_id_search_result.py +1 -1
- criteo_api_retailmedia_preview/model/choice_variable_value.py +1 -1
- criteo_api_retailmedia_preview/model/cpc_min_bids_response.py +1 -1
- criteo_api_retailmedia_preview/model/create_balance_v2.py +3 -3
- criteo_api_retailmedia_preview/model/creative2.py +5 -1
- criteo_api_retailmedia_preview/model/creative_update_model2.py +3 -3
- criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_of_retail_media_child_account.py → entity_resource_collection_outcome_of_retail_media_child_account_and_metadata.py} +18 -25
- criteo_api_retailmedia_preview/model/entity_resource_of_retail_media_child_account.py +6 -13
- criteo_api_retailmedia_preview/model/entity_resource_outcome_partner_billing_report_status_v1.py +274 -0
- criteo_api_retailmedia_preview/model/entity_resource_partner_billing_report_status_v1.py +270 -0
- criteo_api_retailmedia_preview/model/export_report_meta_data.py +1 -1
- criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +4 -0
- criteo_api_retailmedia_preview/model/external_line_item_page_v2.py +3 -3
- criteo_api_retailmedia_preview/model/external_preferred_line_item_v2.py +4 -0
- criteo_api_retailmedia_preview/model/external_retail_media_child_account.py +25 -37
- criteo_api_retailmedia_preview/model/files_variable_value.py +1 -1
- criteo_api_retailmedia_preview/model/grant_consent_model.py +3 -3
- criteo_api_retailmedia_preview/model/grant_consent_model_value_resource.py +3 -3
- criteo_api_retailmedia_preview/model/inbot_discussion.py +3 -3
- criteo_api_retailmedia_preview/model/inbot_discussion_data_instance_model.py +3 -3
- criteo_api_retailmedia_preview/model/installment.py +3 -3
- criteo_api_retailmedia_preview/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_preview/model/keyword_data_model.py +6 -6
- criteo_api_retailmedia_preview/model/keywords.py +12 -14
- criteo_api_retailmedia_preview/model/keywords_model.py +1 -1
- criteo_api_retailmedia_preview/model/keywords_model_resource.py +1 -1
- criteo_api_retailmedia_preview/model/line_item_product_status.py +2 -1
- criteo_api_retailmedia_preview/model/loyalty_points.py +9 -9
- criteo_api_retailmedia_preview/model/message_data_instance_model.py +1 -1
- criteo_api_retailmedia_preview/model/metadata.py +1 -1
- criteo_api_retailmedia_preview/model/nillable_string.py +1 -1
- criteo_api_retailmedia_preview/model/page_metadata.py +6 -6
- criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +1 -1
- criteo_api_retailmedia_preview/model/partner_billing_report_request_v1.py +293 -0
- criteo_api_retailmedia_preview/model/partner_billing_report_status_v1.py +279 -0
- criteo_api_retailmedia_preview/model/price.py +6 -6
- criteo_api_retailmedia_preview/model/product.py +198 -198
- criteo_api_retailmedia_preview/model/product_metadata.py +1 -1
- criteo_api_retailmedia_preview/model/product_shipping.py +18 -18
- criteo_api_retailmedia_preview/model/product_shipping_dimension.py +6 -6
- criteo_api_retailmedia_preview/model/product_shipping_weight.py +6 -6
- criteo_api_retailmedia_preview/model/product_tax.py +18 -18
- criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +6 -6
- criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +6 -6
- criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py +12 -12
- criteo_api_retailmedia_preview/model/promoted_product.py +1 -1
- criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +3 -3
- criteo_api_retailmedia_preview/model/recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_preview/model/report_data_response_resource.py +1 -1
- criteo_api_retailmedia_preview/model/resource_of_balance_response_v2.py +1 -1
- criteo_api_retailmedia_preview/model/resource_of_change_dates_of_balance_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_create_balance_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_update_model_v2.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_product_button_request.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_slim_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_sku_search_request_slim_v2_preview.py +6 -6
- criteo_api_retailmedia_preview/model/resource_of_update_balance_model_v2.py +6 -6
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +3 -3
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_attributes.py +3 -4
- criteo_api_retailmedia_preview/model/rm_algebra_node_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1.py +9 -9
- criteo_api_retailmedia_preview/model/rm_audience_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_create_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_delete_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_bulk_update_input_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_delete_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_preview/model/rm_audience_segment_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_id_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1.py +9 -10
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_entity_v1_resource.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_search_metadata_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +3 -3
- criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1_resource.py +6 -6
- criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +3 -4
- criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_contact_list_statistics_entity_v1_resource.py +1 -1
- criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -1
- criteo_api_retailmedia_preview/model/rm_events_v1.py +1 -1
- criteo_api_retailmedia_preview/model/seller_catalog_request.py +3 -3
- criteo_api_retailmedia_preview/model/seller_search.py +3 -3
- criteo_api_retailmedia_preview/model/seller_search_result.py +1 -1
- criteo_api_retailmedia_preview/model/status_response.py +1 -1
- criteo_api_retailmedia_preview/model/status_response_resource.py +1 -1
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +27 -33
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +27 -34
- criteo_api_retailmedia_preview/model/sync_campaigns_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +30 -37
- criteo_api_retailmedia_preview/model/sync_line_items_report_resource.py +3 -3
- criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_response.py +1 -1
- criteo_api_retailmedia_preview/model/{offset_page_metadata.py → value_resource_input_partner_billing_report_request_v1.py} +15 -32
- criteo_api_retailmedia_preview/model/value_resource_of_recommended_keywords_result.py +1 -1
- criteo_api_retailmedia_preview/model/value_resource_partner_billing_report_request_v1.py +266 -0
- criteo_api_retailmedia_preview/model/video_variable_value.py +1 -1
- criteo_api_retailmedia_preview/models/__init__.py +7 -2
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250317.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250317.dist-info}/RECORD +124 -118
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250317.dist-info}/WHEEL +1 -1
- {criteo_api_retailmedia_sdk-0.0.250218.dist-info → criteo_api_retailmedia_sdk-0.0.250317.dist-info}/top_level.txt +0 -0
|
@@ -56,43 +56,36 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
58
|
('aggregation_level',): {
|
|
59
|
-
'None': None,
|
|
60
59
|
'CAMPAIGN': "campaign",
|
|
61
60
|
'LINEITEM': "lineItem",
|
|
62
61
|
},
|
|
63
62
|
('search_term_types',): {
|
|
64
|
-
'None': None,
|
|
65
63
|
'UNKNOWN': "unknown",
|
|
66
64
|
'SEARCHED': "searched",
|
|
67
65
|
'ENTERED': "entered",
|
|
68
66
|
},
|
|
69
67
|
('search_term_targetings',): {
|
|
70
|
-
'None': None,
|
|
71
68
|
'UNKNOWN': "unknown",
|
|
72
69
|
'AUTOMATIC': "automatic",
|
|
73
70
|
'MANUAL': "manual",
|
|
74
71
|
},
|
|
75
72
|
('campaign_type',): {
|
|
76
|
-
'None': None,
|
|
77
73
|
'ALL': "all",
|
|
78
74
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
79
75
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
80
76
|
},
|
|
81
77
|
('sales_channel',): {
|
|
82
|
-
'None': None,
|
|
83
78
|
'ALL': "all",
|
|
84
79
|
'OFFLINE': "offline",
|
|
85
80
|
'ONLINE': "online",
|
|
86
81
|
},
|
|
87
82
|
('format',): {
|
|
88
|
-
'None': None,
|
|
89
83
|
'JSON': "json",
|
|
90
84
|
'JSON-COMPACT': "json-compact",
|
|
91
85
|
'JSON-NEWLINE': "json-newline",
|
|
92
86
|
'CSV': "csv",
|
|
93
87
|
},
|
|
94
88
|
('report_type',): {
|
|
95
|
-
'None': None,
|
|
96
89
|
'SUMMARY': "summary",
|
|
97
90
|
'PAGETYPE': "pageType",
|
|
98
91
|
'KEYWORD': "keyword",
|
|
@@ -104,14 +97,12 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
104
97
|
'CAPOUT': "capout",
|
|
105
98
|
},
|
|
106
99
|
('click_attribution_window',): {
|
|
107
|
-
'None': None,
|
|
108
100
|
'NONE': "none",
|
|
109
101
|
'7D': "7D",
|
|
110
102
|
'14D': "14D",
|
|
111
103
|
'30D': "30D",
|
|
112
104
|
},
|
|
113
105
|
('view_attribution_window',): {
|
|
114
|
-
'None': None,
|
|
115
106
|
'NONE': "none",
|
|
116
107
|
'1D': "1D",
|
|
117
108
|
'7D': "7D",
|
|
@@ -119,7 +110,6 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
119
110
|
'30D': "30D",
|
|
120
111
|
},
|
|
121
112
|
('dimensions',): {
|
|
122
|
-
'None': None,
|
|
123
113
|
'DATE': "date",
|
|
124
114
|
'HOUR': "hour",
|
|
125
115
|
'ACCOUNTID': "accountId",
|
|
@@ -154,7 +144,6 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
154
144
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
155
145
|
},
|
|
156
146
|
('metrics',): {
|
|
157
|
-
'None': None,
|
|
158
147
|
'IMPRESSIONS': "impressions",
|
|
159
148
|
'CLICKS': "clicks",
|
|
160
149
|
'SPEND': "spend",
|
|
@@ -222,18 +211,18 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
222
211
|
'account_ids': ([str],), # noqa: E501
|
|
223
212
|
'start_date': (datetime,), # noqa: E501
|
|
224
213
|
'end_date': (datetime,), # noqa: E501
|
|
225
|
-
'aggregation_level': (str,
|
|
226
|
-
'search_term_types': ([str],
|
|
227
|
-
'search_term_targetings': ([str],
|
|
228
|
-
'campaign_type': (str,
|
|
229
|
-
'sales_channel': (str,
|
|
230
|
-
'format': (str,
|
|
231
|
-
'report_type': (str,
|
|
232
|
-
'click_attribution_window': (str,
|
|
233
|
-
'view_attribution_window': (str,
|
|
234
|
-
'dimensions': ([str],
|
|
235
|
-
'metrics': ([str],
|
|
236
|
-
'timezone': (str,
|
|
214
|
+
'aggregation_level': (str,), # noqa: E501
|
|
215
|
+
'search_term_types': ([str],), # noqa: E501
|
|
216
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
217
|
+
'campaign_type': (str,), # noqa: E501
|
|
218
|
+
'sales_channel': (str,), # noqa: E501
|
|
219
|
+
'format': (str,), # noqa: E501
|
|
220
|
+
'report_type': (str,), # noqa: E501
|
|
221
|
+
'click_attribution_window': (str,), # noqa: E501
|
|
222
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
223
|
+
'dimensions': ([str],), # noqa: E501
|
|
224
|
+
'metrics': ([str],), # noqa: E501
|
|
225
|
+
'timezone': (str,), # noqa: E501
|
|
237
226
|
}
|
|
238
227
|
|
|
239
228
|
@cached_property
|
|
@@ -305,18 +294,18 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
305
294
|
Animal class but this time we won't travel
|
|
306
295
|
through its discriminator because we passed in
|
|
307
296
|
_visited_composed_classes = (Animal,)
|
|
308
|
-
aggregation_level (str
|
|
309
|
-
search_term_types ([str]
|
|
310
|
-
search_term_targetings ([str]
|
|
311
|
-
campaign_type (str
|
|
312
|
-
sales_channel (str
|
|
313
|
-
format (str
|
|
314
|
-
report_type (str
|
|
315
|
-
click_attribution_window (str
|
|
316
|
-
view_attribution_window (str
|
|
317
|
-
dimensions ([str]
|
|
318
|
-
metrics ([str]
|
|
319
|
-
timezone (str
|
|
297
|
+
aggregation_level (str): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
|
|
298
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
299
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
300
|
+
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
|
|
301
|
+
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
|
|
302
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
303
|
+
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
|
|
304
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
305
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
306
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
307
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
308
|
+
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
|
|
320
309
|
"""
|
|
321
310
|
|
|
322
311
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -410,18 +399,18 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
410
399
|
Animal class but this time we won't travel
|
|
411
400
|
through its discriminator because we passed in
|
|
412
401
|
_visited_composed_classes = (Animal,)
|
|
413
|
-
aggregation_level (str
|
|
414
|
-
search_term_types ([str]
|
|
415
|
-
search_term_targetings ([str]
|
|
416
|
-
campaign_type (str
|
|
417
|
-
sales_channel (str
|
|
418
|
-
format (str
|
|
419
|
-
report_type (str
|
|
420
|
-
click_attribution_window (str
|
|
421
|
-
view_attribution_window (str
|
|
422
|
-
dimensions ([str]
|
|
423
|
-
metrics ([str]
|
|
424
|
-
timezone (str
|
|
402
|
+
aggregation_level (str): Level of aggregation, if no dimensions/metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
|
|
403
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
404
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
405
|
+
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
|
|
406
|
+
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
|
|
407
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
408
|
+
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
|
|
409
|
+
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
410
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
411
|
+
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
412
|
+
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
413
|
+
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
|
|
425
414
|
"""
|
|
426
415
|
|
|
427
416
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -87,7 +87,7 @@ class AsyncAccountsReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,
|
|
90
|
+
'type': (str,), # noqa: E501
|
|
91
91
|
'attributes': (AsyncAccountsReport,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
@@ -142,7 +142,7 @@ class AsyncAccountsReportResource(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 (AsyncAccountsReport): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
@@ -229,7 +229,7 @@ class AsyncAccountsReportResource(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 (AsyncAccountsReport): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|
|
@@ -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
|
|
|
@@ -84,14 +84,13 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
84
84
|
'CPC': "cpc",
|
|
85
85
|
'PLACEMENTIMPRESSIONSREVENUE': "placementImpressionsRevenue",
|
|
86
86
|
'PRODUCTCLICKSREVENUE': "productClicksRevenue",
|
|
87
|
-
'
|
|
87
|
+
'REVENUE': "revenue",
|
|
88
88
|
'WORKINGMEDIA': "workingMedia",
|
|
89
89
|
'NETREVENUE': "netRevenue",
|
|
90
90
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
91
91
|
'FREQUENCY': "frequency",
|
|
92
92
|
},
|
|
93
93
|
('format',): {
|
|
94
|
-
'None': None,
|
|
95
94
|
'JSON': "json",
|
|
96
95
|
'JSON-COMPACT': "json-compact",
|
|
97
96
|
'JSON-NEWLINE': "json-newline",
|
|
@@ -100,6 +99,12 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
100
99
|
}
|
|
101
100
|
|
|
102
101
|
validations = {
|
|
102
|
+
('dimensions',): {
|
|
103
|
+
'min_items': 1,
|
|
104
|
+
},
|
|
105
|
+
('metrics',): {
|
|
106
|
+
'min_items': 1,
|
|
107
|
+
},
|
|
103
108
|
}
|
|
104
109
|
|
|
105
110
|
@cached_property
|
|
@@ -123,13 +128,13 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
123
128
|
and the value is attribute type.
|
|
124
129
|
"""
|
|
125
130
|
return {
|
|
131
|
+
'supply_account_ids': ([str],), # noqa: E501
|
|
126
132
|
'dimensions': ([str],), # noqa: E501
|
|
127
133
|
'metrics': ([str],), # noqa: E501
|
|
128
134
|
'start_date': (datetime,), # noqa: E501
|
|
129
135
|
'end_date': (datetime,), # noqa: E501
|
|
130
|
-
'
|
|
131
|
-
'
|
|
132
|
-
'timezone': (str, none_type,), # noqa: E501
|
|
136
|
+
'format': (str,), # noqa: E501
|
|
137
|
+
'timezone': (str,), # noqa: E501
|
|
133
138
|
}
|
|
134
139
|
|
|
135
140
|
@cached_property
|
|
@@ -138,11 +143,11 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
138
143
|
|
|
139
144
|
|
|
140
145
|
attribute_map = {
|
|
146
|
+
'supply_account_ids': 'supplyAccountIds', # noqa: E501
|
|
141
147
|
'dimensions': 'dimensions', # noqa: E501
|
|
142
148
|
'metrics': 'metrics', # noqa: E501
|
|
143
149
|
'start_date': 'startDate', # noqa: E501
|
|
144
150
|
'end_date': 'endDate', # noqa: E501
|
|
145
|
-
'supply_account_ids': 'supplyAccountIds', # noqa: E501
|
|
146
151
|
'format': 'format', # noqa: E501
|
|
147
152
|
'timezone': 'timezone', # noqa: E501
|
|
148
153
|
}
|
|
@@ -154,10 +159,11 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
154
159
|
|
|
155
160
|
@classmethod
|
|
156
161
|
@convert_js_args_to_python_args
|
|
157
|
-
def _from_openapi_data(cls, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
162
|
+
def _from_openapi_data(cls, supply_account_ids, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
158
163
|
"""AsyncFillRateReport - a model defined in OpenAPI
|
|
159
164
|
|
|
160
165
|
Args:
|
|
166
|
+
supply_account_ids ([str]): Supply account ids to report on
|
|
161
167
|
dimensions ([str]): List of dimensions to report on
|
|
162
168
|
metrics ([str]): List of metrics to report on
|
|
163
169
|
start_date (datetime): Start date
|
|
@@ -194,9 +200,8 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
194
200
|
Animal class but this time we won't travel
|
|
195
201
|
through its discriminator because we passed in
|
|
196
202
|
_visited_composed_classes = (Animal,)
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
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
|
|
203
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json" # noqa: E501
|
|
204
|
+
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
|
|
200
205
|
"""
|
|
201
206
|
|
|
202
207
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -228,6 +233,7 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
228
233
|
self._configuration = _configuration
|
|
229
234
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
230
235
|
|
|
236
|
+
self.supply_account_ids = supply_account_ids
|
|
231
237
|
self.dimensions = dimensions
|
|
232
238
|
self.metrics = metrics
|
|
233
239
|
self.start_date = start_date
|
|
@@ -252,10 +258,11 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
252
258
|
])
|
|
253
259
|
|
|
254
260
|
@convert_js_args_to_python_args
|
|
255
|
-
def __init__(self, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
261
|
+
def __init__(self, supply_account_ids, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
256
262
|
"""AsyncFillRateReport - a model defined in OpenAPI
|
|
257
263
|
|
|
258
264
|
Args:
|
|
265
|
+
supply_account_ids ([str]): Supply account ids to report on
|
|
259
266
|
dimensions ([str]): List of dimensions to report on
|
|
260
267
|
metrics ([str]): List of metrics to report on
|
|
261
268
|
start_date (datetime): Start date
|
|
@@ -292,9 +299,8 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
292
299
|
Animal class but this time we won't travel
|
|
293
300
|
through its discriminator because we passed in
|
|
294
301
|
_visited_composed_classes = (Animal,)
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
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
|
|
302
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json" # noqa: E501
|
|
303
|
+
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
|
|
298
304
|
"""
|
|
299
305
|
|
|
300
306
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -324,6 +330,7 @@ class AsyncFillRateReport(ModelNormal):
|
|
|
324
330
|
self._configuration = _configuration
|
|
325
331
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
326
332
|
|
|
333
|
+
self.supply_account_ids = supply_account_ids
|
|
327
334
|
self.dimensions = dimensions
|
|
328
335
|
self.metrics = metrics
|
|
329
336
|
self.start_date = start_date
|
|
@@ -87,7 +87,7 @@ class AsyncFillRateReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,
|
|
90
|
+
'type': (str,), # noqa: E501
|
|
91
91
|
'attributes': (AsyncFillRateReport,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
@@ -142,7 +142,7 @@ class AsyncFillRateReportResource(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 (AsyncFillRateReport): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
@@ -229,7 +229,7 @@ class AsyncFillRateReportResource(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 (AsyncFillRateReport): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|