criteo-api-retailmedia-sdk 2023.7.0.240118__py3-none-any.whl → 2023.7.0.240404__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.

Files changed (37) hide show
  1. {criteo_api_retailmedia_sdk-2023.7.0.240118.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240404.dist-info}/METADATA +3 -3
  2. {criteo_api_retailmedia_sdk-2023.7.0.240118.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240404.dist-info}/RECORD +35 -36
  3. {criteo_api_retailmedia_sdk-2023.7.0.240118.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240404.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_v2023_07/__init__.py +1 -1
  5. criteo_api_retailmedia_v2023_07/api/audience_api.py +113 -100
  6. criteo_api_retailmedia_v2023_07/api_client.py +1 -1
  7. criteo_api_retailmedia_v2023_07/configuration.py +1 -1
  8. criteo_api_retailmedia_v2023_07/model/async_campaigns_report.py +57 -53
  9. criteo_api_retailmedia_v2023_07/model/async_line_items_report.py +57 -54
  10. criteo_api_retailmedia_v2023_07/model/campaign_attributes_v202301.py +4 -0
  11. criteo_api_retailmedia_v2023_07/model/campaign_v202301.py +4 -0
  12. criteo_api_retailmedia_v2023_07/model/editable_campaign_attributes_v202301.py +4 -0
  13. criteo_api_retailmedia_v2023_07/model/external_account.py +4 -0
  14. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_attributes.py → rm_legacy_audience_create_entity_v1.py} +10 -5
  15. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_body.py → rm_legacy_audience_create_entity_v1_resource.py} +18 -22
  16. criteo_api_retailmedia_v2023_07/model/{retail_media_audience_v2_response.py → rm_legacy_audience_create_entity_v1_response.py} +15 -15
  17. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_v2_attributes.py → rm_legacy_audience_create_entity_v2.py} +10 -10
  18. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience.py → rm_legacy_audience_create_entity_v2_resource.py} +18 -28
  19. criteo_api_retailmedia_v2023_07/model/{common_status_code_response.py → rm_legacy_audience_create_entity_v2_response.py} +16 -10
  20. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_v2_request.py → rm_legacy_audience_create_input_entity_v1.py} +10 -16
  21. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_request.py → rm_legacy_audience_create_input_entity_v2.py} +10 -16
  22. criteo_api_retailmedia_v2023_07/model/{retail_media_audience_v2_attributes.py → rm_legacy_audience_get_entity_v1.py} +23 -23
  23. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_response.py → rm_legacy_audience_get_entity_v1_list_response.py} +18 -20
  24. criteo_api_retailmedia_v2023_07/model/{retail_media_audience_v2.py → rm_legacy_audience_get_entity_v1_resource.py} +24 -29
  25. criteo_api_retailmedia_v2023_07/model/{retail_media_audience_attributes.py → rm_legacy_audience_get_entity_v2.py} +15 -15
  26. criteo_api_retailmedia_v2023_07/model/{retail_media_audience_v2_list_response.py → rm_legacy_audience_get_entity_v2_list_response.py} +17 -29
  27. criteo_api_retailmedia_v2023_07/model/{create_retail_media_audience_v2_data.py → rm_legacy_audience_get_entity_v2_resource.py} +18 -22
  28. criteo_api_retailmedia_v2023_07/model/rm_legacy_audience_user_behavior_create_v2.py +279 -0
  29. criteo_api_retailmedia_v2023_07/model/{user_behavior_details_v2.py → rm_legacy_audience_user_behavior_details_v2.py} +11 -11
  30. criteo_api_retailmedia_v2023_07/model/{customer_list_details.py → rm_legacy_segment_customer_list.py} +11 -5
  31. criteo_api_retailmedia_v2023_07/model/{retail_media_audience.py → rm_legacy_segment_user_behavior_create_v2.py} +44 -38
  32. criteo_api_retailmedia_v2023_07/model/{user_behavior_details.py → rm_legacy_segment_user_behavior_v1.py} +28 -28
  33. criteo_api_retailmedia_v2023_07/model/{create_user_behavior_segment_v2.py → rm_legacy_segment_user_behavior_v2.py} +7 -5
  34. criteo_api_retailmedia_v2023_07/models/__init__.py +20 -21
  35. criteo_api_retailmedia_v2023_07/model/create_retail_media_audience_v2.py +0 -287
  36. criteo_api_retailmedia_v2023_07/model/get_page_of_audiences_by_account_id_response.py +0 -295
  37. {criteo_api_retailmedia_sdk-2023.7.0.240118.dist-info → criteo_api_retailmedia_sdk-2023.7.0.240404.dist-info}/top_level.txt +0 -0
