criteo-api-retailmedia-sdk 0.0.241029__py3-none-any.whl → 0.0.250205__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 +23 -324
- criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
- criteo_api_retailmedia_preview/api/balance_api.py +0 -159
- criteo_api_retailmedia_preview/api/campaign_api.py +226 -859
- criteo_api_retailmedia_preview/api/on_site_recommendation_api.py +0 -1
- criteo_api_retailmedia_preview/api_client.py +4 -4
- criteo_api_retailmedia_preview/configuration.py +1 -1
- criteo_api_retailmedia_preview/model/async_accounts_report.py +44 -0
- criteo_api_retailmedia_preview/model/async_campaigns_report.py +44 -0
- criteo_api_retailmedia_preview/model/{retail_media_contactlist_amendment_attributes.py → async_fill_rate_report.py} +80 -31
- criteo_api_retailmedia_preview/model/{add_funds_to_balance_v2_request.py → async_fill_rate_report_request.py} +8 -8
- criteo_api_retailmedia_preview/model/{http_validation_error.py → async_fill_rate_report_resource.py} +13 -9
- criteo_api_retailmedia_preview/model/async_line_items_report.py +44 -0
- criteo_api_retailmedia_preview/model/balance_response_v2_response.py +1 -1
- criteo_api_retailmedia_preview/model/{resource_of_sku_search_result.py → brand_id_search_request.py} +21 -20
- criteo_api_retailmedia_preview/model/{external_retailer.py → brand_id_search_result.py} +26 -26
- criteo_api_retailmedia_preview/model/category.py +3 -3
- criteo_api_retailmedia_preview/model/change_details_v1.py +8 -18
- criteo_api_retailmedia_preview/model/{external_choice_variable_value.py → choice_variable_value.py} +4 -10
- criteo_api_retailmedia_preview/model/{external_color_variable_value.py → color_variable_value.py} +5 -11
- criteo_api_retailmedia_preview/model/{sku_search_request.py → cpc_min_bids_request.py} +11 -16
- criteo_api_retailmedia_preview/model/{page_of_insertion_order_history_change_data_capture_v2.py → cpc_min_bids_response.py} +19 -21
- criteo_api_retailmedia_preview/model/cpc_rate_card_preview.py +6 -6
- criteo_api_retailmedia_preview/model/{external_creative_v2.py → creative2.py} +23 -30
- criteo_api_retailmedia_preview/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
- criteo_api_retailmedia_preview/model/{resource_collection_outcome_of_sku_search_result.py → creative2_response.py} +9 -9
- criteo_api_retailmedia_preview/model/{external_creative_create_model_v2.py → creative_create_model2.py} +9 -16
- criteo_api_retailmedia_preview/model/{external_creative_update_model_v2.py → creative_update_model2.py} +9 -16
- criteo_api_retailmedia_preview/model/{resource_of_retail_media_account.py → entity_resource_brand_id_search_result.py} +13 -13
- criteo_api_retailmedia_preview/model/{creative_v2_list_response.py → entity_resource_collection_outcome_brand_id_search_result.py} +17 -24
- criteo_api_retailmedia_preview/model/{entity_resource_collection_outcome_of_retail_media_account.py → entity_resource_collection_outcome_of_retail_media_child_account.py} +15 -9
- criteo_api_retailmedia_preview/model/{entity_resource_of_retail_media_account.py → entity_resource_of_retail_media_child_account.py} +9 -9
- criteo_api_retailmedia_preview/model/external_line_item_bid_multipliers_v2.py +1 -1
- criteo_api_retailmedia_preview/model/{external_retail_media_account.py → external_retail_media_child_account.py} +4 -8
- criteo_api_retailmedia_preview/model/{external_files_variable_value.py → files_variable_value.py} +4 -10
- criteo_api_retailmedia_preview/model/{external_hyperlink_variable_value.py → hyperlink_variable_value.py} +5 -11
- criteo_api_retailmedia_preview/model/json_api_request_of_seller_catalog_request.py +1 -1
- criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_request.py +1 -1
- criteo_api_retailmedia_preview/model/line_item_bid_multipliers_v2_response.py +1 -1
- criteo_api_retailmedia_preview/model/message.py +5 -5
- criteo_api_retailmedia_preview/model/offset_page_metadata.py +279 -0
- criteo_api_retailmedia_preview/model/outcome.py +268 -0
- criteo_api_retailmedia_preview/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
- criteo_api_retailmedia_preview/model/placement_preview.py +4 -0
- criteo_api_retailmedia_preview/model/report_ok_response.py +18 -18
- criteo_api_retailmedia_preview/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
- criteo_api_retailmedia_preview/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
- criteo_api_retailmedia_preview/model/resource_of_preferred_line_item_v2.py +1 -1
- criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment.py +31 -18
- criteo_api_retailmedia_preview/model/retail_media_seller.py +4 -0
- criteo_api_retailmedia_preview/model/sdk_api_rest_common_problem.py +296 -0
- criteo_api_retailmedia_preview/model/seller_catalog_request.py +1 -1
- criteo_api_retailmedia_preview/model/{sku_search_request_body.py → seller_search.py} +18 -25
- criteo_api_retailmedia_preview/model/sku_data_preview.py +27 -27
- criteo_api_retailmedia_preview/model/{external_brand.py → sku_min_bid.py} +18 -22
- criteo_api_retailmedia_preview/model/sku_slim_data_v2.py +9 -13
- criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +4 -0
- criteo_api_retailmedia_preview/model/sync_campaigns_report.py +1 -11
- criteo_api_retailmedia_preview/model/sync_line_items_report.py +1 -11
- criteo_api_retailmedia_preview/model/{external_template_variable_value.py → template_variable_value.py} +36 -43
- criteo_api_retailmedia_preview/model/{location_inner.py → text_variable_value.py} +9 -11
- criteo_api_retailmedia_preview/model/{value_resource_of_retail_media_seller_account_creation.py → value_resource_brand_id_search_request.py} +10 -10
- criteo_api_retailmedia_preview/model/value_resource_collection_outcome_of_retail_media_seller.py +8 -8
- criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_request.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_cpc_min_bids_response.py +266 -0
- criteo_api_retailmedia_preview/model/value_resource_input_brand_id_search_request.py +262 -0
- criteo_api_retailmedia_preview/model/{external_text_variable_value.py → value_resource_input_cpc_min_bids_request.py} +13 -14
- criteo_api_retailmedia_preview/model/{value_resource_collection_input_of_retail_media_seller.py → value_resource_input_of_seller_search.py} +8 -8
- criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller.py +2 -2
- criteo_api_retailmedia_preview/model/{value_resource_input_of_retail_media_seller_account_creation.py → value_resource_of_seller_search.py} +13 -9
- criteo_api_retailmedia_preview/model/{proposal_status_model_response.py → value_resource_outcome_cpc_min_bids_response.py} +19 -19
- criteo_api_retailmedia_preview/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
- criteo_api_retailmedia_preview/models/__init__.py +39 -54
- {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/METADATA +14 -5
- {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/RECORD +78 -93
- {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_preview/model/add_funds_to_balance_v2.py +0 -277
- criteo_api_retailmedia_preview/model/approval_status_model.py +0 -292
- criteo_api_retailmedia_preview/model/botmessage.py +0 -329
- criteo_api_retailmedia_preview/model/change_details_v2.py +0 -275
- criteo_api_retailmedia_preview/model/creative_v2_response.py +0 -281
- criteo_api_retailmedia_preview/model/external_account.py +0 -330
- criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture_v2.py +0 -303
- criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_account_and_account.py +0 -285
- criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_brand_and_brand.py +0 -285
- criteo_api_retailmedia_preview/model/json_api_body_with_id_of_int64_and_retailer_and_retailer.py +0 -285
- criteo_api_retailmedia_preview/model/json_api_page_response_of_account.py +0 -295
- criteo_api_retailmedia_preview/model/json_api_page_response_of_brand.py +0 -295
- criteo_api_retailmedia_preview/model/json_api_page_response_of_retailer.py +0 -295
- criteo_api_retailmedia_preview/model/negotiation_state_model.py +0 -293
- criteo_api_retailmedia_preview/model/proposal_status_model.py +0 -284
- criteo_api_retailmedia_preview/model/resource_of_add_funds_to_balance_v2.py +0 -277
- criteo_api_retailmedia_preview/model/resource_of_creative_v2.py +0 -277
- criteo_api_retailmedia_preview/model/retail_media_account.py +0 -301
- criteo_api_retailmedia_preview/model/retail_media_seller_account_creation.py +0 -274
- criteo_api_retailmedia_preview/model/sku_search_result.py +0 -313
- criteo_api_retailmedia_preview/model/validation_error.py +0 -287
- {criteo_api_retailmedia_sdk-0.0.241029.dist-info → criteo_api_retailmedia_sdk-0.0.250205.dist-info}/top_level.txt +0 -0
|
@@ -21,7 +21,6 @@ from criteo_api_retailmedia_preview.model_utils import ( # noqa: F401
|
|
|
21
21
|
none_type,
|
|
22
22
|
validate_and_convert_types
|
|
23
23
|
)
|
|
24
|
-
from criteo_api_retailmedia_preview.model.http_validation_error import HttpValidationError
|
|
25
24
|
from criteo_api_retailmedia_preview.model.inbot_discussion_body_model import InbotDiscussionBodyModel
|
|
26
25
|
from criteo_api_retailmedia_preview.model.message_body_model import MessageBodyModel
|
|
27
26
|
|
|
@@ -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.250205/python'
|
|
80
80
|
|
|
81
81
|
def __enter__(self):
|
|
82
82
|
return self
|
|
@@ -804,10 +804,10 @@ class Endpoint(object):
|
|
|
804
804
|
Example:
|
|
805
805
|
|
|
806
806
|
api_instance = AccountsApi()
|
|
807
|
-
api_instance.
|
|
808
|
-
api_instance.
|
|
807
|
+
api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id # this is an instance of the class Endpoint
|
|
808
|
+
api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id() # this invokes api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.__call__()
|
|
809
809
|
which then invokes the callable functions stored in that endpoint at
|
|
810
|
-
api_instance.
|
|
810
|
+
api_instance.get_api_external_v1_account_private_market_child_accounts_by_account_id.callable or self.callable in this class
|
|
811
811
|
|
|
812
812
|
"""
|
|
813
813
|
return self.callable(self, *args, **kwargs)
|
|
@@ -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.250205".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -60,6 +60,18 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
60
60
|
'CAMPAIGN': "campaign",
|
|
61
61
|
'LINEITEM': "lineItem",
|
|
62
62
|
},
|
|
63
|
+
('search_term_types',): {
|
|
64
|
+
'None': None,
|
|
65
|
+
'UNKNOWN': "unknown",
|
|
66
|
+
'SEARCHED': "searched",
|
|
67
|
+
'ENTERED': "entered",
|
|
68
|
+
},
|
|
69
|
+
('search_term_targetings',): {
|
|
70
|
+
'None': None,
|
|
71
|
+
'UNKNOWN': "unknown",
|
|
72
|
+
'AUTOMATIC': "automatic",
|
|
73
|
+
'MANUAL': "manual",
|
|
74
|
+
},
|
|
63
75
|
('campaign_type',): {
|
|
64
76
|
'None': None,
|
|
65
77
|
'ALL': "all",
|
|
@@ -89,6 +101,7 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
89
101
|
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
90
102
|
'ENVIRONMENT': "environment",
|
|
91
103
|
'SERVEDCATEGORY': "servedCategory",
|
|
104
|
+
'CAPOUT': "capout",
|
|
92
105
|
},
|
|
93
106
|
('click_attribution_window',): {
|
|
94
107
|
'None': None,
|
|
@@ -127,9 +140,18 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
127
140
|
'ENVIRONMENT': "environment",
|
|
128
141
|
'PAGETYPENAME': "pageTypeName",
|
|
129
142
|
'PAGECATEGORY': "pageCategory",
|
|
143
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
130
144
|
'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
|
|
131
145
|
'KEYWORD': "keyword",
|
|
132
146
|
'SEARCHTERM': "searchTerm",
|
|
147
|
+
'SEARCHTERMTYPE': "searchTermType",
|
|
148
|
+
'SEARCHTERMTARGETING': "searchTermTargeting",
|
|
149
|
+
'CREATIVEID': "creativeId",
|
|
150
|
+
'CREATIVENAME': "creativeName",
|
|
151
|
+
'CREATIVETYPEID': "creativeTypeId",
|
|
152
|
+
'CREATIVETYPENAME': "creativeTypeName",
|
|
153
|
+
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
154
|
+
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
133
155
|
},
|
|
134
156
|
('metrics',): {
|
|
135
157
|
'None': None,
|
|
@@ -154,6 +176,20 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
154
176
|
'VIDEOSPLAYEDTO100': "videosPlayedTo100",
|
|
155
177
|
'VIDEOPLAYINGRATE': "videoPlayingRate",
|
|
156
178
|
'VIDEOCOMPLETIONRATE': "videoCompletionRate",
|
|
179
|
+
'VIDEOIMPRESSIONS': "videoImpressions",
|
|
180
|
+
'VIDEOMUTED': "videoMuted",
|
|
181
|
+
'VIDEOUNMUTED': "videoUnmuted",
|
|
182
|
+
'VIDEOPAUSED': "videoPaused",
|
|
183
|
+
'VIDEORESUMED': "videoResumed",
|
|
184
|
+
'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
|
|
185
|
+
'VIDEOVIEWABILITY': "videoViewability",
|
|
186
|
+
'VIDEOSTARTINGRATE': "videoStartingRate",
|
|
187
|
+
'VIDEOCPC': "videoCPC",
|
|
188
|
+
'VIDEOCPCV': "videoCPCV",
|
|
189
|
+
'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
|
|
190
|
+
'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
|
|
191
|
+
'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
|
|
192
|
+
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
157
193
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
158
194
|
'FREQUENCY': "frequency",
|
|
159
195
|
},
|
|
@@ -187,6 +223,8 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
187
223
|
'start_date': (datetime,), # noqa: E501
|
|
188
224
|
'end_date': (datetime,), # noqa: E501
|
|
189
225
|
'aggregation_level': (str, none_type,), # noqa: E501
|
|
226
|
+
'search_term_types': ([str], none_type,), # noqa: E501
|
|
227
|
+
'search_term_targetings': ([str], none_type,), # noqa: E501
|
|
190
228
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
191
229
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
192
230
|
'format': (str, none_type,), # noqa: E501
|
|
@@ -208,6 +246,8 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
208
246
|
'start_date': 'startDate', # noqa: E501
|
|
209
247
|
'end_date': 'endDate', # noqa: E501
|
|
210
248
|
'aggregation_level': 'aggregationLevel', # noqa: E501
|
|
249
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
250
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
211
251
|
'campaign_type': 'campaignType', # noqa: E501
|
|
212
252
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
213
253
|
'format': 'format', # noqa: E501
|
|
@@ -266,6 +306,8 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
266
306
|
through its discriminator because we passed in
|
|
267
307
|
_visited_composed_classes = (Animal,)
|
|
268
308
|
aggregation_level (str, none_type): 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
|
|
309
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
310
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
269
311
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
270
312
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
271
313
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -369,6 +411,8 @@ class AsyncAccountsReport(ModelNormal):
|
|
|
369
411
|
through its discriminator because we passed in
|
|
370
412
|
_visited_composed_classes = (Animal,)
|
|
371
413
|
aggregation_level (str, none_type): 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
|
|
414
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
415
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
372
416
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
373
417
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
374
418
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -55,6 +55,18 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
+
('search_term_types',): {
|
|
59
|
+
'None': None,
|
|
60
|
+
'UNKNOWN': "unknown",
|
|
61
|
+
'SEARCHED': "searched",
|
|
62
|
+
'ENTERED': "entered",
|
|
63
|
+
},
|
|
64
|
+
('search_term_targetings',): {
|
|
65
|
+
'None': None,
|
|
66
|
+
'UNKNOWN': "unknown",
|
|
67
|
+
'AUTOMATIC': "automatic",
|
|
68
|
+
'MANUAL': "manual",
|
|
69
|
+
},
|
|
58
70
|
('campaign_type',): {
|
|
59
71
|
'None': None,
|
|
60
72
|
'ALL': "all",
|
|
@@ -84,6 +96,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
84
96
|
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
85
97
|
'ENVIRONMENT': "environment",
|
|
86
98
|
'SERVEDCATEGORY': "servedCategory",
|
|
99
|
+
'CAPOUT': "capout",
|
|
87
100
|
},
|
|
88
101
|
('click_attribution_window',): {
|
|
89
102
|
'None': None,
|
|
@@ -122,9 +135,18 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
122
135
|
'ENVIRONMENT': "environment",
|
|
123
136
|
'PAGETYPENAME': "pageTypeName",
|
|
124
137
|
'PAGECATEGORY': "pageCategory",
|
|
138
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
125
139
|
'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
|
|
126
140
|
'KEYWORD': "keyword",
|
|
127
141
|
'SEARCHTERM': "searchTerm",
|
|
142
|
+
'SEARCHTERMTYPE': "searchTermType",
|
|
143
|
+
'SEARCHTERMTARGETING': "searchTermTargeting",
|
|
144
|
+
'CREATIVEID': "creativeId",
|
|
145
|
+
'CREATIVENAME': "creativeName",
|
|
146
|
+
'CREATIVETYPEID': "creativeTypeId",
|
|
147
|
+
'CREATIVETYPENAME': "creativeTypeName",
|
|
148
|
+
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
149
|
+
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
128
150
|
},
|
|
129
151
|
('metrics',): {
|
|
130
152
|
'None': None,
|
|
@@ -149,6 +171,20 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
149
171
|
'VIDEOSPLAYEDTO100': "videosPlayedTo100",
|
|
150
172
|
'VIDEOPLAYINGRATE': "videoPlayingRate",
|
|
151
173
|
'VIDEOCOMPLETIONRATE': "videoCompletionRate",
|
|
174
|
+
'VIDEOIMPRESSIONS': "videoImpressions",
|
|
175
|
+
'VIDEOMUTED': "videoMuted",
|
|
176
|
+
'VIDEOUNMUTED': "videoUnmuted",
|
|
177
|
+
'VIDEOPAUSED': "videoPaused",
|
|
178
|
+
'VIDEORESUMED': "videoResumed",
|
|
179
|
+
'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
|
|
180
|
+
'VIDEOVIEWABILITY': "videoViewability",
|
|
181
|
+
'VIDEOSTARTINGRATE': "videoStartingRate",
|
|
182
|
+
'VIDEOCPC': "videoCPC",
|
|
183
|
+
'VIDEOCPCV': "videoCPCV",
|
|
184
|
+
'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
|
|
185
|
+
'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
|
|
186
|
+
'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
|
|
187
|
+
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
152
188
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
153
189
|
'FREQUENCY': "frequency",
|
|
154
190
|
},
|
|
@@ -182,6 +218,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
182
218
|
'end_date': (datetime,), # noqa: E501
|
|
183
219
|
'ids': ([str], none_type,), # noqa: E501
|
|
184
220
|
'id': (str, none_type,), # noqa: E501
|
|
221
|
+
'search_term_types': ([str], none_type,), # noqa: E501
|
|
222
|
+
'search_term_targetings': ([str], none_type,), # noqa: E501
|
|
185
223
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
186
224
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
187
225
|
'format': (str, none_type,), # noqa: E501
|
|
@@ -203,6 +241,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
203
241
|
'end_date': 'endDate', # noqa: E501
|
|
204
242
|
'ids': 'ids', # noqa: E501
|
|
205
243
|
'id': 'id', # noqa: E501
|
|
244
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
245
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
206
246
|
'campaign_type': 'campaignType', # noqa: E501
|
|
207
247
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
208
248
|
'format': 'format', # noqa: E501
|
|
@@ -261,6 +301,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
261
301
|
_visited_composed_classes = (Animal,)
|
|
262
302
|
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
263
303
|
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
304
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
305
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
264
306
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
265
307
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
266
308
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -363,6 +405,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
363
405
|
_visited_composed_classes = (Animal,)
|
|
364
406
|
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
365
407
|
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
408
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
409
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
366
410
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
367
411
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
368
412
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
|
|
33
|
-
class
|
|
33
|
+
class AsyncFillRateReport(ModelNormal):
|
|
34
34
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
35
35
|
Ref: https://openapi-generator.tech
|
|
36
36
|
|
|
@@ -55,18 +55,47 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
-
('
|
|
59
|
-
'
|
|
60
|
-
'
|
|
58
|
+
('dimensions',): {
|
|
59
|
+
'DATE': "date",
|
|
60
|
+
'RETAILERID': "retailerId",
|
|
61
|
+
'RETAILERNAME': "retailerName",
|
|
62
|
+
'PLACEMENTID': "placementId",
|
|
63
|
+
'PLACEMENTNAME': "placementName",
|
|
64
|
+
'PAGETYPENAME': "pageTypeName",
|
|
65
|
+
'ENVIRONMENT': "environment",
|
|
66
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
67
|
+
'RETAILERCATEGORYID': "retailerCategoryId",
|
|
68
|
+
'RETAILERCATEGORYNAME': "retailerCategoryName",
|
|
61
69
|
},
|
|
62
|
-
('
|
|
70
|
+
('metrics',): {
|
|
71
|
+
'PAGEVIEWS': "pageViews",
|
|
72
|
+
'AVAILABLEPLACEMENTS': "availablePlacements",
|
|
73
|
+
'UNFILLEDPLACEMENTS': "unfilledPlacements",
|
|
74
|
+
'FILLRATE': "fillRate",
|
|
75
|
+
'PLACEMENTIMPRESSIONS': "placementImpressions",
|
|
76
|
+
'PRODUCTIMPRESSIONS': "productImpressions",
|
|
77
|
+
'IMPRESSIONS': "impressions",
|
|
78
|
+
'PLACEMENTCLICKS': "placementClicks",
|
|
79
|
+
'PRODUCTCLICKS': "productClicks",
|
|
80
|
+
'CLICKS': "clicks",
|
|
81
|
+
'PLACEMENTIMPRESSIONSCTR': "placementImpressionsCTR",
|
|
82
|
+
'PRODUCTIMPRESSIONSCTR': "productImpressionsCTR",
|
|
83
|
+
'CPM': "cpm",
|
|
84
|
+
'CPC': "cpc",
|
|
85
|
+
'PLACEMENTIMPRESSIONSREVENUE': "placementImpressionsRevenue",
|
|
86
|
+
'PRODUCTCLICKSREVENUE': "productClicksRevenue",
|
|
87
|
+
'TOTALREVENUE': "totalRevenue",
|
|
88
|
+
'WORKINGMEDIA': "workingMedia",
|
|
89
|
+
'NETREVENUE': "netRevenue",
|
|
90
|
+
'UNIQUEVISITORS': "uniqueVisitors",
|
|
91
|
+
'FREQUENCY': "frequency",
|
|
92
|
+
},
|
|
93
|
+
('format',): {
|
|
63
94
|
'None': None,
|
|
64
|
-
'
|
|
65
|
-
'
|
|
66
|
-
'
|
|
67
|
-
'
|
|
68
|
-
'CUSTOMERID': "CustomerId",
|
|
69
|
-
'PHONENUMBER': "PhoneNumber",
|
|
95
|
+
'JSON': "json",
|
|
96
|
+
'JSON-COMPACT': "json-compact",
|
|
97
|
+
'JSON-NEWLINE': "json-newline",
|
|
98
|
+
'CSV': "csv",
|
|
70
99
|
},
|
|
71
100
|
}
|
|
72
101
|
|
|
@@ -94,9 +123,13 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
94
123
|
and the value is attribute type.
|
|
95
124
|
"""
|
|
96
125
|
return {
|
|
97
|
-
'
|
|
98
|
-
'
|
|
99
|
-
'
|
|
126
|
+
'dimensions': ([str],), # noqa: E501
|
|
127
|
+
'metrics': ([str],), # noqa: E501
|
|
128
|
+
'start_date': (datetime,), # noqa: E501
|
|
129
|
+
'end_date': (datetime,), # noqa: E501
|
|
130
|
+
'supply_account_ids': ([str], none_type,), # noqa: E501
|
|
131
|
+
'format': (str, none_type,), # noqa: E501
|
|
132
|
+
'timezone': (str, none_type,), # noqa: E501
|
|
100
133
|
}
|
|
101
134
|
|
|
102
135
|
@cached_property
|
|
@@ -105,9 +138,13 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
105
138
|
|
|
106
139
|
|
|
107
140
|
attribute_map = {
|
|
108
|
-
'
|
|
109
|
-
'
|
|
110
|
-
'
|
|
141
|
+
'dimensions': 'dimensions', # noqa: E501
|
|
142
|
+
'metrics': 'metrics', # noqa: E501
|
|
143
|
+
'start_date': 'startDate', # noqa: E501
|
|
144
|
+
'end_date': 'endDate', # noqa: E501
|
|
145
|
+
'supply_account_ids': 'supplyAccountIds', # noqa: E501
|
|
146
|
+
'format': 'format', # noqa: E501
|
|
147
|
+
'timezone': 'timezone', # noqa: E501
|
|
111
148
|
}
|
|
112
149
|
|
|
113
150
|
read_only_vars = {
|
|
@@ -117,12 +154,14 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
117
154
|
|
|
118
155
|
@classmethod
|
|
119
156
|
@convert_js_args_to_python_args
|
|
120
|
-
def _from_openapi_data(cls,
|
|
121
|
-
"""
|
|
157
|
+
def _from_openapi_data(cls, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
158
|
+
"""AsyncFillRateReport - a model defined in OpenAPI
|
|
122
159
|
|
|
123
160
|
Args:
|
|
124
|
-
|
|
125
|
-
|
|
161
|
+
dimensions ([str]): List of dimensions to report on
|
|
162
|
+
metrics ([str]): List of metrics to report on
|
|
163
|
+
start_date (datetime): Start date
|
|
164
|
+
end_date (datetime): End date
|
|
126
165
|
|
|
127
166
|
Keyword Args:
|
|
128
167
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -155,7 +194,9 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
155
194
|
Animal class but this time we won't travel
|
|
156
195
|
through its discriminator because we passed in
|
|
157
196
|
_visited_composed_classes = (Animal,)
|
|
158
|
-
|
|
197
|
+
supply_account_ids ([str], none_type): Supply account ids to report on. [optional] # noqa: E501
|
|
198
|
+
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json" # noqa: E501
|
|
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
|
|
159
200
|
"""
|
|
160
201
|
|
|
161
202
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -187,8 +228,10 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
187
228
|
self._configuration = _configuration
|
|
188
229
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
189
230
|
|
|
190
|
-
self.
|
|
191
|
-
self.
|
|
231
|
+
self.dimensions = dimensions
|
|
232
|
+
self.metrics = metrics
|
|
233
|
+
self.start_date = start_date
|
|
234
|
+
self.end_date = end_date
|
|
192
235
|
for var_name, var_value in kwargs.items():
|
|
193
236
|
if var_name not in self.attribute_map and \
|
|
194
237
|
self._configuration is not None and \
|
|
@@ -209,12 +252,14 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
209
252
|
])
|
|
210
253
|
|
|
211
254
|
@convert_js_args_to_python_args
|
|
212
|
-
def __init__(self,
|
|
213
|
-
"""
|
|
255
|
+
def __init__(self, dimensions, metrics, start_date, end_date, *args, **kwargs): # noqa: E501
|
|
256
|
+
"""AsyncFillRateReport - a model defined in OpenAPI
|
|
214
257
|
|
|
215
258
|
Args:
|
|
216
|
-
|
|
217
|
-
|
|
259
|
+
dimensions ([str]): List of dimensions to report on
|
|
260
|
+
metrics ([str]): List of metrics to report on
|
|
261
|
+
start_date (datetime): Start date
|
|
262
|
+
end_date (datetime): End date
|
|
218
263
|
|
|
219
264
|
Keyword Args:
|
|
220
265
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -247,7 +292,9 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
247
292
|
Animal class but this time we won't travel
|
|
248
293
|
through its discriminator because we passed in
|
|
249
294
|
_visited_composed_classes = (Animal,)
|
|
250
|
-
|
|
295
|
+
supply_account_ids ([str], none_type): Supply account ids to report on. [optional] # noqa: E501
|
|
296
|
+
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json" # noqa: E501
|
|
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
|
|
251
298
|
"""
|
|
252
299
|
|
|
253
300
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -277,8 +324,10 @@ class RetailMediaContactlistAmendmentAttributes(ModelNormal):
|
|
|
277
324
|
self._configuration = _configuration
|
|
278
325
|
self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
|
|
279
326
|
|
|
280
|
-
self.
|
|
281
|
-
self.
|
|
327
|
+
self.dimensions = dimensions
|
|
328
|
+
self.metrics = metrics
|
|
329
|
+
self.start_date = start_date
|
|
330
|
+
self.end_date = end_date
|
|
282
331
|
for var_name, var_value in kwargs.items():
|
|
283
332
|
if var_name not in self.attribute_map and \
|
|
284
333
|
self._configuration is not None and \
|
|
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
def lazy_import():
|
|
33
|
-
from criteo_api_retailmedia_preview.model.
|
|
34
|
-
globals()['
|
|
33
|
+
from criteo_api_retailmedia_preview.model.async_fill_rate_report_resource import AsyncFillRateReportResource
|
|
34
|
+
globals()['AsyncFillRateReportResource'] = AsyncFillRateReportResource
|
|
35
35
|
|
|
36
36
|
|
|
37
|
-
class
|
|
37
|
+
class AsyncFillRateReportRequest(ModelNormal):
|
|
38
38
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
39
39
|
Ref: https://openapi-generator.tech
|
|
40
40
|
|
|
@@ -87,7 +87,7 @@ class AddFundsToBalanceV2Request(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'data': (
|
|
90
|
+
'data': (AsyncFillRateReportResource,), # noqa: E501
|
|
91
91
|
}
|
|
92
92
|
|
|
93
93
|
@cached_property
|
|
@@ -107,7 +107,7 @@ class AddFundsToBalanceV2Request(ModelNormal):
|
|
|
107
107
|
@classmethod
|
|
108
108
|
@convert_js_args_to_python_args
|
|
109
109
|
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
110
|
-
"""
|
|
110
|
+
"""AsyncFillRateReportRequest - a model defined in OpenAPI
|
|
111
111
|
|
|
112
112
|
Keyword Args:
|
|
113
113
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -140,7 +140,7 @@ class AddFundsToBalanceV2Request(ModelNormal):
|
|
|
140
140
|
Animal class but this time we won't travel
|
|
141
141
|
through its discriminator because we passed in
|
|
142
142
|
_visited_composed_classes = (Animal,)
|
|
143
|
-
data (
|
|
143
|
+
data (AsyncFillRateReportResource): [optional] # noqa: E501
|
|
144
144
|
"""
|
|
145
145
|
|
|
146
146
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -193,7 +193,7 @@ class AddFundsToBalanceV2Request(ModelNormal):
|
|
|
193
193
|
|
|
194
194
|
@convert_js_args_to_python_args
|
|
195
195
|
def __init__(self, *args, **kwargs): # noqa: E501
|
|
196
|
-
"""
|
|
196
|
+
"""AsyncFillRateReportRequest - a model defined in OpenAPI
|
|
197
197
|
|
|
198
198
|
Keyword Args:
|
|
199
199
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -226,7 +226,7 @@ class AddFundsToBalanceV2Request(ModelNormal):
|
|
|
226
226
|
Animal class but this time we won't travel
|
|
227
227
|
through its discriminator because we passed in
|
|
228
228
|
_visited_composed_classes = (Animal,)
|
|
229
|
-
data (
|
|
229
|
+
data (AsyncFillRateReportResource): [optional] # noqa: E501
|
|
230
230
|
"""
|
|
231
231
|
|
|
232
232
|
_check_type = kwargs.pop('_check_type', True)
|
criteo_api_retailmedia_preview/model/{http_validation_error.py → async_fill_rate_report_resource.py}
RENAMED
|
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_preview.exceptions import ApiAttributeError
|
|
|
30
30
|
|
|
31
31
|
|
|
32
32
|
def lazy_import():
|
|
33
|
-
from criteo_api_retailmedia_preview.model.
|
|
34
|
-
globals()['
|
|
33
|
+
from criteo_api_retailmedia_preview.model.async_fill_rate_report import AsyncFillRateReport
|
|
34
|
+
globals()['AsyncFillRateReport'] = AsyncFillRateReport
|
|
35
35
|
|
|
36
36
|
|
|
37
|
-
class
|
|
37
|
+
class AsyncFillRateReportResource(ModelNormal):
|
|
38
38
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
39
39
|
Ref: https://openapi-generator.tech
|
|
40
40
|
|
|
@@ -87,7 +87,8 @@ class HttpValidationError(ModelNormal):
|
|
|
87
87
|
"""
|
|
88
88
|
lazy_import()
|
|
89
89
|
return {
|
|
90
|
-
'
|
|
90
|
+
'type': (str, none_type,), # noqa: E501
|
|
91
|
+
'attributes': (AsyncFillRateReport,), # noqa: E501
|
|
91
92
|
}
|
|
92
93
|
|
|
93
94
|
@cached_property
|
|
@@ -96,7 +97,8 @@ class HttpValidationError(ModelNormal):
|
|
|
96
97
|
|
|
97
98
|
|
|
98
99
|
attribute_map = {
|
|
99
|
-
'
|
|
100
|
+
'type': 'type', # noqa: E501
|
|
101
|
+
'attributes': 'attributes', # noqa: E501
|
|
100
102
|
}
|
|
101
103
|
|
|
102
104
|
read_only_vars = {
|
|
@@ -107,7 +109,7 @@ class HttpValidationError(ModelNormal):
|
|
|
107
109
|
@classmethod
|
|
108
110
|
@convert_js_args_to_python_args
|
|
109
111
|
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
110
|
-
"""
|
|
112
|
+
"""AsyncFillRateReportResource - a model defined in OpenAPI
|
|
111
113
|
|
|
112
114
|
Keyword Args:
|
|
113
115
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -140,7 +142,8 @@ class HttpValidationError(ModelNormal):
|
|
|
140
142
|
Animal class but this time we won't travel
|
|
141
143
|
through its discriminator because we passed in
|
|
142
144
|
_visited_composed_classes = (Animal,)
|
|
143
|
-
|
|
145
|
+
type (str, none_type): [optional] # noqa: E501
|
|
146
|
+
attributes (AsyncFillRateReport): [optional] # noqa: E501
|
|
144
147
|
"""
|
|
145
148
|
|
|
146
149
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -193,7 +196,7 @@ class HttpValidationError(ModelNormal):
|
|
|
193
196
|
|
|
194
197
|
@convert_js_args_to_python_args
|
|
195
198
|
def __init__(self, *args, **kwargs): # noqa: E501
|
|
196
|
-
"""
|
|
199
|
+
"""AsyncFillRateReportResource - a model defined in OpenAPI
|
|
197
200
|
|
|
198
201
|
Keyword Args:
|
|
199
202
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -226,7 +229,8 @@ class HttpValidationError(ModelNormal):
|
|
|
226
229
|
Animal class but this time we won't travel
|
|
227
230
|
through its discriminator because we passed in
|
|
228
231
|
_visited_composed_classes = (Animal,)
|
|
229
|
-
|
|
232
|
+
type (str, none_type): [optional] # noqa: E501
|
|
233
|
+
attributes (AsyncFillRateReport): [optional] # noqa: E501
|
|
230
234
|
"""
|
|
231
235
|
|
|
232
236
|
_check_type = kwargs.pop('_check_type', True)
|