criteo-api-retailmedia-sdk 0.0.250409__py3-none-any.whl → 0.0.250606__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_preview/__init__.py +1 -1
- criteo_api_retailmedia_preview/api/accounts_api.py +3 -147
- criteo_api_retailmedia_preview/api/analytics_api.py +1 -1
- criteo_api_retailmedia_preview/api/audience_api.py +1204 -135
- criteo_api_retailmedia_preview/api/campaign_api.py +741 -104
- criteo_api_retailmedia_preview/api_client.py +1 -1
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/account_fees_update_request.py +4 -0
- criteo_api_retailmedia_preview/model/async_accounts_report.py +6 -6
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +4 -4
- criteo_api_retailmedia_preview/model/async_line_items_report.py +4 -4
- criteo_api_retailmedia_preview/model/async_offsite_report.py +25 -18
- criteo_api_retailmedia_preview/model/brand_id_search_request.py +7 -1
- criteo_api_retailmedia_preview/model/brand_id_search_result.py +7 -1
- criteo_api_retailmedia_preview/model/categories_search_request_v1.py +270 -0
- criteo_api_retailmedia_preview/model/entity_resource_brand_id_search_result.py +8 -1
- criteo_api_retailmedia_preview/model/entity_resource_category202204.py +277 -0
- criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_brand_id_search_result_paging_offset_limit_metadata.py +8 -1
- criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204.py +281 -0
- criteo_api_retailmedia_preview/model/entity_resource_collection_outcome_category202204_metadata.py +287 -0
- criteo_api_retailmedia_preview/model/entity_resource_of_sponsored_products_line_item.py +270 -0
- criteo_api_retailmedia_preview/model/entity_resource_outcome_of_sponsored_products_line_item.py +274 -0
- criteo_api_retailmedia_preview/model/{input_keywords.py → flight_leg.py} +39 -17
- criteo_api_retailmedia_preview/model/{recommended_keywords_result.py → flight_schedule.py} +9 -13
- criteo_api_retailmedia_preview/model/nillable_decimal.py +263 -0
- criteo_api_retailmedia_preview/model/page_of_sponsored_products_line_item.py +276 -0
- criteo_api_retailmedia_preview/model/paging_offset_limit_metadata.py +7 -1
- criteo_api_retailmedia_preview/model/{grant_consent_model.py → recommended_categories_request_v1.py} +14 -21
- criteo_api_retailmedia_preview/model/recommended_keywords_request_v1.py +266 -0
- criteo_api_retailmedia_preview/model/recommended_keywords_response_v1.py +263 -0
- criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_request.py → rm_audience_bulk_create_input_v1.py} +9 -9
- criteo_api_retailmedia_preview/model/{grant_consent_input.py → rm_audience_bulk_delete_input_v1.py} +8 -8
- criteo_api_retailmedia_preview/model/rm_audience_bulk_update_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1.py +272 -0
- criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_entity_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_compute_sizes_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_create_entity_v1.py +291 -0
- criteo_api_retailmedia_preview/model/{grant_consent_model_value_resource.py → rm_audience_create_entity_v1_resource.py} +8 -8
- criteo_api_retailmedia_preview/model/rm_audience_delete_entity_v1_resource.py +271 -0
- criteo_api_retailmedia_preview/model/{value_resource_outcome_of_recommended_keywords_result.py → rm_audience_entity_v1_list_response.py} +16 -9
- criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1.py +282 -0
- criteo_api_retailmedia_preview/model/rm_audience_estimate_size_entity_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_estimate_size_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1.py +272 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_compute_size_entity_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_compute_sizes_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_create_entity_v1.py +6 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1.py +282 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_entity_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_estimate_size_input_v1.py +269 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1.py +267 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_size_entity_v1_list_response.py +281 -0
- criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers_v2.py → rm_audience_segment_size_entity_v1_resource.py} +11 -11
- criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1.py +267 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_size_estimation_v1_response.py +281 -0
- criteo_api_retailmedia_preview/model/rm_audience_segment_update_entity_v1.py +6 -0
- criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1.py +267 -0
- criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_list_response.py +281 -0
- criteo_api_retailmedia_preview/model/rm_audience_size_entity_v1_resource.py +277 -0
- criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1.py +267 -0
- criteo_api_retailmedia_preview/model/rm_audience_size_estimation_v1_resource.py +273 -0
- criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_v2_response.py → rm_audience_size_estimation_v1_response.py} +9 -9
- criteo_api_retailmedia_preview/model/rm_audience_update_entity_v1.py +279 -0
- 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 → rm_audience_update_entity_v1_resource.py} +17 -19
- criteo_api_retailmedia_preview/model/rm_events_create_v1.py +305 -0
- criteo_api_retailmedia_preview/model/rm_events_estimation_v1.py +305 -0
- criteo_api_retailmedia_preview/model/rm_events_update_v1.py +307 -0
- criteo_api_retailmedia_preview/model/sku_slim_data_preview.py +6 -6
- criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +387 -0
- criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers_v2.py → sponsored_products_line_item_create_request_model.py} +81 -33
- criteo_api_retailmedia_preview/model/{keywords.py → sponsored_products_line_item_update_request_model.py} +82 -44
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +2 -2
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +4 -4
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +4 -4
- criteo_api_retailmedia_preview/model/value_resource_brand_id_search_request.py +8 -1
- criteo_api_retailmedia_preview/model/value_resource_categories_search_request_v1.py +273 -0
- criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_private_market_account_fees.py → value_resource_collection_outcome_private_market_account_fees_and_metadata.py} +9 -3
- criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +8 -1
- criteo_api_retailmedia_preview/model/value_resource_input_categories_search_request_v1.py +269 -0
- criteo_api_retailmedia_preview/model/value_resource_input_of_sponsored_products_line_item_update_request_model.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_input_recommended_categories_request_v1.py +269 -0
- criteo_api_retailmedia_preview/model/value_resource_input_recommended_keywords_request_v1.py +262 -0
- criteo_api_retailmedia_preview/model/value_resource_of_sponsored_products_line_item_update_request_model.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_outcome_recommended_keywords_response_v1.py +274 -0
- criteo_api_retailmedia_preview/model/value_resource_recommended_categories_request_v1.py +273 -0
- criteo_api_retailmedia_preview/model/value_resource_recommended_keywords_request_v1.py +266 -0
- criteo_api_retailmedia_preview/model/{value_resource_of_recommended_keywords_result.py → value_resource_recommended_keywords_response_v1.py} +10 -10
- criteo_api_retailmedia_preview/models/__init__.py +63 -17
- {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/RECORD +93 -47
- {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_preview/model/common_error.py +0 -301
- criteo_api_retailmedia_preview/model/common_warning.py +0 -301
- criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +0 -307
- {criteo_api_retailmedia_sdk-0.0.250409.dist-info → criteo_api_retailmedia_sdk-0.0.250606.dist-info}/top_level.txt +0 -0
|
@@ -76,7 +76,7 @@ class ApiClient(object):
|
|
|
76
76
|
self.default_headers[header_name] = header_value
|
|
77
77
|
self.cookie = cookie
|
|
78
78
|
# Set default User-Agent.
|
|
79
|
-
self.user_agent = 'OpenAPI-Generator/0.0.
|
|
79
|
+
self.user_agent = 'OpenAPI-Generator/0.0.250606/python'
|
|
80
80
|
|
|
81
81
|
def __enter__(self):
|
|
82
82
|
return self
|
|
@@ -395,7 +395,7 @@ class Configuration(object):
|
|
|
395
395
|
"OS: {env}\n"\
|
|
396
396
|
"Python Version: {pyversion}\n"\
|
|
397
397
|
"Version of the API: Preview\n"\
|
|
398
|
-
"SDK Package Version: 0.0.
|
|
398
|
+
"SDK Package Version: 0.0.250606".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -161,9 +161,9 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
161
161
|
'CAPOUT': "capout",
|
|
162
162
|
},
|
|
163
163
|
('sales_channel',): {
|
|
164
|
-
'ALL': "all",
|
|
165
|
-
'OFFLINE': "offline",
|
|
166
164
|
'ONLINE': "online",
|
|
165
|
+
'OFFLINE': "offline",
|
|
166
|
+
'ALL': "all",
|
|
167
167
|
},
|
|
168
168
|
('search_term_targetings',): {
|
|
169
169
|
'UNKNOWN': "unknown",
|
|
@@ -294,13 +294,13 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
294
294
|
Animal class but this time we won't travel
|
|
295
295
|
through its discriminator because we passed in
|
|
296
296
|
_visited_composed_classes = (Animal,)
|
|
297
|
-
aggregation_level (str): Level of aggregation, if no dimensions
|
|
297
|
+
aggregation_level (str): Level of aggregation, if no dimensions and metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
|
|
298
298
|
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
|
|
299
299
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
300
300
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
301
301
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
302
302
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
303
|
-
report_type (str): Type of report, if no dimensions
|
|
303
|
+
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
|
|
304
304
|
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
|
|
305
305
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
306
306
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -399,13 +399,13 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
399
399
|
Animal class but this time we won't travel
|
|
400
400
|
through its discriminator because we passed in
|
|
401
401
|
_visited_composed_classes = (Animal,)
|
|
402
|
-
aggregation_level (str): Level of aggregation, if no dimensions
|
|
402
|
+
aggregation_level (str): Level of aggregation, if no dimensions and metrics are provided, falls back to campaign aggregationLevel. [optional] if omitted the server will use the default value of "campaign" # noqa: E501
|
|
403
403
|
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
|
|
404
404
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
405
405
|
dimensions ([str]): List of dimensions to report on. [optional] # noqa: E501
|
|
406
406
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
407
407
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
408
|
-
report_type (str): Type of report, if no dimensions
|
|
408
|
+
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
|
|
409
409
|
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
|
|
410
410
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
411
411
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -157,9 +157,9 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
157
157
|
'CAPOUT': "capout",
|
|
158
158
|
},
|
|
159
159
|
('sales_channel',): {
|
|
160
|
-
'ALL': "all",
|
|
161
|
-
'OFFLINE': "offline",
|
|
162
160
|
'ONLINE': "online",
|
|
161
|
+
'OFFLINE': "offline",
|
|
162
|
+
'ALL': "all",
|
|
163
163
|
},
|
|
164
164
|
('search_term_targetings',): {
|
|
165
165
|
'UNKNOWN': "unknown",
|
|
@@ -296,7 +296,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
296
296
|
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
297
297
|
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
298
298
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
299
|
-
report_type (str): Type of report, if no dimensions
|
|
299
|
+
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
|
|
300
300
|
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
|
|
301
301
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
302
302
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -400,7 +400,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
400
400
|
id (str): Campaign id to report on. [optional] # noqa: E501
|
|
401
401
|
ids ([str]): Campaign ids to report on. [optional] # noqa: E501
|
|
402
402
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
403
|
-
report_type (str): Type of report, if no dimensions
|
|
403
|
+
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
|
|
404
404
|
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
|
|
405
405
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
406
406
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -157,9 +157,9 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
157
157
|
'CAPOUT': "capout",
|
|
158
158
|
},
|
|
159
159
|
('sales_channel',): {
|
|
160
|
-
'ALL': "all",
|
|
161
|
-
'OFFLINE': "offline",
|
|
162
160
|
'ONLINE': "online",
|
|
161
|
+
'OFFLINE': "offline",
|
|
162
|
+
'ALL': "all",
|
|
163
163
|
},
|
|
164
164
|
('search_term_targetings',): {
|
|
165
165
|
'UNKNOWN': "unknown",
|
|
@@ -296,7 +296,7 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
296
296
|
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
297
297
|
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
298
298
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
299
|
-
report_type (str): Type of report, if no dimensions
|
|
299
|
+
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
|
|
300
300
|
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
|
|
301
301
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
302
302
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -400,7 +400,7 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
400
400
|
id (str): Line Item id to report on. [optional] # noqa: E501
|
|
401
401
|
ids ([str]): Line Item ids to report on. [optional] # noqa: E501
|
|
402
402
|
metrics ([str]): List of metrics to report on. [optional] # noqa: E501
|
|
403
|
-
report_type (str): Type of report, if no dimensions
|
|
403
|
+
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
|
|
404
404
|
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
|
|
405
405
|
search_term_targetings ([str]): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
406
406
|
search_term_types ([str]): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
@@ -67,17 +67,17 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
67
67
|
'LINEITEMNAME': "lineItemName",
|
|
68
68
|
'RETAILERID': "retailerId",
|
|
69
69
|
'RETAILERNAME': "retailerName",
|
|
70
|
-
'CREATIVEID': "creativeId",
|
|
71
|
-
'CREATIVENAME': "creativeName",
|
|
72
70
|
'BILLINGTYPE': "billingType",
|
|
73
|
-
'BUYTYPENAME': "buyTypeName",
|
|
74
71
|
'ENVIRONMENT': "environment",
|
|
75
72
|
'ADFORMATSIZE': "adFormatSize",
|
|
76
73
|
'SSP': "ssp",
|
|
77
74
|
'PUBLISHER': "publisher",
|
|
78
75
|
'INVENTORYTYPE': "inventoryType",
|
|
79
76
|
'MEDIATYPE': "mediaType",
|
|
77
|
+
'BUYTYPE': "buyType",
|
|
80
78
|
'SALESCHANNEL': "salesChannel",
|
|
79
|
+
'CREATIVEID': "creativeId",
|
|
80
|
+
'CREATIVENAME': "creativeName",
|
|
81
81
|
},
|
|
82
82
|
('metrics',): {
|
|
83
83
|
'AUDIENCE': "audience",
|
|
@@ -101,8 +101,8 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
101
101
|
'VIDEOSPLAYEDTO50': "videosPlayedTo50",
|
|
102
102
|
'VIDEOSPLAYEDTO75': "videosPlayedTo75",
|
|
103
103
|
'VIDEOSPLAYEDTO100': "videosPlayedTo100",
|
|
104
|
-
'
|
|
105
|
-
'
|
|
104
|
+
'VIDEOSTARTINGRATE': "videoStartingRate",
|
|
105
|
+
'VIDEOCOMPLETIONRATE': "videoCompletionRate",
|
|
106
106
|
'VIDEOCPC': "videoCPC",
|
|
107
107
|
'VIDEOCPCV': "videoCPCV",
|
|
108
108
|
'VISITS': "visits",
|
|
@@ -131,15 +131,16 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
131
131
|
'JSON-NEWLINE': "json-newline",
|
|
132
132
|
'CSV': "csv",
|
|
133
133
|
},
|
|
134
|
-
('
|
|
135
|
-
'
|
|
136
|
-
'DISPLAY': "display",
|
|
134
|
+
('media_type',): {
|
|
135
|
+
'UNKNOWN': "unknown",
|
|
137
136
|
'VIDEO': "video",
|
|
137
|
+
'DISPLAY': "display",
|
|
138
|
+
'ALL': "all",
|
|
138
139
|
},
|
|
139
140
|
('sales_channel',): {
|
|
140
|
-
'ALL': "all",
|
|
141
|
-
'OFFLINE': "offline",
|
|
142
141
|
'ONLINE': "online",
|
|
142
|
+
'OFFLINE': "offline",
|
|
143
|
+
'ALL': "all",
|
|
143
144
|
},
|
|
144
145
|
('view_attribution_window',): {
|
|
145
146
|
'NONE': "none",
|
|
@@ -151,6 +152,12 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
151
152
|
}
|
|
152
153
|
|
|
153
154
|
validations = {
|
|
155
|
+
('dimensions',): {
|
|
156
|
+
'min_items': 1,
|
|
157
|
+
},
|
|
158
|
+
('metrics',): {
|
|
159
|
+
'min_items': 1,
|
|
160
|
+
},
|
|
154
161
|
}
|
|
155
162
|
|
|
156
163
|
@cached_property
|
|
@@ -186,7 +193,7 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
186
193
|
'creative_ids': ([str],), # noqa: E501
|
|
187
194
|
'format': (str,), # noqa: E501
|
|
188
195
|
'line_item_ids': ([str],), # noqa: E501
|
|
189
|
-
'
|
|
196
|
+
'media_type': (str,), # noqa: E501
|
|
190
197
|
'retailer_ids': ([str],), # noqa: E501
|
|
191
198
|
'sales_channel': (str,), # noqa: E501
|
|
192
199
|
'timezone': (str,), # noqa: E501
|
|
@@ -211,7 +218,7 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
211
218
|
'creative_ids': 'creativeIds', # noqa: E501
|
|
212
219
|
'format': 'format', # noqa: E501
|
|
213
220
|
'line_item_ids': 'lineItemIds', # noqa: E501
|
|
214
|
-
'
|
|
221
|
+
'media_type': 'mediaType', # noqa: E501
|
|
215
222
|
'retailer_ids': 'retailerIds', # noqa: E501
|
|
216
223
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
217
224
|
'timezone': 'timezone', # noqa: E501
|
|
@@ -270,13 +277,13 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
270
277
|
campaign_ids ([str]): Campaign ids to filter. [optional] # noqa: E501
|
|
271
278
|
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
|
|
272
279
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
273
|
-
creative_ids ([str]):
|
|
280
|
+
creative_ids ([str]): Creative ids to filter. [optional] # noqa: E501
|
|
274
281
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
275
282
|
line_item_ids ([str]): Line item ids to filter. [optional] # noqa: E501
|
|
276
|
-
|
|
283
|
+
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
|
|
277
284
|
retailer_ids ([str]): Retailer ids to filter. [optional] # noqa: E501
|
|
278
285
|
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
|
|
279
|
-
timezone (str): Time zone : see
|
|
286
|
+
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
|
|
280
287
|
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
281
288
|
"""
|
|
282
289
|
|
|
@@ -379,13 +386,13 @@ class AsyncOffsiteReport(ModelNormal):
|
|
|
379
386
|
campaign_ids ([str]): Campaign ids to filter. [optional] # noqa: E501
|
|
380
387
|
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
|
|
381
388
|
click_attribution_window (str): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
382
|
-
creative_ids ([str]):
|
|
389
|
+
creative_ids ([str]): Creative ids to filter. [optional] # noqa: E501
|
|
383
390
|
format (str): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
384
391
|
line_item_ids ([str]): Line item ids to filter. [optional] # noqa: E501
|
|
385
|
-
|
|
392
|
+
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
|
|
386
393
|
retailer_ids ([str]): Retailer ids to filter. [optional] # noqa: E501
|
|
387
394
|
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
|
|
388
|
-
timezone (str): Time zone : see
|
|
395
|
+
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
|
|
389
396
|
view_attribution_window (str): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
|
|
390
397
|
"""
|
|
391
398
|
|
|
@@ -68,7 +68,13 @@ class BrandIdSearchRequest(ModelNormal):
|
|
|
68
68
|
},
|
|
69
69
|
}
|
|
70
70
|
|
|
71
|
-
|
|
71
|
+
@cached_property
|
|
72
|
+
def additional_properties_type():
|
|
73
|
+
"""
|
|
74
|
+
This must be a method because a model may have properties that are
|
|
75
|
+
of type self, this must run after the class is loaded
|
|
76
|
+
"""
|
|
77
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
72
78
|
|
|
73
79
|
_nullable = False
|
|
74
80
|
|
|
@@ -60,7 +60,13 @@ class BrandIdSearchResult(ModelNormal):
|
|
|
60
60
|
validations = {
|
|
61
61
|
}
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
@cached_property
|
|
64
|
+
def additional_properties_type():
|
|
65
|
+
"""
|
|
66
|
+
This must be a method because a model may have properties that are
|
|
67
|
+
of type self, this must run after the class is loaded
|
|
68
|
+
"""
|
|
69
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
64
70
|
|
|
65
71
|
_nullable = True
|
|
66
72
|
|
|
@@ -0,0 +1,270 @@
|
|
|
1
|
+
"""
|
|
2
|
+
Criteo API
|
|
3
|
+
|
|
4
|
+
Criteo API - RetailMedia # noqa: E501
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: Preview
|
|
7
|
+
Generated by: https://openapi-generator.tech
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
import re # noqa: F401
|
|
12
|
+
import sys # noqa: F401
|
|
13
|
+
|
|
14
|
+
from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
|
|
15
|
+
ApiTypeError,
|
|
16
|
+
ModelComposed,
|
|
17
|
+
ModelNormal,
|
|
18
|
+
ModelSimple,
|
|
19
|
+
cached_property,
|
|
20
|
+
change_keys_js_to_python,
|
|
21
|
+
convert_js_args_to_python_args,
|
|
22
|
+
date,
|
|
23
|
+
datetime,
|
|
24
|
+
file_type,
|
|
25
|
+
none_type,
|
|
26
|
+
validate_get_composed_info,
|
|
27
|
+
OpenApiModel
|
|
28
|
+
)
|
|
29
|
+
from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class CategoriesSearchRequestV1(ModelNormal):
|
|
34
|
+
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
35
|
+
Ref: https://openapi-generator.tech
|
|
36
|
+
|
|
37
|
+
Do not edit the class manually.
|
|
38
|
+
|
|
39
|
+
Attributes:
|
|
40
|
+
allowed_values (dict): The key is the tuple path to the attribute
|
|
41
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
42
|
+
with a capitalized key describing the allowed value and an allowed
|
|
43
|
+
value. These dicts store the allowed enum values.
|
|
44
|
+
attribute_map (dict): The key is attribute name
|
|
45
|
+
and the value is json key in definition.
|
|
46
|
+
discriminator_value_class_map (dict): A dict to go from the discriminator
|
|
47
|
+
variable value to the discriminator class name.
|
|
48
|
+
validations (dict): The key is the tuple path to the attribute
|
|
49
|
+
and the for var_name this is (var_name,). The value is a dict
|
|
50
|
+
that stores validations for max_length, min_length, max_items,
|
|
51
|
+
min_items, exclusive_maximum, inclusive_maximum, exclusive_minimum,
|
|
52
|
+
inclusive_minimum, and regex.
|
|
53
|
+
additional_properties_type (tuple): A tuple of classes accepted
|
|
54
|
+
as additional properties values.
|
|
55
|
+
"""
|
|
56
|
+
|
|
57
|
+
allowed_values = {
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
validations = {
|
|
61
|
+
('category_ids',): {
|
|
62
|
+
'min_items': 1,
|
|
63
|
+
},
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
@cached_property
|
|
67
|
+
def additional_properties_type():
|
|
68
|
+
"""
|
|
69
|
+
This must be a method because a model may have properties that are
|
|
70
|
+
of type self, this must run after the class is loaded
|
|
71
|
+
"""
|
|
72
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
73
|
+
|
|
74
|
+
_nullable = False
|
|
75
|
+
|
|
76
|
+
@cached_property
|
|
77
|
+
def openapi_types():
|
|
78
|
+
"""
|
|
79
|
+
This must be a method because a model may have properties that are
|
|
80
|
+
of type self, this must run after the class is loaded
|
|
81
|
+
|
|
82
|
+
Returns
|
|
83
|
+
openapi_types (dict): The key is attribute name
|
|
84
|
+
and the value is attribute type.
|
|
85
|
+
"""
|
|
86
|
+
return {
|
|
87
|
+
'category_ids': ([str], none_type,), # noqa: E501
|
|
88
|
+
'text_substring': (str, none_type,), # noqa: E501
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
@cached_property
|
|
92
|
+
def discriminator():
|
|
93
|
+
return None
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
attribute_map = {
|
|
97
|
+
'category_ids': 'categoryIds', # noqa: E501
|
|
98
|
+
'text_substring': 'textSubstring', # noqa: E501
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
read_only_vars = {
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
_composed_schemas = {}
|
|
105
|
+
|
|
106
|
+
@classmethod
|
|
107
|
+
@convert_js_args_to_python_args
|
|
108
|
+
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
109
|
+
"""CategoriesSearchRequestV1 - a model defined in OpenAPI
|
|
110
|
+
|
|
111
|
+
Keyword Args:
|
|
112
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
113
|
+
will be type checked and a TypeError will be
|
|
114
|
+
raised if the wrong type is input.
|
|
115
|
+
Defaults to True
|
|
116
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
117
|
+
drill down to the model in received_data
|
|
118
|
+
when deserializing a response
|
|
119
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
120
|
+
are serialized names, as specified in the OpenAPI document.
|
|
121
|
+
False if the variable names in the input data
|
|
122
|
+
are pythonic names, e.g. snake case (default)
|
|
123
|
+
_configuration (Configuration): the instance to use when
|
|
124
|
+
deserializing a file_type parameter.
|
|
125
|
+
If passed, type conversion is attempted
|
|
126
|
+
If omitted no type conversion is done.
|
|
127
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
128
|
+
classes that we have traveled through so that
|
|
129
|
+
if we see that class again we will not use its
|
|
130
|
+
discriminator again.
|
|
131
|
+
When traveling through a discriminator, the
|
|
132
|
+
composed schema that is
|
|
133
|
+
is traveled through is added to this set.
|
|
134
|
+
For example if Animal has a discriminator
|
|
135
|
+
petType and we pass in "Dog", and the class Dog
|
|
136
|
+
allOf includes Animal, we move through Animal
|
|
137
|
+
once using the discriminator, and pick Dog.
|
|
138
|
+
Then in Dog, we will make an instance of the
|
|
139
|
+
Animal class but this time we won't travel
|
|
140
|
+
through its discriminator because we passed in
|
|
141
|
+
_visited_composed_classes = (Animal,)
|
|
142
|
+
category_ids ([str], none_type): Categories search category ids criteria.. [optional] # noqa: E501
|
|
143
|
+
text_substring (str, none_type): Categories search text substring criteria.. [optional] # noqa: E501
|
|
144
|
+
"""
|
|
145
|
+
|
|
146
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
147
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', True)
|
|
148
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
149
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
150
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
151
|
+
|
|
152
|
+
self = super(OpenApiModel, cls).__new__(cls)
|
|
153
|
+
|
|
154
|
+
if args:
|
|
155
|
+
for arg in args:
|
|
156
|
+
if isinstance(arg, dict):
|
|
157
|
+
kwargs.update(arg)
|
|
158
|
+
else:
|
|
159
|
+
raise ApiTypeError(
|
|
160
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
161
|
+
args,
|
|
162
|
+
self.__class__.__name__,
|
|
163
|
+
),
|
|
164
|
+
path_to_item=_path_to_item,
|
|
165
|
+
valid_classes=(self.__class__,),
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
self._data_store = {}
|
|
169
|
+
self._check_type = _check_type
|
|
170
|
+
self._spec_property_naming = _spec_property_naming
|
|
171
|
+
self._path_to_item = _path_to_item
|
|
172
|
+
self._configuration = _configuration
|
|
173
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
174
|
+
|
|
175
|
+
for var_name, var_value in kwargs.items():
|
|
176
|
+
if var_name not in self.attribute_map and \
|
|
177
|
+
self._configuration is not None and \
|
|
178
|
+
self._configuration.discard_unknown_keys and \
|
|
179
|
+
self.additional_properties_type is None:
|
|
180
|
+
# discard variable.
|
|
181
|
+
continue
|
|
182
|
+
setattr(self, var_name, var_value)
|
|
183
|
+
return self
|
|
184
|
+
|
|
185
|
+
required_properties = set([
|
|
186
|
+
'_data_store',
|
|
187
|
+
'_check_type',
|
|
188
|
+
'_spec_property_naming',
|
|
189
|
+
'_path_to_item',
|
|
190
|
+
'_configuration',
|
|
191
|
+
'_visited_composed_classes',
|
|
192
|
+
])
|
|
193
|
+
|
|
194
|
+
@convert_js_args_to_python_args
|
|
195
|
+
def __init__(self, *args, **kwargs): # noqa: E501
|
|
196
|
+
"""CategoriesSearchRequestV1 - a model defined in OpenAPI
|
|
197
|
+
|
|
198
|
+
Keyword Args:
|
|
199
|
+
_check_type (bool): if True, values for parameters in openapi_types
|
|
200
|
+
will be type checked and a TypeError will be
|
|
201
|
+
raised if the wrong type is input.
|
|
202
|
+
Defaults to True
|
|
203
|
+
_path_to_item (tuple/list): This is a list of keys or values to
|
|
204
|
+
drill down to the model in received_data
|
|
205
|
+
when deserializing a response
|
|
206
|
+
_spec_property_naming (bool): True if the variable names in the input data
|
|
207
|
+
are serialized names, as specified in the OpenAPI document.
|
|
208
|
+
False if the variable names in the input data
|
|
209
|
+
are pythonic names, e.g. snake case (default)
|
|
210
|
+
_configuration (Configuration): the instance to use when
|
|
211
|
+
deserializing a file_type parameter.
|
|
212
|
+
If passed, type conversion is attempted
|
|
213
|
+
If omitted no type conversion is done.
|
|
214
|
+
_visited_composed_classes (tuple): This stores a tuple of
|
|
215
|
+
classes that we have traveled through so that
|
|
216
|
+
if we see that class again we will not use its
|
|
217
|
+
discriminator again.
|
|
218
|
+
When traveling through a discriminator, the
|
|
219
|
+
composed schema that is
|
|
220
|
+
is traveled through is added to this set.
|
|
221
|
+
For example if Animal has a discriminator
|
|
222
|
+
petType and we pass in "Dog", and the class Dog
|
|
223
|
+
allOf includes Animal, we move through Animal
|
|
224
|
+
once using the discriminator, and pick Dog.
|
|
225
|
+
Then in Dog, we will make an instance of the
|
|
226
|
+
Animal class but this time we won't travel
|
|
227
|
+
through its discriminator because we passed in
|
|
228
|
+
_visited_composed_classes = (Animal,)
|
|
229
|
+
category_ids ([str], none_type): Categories search category ids criteria.. [optional] # noqa: E501
|
|
230
|
+
text_substring (str, none_type): Categories search text substring criteria.. [optional] # noqa: E501
|
|
231
|
+
"""
|
|
232
|
+
|
|
233
|
+
_check_type = kwargs.pop('_check_type', True)
|
|
234
|
+
_spec_property_naming = kwargs.pop('_spec_property_naming', False)
|
|
235
|
+
_path_to_item = kwargs.pop('_path_to_item', ())
|
|
236
|
+
_configuration = kwargs.pop('_configuration', None)
|
|
237
|
+
_visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
|
|
238
|
+
|
|
239
|
+
if args:
|
|
240
|
+
for arg in args:
|
|
241
|
+
if isinstance(arg, dict):
|
|
242
|
+
kwargs.update(arg)
|
|
243
|
+
else:
|
|
244
|
+
raise ApiTypeError(
|
|
245
|
+
"Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
|
|
246
|
+
args,
|
|
247
|
+
self.__class__.__name__,
|
|
248
|
+
),
|
|
249
|
+
path_to_item=_path_to_item,
|
|
250
|
+
valid_classes=(self.__class__,),
|
|
251
|
+
)
|
|
252
|
+
|
|
253
|
+
self._data_store = {}
|
|
254
|
+
self._check_type = _check_type
|
|
255
|
+
self._spec_property_naming = _spec_property_naming
|
|
256
|
+
self._path_to_item = _path_to_item
|
|
257
|
+
self._configuration = _configuration
|
|
258
|
+
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
259
|
+
|
|
260
|
+
for var_name, var_value in kwargs.items():
|
|
261
|
+
if var_name not in self.attribute_map and \
|
|
262
|
+
self._configuration is not None and \
|
|
263
|
+
self._configuration.discard_unknown_keys and \
|
|
264
|
+
self.additional_properties_type is None:
|
|
265
|
+
# discard variable.
|
|
266
|
+
continue
|
|
267
|
+
setattr(self, var_name, var_value)
|
|
268
|
+
if var_name in self.read_only_vars:
|
|
269
|
+
raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
|
|
270
|
+
f"class with read only attributes.")
|
|
@@ -64,7 +64,14 @@ class EntityResourceBrandIdSearchResult(ModelNormal):
|
|
|
64
64
|
validations = {
|
|
65
65
|
}
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
@cached_property
|
|
68
|
+
def additional_properties_type():
|
|
69
|
+
"""
|
|
70
|
+
This must be a method because a model may have properties that are
|
|
71
|
+
of type self, this must run after the class is loaded
|
|
72
|
+
"""
|
|
73
|
+
lazy_import()
|
|
74
|
+
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
68
75
|
|
|
69
76
|
_nullable = False
|
|
70
77
|
|