criteo-api-retailmedia-sdk 0.0.240207__py3-none-any.whl → 0.0.240515__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.
Files changed (131) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +181 -35
  3. criteo_api_retailmedia_preview/api/analytics_api.py +142 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +284 -0
  5. criteo_api_retailmedia_preview/api/campaign_api.py +1678 -902
  6. criteo_api_retailmedia_preview/api/catalog_api.py +312 -0
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/apis/__init__.py +1 -0
  9. criteo_api_retailmedia_preview/configuration.py +1 -1
  10. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keyword_model.py → add_remove_keyword_model.py} +12 -19
  11. criteo_api_retailmedia_preview/model/add_remove_keywords_model.py +262 -0
  12. criteo_api_retailmedia_preview/model/add_remove_keywords_model_request.py +262 -0
  13. criteo_api_retailmedia_preview/model/add_remove_keywords_model_resource.py +270 -0
  14. criteo_api_retailmedia_preview/model/approval_status_model.py +292 -0
  15. criteo_api_retailmedia_preview/model/async_accounts_report.py +421 -0
  16. criteo_api_retailmedia_preview/model/{external_catalog_request_preview.py → async_accounts_report_request.py} +13 -10
  17. criteo_api_retailmedia_preview/model/async_accounts_report_resource.py +273 -0
  18. criteo_api_retailmedia_preview/model/async_campaigns_report.py +74 -59
  19. criteo_api_retailmedia_preview/model/async_line_items_report.py +74 -60
  20. criteo_api_retailmedia_preview/model/audience_error.py +310 -0
  21. criteo_api_retailmedia_preview/model/{template_variable.py → audience_warning.py} +48 -46
  22. criteo_api_retailmedia_preview/model/{hyperlink_variable_value.py → batch_accepted_response.py} +11 -11
  23. criteo_api_retailmedia_preview/model/change_details.py +275 -0
  24. criteo_api_retailmedia_preview/model/{creative202210_list_response.py → creative_v2_list_response.py} +16 -16
  25. criteo_api_retailmedia_preview/model/{value_resource_collection_outcome_of_int64.py → creative_v2_response.py} +16 -9
  26. criteo_api_retailmedia_preview/model/custom_attribute.py +275 -0
  27. criteo_api_retailmedia_preview/model/error_code_response.py +281 -0
  28. criteo_api_retailmedia_preview/model/export_report_column.py +2 -2
  29. criteo_api_retailmedia_preview/model/{choice_variable_value.py → external_choice_variable_value.py} +3 -3
  30. criteo_api_retailmedia_preview/model/{color_variable_value.py → external_color_variable_value.py} +8 -14
  31. criteo_api_retailmedia_preview/model/{creative_update_model202207.py → external_creative_create_model_v2.py} +11 -11
  32. criteo_api_retailmedia_preview/model/{creative_create_model202207.py → external_creative_update_model_v2.py} +11 -11
  33. criteo_api_retailmedia_preview/model/{creative202210.py → external_creative_v2.py} +34 -28
  34. criteo_api_retailmedia_preview/model/{files_variable_value.py → external_files_variable_value.py} +4 -3
  35. criteo_api_retailmedia_preview/model/{text_variable_specification.py → external_hyperlink_variable_value.py} +7 -7
  36. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers.py → external_line_item_bid_multipliers_v2.py} +41 -29
  37. criteo_api_retailmedia_preview/model/external_line_item_capping_v2.py +280 -0
  38. criteo_api_retailmedia_preview/model/external_line_item_page_category_v2.py +273 -0
  39. criteo_api_retailmedia_preview/model/{choice_variable_specification.py → external_line_item_page_v2.py} +36 -21
  40. criteo_api_retailmedia_preview/model/{page_type_environment.py → external_page_type_environment.py} +15 -9
  41. criteo_api_retailmedia_preview/model/external_preferred_line_item_create_model_v2.py +345 -0
  42. criteo_api_retailmedia_preview/model/{external_catalog_status.py → external_preferred_line_item_update_model_v2.py} +70 -47
  43. criteo_api_retailmedia_preview/model/{template.py → external_preferred_line_item_v2.py} +93 -70
  44. criteo_api_retailmedia_preview/model/{template_variable_value.py → external_template_variable_value.py} +36 -30
  45. criteo_api_retailmedia_preview/model/{text_variable_value.py → external_text_variable_value.py} +8 -14
  46. criteo_api_retailmedia_preview/model/external_video_variable_value.py +293 -0
  47. criteo_api_retailmedia_preview/model/{choice_option.py → fail_response.py} +21 -19
  48. criteo_api_retailmedia_preview/model/{retail_media_externalv1_input_keywords_model.py → input_keywords_model.py} +4 -16
  49. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model.py → input_resource_of_preferred_line_item_create_model_v2.py} +13 -11
  50. criteo_api_retailmedia_preview/model/insertion_order_history_change_data_capture.py +303 -0
  51. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model.py → installment.py} +13 -11
  52. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_line_item_bid_multipliers_and_line_item_bid_multipliers.py → json_api_body_with_id_of_int64_and_line_item_bid_multipliers_v2_and_line_item_bid_multipliers_v2.py} +8 -8
  53. criteo_api_retailmedia_preview/model/{json_api_single_response_of_line_item_bid_multipliers.py → json_api_single_response_of_line_item_bid_multipliers_v2.py} +14 -14
  54. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keyword_data_model.py → keyword_data_model.py} +19 -37
  55. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model.py → keywords_model.py} +9 -18
  56. criteo_api_retailmedia_preview/model/keywords_model_resource.py +270 -0
  57. criteo_api_retailmedia_preview/model/keywords_model_response.py +274 -0
  58. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_request.py → line_item_bid_multipliers_v2_request.py} +8 -8
  59. criteo_api_retailmedia_preview/model/{line_item_bid_multipliers_response.py → line_item_bid_multipliers_v2_response.py} +16 -16
  60. criteo_api_retailmedia_preview/model/line_item_product_status.py +291 -0
  61. criteo_api_retailmedia_preview/model/loyalty_points.py +271 -0
  62. criteo_api_retailmedia_preview/model/match_type_model.py +291 -0
  63. criteo_api_retailmedia_preview/model/metadata.py +273 -0
  64. criteo_api_retailmedia_preview/model/negotiation_state_model.py +293 -0
  65. criteo_api_retailmedia_preview/model/page_of_insertion_order_history_change_data_capture.py +276 -0
  66. criteo_api_retailmedia_preview/model/{json_api_request_of_catalog_request_preview.py → preferred_line_item_create_model_v2_request.py} +8 -8
  67. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_request.py → preferred_line_item_update_model_v2_request.py} +8 -8
  68. criteo_api_retailmedia_preview/model/{creative202210_response.py → preferred_line_item_v2_paged_list_response.py} +22 -16
  69. criteo_api_retailmedia_preview/model/{template_response.py → preferred_line_item_v2_response.py} +16 -16
  70. criteo_api_retailmedia_preview/model/price.py +267 -0
  71. criteo_api_retailmedia_preview/model/product.py +626 -0
  72. criteo_api_retailmedia_preview/model/product_importer_error.py +299 -0
  73. criteo_api_retailmedia_preview/model/product_importer_warning.py +299 -0
  74. criteo_api_retailmedia_preview/model/product_metadata.py +269 -0
  75. criteo_api_retailmedia_preview/model/product_resource_outcome.py +266 -0
  76. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_response.py → product_shipping.py} +33 -25
  77. criteo_api_retailmedia_preview/model/product_shipping_dimension.py +267 -0
  78. criteo_api_retailmedia_preview/model/product_shipping_weight.py +267 -0
  79. criteo_api_retailmedia_preview/model/product_tax.py +283 -0
  80. criteo_api_retailmedia_preview/model/product_unit_pricing_base_measure.py +267 -0
  81. criteo_api_retailmedia_preview/model/product_unit_pricing_measure.py +267 -0
  82. criteo_api_retailmedia_preview/model/{section.py → products_custom_batch_request.py} +13 -19
  83. criteo_api_retailmedia_preview/model/products_custom_batch_request_entry.py +305 -0
  84. criteo_api_retailmedia_preview/model/promoted_product.py +270 -0
  85. criteo_api_retailmedia_preview/model/promoted_product_resource.py +270 -0
  86. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_input.py +262 -0
  87. criteo_api_retailmedia_preview/model/promoted_product_resource_collection_outcome.py +278 -0
  88. criteo_api_retailmedia_preview/model/{retail_media_externalv1_proposal_status_model.py → proposal_status_model.py} +22 -50
  89. criteo_api_retailmedia_preview/model/proposal_status_model_resource.py +270 -0
  90. criteo_api_retailmedia_preview/model/{template_list_response.py → proposal_status_model_response.py} +20 -27
  91. criteo_api_retailmedia_preview/model/report_detail_error.py +299 -0
  92. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_request.py → report_detail_errors.py} +23 -11
  93. criteo_api_retailmedia_preview/model/{retail_media_externalv1_keywords_model_resource.py → report_ok_response.py} +56 -21
  94. criteo_api_retailmedia_preview/model/{resource_of_creative202210.py → resource_of_creative_v2.py} +8 -8
  95. criteo_api_retailmedia_preview/model/{resource_of_template.py → resource_of_line_item_bid_multipliers_v2.py} +8 -8
  96. criteo_api_retailmedia_preview/model/{retail_media_externalv1_add_remove_keywords_model_resource.py → resource_of_preferred_line_item_update_model_v2.py} +16 -22
  97. criteo_api_retailmedia_preview/model/{resource_of_line_item_bid_multipliers.py → resource_of_preferred_line_item_v2.py} +9 -9
  98. criteo_api_retailmedia_preview/model/resource_outcome.py +268 -0
  99. criteo_api_retailmedia_preview/model/retail_media_account.py +6 -6
  100. criteo_api_retailmedia_preview/model/retail_media_brands.py +257 -0
  101. criteo_api_retailmedia_preview/model/{json_api_body_without_id_of_catalog_request_and_catalog_request_preview.py → retail_media_contactlist_amendment.py} +16 -16
  102. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bids_model_resource.py → retail_media_contactlist_amendment_attributes.py} +34 -25
  103. criteo_api_retailmedia_preview/model/retail_media_contactlist_amendment_request.py +275 -0
  104. criteo_api_retailmedia_preview/model/{json_api_single_response_of_catalog_status.py → retail_media_contactlist_operation.py} +24 -20
  105. criteo_api_retailmedia_preview/model/{json_api_body_with_id_of_int64_and_catalog_status_and_catalog_status.py → retail_media_contactlist_operation_response_attributes.py} +14 -18
  106. criteo_api_retailmedia_preview/model/retail_media_contactlist_operation_response_attributes_attributes.py +297 -0
  107. criteo_api_retailmedia_preview/model/review_state_model.py +294 -0
  108. criteo_api_retailmedia_preview/model/{retail_media_externalv1_problem_details.py → rmca_common_problem.py} +41 -30
  109. criteo_api_retailmedia_preview/model/{retail_media_externalv1_set_bid_model.py → set_bid_model.py} +4 -10
  110. criteo_api_retailmedia_preview/model/set_bids_model.py +262 -0
  111. criteo_api_retailmedia_preview/model/set_bids_model_request.py +262 -0
  112. criteo_api_retailmedia_preview/model/set_bids_model_resource.py +270 -0
  113. criteo_api_retailmedia_preview/model/sync_attributed_transactions_report.py +47 -45
  114. criteo_api_retailmedia_preview/model/sync_campaigns_report.py +68 -53
  115. criteo_api_retailmedia_preview/model/sync_line_items_report.py +70 -56
  116. criteo_api_retailmedia_preview/model/value_resource_collection_input_of_retail_media_seller.py +262 -0
  117. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brand_account_creation.py +262 -0
  118. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_brands.py +262 -0
  119. criteo_api_retailmedia_preview/model/value_resource_input_of_retail_media_seller_account_creation.py +262 -0
  120. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_brand_account_creation.py +266 -0
  121. criteo_api_retailmedia_preview/model/{value_resource_of_int64.py → value_resource_of_retail_media_brands.py} +11 -6
  122. criteo_api_retailmedia_preview/model/value_resource_of_retail_media_seller_account_creation.py +266 -0
  123. criteo_api_retailmedia_preview/models/__init__.py +106 -55
  124. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/METADATA +3 -3
  125. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/RECORD +127 -75
  126. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/WHEEL +1 -1
  127. criteo_api_retailmedia_preview/model/files_variables_specification.py +0 -290
  128. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_resource.py +0 -283
  129. criteo_api_retailmedia_preview/model/retail_media_externalv1_proposal_status_model_response.py +0 -285
  130. criteo_api_retailmedia_preview/model/retail_media_externalv1_resource_outcome.py +0 -279
  131. {criteo_api_retailmedia_sdk-0.0.240207.dist-info → criteo_api_retailmedia_sdk-0.0.240515.dist-info}/top_level.txt +0 -0