@@ -55,43 +55,6 @@ class AsyncCampaignsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('metrics',): {
59
- 'None': None,
60
- 'IMPRESSIONS': "impressions",
61
- 'CLICKS': "clicks",
62
- 'SPEND': "spend",
63
- 'ATTRIBUTEDSALES': "attributedSales",
64
- 'ATTRIBUTEDUNITS': "attributedUnits",
65
- 'ATTRIBUTEDORDERS': "attributedOrders",
66
- 'CTR': "ctr",
67
- 'CPC': "cpc",
68
- 'CPO': "cpo",
69
- 'CPM': "cpm",
70
- 'ROAS': "roas",
71
- 'UNIQUEVISITORS': "uniqueVisitors",
72
- 'FREQUENCY': "frequency",
73
- 'ASSISTEDUNITS': "assistedUnits",
74
- 'ASSISTEDSALES': "assistedSales",
75
- },
76
- ('dimensions',): {
77
- 'None': None,
78
- 'DATE': "date",
79
- 'HOUR': "hour",
80
- 'CAMPAIGNID': "campaignId",
81
- 'CAMPAIGNNAME': "campaignName",
82
- 'CAMPAIGNTYPENAME': "campaignTypeName",
83
- 'ADVPRODUCTCATEGORY': "advProductCategory",
84
- 'ADVPRODUCTID': "advProductId",
85
- 'ADVPRODUCTNAME': "advProductName",
86
- 'BRANDID': "brandId",
87
- 'BRANDNAME': "brandName",
88
- 'PAGETYPENAME': "pageTypeName",
89
- 'ENVIRONMENT': "environment",
90
- 'KEYWORD': "keyword",
91
- 'SALESCHANNEL': "salesChannel",
92
- 'RETAILERID': "retailerId",
93
- 'RETAILERNAME': "retailerName",
94
- },
95
58
  ('campaign_type',): {
96
59
  'None': None,
97
60
  'SPONSOREDPRODUCTS': "sponsoredProducts",
@@ -135,6 +98,47 @@ class AsyncCampaignsReport(ModelNormal):
135
98
  '30D': "30D",
136
99
  'NONE': "none",
137
100
  },
101
+ ('dimensions',): {
102
+ 'None': None,
103
+ 'DATE': "date",
104
+ 'HOUR': "hour",
105
+ 'ACCOUNTID': "accountId",
106
+ 'ACCOUNTNAME': "accountName",
107
+ 'CAMPAIGNID': "campaignId",
108
+ 'CAMPAIGNNAME': "campaignName",
109
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
110
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
111
+ 'ADVPRODUCTID': "advProductId",
112
+ 'ADVPRODUCTNAME': "advProductName",
113
+ 'BRANDID': "brandId",
114
+ 'BRANDNAME': "brandName",
115
+ 'LINEITEMID': "lineItemId",
116
+ 'LINEITEMNAME': "lineItemName",
117
+ 'RETAILERID': "retailerId",
118
+ 'RETAILERNAME': "retailerName",
119
+ 'KEYWORD': "keyword",
120
+ 'PAGETYPENAME': "pageTypeName",
121
+ 'SALESCHANNEL': "salesChannel",
122
+ 'ENVIRONMENT': "environment",
123
+ },
124
+ ('metrics',): {
125
+ 'None': None,
126
+ 'IMPRESSIONS': "impressions",
127
+ 'CLICKS': "clicks",
128
+ 'SPEND': "spend",
129
+ 'ATTRIBUTEDSALES': "attributedSales",
130
+ 'ATTRIBUTEDUNITS': "attributedUnits",
131
+ 'ATTRIBUTEDORDERS': "attributedOrders",
132
+ 'ASSISTEDSALES': "assistedSales",
133
+ 'ASSISTEDUNITS': "assistedUnits",
134
+ 'CTR': "ctr",
135
+ 'CPC': "cpc",
136
+ 'CPO': "cpo",
137
+ 'CPM': "cpm",
138
+ 'ROAS': "roas",
139
+ 'UNIQUEVISITORS': "uniqueVisitors",
140
+ 'FREQUENCY': "frequency",
141
+ },
138
142
  }
139
143
 
