criteo-api-retailmedia-sdk 2025.1.0.250317__py3-none-any.whl → 2025.1.0.251112__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.
- {criteo_api_retailmedia_sdk-2025.1.0.250317.dist-info → criteo_api_retailmedia_sdk-2025.1.0.251112.dist-info}/METADATA +4 -4
- {criteo_api_retailmedia_sdk-2025.1.0.250317.dist-info → criteo_api_retailmedia_sdk-2025.1.0.251112.dist-info}/RECORD +184 -183
- {criteo_api_retailmedia_sdk-2025.1.0.250317.dist-info → criteo_api_retailmedia_sdk-2025.1.0.251112.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_v2025_01/__init__.py +1 -1
- criteo_api_retailmedia_v2025_01/api/accounts_api.py +10 -15
- criteo_api_retailmedia_v2025_01/api/analytics_api.py +10 -30
- criteo_api_retailmedia_v2025_01/api/audience_api.py +165 -193
- criteo_api_retailmedia_v2025_01/api/balance_api.py +261 -265
- criteo_api_retailmedia_v2025_01/api/campaign_api.py +1571 -1569
- 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_funds_to_balance_v2.py +7 -7
- criteo_api_retailmedia_v2025_01/model/add_remove_keyword_model.py +8 -8
- criteo_api_retailmedia_v2025_01/model/add_remove_keywords_model_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/{external_add_to_basket_ids_update_model202110.py → add_to_basket_ids_update_model202110.py} +7 -7
- criteo_api_retailmedia_v2025_01/model/{external_add_to_basket_target202110.py → add_to_basket_target202110.py} +7 -7
- criteo_api_retailmedia_v2025_01/model/add_to_basket_target202110_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/application_summary_model.py +8 -8
- criteo_api_retailmedia_v2025_01/model/application_summary_model_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/application_summary_model_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/asset.py +0 -4
- criteo_api_retailmedia_v2025_01/model/asset_response.py +5 -9
- criteo_api_retailmedia_v2025_01/model/async_campaigns_report.py +104 -79
- criteo_api_retailmedia_v2025_01/model/async_campaigns_report_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/async_line_items_report.py +104 -79
- criteo_api_retailmedia_v2025_01/model/async_line_items_report_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/async_report_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/async_revenue_report.py +145 -103
- criteo_api_retailmedia_v2025_01/model/async_revenue_report_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/{external_auction_line_item.py → auction_line_item.py} +43 -49
- criteo_api_retailmedia_v2025_01/model/{external_auction_line_item_create_model.py → auction_line_item_create_model.py} +33 -33
- criteo_api_retailmedia_v2025_01/model/auction_line_item_paged_list_response.py +14 -14
- criteo_api_retailmedia_v2025_01/model/auction_line_item_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/{external_auction_line_item_update_model.py → auction_line_item_update_model.py} +26 -26
- criteo_api_retailmedia_v2025_01/model/audience_error.py +16 -16
- criteo_api_retailmedia_v2025_01/model/{external_audience_ids_update_model202110.py → audience_ids_update_model202110.py} +3 -3
- criteo_api_retailmedia_v2025_01/model/{external_audience_target202110.py → audience_target202110.py} +11 -11
- criteo_api_retailmedia_v2025_01/model/audience_target202110_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/audience_warning.py +22 -22
- criteo_api_retailmedia_v2025_01/model/balance_campaign202110_paged_list_response.py +14 -14
- criteo_api_retailmedia_v2025_01/model/balance_history_change_data_capture_v1.py +14 -14
- criteo_api_retailmedia_v2025_01/model/balance_response_v2.py +45 -45
- criteo_api_retailmedia_v2025_01/model/{paged_resource_collection_outcome_of_balance_response_v2.py → balance_response_v2_paged_list_response.py} +12 -12
- criteo_api_retailmedia_v2025_01/model/balance_response_v2_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/campaign_attributes_v202301.py +59 -63
- criteo_api_retailmedia_v2025_01/model/campaign_budget_overrides.py +8 -8
- criteo_api_retailmedia_v2025_01/model/campaign_v202301.py +84 -94
- criteo_api_retailmedia_v2025_01/model/category202204.py +8 -8
- criteo_api_retailmedia_v2025_01/model/category202204_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/change_dates_of_balance_v2.py +10 -10
- criteo_api_retailmedia_v2025_01/model/change_details_v1.py +8 -8
- criteo_api_retailmedia_v2025_01/model/common_error.py +18 -18
- criteo_api_retailmedia_v2025_01/model/{external_common_line_item.py → common_line_item.py} +37 -39
- criteo_api_retailmedia_v2025_01/model/common_line_item_paged_list_response.py +14 -14
- criteo_api_retailmedia_v2025_01/model/common_line_item_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/common_problem.py +20 -20
- criteo_api_retailmedia_v2025_01/model/common_warning.py +18 -18
- criteo_api_retailmedia_v2025_01/model/create_balance_v2.py +15 -15
- criteo_api_retailmedia_v2025_01/model/creative2.py +50 -50
- criteo_api_retailmedia_v2025_01/model/creative202110.py +16 -12
- criteo_api_retailmedia_v2025_01/model/creative202110_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/creative202210.py +40 -36
- criteo_api_retailmedia_v2025_01/model/creative202210_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/creative2_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/creative2_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/daily_line_item_budget_override.py +4 -4
- criteo_api_retailmedia_v2025_01/model/editable_campaign_attributes_v202301.py +35 -39
- criteo_api_retailmedia_v2025_01/model/entity_resource_of_retail_media_account.py +4 -4
- criteo_api_retailmedia_v2025_01/model/entity_resource_outcome_of_retail_media_account.py +5 -5
- criteo_api_retailmedia_v2025_01/model/external_account.py +18 -18
- criteo_api_retailmedia_v2025_01/model/external_catalog_request.py +4 -4
- criteo_api_retailmedia_v2025_01/model/external_catalog_status.py +20 -20
- criteo_api_retailmedia_v2025_01/model/external_retail_media_account.py +22 -22
- criteo_api_retailmedia_v2025_01/model/external_retail_media_brand_account_creation.py +8 -8
- criteo_api_retailmedia_v2025_01/model/external_retail_media_seller.py +8 -8
- criteo_api_retailmedia_v2025_01/model/external_retail_media_seller_account_creation.py +4 -4
- criteo_api_retailmedia_v2025_01/model/files_variable_value.py +0 -3
- criteo_api_retailmedia_v2025_01/model/files_variables_specification.py +4 -4
- criteo_api_retailmedia_v2025_01/model/grant_consent_model.py +8 -8
- criteo_api_retailmedia_v2025_01/model/grant_consent_model_value_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/input_resource_of_auction_line_item_create_model.py +6 -6
- criteo_api_retailmedia_v2025_01/model/input_resource_of_preferred_line_item_create_model_v2.py +6 -6
- 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 → json_api_body_with_line_item_bid_multipliers_v2.py} +8 -8
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_account.py +8 -8
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_brand.py +8 -8
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_campaign_v202301.py +8 -8
- criteo_api_retailmedia_v2025_01/model/json_api_page_response_of_retailer.py +8 -8
- criteo_api_retailmedia_v2025_01/model/json_api_single_response_of_line_item_bid_multipliers_v2.py +5 -5
- criteo_api_retailmedia_v2025_01/model/keyword_data_model.py +12 -12
- criteo_api_retailmedia_v2025_01/model/{external_keyword_target202110.py → keyword_target202110.py} +3 -3
- criteo_api_retailmedia_v2025_01/model/keyword_target202110_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/keywords.py +18 -18
- criteo_api_retailmedia_v2025_01/model/keywords_model_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/keywords_model_response.py +4 -4
- criteo_api_retailmedia_v2025_01/model/{external_line_item_bid_multipliers_v2.py → line_item_bid_multipliers_v2.py} +31 -31
- criteo_api_retailmedia_v2025_01/model/line_item_bid_multipliers_v2_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/line_item_budget_overrides.py +8 -8
- criteo_api_retailmedia_v2025_01/model/{external_line_item_capping_v2.py → line_item_capping_v2.py} +12 -12
- criteo_api_retailmedia_v2025_01/model/{external_line_item_page_category_v2.py → line_item_page_category_v2.py} +3 -3
- criteo_api_retailmedia_v2025_01/model/{external_line_item_page_v2.py → line_item_page_v2.py} +12 -12
- criteo_api_retailmedia_v2025_01/model/metadata.py +8 -8
- criteo_api_retailmedia_v2025_01/model/nillable_decimal.py +263 -0
- criteo_api_retailmedia_v2025_01/model/page_metadata.py +16 -16
- criteo_api_retailmedia_v2025_01/model/page_of_balance_history_change_data_capture_v1.py +8 -8
- criteo_api_retailmedia_v2025_01/model/page_type_environment2.py +14 -14
- criteo_api_retailmedia_v2025_01/model/page_type_environment202210.py +14 -14
- criteo_api_retailmedia_v2025_01/model/{external_preferred_line_item_create_model_v2.py → preferred_line_item_create_model_v2.py} +37 -37
- criteo_api_retailmedia_v2025_01/model/{external_preferred_line_item_update_model_v2.py → preferred_line_item_update_model_v2.py} +30 -30
- criteo_api_retailmedia_v2025_01/model/{external_preferred_line_item_v2.py → preferred_line_item_v2.py} +55 -57
- criteo_api_retailmedia_v2025_01/model/preferred_line_item_v2_paged_list_response.py +9 -9
- criteo_api_retailmedia_v2025_01/model/preferred_line_item_v2_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/problem_details.py +20 -20
- criteo_api_retailmedia_v2025_01/model/product_metadata.py +8 -8
- criteo_api_retailmedia_v2025_01/model/promoted_product.py +4 -4
- criteo_api_retailmedia_v2025_01/model/promoted_product_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/promoted_product_resource_collection_outcome.py +8 -8
- criteo_api_retailmedia_v2025_01/model/resource_of_auction_line_item.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_campaign202110.py +4 -4
- criteo_api_retailmedia_v2025_01/model/resource_of_common_line_item.py +6 -6
- criteo_api_retailmedia_v2025_01/model/resource_of_line_item_bid_multipliers_v2.py +5 -5
- 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_preferred_line_item_v2.py +6 -6
- criteo_api_retailmedia_v2025_01/model/retail_media_contactlist_amendment_attributes.py +8 -8
- criteo_api_retailmedia_v2025_01/model/rm_algebra_node_v1.py +8 -8
- criteo_api_retailmedia_v2025_01/model/rm_audience_entity_v1.py +20 -20
- criteo_api_retailmedia_v2025_01/model/rm_audience_entity_v1_rm_audience_search_metadata_v1_list_response.py +9 -9
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_entity_v1.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_entity_v1_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_search_metadata_v1.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_create_entity_v1.py +10 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_create_entity_v1_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_entity_v1.py +30 -30
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_entity_v1_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_entity_v1_rm_audience_segment_search_metadata_v1_list_response.py +9 -9
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_id_entity_v1_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_entity_v1.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_entity_v1_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_search_metadata_v1.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_audience_segment_update_entity_v1.py +14 -8
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_create_v1.py +1 -0
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_statistics_entity_v1.py +4 -4
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_statistics_entity_v1_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/rm_contact_list_v1.py +5 -4
- criteo_api_retailmedia_v2025_01/model/rm_events_create_v1.py +311 -0
- criteo_api_retailmedia_v2025_01/model/{report_outcome.py → rm_events_update_v1.py} +45 -15
- criteo_api_retailmedia_v2025_01/model/rm_events_v1.py +23 -23
- criteo_api_retailmedia_v2025_01/model/rmca_common_problem.py +16 -16
- criteo_api_retailmedia_v2025_01/model/sdk_api_rest_common_problem.py +16 -16
- criteo_api_retailmedia_v2025_01/model/section.py +4 -4
- criteo_api_retailmedia_v2025_01/model/set_bid_model.py +4 -4
- criteo_api_retailmedia_v2025_01/model/set_bids_model_resource.py +4 -4
- criteo_api_retailmedia_v2025_01/model/status_response.py +20 -20
- criteo_api_retailmedia_v2025_01/model/{external_store_ids_update_model202110.py → store_ids_update_model202110.py} +3 -3
- criteo_api_retailmedia_v2025_01/model/{external_store_target202110.py → store_target202110.py} +3 -3
- criteo_api_retailmedia_v2025_01/model/store_target202110_response.py +10 -10
- criteo_api_retailmedia_v2025_01/model/template.py +24 -24
- criteo_api_retailmedia_v2025_01/model/template_list_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/template_response.py +5 -5
- criteo_api_retailmedia_v2025_01/model/template_variable.py +4 -4
- criteo_api_retailmedia_v2025_01/model/template_variable_value.py +4 -4
- criteo_api_retailmedia_v2025_01/model/update_balance_model_v2.py +8 -8
- criteo_api_retailmedia_v2025_01/model/value_resource_collection_outcome_of_retail_media_seller.py +5 -5
- criteo_api_retailmedia_v2025_01/model/value_resource_of_campaign_budget_overrides.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_line_item_budget_overrides.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_recommended_keywords_result.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_brand_account_creation.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_brands.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_seller.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_of_retail_media_seller_account_creation.py +4 -4
- criteo_api_retailmedia_v2025_01/model/value_resource_outcome_of_campaign_budget_overrides.py +10 -10
- criteo_api_retailmedia_v2025_01/model/value_resource_outcome_of_line_item_budget_overrides.py +10 -10
- criteo_api_retailmedia_v2025_01/model/value_resource_outcome_of_recommended_keywords_result.py +10 -10
- criteo_api_retailmedia_v2025_01/model/value_resource_outcome_of_retail_media_brands.py +5 -5
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_add_to_basket_ids_update_model202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_add_to_basket_target202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_audience_ids_update_model202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_audience_target202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_keyword_target202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_store_ids_update_model202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/value_type_resource_of_store_target202110.py +6 -6
- criteo_api_retailmedia_v2025_01/model/video_variable_value.py +16 -16
- criteo_api_retailmedia_v2025_01/models/__init__.py +23 -22
- criteo_api_retailmedia_v2025_01/model/error_code_response.py +0 -281
- {criteo_api_retailmedia_sdk-2025.1.0.250317.dist-info → criteo_api_retailmedia_sdk-2025.1.0.251112.dist-info}/top_level.txt +0 -0
|
@@ -55,56 +55,17 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
-
('search_term_types',): {
|
|
59
|
-
'UNKNOWN': "unknown",
|
|
60
|
-
'SEARCHED': "searched",
|
|
61
|
-
'ENTERED': "entered",
|
|
62
|
-
},
|
|
63
|
-
('search_term_targetings',): {
|
|
64
|
-
'UNKNOWN': "unknown",
|
|
65
|
-
'AUTOMATIC': "automatic",
|
|
66
|
-
'MANUAL': "manual",
|
|
67
|
-
},
|
|
68
58
|
('campaign_type',): {
|
|
69
59
|
'ALL': "all",
|
|
70
60
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
71
61
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
72
62
|
},
|
|
73
|
-
('sales_channel',): {
|
|
74
|
-
'ALL': "all",
|
|
75
|
-
'OFFLINE': "offline",
|
|
76
|
-
'ONLINE': "online",
|
|
77
|
-
},
|
|
78
|
-
('format',): {
|
|
79
|
-
'JSON': "json",
|
|
80
|
-
'JSON-COMPACT': "json-compact",
|
|
81
|
-
'JSON-NEWLINE': "json-newline",
|
|
82
|
-
'CSV': "csv",
|
|
83
|
-
},
|
|
84
|
-
('report_type',): {
|
|
85
|
-
'SUMMARY': "summary",
|
|
86
|
-
'PAGETYPE': "pageType",
|
|
87
|
-
'KEYWORD': "keyword",
|
|
88
|
-
'PRODUCTCATEGORY': "productCategory",
|
|
89
|
-
'PRODUCT': "product",
|
|
90
|
-
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
91
|
-
'ENVIRONMENT': "environment",
|
|
92
|
-
'SERVEDCATEGORY': "servedCategory",
|
|
93
|
-
'CAPOUT': "capout",
|
|
94
|
-
},
|
|
95
63
|
('click_attribution_window',): {
|
|
96
64
|
'NONE': "none",
|
|
97
65
|
'7D': "7D",
|
|
98
66
|
'14D': "14D",
|
|
99
67
|
'30D': "30D",
|
|
100
68
|
},
|
|
101
|
-
('view_attribution_window',): {
|
|
102
|
-
'NONE': "none",
|
|
103
|
-
'1D': "1D",
|
|
104
|
-
'7D': "7D",
|
|
105
|
-
'14D': "14D",
|
|
106
|
-
'30D': "30D",
|
|
107
|
-
},
|
|
108
69
|
('dimensions',): {
|
|
109
70
|
'DATE': "date",
|
|
110
71
|
'HOUR': "hour",
|
|
@@ -123,6 +84,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
123
84
|
'ADVPRODUCTID': "advProductId",
|
|
124
85
|
'ADVPRODUCTNAME': "advProductName",
|
|
125
86
|
'SALESCHANNEL': "salesChannel",
|
|
87
|
+
'MEDIATYPE': "mediaType",
|
|
126
88
|
'ENVIRONMENT': "environment",
|
|
127
89
|
'PAGETYPENAME': "pageTypeName",
|
|
128
90
|
'PAGECATEGORY': "pageCategory",
|
|
@@ -138,6 +100,19 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
138
100
|
'CREATIVETYPENAME': "creativeTypeName",
|
|
139
101
|
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
140
102
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
103
|
+
'TARGETEDKEYWORDTYPE': "targetedKeywordType",
|
|
104
|
+
},
|
|
105
|
+
('format',): {
|
|
106
|
+
'JSON': "json",
|
|
107
|
+
'JSON-COMPACT': "json-compact",
|
|
108
|
+
'JSON-NEWLINE': "json-newline",
|
|
109
|
+
'CSV': "csv",
|
|
110
|
+
},
|
|
111
|
+
('media_type',): {
|
|
112
|
+
'UNKNOWN': "unknown",
|
|
113
|
+
'VIDEO': "video",
|
|
114
|
+
'DISPLAY': "display",
|
|
115
|
+
'ALL': "all",
|
|
141
116
|
},
|
|
142
117
|
('metrics',): {
|
|
143
118
|
'IMPRESSIONS': "impressions",
|
|
@@ -177,6 +152,48 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
177
152
|
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
178
153
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
179
154
|
'FREQUENCY': "frequency",
|
|
155
|
+
'WINRATE': "winRate",
|
|
156
|
+
'SAMPLEDBIDSWON': "sampledBidsWon",
|
|
157
|
+
'SAMPLEDBIDSPARTICIPATED': "sampledBidsParticipated",
|
|
158
|
+
},
|
|
159
|
+
('report_type',): {
|
|
160
|
+
'SUMMARY': "summary",
|
|
161
|
+
'PAGETYPE': "pageType",
|
|
162
|
+
'KEYWORD': "keyword",
|
|
163
|
+
'PRODUCTCATEGORY': "productCategory",
|
|
164
|
+
'PRODUCT': "product",
|
|
165
|
+
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
166
|
+
'ENVIRONMENT': "environment",
|
|
167
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
168
|
+
'CAPOUT': "capout",
|
|
169
|
+
},
|
|
170
|
+
('sales_channel',): {
|
|
171
|
+
'ONLINE': "online",
|
|
172
|
+
'OFFLINE': "offline",
|
|
173
|
+
'ALL': "all",
|
|
174
|
+
},
|
|
175
|
+
('search_term_targetings',): {
|
|
176
|
+
'UNKNOWN': "unknown",
|
|
177
|
+
'AUTOMATIC': "automatic",
|
|
178
|
+
'MANUAL': "manual",
|
|
179
|
+
},
|
|
180
|
+
('search_term_types',): {
|
|
181
|
+
'UNKNOWN': "unknown",
|
|
182
|
+
'SEARCHED': "searched",
|
|
183
|
+
'ENTERED': "entered",
|
|
184
|
+
},
|
|
185
|
+
('targeted_keyword_types',): {
|
|
186
|
+
'UNKNOWN': "unknown",
|
|
187
|
+
'GENERIC': "generic",
|
|
188
|
+
'BRANDED': "branded",
|
|
189
|
+
'CONQUESTING': "conquesting",
|
|
190
|
+
},
|
|
191
|
+
('view_attribution_window',): {
|
|
192
|
+
'NONE': "none",
|
|
193
|
+
'1D': "1D",
|
|
194
|
+
'7D': "7D",
|
|
195
|
+
'14D': "14D",
|
|
196
|
+
'30D': "30D",
|
|
180
197
|
},
|
|
181
198
|
}
|
|
182
199
|
|
|
@@ -204,21 +221,23 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
204
221
|
and the value is attribute type.
|
|
205
222
|
"""
|
|
206
223
|
return {
|
|
207
|
-
'start_date': (datetime,), # noqa: E501
|
|
208
224
|
'end_date': (datetime,), # noqa: E501
|
|
209
|
-
'
|
|
210
|
-
'id': (str,), # noqa: E501
|
|
211
|
-
'search_term_types': ([str],), # noqa: E501
|
|
212
|
-
'search_term_targetings': ([str],), # noqa: E501
|
|
225
|
+
'start_date': (datetime,), # noqa: E501
|
|
213
226
|
'campaign_type': (str,), # noqa: E501
|
|
214
|
-
'sales_channel': (str,), # noqa: E501
|
|
215
|
-
'format': (str,), # noqa: E501
|
|
216
|
-
'report_type': (str,), # noqa: E501
|
|
217
227
|
'click_attribution_window': (str,), # noqa: E501
|
|
218
|
-
'view_attribution_window': (str,), # noqa: E501
|
|
219
228
|
'dimensions': ([str],), # noqa: E501
|
|
229
|
+
'format': (str,), # noqa: E501
|
|
230
|
+
'id': (str,), # noqa: E501
|
|
231
|
+
'ids': ([str],), # noqa: E501
|
|
232
|
+
'media_type': (str,), # noqa: E501
|
|
220
233
|
'metrics': ([str],), # noqa: E501
|
|
234
|
+
'report_type': (str,), # noqa: E501
|
|
235
|
+
'sales_channel': (str,), # noqa: E501
|
|
236
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
237
|
+
'search_term_types': ([str],), # noqa: E501
|
|
238
|
+
'targeted_keyword_types': ([str],), # noqa: E501
|
|
221
239
|
'timezone': (str,), # noqa: E501
|
|
240
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
222
241
|
}
|
|
223
242
|
|
|
224
243
|
@cached_property
|
|
@@ -227,21 +246,23 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
227
246
|
|
|
228
247
|
|
|
229
248
|
attribute_map = {
|
|
230
|
-
'start_date': 'startDate', # noqa: E501
|
|
231
249
|
'end_date': 'endDate', # noqa: E501
|
|
232
|
-
'
|
|
233
|
-
'id': 'id', # noqa: E501
|
|
234
|
-
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
235
|
-
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
250
|
+
'start_date': 'startDate', # noqa: E501
|
|
236
251
|
'campaign_type': 'campaignType', # noqa: E501
|
|
237
|
-
'sales_channel': 'salesChannel', # noqa: E501
|
|
238
|
-
'format': 'format', # noqa: E501
|
|
239
|
-
'report_type': 'reportType', # noqa: E501
|
|
240
252
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
241
|
-
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
242
253
|
'dimensions': 'dimensions', # noqa: E501
|
|
254
|
+
'format': 'format', # noqa: E501
|
|
255
|
+
'id': 'id', # noqa: E501
|
|
256
|
+
'ids': 'ids', # noqa: E501
|
|
257
|
+
'media_type': 'mediaType', # noqa: E501
|
|
243
258
|
'metrics': 'metrics', # noqa: E501
|
|
259
|
+
'report_type': 'reportType', # noqa: E501
|
|
260
|
+
'sales_channel': 'salesChannel', # noqa: E501
|
|
261
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
262
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
263
|
+
'targeted_keyword_types': 'targetedKeywordTypes', # noqa: E501
|
|
244
264
|
'timezone': 'timezone', # noqa: E501
|
|
265
|
+
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
245
266
|
}
|
|
246
267
|
|
|
247
268
|
read_only_vars = {
|
|
@@ -251,12 +272,12 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
251
272
|
|
|
252
273
|
@classmethod
|
|
253
274
|
@convert_js_args_to_python_args
|
|
254
|
-
def _from_openapi_data(cls,
|
|
275
|
+
def _from_openapi_data(cls, end_date, start_date, *args, **kwargs): # noqa: E501
|
|
255
276
|
"""AsyncCampaignsReport - a model defined in OpenAPI
|
|
256
277
|
|
|
257
278
|
Args:
|
|
258
|
-
start_date (datetime): Start date
|
|
259
279
|
end_date (datetime): End date
|
|
280
|
+
start_date (datetime): Start date
|
|
260
281
|
|
|
261
282
|
Keyword Args:
|
|
262
283
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -289,19 +310,21 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
289
310
|
Animal class but this time we won't travel
|
|
290
311
|
through its discriminator because we passed in
|
|
291
312
|
_visited_composed_classes = (Animal,)
|
|
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
313
|
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
314
|
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
315
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
316
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
317
|
+
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
318
|
+
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
319
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
303
320
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
321
|
+
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
322
|
+
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
|
|
323
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
324
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
325
|
+
targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional] # noqa: E501
|
|
304
326
|
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
|
|
327
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
305
328
|
"""
|
|
306
329
|
|
|
307
330
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -333,8 +356,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
333
356
|
self._configuration = _configuration
|
|
334
357
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
335
358
|
|
|
336
|
-
self.start_date = start_date
|
|
337
359
|
self.end_date = end_date
|
|
360
|
+
self.start_date = start_date
|
|
338
361
|
for var_name, var_value in kwargs.items():
|
|
339
362
|
if var_name not in self.attribute_map and \
|
|
340
363
|
self._configuration is not None and \
|
|
@@ -355,12 +378,12 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
355
378
|
])
|
|
356
379
|
|
|
357
380
|
@convert_js_args_to_python_args
|
|
358
|
-
def __init__(self,
|
|
381
|
+
def __init__(self, end_date, start_date, *args, **kwargs): # noqa: E501
|
|
359
382
|
"""AsyncCampaignsReport - a model defined in OpenAPI
|
|
360
383
|
|
|
361
384
|
Args:
|
|
362
|
-
start_date (datetime): Start date
|
|
363
385
|
end_date (datetime): End date
|
|
386
|
+
start_date (datetime): Start date
|
|
364
387
|
|
|
365
388
|
Keyword Args:
|
|
366
389
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -393,19 +416,21 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
393
416
|
Animal class but this time we won't travel
|
|
394
417
|
through its discriminator because we passed in
|
|
395
418
|
_visited_composed_classes = (Animal,)
|
|
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
419
|
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
420
|
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
421
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
422
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
423
|
+
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
424
|
+
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
425
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
407
426
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
427
|
+
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
428
|
+
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
|
|
429
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
430
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
431
|
+
targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional] # noqa: E501
|
|
408
432
|
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
|
|
433
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
409
434
|
"""
|
|
410
435
|
|
|
411
436
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -435,8 +460,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
435
460
|
self._configuration = _configuration
|
|
436
461
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
437
462
|
|
|
438
|
-
self.start_date = start_date
|
|
439
463
|
self.end_date = end_date
|
|
464
|
+
self.start_date = start_date
|
|
440
465
|
for var_name, var_value in kwargs.items():
|
|
441
466
|
if var_name not in self.attribute_map and \
|
|
442
467
|
self._configuration is not None and \
|
|
@@ -87,8 +87,8 @@ class AsyncCampaignsReportResource(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'type': (str,), # noqa: E501
|
|
91
90
|
'attributes': (AsyncCampaignsReport,), # noqa: E501
|
|
91
|
+
'type': (str,), # noqa: E501
|
|
92
92
|
}
|
|
93
93
|
|
|
94
94
|
@cached_property
|
|
@@ -97,8 +97,8 @@ class AsyncCampaignsReportResource(ModelNormal):
|
|
|
97
97
|
|
|
98
98
|
|
|
99
99
|
attribute_map = {
|
|
100
|
-
'type': 'type', # noqa: E501
|
|
101
100
|
'attributes': 'attributes', # noqa: E501
|
|
101
|
+
'type': 'type', # noqa: E501
|
|
102
102
|
}
|
|
103
103
|
|
|
104
104
|
read_only_vars = {
|
|
@@ -142,8 +142,8 @@ 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): [optional] # noqa: E501
|
|
146
145
|
attributes (AsyncCampaignsReport): [optional] # noqa: E501
|
|
146
|
+
type (str): [optional] # noqa: E501
|
|
147
147
|
"""
|
|
148
148
|
|
|
149
149
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -229,8 +229,8 @@ 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): [optional] # noqa: E501
|
|
233
232
|
attributes (AsyncCampaignsReport): [optional] # noqa: E501
|
|
233
|
+
type (str): [optional] # noqa: E501
|
|
234
234
|
"""
|
|
235
235
|
|
|
236
236
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -55,56 +55,17 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
-
('search_term_types',): {
|
|
59
|
-
'UNKNOWN': "unknown",
|
|
60
|
-
'SEARCHED': "searched",
|
|
61
|
-
'ENTERED': "entered",
|
|
62
|
-
},
|
|
63
|
-
('search_term_targetings',): {
|
|
64
|
-
'UNKNOWN': "unknown",
|
|
65
|
-
'AUTOMATIC': "automatic",
|
|
66
|
-
'MANUAL': "manual",
|
|
67
|
-
},
|
|
68
58
|
('campaign_type',): {
|
|
69
59
|
'ALL': "all",
|
|
70
60
|
'SPONSOREDPRODUCTS': "sponsoredProducts",
|
|
71
61
|
'ONSITEDISPLAYS': "onSiteDisplays",
|
|
72
62
|
},
|
|
73
|
-
('sales_channel',): {
|
|
74
|
-
'ALL': "all",
|
|
75
|
-
'OFFLINE': "offline",
|
|
76
|
-
'ONLINE': "online",
|
|
77
|
-
},
|
|
78
|
-
('format',): {
|
|
79
|
-
'JSON': "json",
|
|
80
|
-
'JSON-COMPACT': "json-compact",
|
|
81
|
-
'JSON-NEWLINE': "json-newline",
|
|
82
|
-
'CSV': "csv",
|
|
83
|
-
},
|
|
84
|
-
('report_type',): {
|
|
85
|
-
'SUMMARY': "summary",
|
|
86
|
-
'PAGETYPE': "pageType",
|
|
87
|
-
'KEYWORD': "keyword",
|
|
88
|
-
'PRODUCTCATEGORY': "productCategory",
|
|
89
|
-
'PRODUCT': "product",
|
|
90
|
-
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
91
|
-
'ENVIRONMENT': "environment",
|
|
92
|
-
'SERVEDCATEGORY': "servedCategory",
|
|
93
|
-
'CAPOUT': "capout",
|
|
94
|
-
},
|
|
95
63
|
('click_attribution_window',): {
|
|
96
64
|
'NONE': "none",
|
|
97
65
|
'7D': "7D",
|
|
98
66
|
'14D': "14D",
|
|
99
67
|
'30D': "30D",
|
|
100
68
|
},
|
|
101
|
-
('view_attribution_window',): {
|
|
102
|
-
'NONE': "none",
|
|
103
|
-
'1D': "1D",
|
|
104
|
-
'7D': "7D",
|
|
105
|
-
'14D': "14D",
|
|
106
|
-
'30D': "30D",
|
|
107
|
-
},
|
|
108
69
|
('dimensions',): {
|
|
109
70
|
'DATE': "date",
|
|
110
71
|
'HOUR': "hour",
|
|
@@ -123,6 +84,7 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
123
84
|
'ADVPRODUCTID': "advProductId",
|
|
124
85
|
'ADVPRODUCTNAME': "advProductName",
|
|
125
86
|
'SALESCHANNEL': "salesChannel",
|
|
87
|
+
'MEDIATYPE': "mediaType",
|
|
126
88
|
'ENVIRONMENT': "environment",
|
|
127
89
|
'PAGETYPENAME': "pageTypeName",
|
|
128
90
|
'PAGECATEGORY': "pageCategory",
|
|
@@ -138,6 +100,19 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
138
100
|
'CREATIVETYPENAME': "creativeTypeName",
|
|
139
101
|
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
140
102
|
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
103
|
+
'TARGETEDKEYWORDTYPE': "targetedKeywordType",
|
|
104
|
+
},
|
|
105
|
+
('format',): {
|
|
106
|
+
'JSON': "json",
|
|
107
|
+
'JSON-COMPACT': "json-compact",
|
|
108
|
+
'JSON-NEWLINE': "json-newline",
|
|
109
|
+
'CSV': "csv",
|
|
110
|
+
},
|
|
111
|
+
('media_type',): {
|
|
112
|
+
'UNKNOWN': "unknown",
|
|
113
|
+
'VIDEO': "video",
|
|
114
|
+
'DISPLAY': "display",
|
|
115
|
+
'ALL': "all",
|
|
141
116
|
},
|
|
142
117
|
('metrics',): {
|
|
143
118
|
'IMPRESSIONS': "impressions",
|
|
@@ -177,6 +152,48 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
177
152
|
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
178
153
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
179
154
|
'FREQUENCY': "frequency",
|
|
155
|
+
'WINRATE': "winRate",
|
|
156
|
+
'SAMPLEDBIDSWON': "sampledBidsWon",
|
|
157
|
+
'SAMPLEDBIDSPARTICIPATED': "sampledBidsParticipated",
|
|
158
|
+
},
|
|
159
|
+
('report_type',): {
|
|
160
|
+
'SUMMARY': "summary",
|
|
161
|
+
'PAGETYPE': "pageType",
|
|
162
|
+
'KEYWORD': "keyword",
|
|
163
|
+
'PRODUCTCATEGORY': "productCategory",
|
|
164
|
+
'PRODUCT': "product",
|
|
165
|
+
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
166
|
+
'ENVIRONMENT': "environment",
|
|
167
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
168
|
+
'CAPOUT': "capout",
|
|
169
|
+
},
|
|
170
|
+
('sales_channel',): {
|
|
171
|
+
'ONLINE': "online",
|
|
172
|
+
'OFFLINE': "offline",
|
|
173
|
+
'ALL': "all",
|
|
174
|
+
},
|
|
175
|
+
('search_term_targetings',): {
|
|
176
|
+
'UNKNOWN': "unknown",
|
|
177
|
+
'AUTOMATIC': "automatic",
|
|
178
|
+
'MANUAL': "manual",
|
|
179
|
+
},
|
|
180
|
+
('search_term_types',): {
|
|
181
|
+
'UNKNOWN': "unknown",
|
|
182
|
+
'SEARCHED': "searched",
|
|
183
|
+
'ENTERED': "entered",
|
|
184
|
+
},
|
|
185
|
+
('targeted_keyword_types',): {
|
|
186
|
+
'UNKNOWN': "unknown",
|
|
187
|
+
'GENERIC': "generic",
|
|
188
|
+
'BRANDED': "branded",
|
|
189
|
+
'CONQUESTING': "conquesting",
|
|
190
|
+
},
|
|
191
|
+
('view_attribution_window',): {
|
|
192
|
+
'NONE': "none",
|
|
193
|
+
'1D': "1D",
|
|
194
|
+
'7D': "7D",
|
|
195
|
+
'14D': "14D",
|
|
196
|
+
'30D': "30D",
|
|
180
197
|
},
|
|
181
198
|
}
|
|
182
199
|
|
|
@@ -204,21 +221,23 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
204
221
|
and the value is attribute type.
|
|
205
222
|
"""
|
|
206
223
|
return {
|
|
207
|
-
'start_date': (datetime,), # noqa: E501
|
|
208
224
|
'end_date': (datetime,), # noqa: E501
|
|
209
|
-
'
|
|
210
|
-
'id': (str,), # noqa: E501
|
|
211
|
-
'search_term_types': ([str],), # noqa: E501
|
|
212
|
-
'search_term_targetings': ([str],), # noqa: E501
|
|
225
|
+
'start_date': (datetime,), # noqa: E501
|
|
213
226
|
'campaign_type': (str,), # noqa: E501
|
|
214
|
-
'sales_channel': (str,), # noqa: E501
|
|
215
|
-
'format': (str,), # noqa: E501
|
|
216
|
-
'report_type': (str,), # noqa: E501
|
|
217
227
|
'click_attribution_window': (str,), # noqa: E501
|
|
218
|
-
'view_attribution_window': (str,), # noqa: E501
|
|
219
228
|
'dimensions': ([str],), # noqa: E501
|
|
229
|
+
'format': (str,), # noqa: E501
|
|
230
|
+
'id': (str,), # noqa: E501
|
|
231
|
+
'ids': ([str],), # noqa: E501
|
|
232
|
+
'media_type': (str,), # noqa: E501
|
|
220
233
|
'metrics': ([str],), # noqa: E501
|
|
234
|
+
'report_type': (str,), # noqa: E501
|
|
235
|
+
'sales_channel': (str,), # noqa: E501
|
|
236
|
+
'search_term_targetings': ([str],), # noqa: E501
|
|
237
|
+
'search_term_types': ([str],), # noqa: E501
|
|
238
|
+
'targeted_keyword_types': ([str],), # noqa: E501
|
|
221
239
|
'timezone': (str,), # noqa: E501
|
|
240
|
+
'view_attribution_window': (str,), # noqa: E501
|
|
222
241
|
}
|
|
223
242
|
|
|
224
243
|
@cached_property
|
|
@@ -227,21 +246,23 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
227
246
|
|
|
228
247
|
|
|
229
248
|
attribute_map = {
|
|
230
|
-
'start_date': 'startDate', # noqa: E501
|
|
231
249
|
'end_date': 'endDate', # noqa: E501
|
|
232
|
-
'
|
|
233
|
-
'id': 'id', # noqa: E501
|
|
234
|
-
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
235
|
-
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
250
|
+
'start_date': 'startDate', # noqa: E501
|
|
236
251
|
'campaign_type': 'campaignType', # noqa: E501
|
|
237
|
-
'sales_channel': 'salesChannel', # noqa: E501
|
|
238
|
-
'format': 'format', # noqa: E501
|
|
239
|
-
'report_type': 'reportType', # noqa: E501
|
|
240
252
|
'click_attribution_window': 'clickAttributionWindow', # noqa: E501
|
|
241
|
-
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
242
253
|
'dimensions': 'dimensions', # noqa: E501
|
|
254
|
+
'format': 'format', # noqa: E501
|
|
255
|
+
'id': 'id', # noqa: E501
|
|
256
|
+
'ids': 'ids', # noqa: E501
|
|
257
|
+
'media_type': 'mediaType', # noqa: E501
|
|
243
258
|
'metrics': 'metrics', # noqa: E501
|
|
259
|
+
'report_type': 'reportType', # noqa: E501
|
|
260
|
+
'sales_channel': 'salesChannel', # noqa: E501
|
|
261
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
262
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
263
|
+
'targeted_keyword_types': 'targetedKeywordTypes', # noqa: E501
|
|
244
264
|
'timezone': 'timezone', # noqa: E501
|
|
265
|
+
'view_attribution_window': 'viewAttributionWindow', # noqa: E501
|
|
245
266
|
}
|
|
246
267
|
|
|
247
268
|
read_only_vars = {
|
|
@@ -251,12 +272,12 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
251
272
|
|
|
252
273
|
@classmethod
|
|
253
274
|
@convert_js_args_to_python_args
|
|
254
|
-
def _from_openapi_data(cls,
|
|
275
|
+
def _from_openapi_data(cls, end_date, start_date, *args, **kwargs): # noqa: E501
|
|
255
276
|
"""AsyncLineItemsReport - a model defined in OpenAPI
|
|
256
277
|
|
|
257
278
|
Args:
|
|
258
|
-
start_date (datetime): Start date
|
|
259
279
|
end_date (datetime): End date
|
|
280
|
+
start_date (datetime): Start date
|
|
260
281
|
|
|
261
282
|
Keyword Args:
|
|
262
283
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -289,19 +310,21 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
289
310
|
Animal class but this time we won't travel
|
|
290
311
|
through its discriminator because we passed in
|
|
291
312
|
_visited_composed_classes = (Animal,)
|
|
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
313
|
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
314
|
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
315
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
316
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
317
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
318
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
319
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
303
320
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
321
|
+
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
322
|
+
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
|
|
323
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
324
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
325
|
+
targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional] # noqa: E501
|
|
304
326
|
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
|
|
327
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
305
328
|
"""
|
|
306
329
|
|
|
307
330
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -333,8 +356,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
333
356
|
self._configuration = _configuration
|
|
334
357
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
335
358
|
|
|
336
|
-
self.start_date = start_date
|
|
337
359
|
self.end_date = end_date
|
|
360
|
+
self.start_date = start_date
|
|
338
361
|
for var_name, var_value in kwargs.items():
|
|
339
362
|
if var_name not in self.attribute_map and \
|
|
340
363
|
self._configuration is not None and \
|
|
@@ -355,12 +378,12 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
355
378
|
])
|
|
356
379
|
|
|
357
380
|
@convert_js_args_to_python_args
|
|
358
|
-
def __init__(self,
|
|
381
|
+
def __init__(self, end_date, start_date, *args, **kwargs): # noqa: E501
|
|
359
382
|
"""AsyncLineItemsReport - a model defined in OpenAPI
|
|
360
383
|
|
|
361
384
|
Args:
|
|
362
|
-
start_date (datetime): Start date
|
|
363
385
|
end_date (datetime): End date
|
|
386
|
+
start_date (datetime): Start date
|
|
364
387
|
|
|
365
388
|
Keyword Args:
|
|
366
389
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -393,19 +416,21 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
393
416
|
Animal class but this time we won't travel
|
|
394
417
|
through its discriminator because we passed in
|
|
395
418
|
_visited_composed_classes = (Animal,)
|
|
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
419
|
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
420
|
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
421
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
422
|
+
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
423
|
+
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
424
|
+
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
425
|
+
media_type (str): Filter on the type of media: unknown, display, video. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
407
426
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
427
|
+
report_type (str): Type of report, if no dimensions and metrics are provided, falls back to summary reportType. [optional] if omitted the server will use the default value of "summary" # noqa: E501
|
|
428
|
+
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
|
|
429
|
+
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
430
|
+
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
431
|
+
targeted_keyword_types ([str]): Filter on targeted keyword type: unknown, generic, branded, conquesting. [optional] # noqa: E501
|
|
408
432
|
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
|
|
433
|
+
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
409
434
|
"""
|
|
410
435
|
|
|
411
436
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -435,8 +460,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
435
460
|
self._configuration = _configuration
|
|
436
461
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
437
462
|
|
|
438
|
-
self.start_date = start_date
|
|
439
463
|
self.end_date = end_date
|
|
464
|
+
self.start_date = start_date
|
|
440
465
|
for var_name, var_value in kwargs.items():
|
|
441
466
|
if var_name not in self.attribute_map and \
|
|
442
467
|
self._configuration is not None and \
|