@@ -55,16 +55,43 @@ class SyncAttributedTransactionsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
+ ('click_attribution_window',): {
59
+ 'None': None,
60
+ 'NONE': "none",
61
+ '7D': "7D",
62
+ '14D': "14D",
63
+ '30D': "30D",
64
+ },
65
+ ('view_attribution_window',): {
66
+ 'None': None,
67
+ 'NONE': "none",
68
+ '1D': "1D",
69
+ '7D': "7D",
70
+ '14D': "14D",
71
+ '30D': "30D",
72
+ },
73
+ ('campaign_type',): {
74
+ 'None': None,
75
+ 'ALL': "all",
76
+ 'SPONSOREDPRODUCTS': "sponsoredProducts",
77
+ 'ONSITEDISPLAYS': "onSiteDisplays",
78
+ },
79
+ ('sales_channel',): {
80
+ 'None': None,
81
+ 'ALL': "all",
82
+ 'OFFLINE': "offline",
83
+ 'ONLINE': "online",
84
+ },
58
85
  ('dimensions',): {
59
86
  'None': None,
60
- 'CAMPAIGNNAME': "campaignName",
61
- 'CAMPAIGNID': "campaignId",
62
- 'LINEITEMID': "lineItemId",
63
87
  'PURCHASEDDATE': "purchasedDate",
64
88
  'PURCHASEDHOUR': "purchasedHour",
65
89
  'ADVDATE': "advDate",
66
90
  'ADVHOUR': "advHour",
67
91
  'DAYSDIFFERENCE': "daysDifference",
92
+ 'CAMPAIGNID': "campaignId",
93
+ 'CAMPAIGNNAME': "campaignName",
94
+ 'LINEITEMID': "lineItemId",
68
95
  'LINEITEMNAME': "lineItemName",
69
96
  'ADVPRODUCTID': "advProductId",
70
97
  'ADVPRODUCTGTIN': "advProductGtin",
@@ -79,8 +106,8 @@ class SyncAttributedTransactionsReport(ModelNormal):
79
106
  'ADVENGAGEMENT': "advEngagement",
80
107
  'ADVTOPURCHASEDPRODUCTRELATIONSHIP': "advToPurchasedProductRelationship",
81
108
  'SALESCHANNEL': "salesChannel",
82
- 'PAGETYPENAME': "pageTypeName",
83
109
  'RETAILERNAME': "retailerName",
110
+ 'PAGETYPENAME': "pageTypeName",
84
111
  'KEYWORD': "keyword",
85
112
  'ATTRIBUTIONWINDOW': "attributionWindow",
86
113
  },