140
144
  validations = {
@@ -163,16 +167,16 @@ class AsyncCampaignsReport(ModelNormal):
163
167
  return {
164
168
  'start_date': (datetime,), # noqa: E501
165
169
  'end_date': (datetime,), # noqa: E501
166
- 'metrics': ([str], none_type,), # noqa: E501
167
- 'dimensions': ([str], none_type,), # noqa: E501
170
+ 'ids': ([str], none_type,), # noqa: E501
171
+ 'id': (str, none_type,), # noqa: E501
168
172
  'campaign_type': (str, none_type,), # noqa: E501
169
173
  'sales_channel': (str, none_type,), # noqa: E501
170
174
  'format': (str, none_type,), # noqa: E501
171
175
  'report_type': (str, none_type,), # noqa: E501
172
176
  'click_attribution_window': (str, none_type,), # noqa: E501
173
177
  'view_attribution_window': (str, none_type,), # noqa: E501
174
- 'ids': ([str], none_type,), # noqa: E501
175
- 'id': (str, none_type,), # noqa: E501
178
+ 'dimensions': ([str], none_type,), # noqa: E501
179
+ 'metrics': ([str], none_type,), # noqa: E501
176
180
  'timezone': (str, none_type,), # noqa: E501
177
181
  }
178
182
 
@@ -184,16 +188,16 @@ class AsyncCampaignsReport(ModelNormal):
184
188
  attribute_map = {
185
189
  'start_date': 'startDate', # noqa: E501
186
190
  'end_date': 'endDate', # noqa: E501
187
- 'metrics': 'metrics', # noqa: E501
188
- 'dimensions': 'dimensions', # noqa: E501
191
+ 'ids': 'ids', # noqa: E501
192
+ 'id': 'id', # noqa: E501
189
193
  'campaign_type': 'campaignType', # noqa: E501
190
194
  'sales_channel': 'salesChannel', # noqa: E501
191
195
  'format': 'format', # noqa: E501
192
196
  'report_type': 'reportType', # noqa: E501
193
197
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
194
198
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
195
- 'ids': 'ids', # noqa: E501
196
- 'id': 'id', # noqa: E501
199
+ 'dimensions': 'dimensions', # noqa: E501
200
+ 'metrics': 'metrics', # noqa: E501
197
201
  'timezone': 'timezone', # noqa: E501
198
202
  }
199
203
 
@@ -242,16 +246,16 @@ class AsyncCampaignsReport(ModelNormal):
242
246
  Animal class but this time we won't travel
243
247
  through its discriminator because we passed in
244
248
  _visited_composed_classes = (Animal,)
245
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
246
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
249
+ ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
250
+ id (str, none_type): Campaign id to report on. [optional] # noqa: E501
247
251
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
248
252
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
249
253
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
250
254
  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
251
255
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
252
256
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
253
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
254
- id (str, none_type): Id to report on. [optional] # 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
255
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
256
260
  """
257
261
 
@@ -344,16 +348,16 @@ class AsyncCampaignsReport(ModelNormal):
344
348
  Animal class but this time we won't travel
345
349
  through its discriminator because we passed in
346
350
  _visited_composed_classes = (Animal,)
347
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
348
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
351
+ ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
352
+ id (str, none_type): Campaign id to report on. [optional] # noqa: E501
349
353
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
350
354
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
351
355
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
352
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
353
357
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
354
358
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
355
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
356
- id (str, none_type): Id to report on. [optional] # 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
357
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
358
362
  """
359
363
 
@@ -55,44 +55,6 @@ class AsyncLineItemsReport(ModelNormal):
55
55
  """
56
56
 
57
57
  allowed_values = {
58
- ('metrics',): {
59
- 'None': None,
60
- 'IMPRESSIONS': "impressions",
61
- 'CLICKS': "clicks",
62
- 'SPEND': "spend",
63
- 'ATTRIBUTEDSALES': "attributedSales",
64
- 'ATTRIBUTEDUNITS': "attributedUnits",
65
- 'ATTRIBUTEDORDERS': "attributedOrders",
66
- 'CTR': "ctr",
67
- 'CPC': "cpc",
68
- 'CPO': "cpo",
69
- 'ROAS': "roas",
70
- 'ASSISTEDUNITS': "assistedUnits",
71
- 'ASSISTEDSALES': "assistedSales",
72
- 'UNIQUEVISITORS': "uniqueVisitors",
73
- 'FREQUENCY': "frequency",
74
- },
75
- ('dimensions',): {
76
- 'None': None,
77
- 'DATE': "date",
78
- 'HOUR': "hour",
79
- 'CAMPAIGNID': "campaignId",
80
- 'CAMPAIGNNAME': "campaignName",
81
- 'CAMPAIGNTYPENAME': "campaignTypeName",
82
- 'ADVPRODUCTCATEGORY': "advProductCategory",
83
- 'ADVPRODUCTID': "advProductId",
84
- 'ADVPRODUCTNAME': "advProductName",
85
- 'BRANDID': "brandId",
86
- 'BRANDNAME': "brandName",
87
- 'LINEITEMID': "lineItemId",
88
- 'LINEITEMNAME': "lineItemName",
89
- 'RETAILERID': "retailerId",
90
- 'RETAILERNAME': "retailerName",
91
- 'KEYWORD': "keyword",
92
- 'PAGETYPENAME': "pageTypeName",
93
- 'SALESCHANNEL': "salesChannel",
94
- 'ENVIRONMENT': "environment",
95
- },
96
58
  ('campaign_type',): {
97
59
  'None': None,
98
60
  'SPONSOREDPRODUCTS': "sponsoredProducts",
@@ -136,6 +98,47 @@ class AsyncLineItemsReport(ModelNormal):
136
98
  '30D': "30D",
137
99
  'NONE': "none",
138
100
  },
101
+ ('dimensions',): {
102
+ 'None': None,
103
+ 'DATE': "date",
104
+ 'HOUR': "hour",
105
+ 'ACCOUNTID': "accountId",
106
+ 'ACCOUNTNAME': "accountName",
107
+ 'CAMPAIGNID': "campaignId",
108
+ 'CAMPAIGNNAME': "campaignName",
109
+ 'CAMPAIGNTYPENAME': "campaignTypeName",
110
+ 'ADVPRODUCTCATEGORY': "advProductCategory",
111
+ 'ADVPRODUCTID': "advProductId",
112
+ 'ADVPRODUCTNAME': "advProductName",
113
+ 'BRANDID': "brandId",
114
+ 'BRANDNAME': "brandName",
115
+ 'LINEITEMID': "lineItemId",
116
+ 'LINEITEMNAME': "lineItemName",
117
+ 'RETAILERID': "retailerId",
118
+ 'RETAILERNAME': "retailerName",
119
+ 'KEYWORD': "keyword",
120
+ 'PAGETYPENAME': "pageTypeName",
121
+ 'SALESCHANNEL': "salesChannel",
122
+ 'ENVIRONMENT': "environment",
123
+ },
124
+ ('metrics',): {
125
+ 'None': None,
126
+ 'IMPRESSIONS': "impressions",
127
+ 'CLICKS': "clicks",
128
+ 'SPEND': "spend",
129
+ 'ATTRIBUTEDSALES': "attributedSales",
130
+ 'ATTRIBUTEDUNITS': "attributedUnits",
131
+ 'ATTRIBUTEDORDERS': "attributedOrders",
132
+ 'ASSISTEDSALES': "assistedSales",
133
+ 'ASSISTEDUNITS': "assistedUnits",
134
+ 'CTR': "ctr",
135
+ 'CPC': "cpc",
136
+ 'CPO': "cpo",
137
+ 'CPM': "cpm",
138
+ 'ROAS': "roas",
139
+ 'UNIQUEVISITORS': "uniqueVisitors",
140
+ 'FREQUENCY': "frequency",
141
+ },
139
142
  }
140
143
 
141
144
  validations = {
@@ -164,16 +167,16 @@ class AsyncLineItemsReport(ModelNormal):
164
167
  return {
165
168
  'start_date': (datetime,), # noqa: E501
166
169
  'end_date': (datetime,), # noqa: E501
167
- 'metrics': ([str], none_type,), # noqa: E501
168
- 'dimensions': ([str], none_type,), # noqa: E501
170
+ 'ids': ([str], none_type,), # noqa: E501
171
+ 'id': (str, none_type,), # noqa: E501
169
172
  'campaign_type': (str, none_type,), # noqa: E501
170
173
  'sales_channel': (str, none_type,), # noqa: E501
171
174
  'format': (str, none_type,), # noqa: E501
172
175
  'report_type': (str, none_type,), # noqa: E501
173
176
  'click_attribution_window': (str, none_type,), # noqa: E501
174
177
  'view_attribution_window': (str, none_type,), # noqa: E501
175
- 'ids': ([str], none_type,), # noqa: E501
176
- 'id': (str, none_type,), # noqa: E501
178
+ 'dimensions': ([str], none_type,), # noqa: E501
179
+ 'metrics': ([str], none_type,), # noqa: E501
177
180
  'timezone': (str, none_type,), # noqa: E501
178
181
  }
179
182
 
@@ -185,16 +188,16 @@ class AsyncLineItemsReport(ModelNormal):
185
188
  attribute_map = {
186
189
  'start_date': 'startDate', # noqa: E501
187
190
  'end_date': 'endDate', # noqa: E501
188
- 'metrics': 'metrics', # noqa: E501
189
- 'dimensions': 'dimensions', # noqa: E501
191
+ 'ids': 'ids', # noqa: E501
192
+ 'id': 'id', # noqa: E501
190
193
  'campaign_type': 'campaignType', # noqa: E501
191
194
  'sales_channel': 'salesChannel', # noqa: E501
192
195
  'format': 'format', # noqa: E501
193
196
  'report_type': 'reportType', # noqa: E501
194
197
  'click_attribution_window': 'clickAttributionWindow', # noqa: E501
195
198
  'view_attribution_window': 'viewAttributionWindow', # noqa: E501
196
- 'ids': 'ids', # noqa: E501
197
- 'id': 'id', # noqa: E501
199
+ 'dimensions': 'dimensions', # noqa: E501
200
+ 'metrics': 'metrics', # noqa: E501
198
201
  'timezone': 'timezone', # noqa: E501
199
202
  }
200
203
 
@@ -243,16 +246,16 @@ class AsyncLineItemsReport(ModelNormal):
243
246
  Animal class but this time we won't travel
244
247
  through its discriminator because we passed in
245
248
  _visited_composed_classes = (Animal,)
246
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
247
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
249
+ ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
250
+ id (str, none_type): Line Item id to report on. [optional] # noqa: E501
248
251
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
249
252
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
250
253
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
251
254
  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
252
255
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
253
256
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
254
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
255
- id (str, none_type): Id to report on. [optional] # 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
256
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
257
260
  """
258
261
 
@@ -345,16 +348,16 @@ class AsyncLineItemsReport(ModelNormal):
345
348
  Animal class but this time we won't travel
346
349
  through its discriminator because we passed in
347
350
  _visited_composed_classes = (Animal,)
348
- metrics ([str], none_type): List of metrics to report on. [optional] # noqa: E501
349
- dimensions ([str], none_type): List of dimensions to report on. [optional] # noqa: E501
351
+ ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
352
+ id (str, none_type): Line Item id to report on. [optional] # noqa: E501
350
353
  campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] # noqa: E501
