criteo-api-retailmedia-sdk 2023.4.0.231113__py3-none-any.whl → 2023.4.0.240207__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {criteo_api_retailmedia_sdk-2023.4.0.231113.dist-info → criteo_api_retailmedia_sdk-2023.4.0.240207.dist-info}/METADATA +3 -3
- {criteo_api_retailmedia_sdk-2023.4.0.231113.dist-info → criteo_api_retailmedia_sdk-2023.4.0.240207.dist-info}/RECORD +34 -35
- {criteo_api_retailmedia_sdk-2023.4.0.231113.dist-info → criteo_api_retailmedia_sdk-2023.4.0.240207.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_v2023_04/__init__.py +1 -1
- criteo_api_retailmedia_v2023_04/api/audience_api.py +113 -100
- criteo_api_retailmedia_v2023_04/api/campaign_api.py +4 -4
- criteo_api_retailmedia_v2023_04/api_client.py +1 -1
- criteo_api_retailmedia_v2023_04/configuration.py +1 -1
- criteo_api_retailmedia_v2023_04/model/campaign_attributes_v202301.py +4 -0
- criteo_api_retailmedia_v2023_04/model/campaign_v202301.py +4 -0
- criteo_api_retailmedia_v2023_04/model/editable_campaign_attributes_v202301.py +4 -0
- criteo_api_retailmedia_v2023_04/model/external_account.py +4 -0
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_attributes.py → rm_legacy_audience_create_entity_v1.py} +10 -5
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_body.py → rm_legacy_audience_create_entity_v1_resource.py} +18 -22
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience_v2_response.py → rm_legacy_audience_create_entity_v1_response.py} +15 -15
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_v2_attributes.py → rm_legacy_audience_create_entity_v2.py} +10 -10
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience.py → rm_legacy_audience_create_entity_v2_resource.py} +18 -28
- criteo_api_retailmedia_v2023_04/model/{common_status_code_response.py → rm_legacy_audience_create_entity_v2_response.py} +16 -10
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_v2_request.py → rm_legacy_audience_create_input_entity_v1.py} +10 -16
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_request.py → rm_legacy_audience_create_input_entity_v2.py} +10 -16
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience_v2_attributes.py → rm_legacy_audience_get_entity_v1.py} +23 -23
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_response.py → rm_legacy_audience_get_entity_v1_list_response.py} +18 -20
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience_v2.py → rm_legacy_audience_get_entity_v1_resource.py} +24 -29
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience_attributes.py → rm_legacy_audience_get_entity_v2.py} +15 -15
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience_v2_list_response.py → rm_legacy_audience_get_entity_v2_list_response.py} +17 -29
- criteo_api_retailmedia_v2023_04/model/{create_retail_media_audience_v2_data.py → rm_legacy_audience_get_entity_v2_resource.py} +18 -22
- criteo_api_retailmedia_v2023_04/model/rm_legacy_audience_user_behavior_create_v2.py +279 -0
- criteo_api_retailmedia_v2023_04/model/{user_behavior_details_v2.py → rm_legacy_audience_user_behavior_details_v2.py} +11 -11
- criteo_api_retailmedia_v2023_04/model/{customer_list_details.py → rm_legacy_segment_customer_list.py} +11 -5
- criteo_api_retailmedia_v2023_04/model/{retail_media_audience.py → rm_legacy_segment_user_behavior_create_v2.py} +44 -38
- criteo_api_retailmedia_v2023_04/model/{user_behavior_details.py → rm_legacy_segment_user_behavior_v1.py} +28 -28
- criteo_api_retailmedia_v2023_04/model/{create_user_behavior_segment_v2.py → rm_legacy_segment_user_behavior_v2.py} +7 -5
- criteo_api_retailmedia_v2023_04/models/__init__.py +20 -21
- criteo_api_retailmedia_v2023_04/model/create_retail_media_audience_v2.py +0 -287
- criteo_api_retailmedia_v2023_04/model/get_page_of_audiences_by_account_id_response.py +0 -295
- {criteo_api_retailmedia_sdk-2023.4.0.231113.dist-info → criteo_api_retailmedia_sdk-2023.4.0.240207.dist-info}/top_level.txt +0 -0
|
@@ -21,13 +21,12 @@ from criteo_api_retailmedia_v2023_04.model_utils import ( # noqa: F401
|
|
|
21
21
|
none_type,
|
|
22
22
|
validate_and_convert_types
|
|
23
23
|
)
|
|
24
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
25
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
26
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
27
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
28
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
29
|
-
from criteo_api_retailmedia_v2023_04.model.
|
|
30
|
-
from criteo_api_retailmedia_v2023_04.model.retail_media_audience_v2_response import RetailMediaAudienceV2Response
|
|
24
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v1_response import RmLegacyAudienceCreateEntityV1Response
|
|
25
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_entity_v2_response import RmLegacyAudienceCreateEntityV2Response
|
|
26
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_input_entity_v1 import RmLegacyAudienceCreateInputEntityV1
|
|
27
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_create_input_entity_v2 import RmLegacyAudienceCreateInputEntityV2
|
|
28
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_get_entity_v1_list_response import RmLegacyAudienceGetEntityV1ListResponse
|
|
29
|
+
from criteo_api_retailmedia_v2023_04.model.rm_legacy_audience_get_entity_v2_list_response import RmLegacyAudienceGetEntityV2ListResponse
|
|
31
30
|
|
|
32
31
|
|
|
33
32
|
class AudienceApi(object):
|
|
@@ -41,26 +40,26 @@ class AudienceApi(object):
|
|
|
41
40
|
if api_client is None:
|
|
42
41
|
api_client = ApiClient()
|
|
43
42
|
self.api_client = api_client
|
|
44
|
-
self.
|
|
43
|
+
self.legacy_create_audience_v1_endpoint = _Endpoint(
|
|
45
44
|
settings={
|
|
46
|
-
'response_type': (
|
|
45
|
+
'response_type': (RmLegacyAudienceCreateEntityV1Response,),
|
|
47
46
|
'auth': [
|
|
48
47
|
'oauth',
|
|
49
48
|
'oauth'
|
|
50
49
|
],
|
|
51
50
|
'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
|
|
52
|
-
'operation_id': '
|
|
51
|
+
'operation_id': 'legacy_create_audience_v1',
|
|
53
52
|
'http_method': 'POST',
|
|
54
53
|
'servers': None,
|
|
55
54
|
},
|
|
56
55
|
params_map={
|
|
57
56
|
'all': [
|
|
58
57
|
'account_id',
|
|
59
|
-
'
|
|
58
|
+
'rm_legacy_audience_create_input_entity_v1',
|
|
60
59
|
],
|
|
61
60
|
'required': [
|
|
62
61
|
'account_id',
|
|
63
|
-
'
|
|
62
|
+
'rm_legacy_audience_create_input_entity_v1',
|
|
64
63
|
],
|
|
65
64
|
'nullable': [
|
|
66
65
|
],
|
|
@@ -77,49 +76,55 @@ class AudienceApi(object):
|
|
|
77
76
|
'openapi_types': {
|
|
78
77
|
'account_id':
|
|
79
78
|
(int,),
|
|
80
|
-
'
|
|
81
|
-
(
|
|
79
|
+
'rm_legacy_audience_create_input_entity_v1':
|
|
80
|
+
(RmLegacyAudienceCreateInputEntityV1,),
|
|
82
81
|
},
|
|
83
82
|
'attribute_map': {
|
|
84
83
|
'account_id': 'accountId',
|
|
85
84
|
},
|
|
86
85
|
'location_map': {
|
|
87
86
|
'account_id': 'path',
|
|
88
|
-
'
|
|
87
|
+
'rm_legacy_audience_create_input_entity_v1': 'body',
|
|
89
88
|
},
|
|
90
89
|
'collection_format_map': {
|
|
91
90
|
}
|
|
92
91
|
},
|
|
93
92
|
headers_map={
|
|
94
93
|
'accept': [
|
|
95
|
-
'
|
|
94
|
+
'text/plain',
|
|
95
|
+
'application/json',
|
|
96
|
+
'text/json'
|
|
96
97
|
],
|
|
97
98
|
'content_type': [
|
|
98
|
-
'application/json'
|
|
99
|
+
'application/json-patch+json',
|
|
100
|
+
'application/json',
|
|
101
|
+
'text/json',
|
|
102
|
+
'application/*+json'
|
|
99
103
|
]
|
|
100
104
|
},
|
|
101
105
|
api_client=api_client
|
|
102
106
|
)
|
|
103
|
-
self.
|
|
107
|
+
self.legacy_get_audience_v1_endpoint = _Endpoint(
|
|
104
108
|
settings={
|
|
105
|
-
'response_type': (
|
|
109
|
+
'response_type': (RmLegacyAudienceGetEntityV1ListResponse,),
|
|
106
110
|
'auth': [
|
|
107
111
|
'oauth',
|
|
108
112
|
'oauth'
|
|
109
113
|
],
|
|
110
|
-
'endpoint_path': '/2023-04/retail-media/
|
|
111
|
-
'operation_id': '
|
|
112
|
-
'http_method': '
|
|
114
|
+
'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
|
|
115
|
+
'operation_id': 'legacy_get_audience_v1',
|
|
116
|
+
'http_method': 'GET',
|
|
113
117
|
'servers': None,
|
|
114
118
|
},
|
|
115
119
|
params_map={
|
|
116
120
|
'all': [
|
|
117
121
|
'account_id',
|
|
118
|
-
'
|
|
122
|
+
'limit_to_id',
|
|
123
|
+
'page_size',
|
|
124
|
+
'page_index',
|
|
119
125
|
],
|
|
120
126
|
'required': [
|
|
121
127
|
'account_id',
|
|
122
|
-
'create_retail_media_audience_v2_request',
|
|
123
128
|
],
|
|
124
129
|
'nullable': [
|
|
125
130
|
],
|
|
@@ -136,38 +141,48 @@ class AudienceApi(object):
|
|
|
136
141
|
'openapi_types': {
|
|
137
142
|
'account_id':
|
|
138
143
|
(int,),
|
|
139
|
-
'
|
|
140
|
-
(
|
|
144
|
+
'limit_to_id':
|
|
145
|
+
([int],),
|
|
146
|
+
'page_size':
|
|
147
|
+
(int,),
|
|
148
|
+
'page_index':
|
|
149
|
+
(int,),
|
|
141
150
|
},
|
|
142
151
|
'attribute_map': {
|
|
143
152
|
'account_id': 'accountId',
|
|
153
|
+
'limit_to_id': 'limitToId',
|
|
154
|
+
'page_size': 'pageSize',
|
|
155
|
+
'page_index': 'pageIndex',
|
|
144
156
|
},
|
|
145
157
|
'location_map': {
|
|
146
158
|
'account_id': 'path',
|
|
147
|
-
'
|
|
159
|
+
'limit_to_id': 'query',
|
|
160
|
+
'page_size': 'query',
|
|
161
|
+
'page_index': 'query',
|
|
148
162
|
},
|
|
149
163
|
'collection_format_map': {
|
|
164
|
+
'limit_to_id': 'multi',
|
|
150
165
|
}
|
|
151
166
|
},
|
|
152
167
|
headers_map={
|
|
153
168
|
'accept': [
|
|
154
|
-
'
|
|
169
|
+
'text/plain',
|
|
170
|
+
'application/json',
|
|
171
|
+
'text/json'
|
|
155
172
|
],
|
|
156
|
-
'content_type': [
|
|
157
|
-
'application/json'
|
|
158
|
-
]
|
|
173
|
+
'content_type': [],
|
|
159
174
|
},
|
|
160
175
|
api_client=api_client
|
|
161
176
|
)
|
|
162
|
-
self.
|
|
177
|
+
self.legacy_get_audience_v2_endpoint = _Endpoint(
|
|
163
178
|
settings={
|
|
164
|
-
'response_type': (
|
|
179
|
+
'response_type': (RmLegacyAudienceGetEntityV2ListResponse,),
|
|
165
180
|
'auth': [
|
|
166
181
|
'oauth',
|
|
167
182
|
'oauth'
|
|
168
183
|
],
|
|
169
|
-
'endpoint_path': '/2023-04/retail-media/accounts/{accountId}/audiences',
|
|
170
|
-
'operation_id': '
|
|
184
|
+
'endpoint_path': '/2023-04/retail-media/v2/accounts/{accountId}/audiences',
|
|
185
|
+
'operation_id': 'legacy_get_audience_v2',
|
|
171
186
|
'http_method': 'GET',
|
|
172
187
|
'servers': None,
|
|
173
188
|
},
|
|
@@ -195,9 +210,9 @@ class AudienceApi(object):
|
|
|
195
210
|
},
|
|
196
211
|
'openapi_types': {
|
|
197
212
|
'account_id':
|
|
198
|
-
(
|
|
213
|
+
(int,),
|
|
199
214
|
'limit_to_id':
|
|
200
|
-
([
|
|
215
|
+
([int],),
|
|
201
216
|
'page_size':
|
|
202
217
|
(int,),
|
|
203
218
|
'page_index':
|
|
@@ -221,33 +236,34 @@ class AudienceApi(object):
|
|
|
221
236
|
},
|
|
222
237
|
headers_map={
|
|
223
238
|
'accept': [
|
|
224
|
-
'
|
|
239
|
+
'text/plain',
|
|
240
|
+
'application/json',
|
|
241
|
+
'text/json'
|
|
225
242
|
],
|
|
226
243
|
'content_type': [],
|
|
227
244
|
},
|
|
228
245
|
api_client=api_client
|
|
229
246
|
)
|
|
230
|
-
self.
|
|
247
|
+
self.legacy_update_audience_v2_endpoint = _Endpoint(
|
|
231
248
|
settings={
|
|
232
|
-
'response_type': (
|
|
249
|
+
'response_type': (RmLegacyAudienceCreateEntityV2Response,),
|
|
233
250
|
'auth': [
|
|
234
251
|
'oauth',
|
|
235
252
|
'oauth'
|
|
236
253
|
],
|
|
237
254
|
'endpoint_path': '/2023-04/retail-media/v2/accounts/{accountId}/audiences',
|
|
238
|
-
'operation_id': '
|
|
239
|
-
'http_method': '
|
|
255
|
+
'operation_id': 'legacy_update_audience_v2',
|
|
256
|
+
'http_method': 'POST',
|
|
240
257
|
'servers': None,
|
|
241
258
|
},
|
|
242
259
|
params_map={
|
|
243
260
|
'all': [
|
|
244
261
|
'account_id',
|
|
245
|
-
'
|
|
246
|
-
'page_size',
|
|
247
|
-
'page_index',
|
|
262
|
+
'rm_legacy_audience_create_input_entity_v2',
|
|
248
263
|
],
|
|
249
264
|
'required': [
|
|
250
265
|
'account_id',
|
|
266
|
+
'rm_legacy_audience_create_input_entity_v2',
|
|
251
267
|
],
|
|
252
268
|
'nullable': [
|
|
253
269
|
],
|
|
@@ -264,56 +280,53 @@ class AudienceApi(object):
|
|
|
264
280
|
'openapi_types': {
|
|
265
281
|
'account_id':
|
|
266
282
|
(int,),
|
|
267
|
-
'
|
|
268
|
-
(
|
|
269
|
-
'page_size':
|
|
270
|
-
(int,),
|
|
271
|
-
'page_index':
|
|
272
|
-
(int,),
|
|
283
|
+
'rm_legacy_audience_create_input_entity_v2':
|
|
284
|
+
(RmLegacyAudienceCreateInputEntityV2,),
|
|
273
285
|
},
|
|
274
286
|
'attribute_map': {
|
|
275
287
|
'account_id': 'accountId',
|
|
276
|
-
'limit_to_id': 'limitToId',
|
|
277
|
-
'page_size': 'pageSize',
|
|
278
|
-
'page_index': 'pageIndex',
|
|
279
288
|
},
|
|
280
289
|
'location_map': {
|
|
281
290
|
'account_id': 'path',
|
|
282
|
-
'
|
|
283
|
-
'page_size': 'query',
|
|
284
|
-
'page_index': 'query',
|
|
291
|
+
'rm_legacy_audience_create_input_entity_v2': 'body',
|
|
285
292
|
},
|
|
286
293
|
'collection_format_map': {
|
|
287
|
-
'limit_to_id': 'multi',
|
|
288
294
|
}
|
|
289
295
|
},
|
|
290
296
|
headers_map={
|
|
291
297
|
'accept': [
|
|
292
|
-
'
|
|
298
|
+
'text/plain',
|
|
299
|
+
'application/json',
|
|
300
|
+
'text/json'
|
|
293
301
|
],
|
|
294
|
-
'content_type': [
|
|
302
|
+
'content_type': [
|
|
303
|
+
'application/json-patch+json',
|
|
304
|
+
'application/json',
|
|
305
|
+
'text/json',
|
|
306
|
+
'application/*+json'
|
|
307
|
+
]
|
|
295
308
|
},
|
|
296
309
|
api_client=api_client
|
|
297
310
|
)
|
|
298
311
|
|
|
299
|
-
def
|
|
312
|
+
def legacy_create_audience_v1(
|
|
300
313
|
self,
|
|
301
314
|
account_id,
|
|
302
|
-
|
|
315
|
+
rm_legacy_audience_create_input_entity_v1,
|
|
303
316
|
**kwargs
|
|
304
317
|
):
|
|
305
|
-
"""
|
|
318
|
+
"""legacy_create_audience_v1 # noqa: E501
|
|
306
319
|
|
|
307
|
-
Create an
|
|
320
|
+
Create an Audience (deprecated Public API) # noqa: E501
|
|
308
321
|
This method makes a synchronous HTTP request by default. To make an
|
|
309
322
|
asynchronous HTTP request, please pass async_req=True
|
|
310
323
|
|
|
311
|
-
>>> thread = api.
|
|
324
|
+
>>> thread = api.legacy_create_audience_v1(account_id, rm_legacy_audience_create_input_entity_v1, async_req=True)
|
|
312
325
|
>>> result = thread.get()
|
|
313
326
|
|
|
314
327
|
Args:
|
|
315
328
|
account_id (int): ID of the account to which this audience belongs.
|
|
316
|
-
|
|
329
|
+
rm_legacy_audience_create_input_entity_v1 (RmLegacyAudienceCreateInputEntityV1): Audience creation request.
|
|
317
330
|
|
|
318
331
|
Keyword Args:
|
|
319
332
|
_return_http_data_only (bool): response data without head status
|
|
@@ -348,7 +361,7 @@ class AudienceApi(object):
|
|
|
348
361
|
async_req (bool): execute request asynchronously
|
|
349
362
|
|
|
350
363
|
Returns:
|
|
351
|
-
|
|
364
|
+
RmLegacyAudienceCreateEntityV1Response
|
|
352
365
|
If the method is called asynchronously, returns the request
|
|
353
366
|
thread.
|
|
354
367
|
"""
|
|
@@ -379,30 +392,31 @@ class AudienceApi(object):
|
|
|
379
392
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
380
393
|
kwargs['account_id'] = \
|
|
381
394
|
account_id
|
|
382
|
-
kwargs['
|
|
383
|
-
|
|
384
|
-
return self.
|
|
395
|
+
kwargs['rm_legacy_audience_create_input_entity_v1'] = \
|
|
396
|
+
rm_legacy_audience_create_input_entity_v1
|
|
397
|
+
return self.legacy_create_audience_v1_endpoint.call_with_http_info(**kwargs)
|
|
385
398
|
|
|
386
|
-
def
|
|
399
|
+
def legacy_get_audience_v1(
|
|
387
400
|
self,
|
|
388
401
|
account_id,
|
|
389
|
-
create_retail_media_audience_v2_request,
|
|
390
402
|
**kwargs
|
|
391
403
|
):
|
|
392
|
-
"""
|
|
404
|
+
"""legacy_get_audience_v1 # noqa: E501
|
|
393
405
|
|
|
394
|
-
|
|
406
|
+
Get a page of Audiences. (deprecated Public API) # noqa: E501
|
|
395
407
|
This method makes a synchronous HTTP request by default. To make an
|
|
396
408
|
asynchronous HTTP request, please pass async_req=True
|
|
397
409
|
|
|
398
|
-
>>> thread = api.
|
|
410
|
+
>>> thread = api.legacy_get_audience_v1(account_id, async_req=True)
|
|
399
411
|
>>> result = thread.get()
|
|
400
412
|
|
|
401
413
|
Args:
|
|
402
414
|
account_id (int): ID of the account to which this audience belongs.
|
|
403
|
-
create_retail_media_audience_v2_request (CreateRetailMediaAudienceV2Request):
|
|
404
415
|
|
|
405
416
|
Keyword Args:
|
|
417
|
+
limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
|
|
418
|
+
page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
|
|
419
|
+
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
|
|
406
420
|
_return_http_data_only (bool): response data without head status
|
|
407
421
|
code and headers. Default is True.
|
|
408
422
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -435,7 +449,7 @@ class AudienceApi(object):
|
|
|
435
449
|
async_req (bool): execute request asynchronously
|
|
436
450
|
|
|
437
451
|
Returns:
|
|
438
|
-
|
|
452
|
+
RmLegacyAudienceGetEntityV1ListResponse
|
|
439
453
|
If the method is called asynchronously, returns the request
|
|
440
454
|
thread.
|
|
441
455
|
"""
|
|
@@ -466,31 +480,29 @@ class AudienceApi(object):
|
|
|
466
480
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
467
481
|
kwargs['account_id'] = \
|
|
468
482
|
account_id
|
|
469
|
-
kwargs
|
|
470
|
-
create_retail_media_audience_v2_request
|
|
471
|
-
return self.create_retail_media_audience_v2_endpoint.call_with_http_info(**kwargs)
|
|
483
|
+
return self.legacy_get_audience_v1_endpoint.call_with_http_info(**kwargs)
|
|
472
484
|
|
|
473
|
-
def
|
|
485
|
+
def legacy_get_audience_v2(
|
|
474
486
|
self,
|
|
475
487
|
account_id,
|
|
476
488
|
**kwargs
|
|
477
489
|
):
|
|
478
|
-
"""
|
|
490
|
+
"""legacy_get_audience_v2 # noqa: E501
|
|
479
491
|
|
|
480
|
-
Get a page of
|
|
492
|
+
Get a page of Audiences. (deprecated Public API) # noqa: E501
|
|
481
493
|
This method makes a synchronous HTTP request by default. To make an
|
|
482
494
|
asynchronous HTTP request, please pass async_req=True
|
|
483
495
|
|
|
484
|
-
>>> thread = api.
|
|
496
|
+
>>> thread = api.legacy_get_audience_v2(account_id, async_req=True)
|
|
485
497
|
>>> result = thread.get()
|
|
486
498
|
|
|
487
499
|
Args:
|
|
488
|
-
account_id (
|
|
500
|
+
account_id (int): ID of the account to which this audience belongs.
|
|
489
501
|
|
|
490
502
|
Keyword Args:
|
|
491
|
-
limit_to_id ([
|
|
492
|
-
page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page
|
|
493
|
-
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed
|
|
503
|
+
limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
|
|
504
|
+
page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page.. [optional]
|
|
505
|
+
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed.. [optional]
|
|
494
506
|
_return_http_data_only (bool): response data without head status
|
|
495
507
|
code and headers. Default is True.
|
|
496
508
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -523,7 +535,7 @@ class AudienceApi(object):
|
|
|
523
535
|
async_req (bool): execute request asynchronously
|
|
524
536
|
|
|
525
537
|
Returns:
|
|
526
|
-
|
|
538
|
+
RmLegacyAudienceGetEntityV2ListResponse
|
|
527
539
|
If the method is called asynchronously, returns the request
|
|
528
540
|
thread.
|
|
529
541
|
"""
|
|
@@ -554,29 +566,28 @@ class AudienceApi(object):
|
|
|
554
566
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
555
567
|
kwargs['account_id'] = \
|
|
556
568
|
account_id
|
|
557
|
-
return self.
|
|
569
|
+
return self.legacy_get_audience_v2_endpoint.call_with_http_info(**kwargs)
|
|
558
570
|
|
|
559
|
-
def
|
|
571
|
+
def legacy_update_audience_v2(
|
|
560
572
|
self,
|
|
561
573
|
account_id,
|
|
574
|
+
rm_legacy_audience_create_input_entity_v2,
|
|
562
575
|
**kwargs
|
|
563
576
|
):
|
|
564
|
-
"""
|
|
577
|
+
"""legacy_update_audience_v2 # noqa: E501
|
|
565
578
|
|
|
566
|
-
|
|
579
|
+
Create an Audience (deprecated Public API) # noqa: E501
|
|
567
580
|
This method makes a synchronous HTTP request by default. To make an
|
|
568
581
|
asynchronous HTTP request, please pass async_req=True
|
|
569
582
|
|
|
570
|
-
>>> thread = api.
|
|
583
|
+
>>> thread = api.legacy_update_audience_v2(account_id, rm_legacy_audience_create_input_entity_v2, async_req=True)
|
|
571
584
|
>>> result = thread.get()
|
|
572
585
|
|
|
573
586
|
Args:
|
|
574
|
-
account_id (int):
|
|
587
|
+
account_id (int): ID of the account to which this audience belongs.
|
|
588
|
+
rm_legacy_audience_create_input_entity_v2 (RmLegacyAudienceCreateInputEntityV2): Audience creation request.
|
|
575
589
|
|
|
576
590
|
Keyword Args:
|
|
577
|
-
limit_to_id ([int]): Limits results to the entity IDs specified; parameter key is repeated, eg. limitToId=1&limitToId=2. [optional]
|
|
578
|
-
page_size (int): Specifies the maximum number of entities returned in a single page; defaults to 25 entities per page. [optional]
|
|
579
|
-
page_index (int): Returns the specified page of results given a pageSize; pages are 0-indexed. [optional]
|
|
580
591
|
_return_http_data_only (bool): response data without head status
|
|
581
592
|
code and headers. Default is True.
|
|
582
593
|
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
@@ -609,7 +620,7 @@ class AudienceApi(object):
|
|
|
609
620
|
async_req (bool): execute request asynchronously
|
|
610
621
|
|
|
611
622
|
Returns:
|
|
612
|
-
|
|
623
|
+
RmLegacyAudienceCreateEntityV2Response
|
|
613
624
|
If the method is called asynchronously, returns the request
|
|
614
625
|
thread.
|
|
615
626
|
"""
|
|
@@ -640,5 +651,7 @@ class AudienceApi(object):
|
|
|
640
651
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
641
652
|
kwargs['account_id'] = \
|
|
642
653
|
account_id
|
|
643
|
-
|
|
654
|
+
kwargs['rm_legacy_audience_create_input_entity_v2'] = \
|
|
655
|
+
rm_legacy_audience_create_input_entity_v2
|
|
656
|
+
return self.legacy_update_audience_v2_endpoint.call_with_http_info(**kwargs)
|
|
644
657
|
|
|
@@ -1252,7 +1252,7 @@ class CampaignApi(object):
|
|
|
1252
1252
|
'oauth',
|
|
1253
1253
|
'oauth'
|
|
1254
1254
|
],
|
|
1255
|
-
'endpoint_path': '/2023-04/retail-media/accounts/{
|
|
1255
|
+
'endpoint_path': '/2023-04/retail-media/accounts/{account-id}/campaigns',
|
|
1256
1256
|
'operation_id': 'get_api202301_external_account_campaigns_by_account_id',
|
|
1257
1257
|
'http_method': 'GET',
|
|
1258
1258
|
'servers': None,
|
|
@@ -1290,7 +1290,7 @@ class CampaignApi(object):
|
|
|
1290
1290
|
(int,),
|
|
1291
1291
|
},
|
|
1292
1292
|
'attribute_map': {
|
|
1293
|
-
'account_id': '
|
|
1293
|
+
'account_id': 'account-id',
|
|
1294
1294
|
'limit_to_id': 'limitToId',
|
|
1295
1295
|
'page_index': 'pageIndex',
|
|
1296
1296
|
'page_size': 'pageSize',
|
|
@@ -2968,7 +2968,7 @@ class CampaignApi(object):
|
|
|
2968
2968
|
'oauth',
|
|
2969
2969
|
'oauth'
|
|
2970
2970
|
],
|
|
2971
|
-
'endpoint_path': '/2023-04/retail-media/accounts/{
|
|
2971
|
+
'endpoint_path': '/2023-04/retail-media/accounts/{account-id}/campaigns',
|
|
2972
2972
|
'operation_id': 'post_api202301_external_account_campaigns_by_account_id',
|
|
2973
2973
|
'http_method': 'POST',
|
|
2974
2974
|
'servers': None,
|
|
@@ -3000,7 +3000,7 @@ class CampaignApi(object):
|
|
|
3000
3000
|
(PostCampaignV202301,),
|
|
3001
3001
|
},
|
|
3002
3002
|
'attribute_map': {
|
|
3003
|
-
'account_id': '
|
|
3003
|
+
'account_id': 'account-id',
|
|
3004
3004
|
},
|
|
3005
3005
|
'location_map': {
|
|
3006
3006
|
'account_id': 'path',
|
|
@@ -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/2023.04.0.
|
|
79
|
+
self.user_agent = 'OpenAPI-Generator/2023.04.0.240207/python'
|
|
80
80
|
|
|
81
81
|
def __enter__(self):
|
|
82
82
|
return self
|
|
@@ -395,7 +395,7 @@ class Configuration(object):
|
|
|
395
395
|
"OS: {env}\n"\
|
|
396
396
|
"Python Version: {pyversion}\n"\
|
|
397
397
|
"Version of the API: 2023-04\n"\
|
|
398
|
-
"SDK Package Version: 2023.04.0.
|
|
398
|
+
"SDK Package Version: 2023.04.0.240207".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -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)
|