@@ -89,31 +116,6 @@ class SyncAttributedTransactionsReport(ModelNormal):
89
116
  'ATTRIBUTEDUNITS': "attributedUnits",
90
117
  'ATTRIBUTEDSALES': "attributedSales",
91
118
  },
92
- ('click_attribution_window',): {
93
- 'None': None,
94
- '7D': "7D",
95
- '14D': "14D",
96
- '30D': "30D",
97
- 'NONE': "none",
98
- },
99
- ('view_attribution_window',): {
100
- 'None': None,
101
- '1D': "1D",
102
- '7D': "7D",
103
- '14D': "14D",
104
- '30D': "30D",
105
- 'NONE': "none",
106
- },
107
- ('campaign_type',): {
108
- 'None': None,
109
- 'SPONSOREDPRODUCTS': "sponsoredProducts",
110
- 'ONSITEDISPLAYS': "onSiteDisplays",
111
- },
112
- ('sales_channel',): {
113
- 'None': None,
114
- 'OFFLINE': "offline",
115
- 'ONLINE': "online",
116
- },
117
119
  }
118
120
 
119
121
  validations = {
@@ -145,12 +147,12 @@ class SyncAttributedTransactionsReport(ModelNormal):
145
147
  'end_date': (datetime,), # noqa: E501
146
148
  'campaign_ids': ([str], none_type,), # noqa: E501
147
149
  'line_item_ids': ([str], none_type,), # noqa: E501
148
- 'dimensions': ([str], none_type,), # noqa: E501
149
- 'metrics': ([str], none_type,), # noqa: E501
150
150
  'click_attribution_window': (str, none_type,), # noqa: E501
151
151
  'view_attribution_window': (str, none_type,), # noqa: E501
152
152
  'campaign_type': (str, none_type,), # noqa: E501
153
153
  'sales_channel': (str, none_type,), # noqa: E501
154
+ 'dimensions': ([str], none_type,), # noqa: E501
155
+ 'metrics': ([str], none_type,), # noqa: E501
154
156
  'timezone': (str, none_type,), # noqa: E501
155
157
  }