351
354
  sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] # noqa: E501
352
355
  format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
353
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
354
357
  click_attribution_window (str, none_type): Click attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
355
358
  view_attribution_window (str, none_type): View attribution window. [optional] if omitted the server will use the default value of "none" # noqa: E501
356
- ids ([str], none_type): Ids to report on. [optional] # noqa: E501
357
- id (str, none_type): Id to report on. [optional] # 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
358
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
359
362
  """
360
363
 
@@ -131,6 +131,7 @@ class CampaignAttributesV202301(ModelNormal):
131
131
  'daily_pacing': (float, none_type,), # noqa: E501
132
132
  'click_attribution_scope': (str, none_type,), # noqa: E501
133
133
  'view_attribution_scope': (str, none_type,), # noqa: E501
134
+ 'company_name': (str, none_type,), # noqa: E501
134
135
  }
135
136
 
136
137
  @cached_property
@@ -152,6 +153,7 @@ class CampaignAttributesV202301(ModelNormal):
152
153
  'daily_pacing': 'dailyPacing', # noqa: E501
153
154
  'click_attribution_scope': 'clickAttributionScope', # noqa: E501
154
155
  'view_attribution_scope': 'viewAttributionScope', # noqa: E501
156
+ 'company_name': 'companyName', # noqa: E501
155
157
  }
156
158
 
157
159
  read_only_vars = {
@@ -210,6 +212,7 @@ class CampaignAttributesV202301(ModelNormal):
210
212
  daily_pacing (float, none_type): [optional] # noqa: E501
211
213
  click_attribution_scope (str, none_type): [optional] # noqa: E501
212
214
  view_attribution_scope (str, none_type): [optional] # noqa: E501
215
+ company_name (str, none_type): [optional] # noqa: E501
213
216
  """
214
217
 
215
218
  _check_type = kwargs.pop('_check_type', True)
@@ -314,6 +317,7 @@ class CampaignAttributesV202301(ModelNormal):
314
317
  daily_pacing (float, none_type): [optional] # noqa: E501
315
318
  click_attribution_scope (str, none_type): [optional] # noqa: E501
316
319
  view_attribution_scope (str, none_type): [optional] # noqa: E501
320
+ company_name (str, none_type): [optional] # noqa: E501
317
321
  """
318
322
 
319
323
  _check_type = kwargs.pop('_check_type', True)
@@ -145,6 +145,7 @@ class CampaignV202301(ModelNormal):
145
145
  'daily_pacing': (float, none_type,), # noqa: E501
146
146
  'click_attribution_scope': (str, none_type,), # noqa: E501
147
147
  'view_attribution_scope': (str, none_type,), # noqa: E501
148
+ 'company_name': (str, none_type,), # noqa: E501
148
149
  }
149
150
 
150
151
  @cached_property
@@ -173,6 +174,7 @@ class CampaignV202301(ModelNormal):
173
174
  'daily_pacing': 'dailyPacing', # noqa: E501
174
175
  'click_attribution_scope': 'clickAttributionScope', # noqa: E501
175
176
  'view_attribution_scope': 'viewAttributionScope', # noqa: E501
177
+ 'company_name': 'companyName', # noqa: E501
176
178
  }
177
179
 
178
180
  read_only_vars = {
@@ -238,6 +240,7 @@ class CampaignV202301(ModelNormal):
238
240
  daily_pacing (float, none_type): [optional] # noqa: E501
239
241
  click_attribution_scope (str, none_type): [optional] # noqa: E501
240
242
  view_attribution_scope (str, none_type): [optional] # noqa: E501
243
+ company_name (str, none_type): [optional] # noqa: E501
241
244
  """