156
158
 
@@ -165,12 +167,12 @@ class SyncAttributedTransactionsReport(ModelNormal):
165
167
  'end_date': 'endDate', # noqa: E501
166
168
  'campaign_ids': 'campaignIds', # noqa: E501
167
169
  'line_item_ids': 'lineItemIds', # noqa: E501
168
- 'dimensions': 'dimensions', # noqa: E501
169
- 'metrics': 'metrics', # noqa: E501
170
170
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
171
171
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
172
172
  'campaign_type': 'campaignType', # noqa: E501
173
173
  'sales_channel': 'salesChannel', # noqa: E501
174
+ 'dimensions': 'dimensions', # noqa: E501
175
+ 'metrics': 'metrics', # noqa: E501
174
176
  'timezone': 'timezone', # noqa: E501
175
177
  }
176
178
 
@@ -220,14 +222,14 @@ class SyncAttributedTransactionsReport(ModelNormal):
220
222
  Animal class but this time we won't travel
221
223
  through its discriminator because we passed in
222
224
  _visited_composed_classes = (Animal,)
223
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
224
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
225
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
226
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
225
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
226
+ line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501
227
227
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
228
228
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
229
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
230
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
229
+ 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
230
+ 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
231
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
232
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
231
233
  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
232
234
  """
233
235
 
@@ -322,14 +324,14 @@ class SyncAttributedTransactionsReport(ModelNormal):
322
324
  Animal class but this time we won't travel
323
325
  through its discriminator because we passed in
324
326
  _visited_composed_classes = (Animal,)
325
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
326
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
327
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
328
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
327
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
328
+ line_item_ids ([str], none_type): Line item ids to filter. [optional] # noqa: E501
329
329
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
330
330
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
331
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
332
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
331
+ 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
332
+ 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
333
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
334
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
333
335
  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
334
336
  """
335
337
 
@@ -65,68 +65,83 @@ class SyncCampaignsReport(ModelNormal):
65
65
  'ENVIRONMENT': "environment",
66
66
  'SERVEDCATEGORY': "servedCategory",
67
67
  },
68
- ('metrics',): {
69
- 'None': None,
70
- 'IMPRESSIONS': "impressions",
71
- 'CLICKS': "clicks",
72
- 'SPEND': "spend",
73
- 'ATTRIBUTEDSALES': "attributedSales",
74
- 'ATTRIBUTEDUNITS': "attributedUnits",
75
- 'ATTRIBUTEDORDERS': "attributedOrders",
76
- 'CTR': "ctr",
77
- 'CPC': "cpc",
78
- 'CPO': "cpo",
79
- 'CPM': "cpm",
80
- 'ROAS': "roas",
81
- 'UNIQUEVISITORS': "uniqueVisitors",
82
- 'FREQUENCY': "frequency",
83
- 'ASSISTEDUNITS': "assistedUnits",
84
- 'ASSISTEDSALES': "assistedSales",
85
- },
86
- ('dimensions',): {
87
- 'None': None,
88
- 'DATE': "date",
89
- 'HOUR': "hour",
90
- 'CAMPAIGNID': "campaignId",
91
- 'CAMPAIGNNAME': "campaignName",
92
- 'CAMPAIGNTYPENAME': "campaignTypeName",
93
- 'ADVPRODUCTCATEGORY': "advProductCategory",
94
- 'ADVPRODUCTID': "advProductId",
95
- 'ADVPRODUCTNAME': "advProductName",
96
- 'BRANDID': "brandId",
97
- 'BRANDNAME': "brandName",
98
- 'PAGETYPENAME': "pageTypeName",
99
- 'ENVIRONMENT': "environment",
100
- 'KEYWORD': "keyword",
101
- 'SALESCHANNEL': "salesChannel",
102
- 'RETAILERID': "retailerId",
103
- 'RETAILERNAME': "retailerName",
104
- },
105
68
  ('click_attribution_window',): {
106
69
  'None': None,
70
+ 'NONE': "none",
107
71
  '7D': "7D",
108
72
  '14D': "14D",
109
73
  '30D': "30D",
110
- 'NONE': "none",
111
74
  },
112
75
  ('view_attribution_window',): {
113
76
  'None': None,
77
+ 'NONE': "none",
114
78
  '1D': "1D",
115
79
  '7D': "7D",
116
80
  '14D': "14D",
117
81
  '30D': "30D",
118
- 'NONE': "none",
119
82
  },
120
83
  ('campaign_type',): {
121
84
  'None': None,
85
+ 'ALL': "all",
122
86
  'SPONSOREDPRODUCTS': "sponsoredProducts",
123
87
  'ONSITEDISPLAYS': "onSiteDisplays",
124
88
  },
125
89
  ('sales_channel',): {
126
90
  'None': None,
91
+ 'ALL': "all",
127
92
  'OFFLINE': "offline",
128
93
  'ONLINE': "online",
129
94
  },