242
245
 
243
246
  _check_type = kwargs.pop('_check_type', True)
@@ -355,6 +358,7 @@ class CampaignV202301(ModelNormal):
355
358
  daily_pacing (float, none_type): [optional] # noqa: E501
356
359
  click_attribution_scope (str, none_type): [optional] # noqa: E501
357
360
  view_attribution_scope (str, none_type): [optional] # noqa: E501
361
+ company_name (str, none_type): [optional] # noqa: E501
358
362
  """
359
363
 
360
364
  _check_type = kwargs.pop('_check_type', True)
@@ -124,6 +124,7 @@ class EditableCampaignAttributesV202301(ModelNormal):
124
124
  'daily_pacing': (float, none_type,), # noqa: E501
125
125
  'click_attribution_scope': (str, none_type,), # noqa: E501
126
126
  'view_attribution_scope': (str, none_type,), # noqa: E501
127
+ 'company_name': (str, none_type,), # noqa: E501
127
128
  }
128
129
 
129
130
  @cached_property
@@ -143,6 +144,7 @@ class EditableCampaignAttributesV202301(ModelNormal):
143
144
  'daily_pacing': 'dailyPacing', # noqa: E501
144
145
  'click_attribution_scope': 'clickAttributionScope', # noqa: E501
145
146
  'view_attribution_scope': 'viewAttributionScope', # noqa: E501
147
+ 'company_name': 'companyName', # noqa: E501
146
148
  }
147
149
 
148
150
  read_only_vars = {
@@ -199,6 +201,7 @@ class EditableCampaignAttributesV202301(ModelNormal):
199
201
  daily_pacing (float, none_type): [optional] # noqa: E501
200
202
  click_attribution_scope (str, none_type): [optional] # noqa: E501
201
203
  view_attribution_scope (str, none_type): [optional] # noqa: E501
204
+ company_name (str, none_type): [optional] # noqa: E501
202
205
  """
203
206
 
204
207
  _check_type = kwargs.pop('_check_type', True)
@@ -303,6 +306,7 @@ class EditableCampaignAttributesV202301(ModelNormal):
303
306
  daily_pacing (float, none_type): [optional] # noqa: E501
304
307
  click_attribution_scope (str, none_type): [optional] # noqa: E501
305
308
  view_attribution_scope (str, none_type): [optional] # noqa: E501
309
+ company_name (str, none_type): [optional] # noqa: E501
306
310
  """
307
311
 
308
312
  _check_type = kwargs.pop('_check_type', True)
@@ -107,6 +107,7 @@ class ExternalAccount(ModelNormal):
107
107
  'parent_account_label': (str,), # noqa: E501
108
108
  'time_zone': (str,), # noqa: E501
109
109
  'subtype': (str, none_type,), # noqa: E501
110
+ 'company_name': (str, none_type,), # noqa: E501
110
111
  }
111
112
 
112
113
  @cached_property
@@ -122,6 +123,7 @@ class ExternalAccount(ModelNormal):
122
123
  'parent_account_label': 'parentAccountLabel', # noqa: E501
123
124
  'time_zone': 'timeZone', # noqa: E501
124
125
  'subtype': 'subtype', # noqa: E501
126
+ 'company_name': 'companyName', # noqa: E501
125
127
  }
126
128
 
127
129
  read_only_vars = {
@@ -174,6 +176,7 @@ class ExternalAccount(ModelNormal):
174
176
  through its discriminator because we passed in
175
177
  _visited_composed_classes = (Animal,)
176
178
  subtype (str, none_type): [optional] # noqa: E501
179
+ company_name (str, none_type): [optional] # noqa: E501
177
180
  """