95
+ ('dimensions',): {
96
+ 'None': None,
97
+ 'DATE': "date",
98
+ 'HOUR': "hour",
99
+ 'ACCOUNTID': "accountId",
100
+ 'ACCOUNTNAME': "accountName",
101
+ 'CAMPAIGNID': "campaignId",
102
+ 'CAMPAIGNNAME': "campaignName",
103
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
104
+ 'LINEITEMID': "lineItemId",
105
+ 'LINEITEMNAME': "lineItemName",
106
+ 'RETAILERID': "retailerId",
107
+ 'RETAILERNAME': "retailerName",
108
+ 'BRANDID': "brandId",
109
+ 'BRANDNAME': "brandName",
110
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
111
+ 'ADVPRODUCTID': "advProductId",
112
+ 'ADVPRODUCTNAME': "advProductName",
113
+ 'SALESCHANNEL': "salesChannel",
114
+ 'ENVIRONMENT': "environment",
115
+ 'PAGETYPENAME': "pageTypeName",
116
+ 'KEYWORD': "keyword",
117
+ 'SEARCHTERM': "searchTerm",
118
+ },
119
+ ('metrics',): {
120
+ 'None': None,
121
+ 'IMPRESSIONS': "impressions",
122
+ 'CLICKS': "clicks",
123
+ 'SPEND': "spend",
124
+ 'ATTRIBUTEDSALES': "attributedSales",
125
+ 'ATTRIBUTEDUNITS': "attributedUnits",
126
+ 'ATTRIBUTEDORDERS': "attributedOrders",
127
+ 'ASSISTEDSALES': "assistedSales",
128
+ 'ASSISTEDUNITS': "assistedUnits",
129
+ 'CTR': "ctr",
130
+ 'CPC': "cpc",
131
+ 'CPO': "cpo",
132
+ 'CPM': "cpm",
133
+ 'ROAS': "roas",
134
+ 'VIDEOVIEWS': "videoViews",
135
+ 'VIDEOSSTARTED': "videosStarted",
136
+ 'VIDEOSPLAYEDTO25': "videosPlayedTo25",
137
+ 'VIDEOSPLAYEDTO50': "videosPlayedTo50",
138
+ 'VIDEOSPLAYEDTO75': "videosPlayedTo75",
139
+ 'VIDEOSPLAYEDTO100': "videosPlayedTo100",
140
+ 'VIDEOPLAYINGRATE': "videoPlayingRate",
141
+ 'VIDEOCOMPLETIONRATE': "videoCompletionRate",
142
+ 'UNIQUEVISITORS': "uniqueVisitors",
143
+ 'FREQUENCY': "frequency",
144
+ },
130
145
  }
131
146
 
132
147
  validations = {
@@ -158,12 +173,12 @@ class SyncCampaignsReport(ModelNormal):
158
173
  'end_date': (datetime,), # noqa: E501
159
174
  'report_type': (str, none_type,), # noqa: E501
160
175
  'campaign_ids': ([str], none_type,), # noqa: E501
161
- 'metrics': ([str], none_type,), # noqa: E501
162
- 'dimensions': ([str], none_type,), # noqa: E501
163
176
  'click_attribution_window': (str, none_type,), # noqa: E501
164
177
  'view_attribution_window': (str, none_type,), # noqa: E501
165
178
  'campaign_type': (str, none_type,), # noqa: E501
166
179
  'sales_channel': (str, none_type,), # noqa: E501
180
+ 'dimensions': ([str], none_type,), # noqa: E501
181
+ 'metrics': ([str], none_type,), # noqa: E501
167
182
  'timezone': (str, none_type,), # noqa: E501
168
183
  }
169
184
 
@@ -178,12 +193,12 @@ class SyncCampaignsReport(ModelNormal):
178
193
  'end_date': 'endDate', # noqa: E501
179
194
  'report_type': 'reportType', # noqa: E501
180
195
  'campaign_ids': 'campaignIds', # noqa: E501
181
- 'metrics': 'metrics', # noqa: E501
182
- 'dimensions': 'dimensions', # noqa: E501
183
196
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
184
197
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
185
198
  'campaign_type': 'campaignType', # noqa: E501
186
199
  'sales_channel': 'salesChannel', # noqa: E501
200
+ 'dimensions': 'dimensions', # noqa: E501
201
+ 'metrics': 'metrics', # noqa: E501
187
202
  'timezone': 'timezone', # noqa: E501
188
203
  }
189
204
 
@@ -234,13 +249,13 @@ class SyncCampaignsReport(ModelNormal):
234
249
  through its discriminator because we passed in
235
250
  _visited_composed_classes = (Animal,)
236
251
  report_type (str, none_type): 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
237
- campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501
238
- metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501
239
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
252
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
240
253
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
241
254
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
242
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
243
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
255
+ 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
256
+ 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
257
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
258
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
244
259
  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