178
181
 
179
182
  _check_type = kwargs.pop('_check_type', True)
@@ -274,6 +277,7 @@ class ExternalAccount(ModelNormal):
274
277
  through its discriminator because we passed in
275
278
  _visited_composed_classes = (Animal,)
276
279
  subtype (str, none_type): [optional] # noqa: E501
280
+ company_name (str, none_type): [optional] # noqa: E501
277
281
  """
278
282
 
279
283
  _check_type = kwargs.pop('_check_type', True)
@@ -30,7 +30,7 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
 
33
- class CreateRetailMediaAudienceAttributes(ModelNormal):
33
+ class RmLegacyAudienceCreateEntityV1(ModelNormal):
34
34
  """NOTE: This class is auto generated by OpenAPI Generator.
35
35
  Ref: https://openapi-generator.tech
36
36
 
@@ -58,6 +58,7 @@ class CreateRetailMediaAudienceAttributes(ModelNormal):
58
58
  ('user_type',): {
59
59
  'VIEWER': "viewer",
60
60
  'BUYER': "buyer",
61
+ 'ADDTOCARTER': "addToCarter",
61
62
  },
62
63
  ('lookback_window',): {
63
64
  'P7D': "P7D",
@@ -73,6 +74,10 @@ class CreateRetailMediaAudienceAttributes(ModelNormal):
73
74
  }
74
75
 
75
76
  validations = {
77
+ ('brand_ids',): {
78
+ },
79
+ ('category_ids',): {
80
+ },
76
81
  }
77
82
 
78
83
  @cached_property
@@ -126,13 +131,13 @@ class CreateRetailMediaAudienceAttributes(ModelNormal):
126
131
  @classmethod
127
132
  @convert_js_args_to_python_args
128
133
  def _from_openapi_data(cls, user_type, lookback_window, retailer_id, name, *args, **kwargs): # noqa: E501
129
- """CreateRetailMediaAudienceAttributes - a model defined in OpenAPI
134
+ """RmLegacyAudienceCreateEntityV1 - a model defined in OpenAPI
130
135
 
131
136
  Args:
132
137
  user_type (str): Type of the user
133
138
  lookback_window (str): Length of lookback window
134
139
  retailer_id (int): ID of the retailer associated with this audience
135
- name (str): Name of the audience.
140
+ name (str): Name of the audience
136
141
 
137
142
  Keyword Args:
138
143
  _check_type (bool): if True, values for parameters in openapi_types
@@ -223,13 +228,13 @@ class CreateRetailMediaAudienceAttributes(ModelNormal):
223
228
 
224
229
  @convert_js_args_to_python_args
225
230
  def __init__(self, user_type, lookback_window, retailer_id, name, *args, **kwargs): # noqa: E501
226
- """CreateRetailMediaAudienceAttributes - a model defined in OpenAPI
231
+ """RmLegacyAudienceCreateEntityV1 - a model defined in OpenAPI
227
232
 
228
233
  Args:
229
234
  user_type (str): Type of the user
230
235
  lookback_window (str): Length of lookback window
231
236
  retailer_id (int): ID of the retailer associated with this audience
232
- name (str): Name of the audience.
237
+ name (str): Name of the audience
233
238
 
234
239
  Keyword Args:
235
240
  _check_type (bool): if True, values for parameters in openapi_types
@@ -30,11 +30,11 @@ from criteo_api_retailmedia_v2023_07.exceptions import ApiAttributeError
30
30
 
31
31
 
32
32
  def lazy_import():
33
- from criteo_api_retailmedia_v2023_07.model.create_retail_media_audience_attributes import CreateRetailMediaAudienceAttributes
34
- globals()['CreateRetailMediaAudienceAttributes'] = CreateRetailMediaAudienceAttributes
33
+ from criteo_api_retailmedia_v2023_07.model.rm_legacy_audience_create_entity_v1 import RmLegacyAudienceCreateEntityV1
34
+ globals()['RmLegacyAudienceCreateEntityV1'] = RmLegacyAudienceCreateEntityV1
35
35
 
36
36
 
37
- class CreateRetailMediaAudienceBody(ModelNormal):
37
+ class RmLegacyAudienceCreateEntityV1Resource(ModelNormal):
38
38
  """NOTE: This class is auto generated by OpenAPI Generator.
39
39
  Ref: https://openapi-generator.tech
40
40
 
@@ -87,8 +87,9 @@ class CreateRetailMediaAudienceBody(ModelNormal):
87
87
  """
88
88
  lazy_import()
89
89
  return {
90
- 'type': (str,), # noqa: E501
91
- 'attributes': (CreateRetailMediaAudienceAttributes,), # noqa: E501
90
+ 'attributes': (RmLegacyAudienceCreateEntityV1,), # noqa: E501
91
+ 'id': (str, none_type,), # noqa: E501
92
+ 'type': (str, none_type,), # noqa: E501
92
93
  }
93
94
 
94
95
  @cached_property
@@ -97,8 +98,9 @@ class CreateRetailMediaAudienceBody(ModelNormal):
97
98
 
98
99
 
99
100
  attribute_map = {
100
- 'type': 'type', # noqa: E501
101
101
  'attributes': 'attributes', # noqa: E501
102
+ 'id': 'id', # noqa: E501
103
+ 'type': 'type', # noqa: E501
102
104
  }
103
105
 
104
106
  read_only_vars = {
@@ -108,12 +110,8 @@ class CreateRetailMediaAudienceBody(ModelNormal):
108
110
 
109
111
  @classmethod
110
112
  @convert_js_args_to_python_args
111
- def _from_openapi_data(cls, type, attributes, *args, **kwargs): # noqa: E501
112
- """CreateRetailMediaAudienceBody - a model defined in OpenAPI
113
-
114
- Args:
115
- type (str): the name of the entity type
116
- attributes (CreateRetailMediaAudienceAttributes):
113
+ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
114
+ """RmLegacyAudienceCreateEntityV1Resource - a model defined in OpenAPI
117
115
 
118
116
  Keyword Args:
119
117
  _check_type (bool): if True, values for parameters in openapi_types
@@ -146,6 +144,9 @@ class CreateRetailMediaAudienceBody(ModelNormal):
146
144
  Animal class but this time we won't travel
147
145
  through its discriminator because we passed in
148
146
  _visited_composed_classes = (Animal,)
147
+ attributes (RmLegacyAudienceCreateEntityV1): [optional] # noqa: E501
148
+ id (str, none_type): Id of the entity. [optional] # noqa: E501
149
+ type (str, none_type): [optional] # noqa: E501
149
150
  """
150
151
 
151
152
  _check_type = kwargs.pop('_check_type', True)
@@ -177,8 +178,6 @@ class CreateRetailMediaAudienceBody(ModelNormal):
177
178
  self._configuration = _configuration
178
179
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
179
180
 
180
- self.type = type
181
- self.attributes = attributes
182
181
  for var_name, var_value in kwargs.items():
183
182
  if var_name not in self.attribute_map and \
184
183
  self._configuration is not None and \
@@ -199,12 +198,8 @@ class CreateRetailMediaAudienceBody(ModelNormal):
199
198
  ])
200
199
 
201
200
  @convert_js_args_to_python_args
202
- def __init__(self, type, attributes, *args, **kwargs): # noqa: E501
203
- """CreateRetailMediaAudienceBody - a model defined in OpenAPI
204
-
205
- Args:
206
- type (str): the name of the entity type
207
- attributes (CreateRetailMediaAudienceAttributes):
201
+ def __init__(self, *args, **kwargs): # noqa: E501
202
+ """RmLegacyAudienceCreateEntityV1Resource - a model defined in OpenAPI
208
203
 
209
204
  Keyword Args:
210
205
  _check_type (bool): if True, values for parameters in openapi_types
@@ -237,6 +232,9 @@ class CreateRetailMediaAudienceBody(ModelNormal):
237
232
  Animal class but this time we won't travel
238
233
  through its discriminator because we passed in
239
234
  _visited_composed_classes = (Animal,)
235
+ attributes (RmLegacyAudienceCreateEntityV1): [optional] # noqa: E501
236
+ id (str, none_type): Id of the entity. [optional] # noqa: E501
237
+ type (str, none_type): [optional] # noqa: E501
240
238
  """
241
239
 
242
240
  _check_type = kwargs.pop('_check_type', True)
@@ -266,8 +264,6 @@ class CreateRetailMediaAudienceBody(ModelNormal):
266
264
  self._configuration = _configuration
267
265
  self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
268
266
 
269
- self.type = type
270
- self.attributes = attributes
271
267
  for var_name, var_value in kwargs.items():
272
268
  if var_name not in self.attribute_map and \
273
269
  self._configuration is not None and \