245
260
  """
246
261
 
@@ -336,13 +351,13 @@ class SyncCampaignsReport(ModelNormal):
336
351
  through its discriminator because we passed in
337
352
  _visited_composed_classes = (Animal,)
338
353
  report_type (str, none_type): 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
339
- campaign_ids ([str], none_type): List of campaign Ids to filter. [optional] # noqa: E501
340
- metrics ([str], none_type): List of Metrics to report on. [optional] # noqa: E501
341
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
354
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
342
355
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
343
356
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
344
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
345
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
357
+ 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
358
+ 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
359
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
360
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
346
361
  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
347
362
  """
348
363
 
@@ -65,69 +65,83 @@ class SyncLineItemsReport(ModelNormal):
65
65
  'ENVIRONMENT': "environment",
66
66
  'SERVEDCATEGORY': "servedCategory",
67
67
  },
68
- ('metrics',): {
69
- 'None': None,
70
- 'IMPRESSIONS': "impressions",
71
- 'CLICKS': "clicks",
72
- 'SPEND': "spend",
73
- 'ATTRIBUTEDSALES': "attributedSales",
74
- 'ATTRIBUTEDUNITS': "attributedUnits",
75
- 'ATTRIBUTEDORDERS': "attributedOrders",
76
- 'CTR': "ctr",
77
- 'CPC': "cpc",
78
- 'CPO': "cpo",
79
- 'ROAS': "roas",
80
- 'ASSISTEDUNITS': "assistedUnits",
81
- 'ASSISTEDSALES': "assistedSales",
82
- 'UNIQUEVISITORS': "uniqueVisitors",
83
- 'FREQUENCY': "frequency",
84
- },
85
- ('dimensions',): {
86
- 'None': None,
87
- 'DATE': "date",
88
- 'HOUR': "hour",
89
- 'CAMPAIGNID': "campaignId",
90
- 'CAMPAIGNNAME': "campaignName",
91
- 'CAMPAIGNTYPENAME': "campaignTypeName",
92
- 'ADVPRODUCTCATEGORY': "advProductCategory",
93
- 'ADVPRODUCTID': "advProductId",
94
- 'ADVPRODUCTNAME': "advProductName",
95
- 'BRANDID': "brandId",
96
- 'BRANDNAME': "brandName",
97
- 'LINEITEMID': "lineItemId",
98
- 'LINEITEMNAME': "lineItemName",
99
- 'RETAILERID': "retailerId",
100
- 'RETAILERNAME': "retailerName",
101
- 'KEYWORD': "keyword",
102
- 'PAGETYPENAME': "pageTypeName",
103
- 'SALESCHANNEL': "salesChannel",
104
- 'ENVIRONMENT': "environment",
105
- },
106
68
  ('click_attribution_window',): {
107
69
  'None': None,
70
+ 'NONE': "none",
108
71
  '7D': "7D",
109
72
  '14D': "14D",
110
73
  '30D': "30D",
111
- 'NONE': "none",
112
74
  },
113
75
  ('view_attribution_window',): {
114
76
  'None': None,
77
+ 'NONE': "none",
115
78
  '1D': "1D",
116
79
  '7D': "7D",
117
80
  '14D': "14D",
118
81
  '30D': "30D",
119
- 'NONE': "none",
120
82
  },
121
83
  ('campaign_type',): {
122
84
  'None': None,
85
+ 'ALL': "all",
123
86
  'SPONSOREDPRODUCTS': "sponsoredProducts",
124
87
  'ONSITEDISPLAYS': "onSiteDisplays",
125
88
  },
126
89
  ('sales_channel',): {
127
90
  'None': None,
91
+ 'ALL': "all",
128
92
  'OFFLINE': "offline",
129
93
  'ONLINE': "online",
130
94
  },
95
+ ('dimensions',): {
96
+ 'None': None,
97
+ 'DATE': "date",
98
+ 'HOUR': "hour",
99
+ 'ACCOUNTID': "accountId",
100
+ 'ACCOUNTNAME': "accountName",
101
+ 'CAMPAIGNID': "campaignId",
102
+ 'CAMPAIGNNAME': "campaignName",
103
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
104
+ 'LINEITEMID': "lineItemId",
105
+ 'LINEITEMNAME': "lineItemName",
106
+ 'RETAILERID': "retailerId",
107
+ 'RETAILERNAME': "retailerName",
108
+ 'BRANDID': "brandId",
109
+ 'BRANDNAME': "brandName",
110
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
111
+ 'ADVPRODUCTID': "advProductId",
112
+ 'ADVPRODUCTNAME': "advProductName",
113
+ 'SALESCHANNEL': "salesChannel",
114
+ 'ENVIRONMENT': "environment",
115
+ 'PAGETYPENAME': "pageTypeName",
116
+ 'KEYWORD': "keyword",
117
+ 'SEARCHTERM': "searchTerm",
118
+ },
119
+ ('metrics',): {
120
+ 'None': None,
121
+ 'IMPRESSIONS': "impressions",
122
+ 'CLICKS': "clicks",
123
+ 'SPEND': "spend",
124
+ 'ATTRIBUTEDSALES': "attributedSales",
125
+ 'ATTRIBUTEDUNITS': "attributedUnits",
126
+ 'ATTRIBUTEDORDERS': "attributedOrders",
127
+ 'ASSISTEDSALES': "assistedSales",
128
+ 'ASSISTEDUNITS': "assistedUnits",
129
+ 'CTR': "ctr",
130
+ 'CPC': "cpc",
131
+ 'CPO': "cpo",
132
+ 'CPM': "cpm",
133
+ 'ROAS': "roas",
134
+ 'VIDEOVIEWS': "videoViews",
135
+ 'VIDEOSSTARTED': "videosStarted",
136
+ 'VIDEOSPLAYEDTO25': "videosPlayedTo25",
137
+ 'VIDEOSPLAYEDTO50': "videosPlayedTo50",
138
+ 'VIDEOSPLAYEDTO75': "videosPlayedTo75",
139
+ 'VIDEOSPLAYEDTO100': "videosPlayedTo100",
140
+ 'VIDEOPLAYINGRATE': "videoPlayingRate",
141
+ 'VIDEOCOMPLETIONRATE': "videoCompletionRate",
142
+ 'UNIQUEVISITORS': "uniqueVisitors",
143
+ 'FREQUENCY': "frequency",
144
+ },
131
145
  }
132
146
 
133
147
  validations = {
@@ -160,12 +174,12 @@ class SyncLineItemsReport(ModelNormal):
160
174
  'report_type': (str, none_type,), # noqa: E501
161
175
  'line_item_ids': ([str], none_type,), # noqa: E501
162
176
  'campaign_ids': ([str], none_type,), # noqa: E501
163
- 'metrics': ([str], none_type,), # noqa: E501
164
- 'dimensions': ([str], none_type,), # noqa: E501
165
177
  'click_attribution_window': (str, none_type,), # noqa: E501
166
178
  'view_attribution_window': (str, none_type,), # noqa: E501
167
179
  'campaign_type': (str, none_type,), # noqa: E501
168
180
  'sales_channel': (str, none_type,), # noqa: E501
181
+ 'dimensions': ([str], none_type,), # noqa: E501
182
+ 'metrics': ([str], none_type,), # noqa: E501
169
183
  'timezone': (str, none_type,), # noqa: E501
170
184
  }
171
185
 
@@ -181,12 +195,12 @@ class SyncLineItemsReport(ModelNormal):
181
195
  'report_type': 'reportType', # noqa: E501
182
196
  'line_item_ids': 'lineItemIds', # noqa: E501
183
197
  'campaign_ids': 'campaignIds', # noqa: E501
184
- 'metrics': 'metrics', # noqa: E501
185
- 'dimensions': 'dimensions', # noqa: E501
186
198
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
187
199
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
188
200
  'campaign_type': 'campaignType', # noqa: E501
189
201
  'sales_channel': 'salesChannel', # noqa: E501
202
+ 'dimensions': 'dimensions', # noqa: E501
203
+ 'metrics': 'metrics', # noqa: E501
190
204
  'timezone': 'timezone', # noqa: E501
191
205
  }
192
206
 
@@ -237,14 +251,14 @@ class SyncLineItemsReport(ModelNormal):
237
251
  through its discriminator because we passed in
238
252
  _visited_composed_classes = (Animal,)
239
253
  report_type (str, none_type): 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
240
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
241
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
242
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
243
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
254
+ line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501
255
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
244
256
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
245
257
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
246
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
247
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
258
+ 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
259
+ 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
260
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
261
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
248
262
  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
249
263
  """
250
264
 
@@ -340,14 +354,14 @@ class SyncLineItemsReport(ModelNormal):
340
354
  through its discriminator because we passed in
341
355
  _visited_composed_classes = (Animal,)
342
356
  report_type (str, none_type): 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
343
- line_item_ids ([str], none_type): Line item ids to report on. [optional] # noqa: E501
344
- campaign_ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
345
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
346
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
357
+ line_item_ids ([str], none_type): Line Item ids to filter. [optional] # noqa: E501
358
+ campaign_ids ([str], none_type): Campaign ids to filter. [optional] # noqa: E501
347
359
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
348
360
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
349
- campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
350
- sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
361
+ 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
362
+ 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
363
+ dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
364
+ metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
351
365
  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
352
366
  """
353
367