criteo-api-marketingsolutions-sdk 0.0.250911__py3-none-any.whl → 0.0.251009__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-marketingsolutions-sdk might be problematic. Click here for more details.
- criteo_api_marketingsolutions_preview/__init__.py +1 -1
- criteo_api_marketingsolutions_preview/api/advertiser_api.py +15 -21
- criteo_api_marketingsolutions_preview/api/analytics_api.py +16 -62
- criteo_api_marketingsolutions_preview/api/audience_api.py +27 -94
- criteo_api_marketingsolutions_preview/api/campaign_api.py +263 -415
- criteo_api_marketingsolutions_preview/api/catalog_api.py +0 -1
- criteo_api_marketingsolutions_preview/api/creative_api.py +22 -63
- criteo_api_marketingsolutions_preview/api/on_site_recommendation_api.py +7 -10
- criteo_api_marketingsolutions_preview/api/reco_api.py +10 -32
- criteo_api_marketingsolutions_preview/api_client.py +4 -4
- criteo_api_marketingsolutions_preview/configuration.py +1 -1
- criteo_api_marketingsolutions_preview/model/adaptive_attributes.py +12 -12
- criteo_api_marketingsolutions_preview/model/adaptive_colors.py +1 -1
- criteo_api_marketingsolutions_preview/model/{error_description.py → adaptive_read_attributes.py} +76 -25
- criteo_api_marketingsolutions_preview/model/{error_code_response.py → creative_read.py} +66 -20
- criteo_api_marketingsolutions_preview/model/generate_categories_report_request_attributes.py +12 -8
- criteo_api_marketingsolutions_preview/model/json_report_rows.py +3 -3
- criteo_api_marketingsolutions_preview/model/outcome.py +16 -5
- criteo_api_marketingsolutions_preview/model/placements_report_query_message.py +12 -8
- criteo_api_marketingsolutions_preview/model/{resource_collection_outcome_of_creative.py → resource_collection_outcome_of_creative_read.py} +8 -8
- criteo_api_marketingsolutions_preview/model/{api_error_response.py → resource_of_creative_read.py} +17 -11
- criteo_api_marketingsolutions_preview/model/statistics_report_query_message.py +248 -8
- criteo_api_marketingsolutions_preview/model/transactions_report_query_message.py +12 -8
- criteo_api_marketingsolutions_preview/models/__init__.py +4 -5
- {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/METADATA +3 -3
- {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/RECORD +28 -29
- criteo_api_marketingsolutions_preview/model/fail_response.py +0 -283
- {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/WHEEL +0 -0
- {criteo_api_marketingsolutions_sdk-0.0.250911.dist-info → criteo_api_marketingsolutions_sdk-0.0.251009.dist-info}/top_level.txt +0 -0
|
@@ -22,7 +22,6 @@ from criteo_api_marketingsolutions_preview.model_utils import ( # noqa: F401
|
|
|
22
22
|
validate_and_convert_types
|
|
23
23
|
)
|
|
24
24
|
from criteo_api_marketingsolutions_preview.model.batch_accepted_response import BatchAcceptedResponse
|
|
25
|
-
from criteo_api_marketingsolutions_preview.model.fail_response import FailResponse
|
|
26
25
|
from criteo_api_marketingsolutions_preview.model.products_custom_batch_request import ProductsCustomBatchRequest
|
|
27
26
|
from criteo_api_marketingsolutions_preview.model.report_ok_response import ReportOkResponse
|
|
28
27
|
from criteo_api_marketingsolutions_preview.model.statistics_ok_response import StatisticsOkResponse
|
|
@@ -23,7 +23,7 @@ from criteo_api_marketingsolutions_preview.model_utils import ( # noqa: F401
|
|
|
23
23
|
)
|
|
24
24
|
from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_ad import ResourceCollectionOutcomeOfAd
|
|
25
25
|
from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_coupon import ResourceCollectionOutcomeOfCoupon
|
|
26
|
-
from criteo_api_marketingsolutions_preview.model.
|
|
26
|
+
from criteo_api_marketingsolutions_preview.model.resource_collection_outcome_of_creative_read import ResourceCollectionOutcomeOfCreativeRead
|
|
27
27
|
from criteo_api_marketingsolutions_preview.model.resource_input_of_ad_write import ResourceInputOfAdWrite
|
|
28
28
|
from criteo_api_marketingsolutions_preview.model.resource_input_of_create_coupon import ResourceInputOfCreateCoupon
|
|
29
29
|
from criteo_api_marketingsolutions_preview.model.resource_input_of_creative_write import ResourceInputOfCreativeWrite
|
|
@@ -96,15 +96,10 @@ class CreativeApi(object):
|
|
|
96
96
|
},
|
|
97
97
|
headers_map={
|
|
98
98
|
'accept': [
|
|
99
|
-
'
|
|
100
|
-
'application/json',
|
|
101
|
-
'text/json'
|
|
99
|
+
'application/json'
|
|
102
100
|
],
|
|
103
101
|
'content_type': [
|
|
104
|
-
'application/json
|
|
105
|
-
'application/json',
|
|
106
|
-
'text/json',
|
|
107
|
-
'application/*+json'
|
|
102
|
+
'application/json'
|
|
108
103
|
]
|
|
109
104
|
},
|
|
110
105
|
api_client=api_client
|
|
@@ -160,15 +155,10 @@ class CreativeApi(object):
|
|
|
160
155
|
},
|
|
161
156
|
headers_map={
|
|
162
157
|
'accept': [
|
|
163
|
-
'
|
|
164
|
-
'application/json',
|
|
165
|
-
'text/json'
|
|
158
|
+
'application/json'
|
|
166
159
|
],
|
|
167
160
|
'content_type': [
|
|
168
|
-
'application/json
|
|
169
|
-
'application/json',
|
|
170
|
-
'text/json',
|
|
171
|
-
'application/*+json'
|
|
161
|
+
'application/json'
|
|
172
162
|
]
|
|
173
163
|
},
|
|
174
164
|
api_client=api_client
|
|
@@ -224,15 +214,10 @@ class CreativeApi(object):
|
|
|
224
214
|
},
|
|
225
215
|
headers_map={
|
|
226
216
|
'accept': [
|
|
227
|
-
'
|
|
228
|
-
'application/json',
|
|
229
|
-
'text/json'
|
|
217
|
+
'application/json'
|
|
230
218
|
],
|
|
231
219
|
'content_type': [
|
|
232
|
-
'application/json
|
|
233
|
-
'application/json',
|
|
234
|
-
'text/json',
|
|
235
|
-
'application/*+json'
|
|
220
|
+
'application/json'
|
|
236
221
|
]
|
|
237
222
|
},
|
|
238
223
|
api_client=api_client
|
|
@@ -450,15 +435,10 @@ class CreativeApi(object):
|
|
|
450
435
|
},
|
|
451
436
|
headers_map={
|
|
452
437
|
'accept': [
|
|
453
|
-
'
|
|
454
|
-
'application/json',
|
|
455
|
-
'text/json'
|
|
438
|
+
'application/json'
|
|
456
439
|
],
|
|
457
440
|
'content_type': [
|
|
458
|
-
'application/json
|
|
459
|
-
'application/json',
|
|
460
|
-
'text/json',
|
|
461
|
-
'application/*+json'
|
|
441
|
+
'application/json'
|
|
462
442
|
]
|
|
463
443
|
},
|
|
464
444
|
api_client=api_client
|
|
@@ -514,15 +494,10 @@ class CreativeApi(object):
|
|
|
514
494
|
},
|
|
515
495
|
headers_map={
|
|
516
496
|
'accept': [
|
|
517
|
-
'
|
|
518
|
-
'application/json',
|
|
519
|
-
'text/json'
|
|
497
|
+
'application/json'
|
|
520
498
|
],
|
|
521
499
|
'content_type': [
|
|
522
|
-
'application/json
|
|
523
|
-
'application/json',
|
|
524
|
-
'text/json',
|
|
525
|
-
'application/*+json'
|
|
500
|
+
'application/json'
|
|
526
501
|
]
|
|
527
502
|
},
|
|
528
503
|
api_client=api_client
|
|
@@ -584,8 +559,7 @@ class CreativeApi(object):
|
|
|
584
559
|
headers_map={
|
|
585
560
|
'accept': [
|
|
586
561
|
'text/html',
|
|
587
|
-
'application/json'
|
|
588
|
-
'text/json'
|
|
562
|
+
'application/json'
|
|
589
563
|
],
|
|
590
564
|
'content_type': [],
|
|
591
565
|
},
|
|
@@ -637,9 +611,7 @@ class CreativeApi(object):
|
|
|
637
611
|
},
|
|
638
612
|
headers_map={
|
|
639
613
|
'accept': [
|
|
640
|
-
'
|
|
641
|
-
'application/json',
|
|
642
|
-
'text/json'
|
|
614
|
+
'application/json'
|
|
643
615
|
],
|
|
644
616
|
'content_type': [],
|
|
645
617
|
},
|
|
@@ -703,9 +675,7 @@ class CreativeApi(object):
|
|
|
703
675
|
},
|
|
704
676
|
headers_map={
|
|
705
677
|
'accept': [
|
|
706
|
-
'
|
|
707
|
-
'application/json',
|
|
708
|
-
'text/json'
|
|
678
|
+
'application/json'
|
|
709
679
|
],
|
|
710
680
|
'content_type': [],
|
|
711
681
|
},
|
|
@@ -763,9 +733,7 @@ class CreativeApi(object):
|
|
|
763
733
|
},
|
|
764
734
|
headers_map={
|
|
765
735
|
'accept': [
|
|
766
|
-
'
|
|
767
|
-
'application/json',
|
|
768
|
-
'text/json'
|
|
736
|
+
'application/json'
|
|
769
737
|
],
|
|
770
738
|
'content_type': [],
|
|
771
739
|
},
|
|
@@ -834,8 +802,7 @@ class CreativeApi(object):
|
|
|
834
802
|
headers_map={
|
|
835
803
|
'accept': [
|
|
836
804
|
'text/html',
|
|
837
|
-
'application/json'
|
|
838
|
-
'text/json'
|
|
805
|
+
'application/json'
|
|
839
806
|
],
|
|
840
807
|
'content_type': [],
|
|
841
808
|
},
|
|
@@ -892,9 +859,7 @@ class CreativeApi(object):
|
|
|
892
859
|
},
|
|
893
860
|
headers_map={
|
|
894
861
|
'accept': [
|
|
895
|
-
'
|
|
896
|
-
'application/json',
|
|
897
|
-
'text/json'
|
|
862
|
+
'application/json'
|
|
898
863
|
],
|
|
899
864
|
'content_type': [],
|
|
900
865
|
},
|
|
@@ -958,9 +923,7 @@ class CreativeApi(object):
|
|
|
958
923
|
},
|
|
959
924
|
headers_map={
|
|
960
925
|
'accept': [
|
|
961
|
-
'
|
|
962
|
-
'application/json',
|
|
963
|
-
'text/json'
|
|
926
|
+
'application/json'
|
|
964
927
|
],
|
|
965
928
|
'content_type': [],
|
|
966
929
|
},
|
|
@@ -968,7 +931,7 @@ class CreativeApi(object):
|
|
|
968
931
|
)
|
|
969
932
|
self.get_advertiser_creatives_endpoint = _Endpoint(
|
|
970
933
|
settings={
|
|
971
|
-
'response_type': (
|
|
934
|
+
'response_type': (ResourceCollectionOutcomeOfCreativeRead,),
|
|
972
935
|
'auth': [
|
|
973
936
|
'oauth',
|
|
974
937
|
'oauth'
|
|
@@ -1024,9 +987,7 @@ class CreativeApi(object):
|
|
|
1024
987
|
},
|
|
1025
988
|
headers_map={
|
|
1026
989
|
'accept': [
|
|
1027
|
-
'
|
|
1028
|
-
'application/json',
|
|
1029
|
-
'text/json'
|
|
990
|
+
'application/json'
|
|
1030
991
|
],
|
|
1031
992
|
'content_type': [],
|
|
1032
993
|
},
|
|
@@ -1078,9 +1039,7 @@ class CreativeApi(object):
|
|
|
1078
1039
|
},
|
|
1079
1040
|
headers_map={
|
|
1080
1041
|
'accept': [
|
|
1081
|
-
'
|
|
1082
|
-
'application/json',
|
|
1083
|
-
'text/json'
|
|
1042
|
+
'application/json'
|
|
1084
1043
|
],
|
|
1085
1044
|
'content_type': [],
|
|
1086
1045
|
},
|
|
@@ -2429,7 +2388,7 @@ class CreativeApi(object):
|
|
|
2429
2388
|
async_req (bool): execute request asynchronously
|
|
2430
2389
|
|
|
2431
2390
|
Returns:
|
|
2432
|
-
|
|
2391
|
+
ResourceCollectionOutcomeOfCreativeRead
|
|
2433
2392
|
If the method is called asynchronously, returns the request
|
|
2434
2393
|
thread.
|
|
2435
2394
|
"""
|
|
@@ -36,7 +36,7 @@ class OnSiteRecommendationApi(object):
|
|
|
36
36
|
if api_client is None:
|
|
37
37
|
api_client = ApiClient()
|
|
38
38
|
self.api_client = api_client
|
|
39
|
-
self.
|
|
39
|
+
self.search_recommended_products_endpoint = _Endpoint(
|
|
40
40
|
settings={
|
|
41
41
|
'response_type': (OnSiteRecoResponse,),
|
|
42
42
|
'auth': [
|
|
@@ -44,7 +44,7 @@ class OnSiteRecommendationApi(object):
|
|
|
44
44
|
'oauth'
|
|
45
45
|
],
|
|
46
46
|
'endpoint_path': '/preview/recommendation/search',
|
|
47
|
-
'operation_id': '
|
|
47
|
+
'operation_id': 'search_recommended_products',
|
|
48
48
|
'http_method': 'POST',
|
|
49
49
|
'servers': None,
|
|
50
50
|
},
|
|
@@ -82,26 +82,23 @@ class OnSiteRecommendationApi(object):
|
|
|
82
82
|
'application/json'
|
|
83
83
|
],
|
|
84
84
|
'content_type': [
|
|
85
|
-
'application/json
|
|
86
|
-
'application/json',
|
|
87
|
-
'text/json',
|
|
88
|
-
'application/*+json'
|
|
85
|
+
'application/json'
|
|
89
86
|
]
|
|
90
87
|
},
|
|
91
88
|
api_client=api_client
|
|
92
89
|
)
|
|
93
90
|
|
|
94
|
-
def
|
|
91
|
+
def search_recommended_products(
|
|
95
92
|
self,
|
|
96
93
|
**kwargs
|
|
97
94
|
):
|
|
98
|
-
"""
|
|
95
|
+
"""search_recommended_products # noqa: E501
|
|
99
96
|
|
|
100
97
|
Retrieves a list of products recommended for the given user. This end point can either rely on a Criteo UserId, or a list of user events to perform the recommendation. # noqa: E501
|
|
101
98
|
This method makes a synchronous HTTP request by default. To make an
|
|
102
99
|
asynchronous HTTP request, please pass async_req=True
|
|
103
100
|
|
|
104
|
-
>>> thread = api.
|
|
101
|
+
>>> thread = api.search_recommended_products(async_req=True)
|
|
105
102
|
>>> result = thread.get()
|
|
106
103
|
|
|
107
104
|
|
|
@@ -168,5 +165,5 @@ class OnSiteRecommendationApi(object):
|
|
|
168
165
|
'_content_type')
|
|
169
166
|
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
170
167
|
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
171
|
-
return self.
|
|
168
|
+
return self.search_recommended_products_endpoint.call_with_http_info(**kwargs)
|
|
172
169
|
|
|
@@ -84,15 +84,10 @@ class RecoApi(object):
|
|
|
84
84
|
},
|
|
85
85
|
headers_map={
|
|
86
86
|
'accept': [
|
|
87
|
-
'
|
|
88
|
-
'application/json',
|
|
89
|
-
'text/json'
|
|
87
|
+
'application/json'
|
|
90
88
|
],
|
|
91
89
|
'content_type': [
|
|
92
|
-
'application/json
|
|
93
|
-
'application/json',
|
|
94
|
-
'text/json',
|
|
95
|
-
'application/*+json'
|
|
90
|
+
'application/json'
|
|
96
91
|
]
|
|
97
92
|
},
|
|
98
93
|
api_client=api_client
|
|
@@ -143,9 +138,7 @@ class RecoApi(object):
|
|
|
143
138
|
},
|
|
144
139
|
headers_map={
|
|
145
140
|
'accept': [
|
|
146
|
-
'
|
|
147
|
-
'application/json',
|
|
148
|
-
'text/json'
|
|
141
|
+
'application/json'
|
|
149
142
|
],
|
|
150
143
|
'content_type': [],
|
|
151
144
|
},
|
|
@@ -201,15 +194,10 @@ class RecoApi(object):
|
|
|
201
194
|
},
|
|
202
195
|
headers_map={
|
|
203
196
|
'accept': [
|
|
204
|
-
'
|
|
205
|
-
'application/json',
|
|
206
|
-
'text/json'
|
|
197
|
+
'application/json'
|
|
207
198
|
],
|
|
208
199
|
'content_type': [
|
|
209
|
-
'application/json
|
|
210
|
-
'application/json',
|
|
211
|
-
'text/json',
|
|
212
|
-
'application/*+json'
|
|
200
|
+
'application/json'
|
|
213
201
|
]
|
|
214
202
|
},
|
|
215
203
|
api_client=api_client
|
|
@@ -260,9 +248,7 @@ class RecoApi(object):
|
|
|
260
248
|
},
|
|
261
249
|
headers_map={
|
|
262
250
|
'accept': [
|
|
263
|
-
'
|
|
264
|
-
'application/json',
|
|
265
|
-
'text/json'
|
|
251
|
+
'application/json'
|
|
266
252
|
],
|
|
267
253
|
'content_type': [],
|
|
268
254
|
},
|
|
@@ -314,9 +300,7 @@ class RecoApi(object):
|
|
|
314
300
|
},
|
|
315
301
|
headers_map={
|
|
316
302
|
'accept': [
|
|
317
|
-
'
|
|
318
|
-
'application/json',
|
|
319
|
-
'text/json'
|
|
303
|
+
'application/json'
|
|
320
304
|
],
|
|
321
305
|
'content_type': [],
|
|
322
306
|
},
|
|
@@ -368,9 +352,7 @@ class RecoApi(object):
|
|
|
368
352
|
},
|
|
369
353
|
headers_map={
|
|
370
354
|
'accept': [
|
|
371
|
-
'
|
|
372
|
-
'application/json',
|
|
373
|
-
'text/json'
|
|
355
|
+
'application/json'
|
|
374
356
|
],
|
|
375
357
|
'content_type': [],
|
|
376
358
|
},
|
|
@@ -422,9 +404,7 @@ class RecoApi(object):
|
|
|
422
404
|
},
|
|
423
405
|
headers_map={
|
|
424
406
|
'accept': [
|
|
425
|
-
'
|
|
426
|
-
'application/json',
|
|
427
|
-
'text/json'
|
|
407
|
+
'application/json'
|
|
428
408
|
],
|
|
429
409
|
'content_type': [],
|
|
430
410
|
},
|
|
@@ -476,9 +456,7 @@ class RecoApi(object):
|
|
|
476
456
|
},
|
|
477
457
|
headers_map={
|
|
478
458
|
'accept': [
|
|
479
|
-
'
|
|
480
|
-
'application/json',
|
|
481
|
-
'text/json'
|
|
459
|
+
'application/json'
|
|
482
460
|
],
|
|
483
461
|
'content_type': [],
|
|
484
462
|
},
|
|
@@ -76,7 +76,7 @@ class ApiClient(object):
|
|
|
76
76
|
self.default_headers[header_name] = header_value
|
|
77
77
|
self.cookie = cookie
|
|
78
78
|
# Set default User-Agent.
|
|
79
|
-
self.user_agent = 'OpenAPI-Generator/0.0.
|
|
79
|
+
self.user_agent = 'OpenAPI-Generator/0.0.251009/python'
|
|
80
80
|
|
|
81
81
|
def __enter__(self):
|
|
82
82
|
return self
|
|
@@ -804,10 +804,10 @@ class Endpoint(object):
|
|
|
804
804
|
Example:
|
|
805
805
|
|
|
806
806
|
api_instance = AdvertiserApi()
|
|
807
|
-
api_instance.
|
|
808
|
-
api_instance.
|
|
807
|
+
api_instance.list_advertisers # this is an instance of the class Endpoint
|
|
808
|
+
api_instance.list_advertisers() # this invokes api_instance.list_advertisers.__call__()
|
|
809
809
|
which then invokes the callable functions stored in that endpoint at
|
|
810
|
-
api_instance.
|
|
810
|
+
api_instance.list_advertisers.callable or self.callable in this class
|
|
811
811
|
|
|
812
812
|
"""
|
|
813
813
|
return self.callable(self, *args, **kwargs)
|
|
@@ -395,7 +395,7 @@ class Configuration(object):
|
|
|
395
395
|
"OS: {env}\n"\
|
|
396
396
|
"Python Version: {pyversion}\n"\
|
|
397
397
|
"Version of the API: Preview\n"\
|
|
398
|
-
"SDK Package Version: 0.0.
|
|
398
|
+
"SDK Package Version: 0.0.251009".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -105,10 +105,10 @@ class AdaptiveAttributes(ModelNormal):
|
|
|
105
105
|
return {
|
|
106
106
|
'calls_to_action': ([str],), # noqa: E501
|
|
107
107
|
'colors': (AdaptiveColors,), # noqa: E501
|
|
108
|
-
'description_font': (str,
|
|
109
|
-
'description_text': (str,
|
|
110
|
-
'headline_font': (str,
|
|
111
|
-
'headline_text': (str,
|
|
108
|
+
'description_font': (str,), # noqa: E501
|
|
109
|
+
'description_text': (str,), # noqa: E501
|
|
110
|
+
'headline_font': (str,), # noqa: E501
|
|
111
|
+
'headline_text': (str,), # noqa: E501
|
|
112
112
|
'landing_page_url': (str,), # noqa: E501
|
|
113
113
|
'layouts': ([str],), # noqa: E501
|
|
114
114
|
'logos': ([ImageShape],), # noqa: E501
|
|
@@ -150,10 +150,10 @@ class AdaptiveAttributes(ModelNormal):
|
|
|
150
150
|
Args:
|
|
151
151
|
calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.
|
|
152
152
|
colors (AdaptiveColors):
|
|
153
|
-
description_font (str
|
|
154
|
-
description_text (str
|
|
155
|
-
headline_font (str
|
|
156
|
-
headline_text (str
|
|
153
|
+
description_font (str): Font of the description Valid supported font like \"Arial\"
|
|
154
|
+
description_text (str): The description text of the banner
|
|
155
|
+
headline_font (str): Font of the headline Valid supported font like \"Arial\"
|
|
156
|
+
headline_text (str): The headline text of the banner
|
|
157
157
|
landing_page_url (str): Web redirection of the landing page url
|
|
158
158
|
layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".
|
|
159
159
|
logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
|
|
@@ -258,10 +258,10 @@ class AdaptiveAttributes(ModelNormal):
|
|
|
258
258
|
Args:
|
|
259
259
|
calls_to_action ([str]): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.
|
|
260
260
|
colors (AdaptiveColors):
|
|
261
|
-
description_font (str
|
|
262
|
-
description_text (str
|
|
263
|
-
headline_font (str
|
|
264
|
-
headline_text (str
|
|
261
|
+
description_font (str): Font of the description Valid supported font like \"Arial\"
|
|
262
|
+
description_text (str): The description text of the banner
|
|
263
|
+
headline_font (str): Font of the headline Valid supported font like \"Arial\"
|
|
264
|
+
headline_text (str): The headline text of the banner
|
|
265
265
|
landing_page_url (str): Web redirection of the landing page url
|
|
266
266
|
layouts ([str]): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".
|
|
267
267
|
logos ([ImageShape]): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net
|
criteo_api_marketingsolutions_preview/model/{error_description.py → adaptive_read_attributes.py}
RENAMED
|
@@ -29,8 +29,18 @@ from criteo_api_marketingsolutions_preview.model_utils import ( # noqa: F401
|
|
|
29
29
|
from criteo_api_marketingsolutions_preview.exceptions import ApiAttributeError
|
|
30
30
|
|
|
31
31
|
|
|
32
|
-
|
|
33
|
-
|
|
32
|
+
def lazy_import():
|
|
33
|
+
from criteo_api_marketingsolutions_preview.model.adaptive_colors import AdaptiveColors
|
|
34
|
+
from criteo_api_marketingsolutions_preview.model.image_set import ImageSet
|
|
35
|
+
from criteo_api_marketingsolutions_preview.model.image_shape import ImageShape
|
|
36
|
+
from criteo_api_marketingsolutions_preview.model.video_detail import VideoDetail
|
|
37
|
+
globals()['AdaptiveColors'] = AdaptiveColors
|
|
38
|
+
globals()['ImageSet'] = ImageSet
|
|
39
|
+
globals()['ImageShape'] = ImageShape
|
|
40
|
+
globals()['VideoDetail'] = VideoDetail
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
class AdaptiveReadAttributes(ModelNormal):
|
|
34
44
|
"""NOTE: This class is auto generated by OpenAPI Generator.
|
|
35
45
|
Ref: https://openapi-generator.tech
|
|
36
46
|
|
|
@@ -55,6 +65,17 @@ class ErrorDescription(ModelNormal):
|
|
|
55
65
|
"""
|
|
56
66
|
|
|
57
67
|
allowed_values = {
|
|
68
|
+
('image_display',): {
|
|
69
|
+
'None': None,
|
|
70
|
+
'SHOWFULLIMAGE': "ShowFullImage",
|
|
71
|
+
'ZOOMONIMAGE': "ZoomOnImage",
|
|
72
|
+
},
|
|
73
|
+
('layouts',): {
|
|
74
|
+
'None': None,
|
|
75
|
+
'EDITORIAL': "Editorial",
|
|
76
|
+
'MONTAGE': "Montage",
|
|
77
|
+
'INBANNERVIDEO': "InBannerVideo",
|
|
78
|
+
},
|
|
58
79
|
}
|
|
59
80
|
|
|
60
81
|
validations = {
|
|
@@ -66,9 +87,10 @@ class ErrorDescription(ModelNormal):
|
|
|
66
87
|
This must be a method because a model may have properties that are
|
|
67
88
|
of type self, this must run after the class is loaded
|
|
68
89
|
"""
|
|
90
|
+
lazy_import()
|
|
69
91
|
return (bool, date, datetime, dict, float, int, list, str, none_type,) # noqa: E501
|
|
70
92
|
|
|
71
|
-
_nullable =
|
|
93
|
+
_nullable = True
|
|
72
94
|
|
|
73
95
|
@cached_property
|
|
74
96
|
def openapi_types():
|
|
@@ -80,12 +102,20 @@ class ErrorDescription(ModelNormal):
|
|
|
80
102
|
openapi_types (dict): The key is attribute name
|
|
81
103
|
and the value is attribute type.
|
|
82
104
|
"""
|
|
105
|
+
lazy_import()
|
|
83
106
|
return {
|
|
84
|
-
'
|
|
85
|
-
'
|
|
86
|
-
'
|
|
87
|
-
'
|
|
88
|
-
'
|
|
107
|
+
'calls_to_action': ([str], none_type,), # noqa: E501
|
|
108
|
+
'colors': (AdaptiveColors,), # noqa: E501
|
|
109
|
+
'description_font': (str, none_type,), # noqa: E501
|
|
110
|
+
'description_text': (str, none_type,), # noqa: E501
|
|
111
|
+
'headline_font': (str, none_type,), # noqa: E501
|
|
112
|
+
'headline_text': (str, none_type,), # noqa: E501
|
|
113
|
+
'image_display': (str, none_type,), # noqa: E501
|
|
114
|
+
'image_sets': ([ImageSet], none_type,), # noqa: E501
|
|
115
|
+
'landing_page_url': (str, none_type,), # noqa: E501
|
|
116
|
+
'layouts': ([str], none_type,), # noqa: E501
|
|
117
|
+
'logos': ([ImageShape], none_type,), # noqa: E501
|
|
118
|
+
'videos': ([VideoDetail], none_type,), # noqa: E501
|
|
89
119
|
}
|
|
90
120
|
|
|
91
121
|
@cached_property
|
|
@@ -94,11 +124,18 @@ class ErrorDescription(ModelNormal):
|
|
|
94
124
|
|
|
95
125
|
|
|
96
126
|
attribute_map = {
|
|
97
|
-
'
|
|
98
|
-
'
|
|
99
|
-
'
|
|
100
|
-
'
|
|
101
|
-
'
|
|
127
|
+
'calls_to_action': 'callsToAction', # noqa: E501
|
|
128
|
+
'colors': 'colors', # noqa: E501
|
|
129
|
+
'description_font': 'descriptionFont', # noqa: E501
|
|
130
|
+
'description_text': 'descriptionText', # noqa: E501
|
|
131
|
+
'headline_font': 'headlineFont', # noqa: E501
|
|
132
|
+
'headline_text': 'headlineText', # noqa: E501
|
|
133
|
+
'image_display': 'imageDisplay', # noqa: E501
|
|
134
|
+
'image_sets': 'imageSets', # noqa: E501
|
|
135
|
+
'landing_page_url': 'landingPageUrl', # noqa: E501
|
|
136
|
+
'layouts': 'layouts', # noqa: E501
|
|
137
|
+
'logos': 'logos', # noqa: E501
|
|
138
|
+
'videos': 'videos', # noqa: E501
|
|
102
139
|
}
|
|
103
140
|
|
|
104
141
|
read_only_vars = {
|
|
@@ -109,7 +146,7 @@ class ErrorDescription(ModelNormal):
|
|
|
109
146
|
@classmethod
|
|
110
147
|
@convert_js_args_to_python_args
|
|
111
148
|
def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
|
|
112
|
-
"""
|
|
149
|
+
"""AdaptiveReadAttributes - a model defined in OpenAPI
|
|
113
150
|
|
|
114
151
|
Keyword Args:
|
|
115
152
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -142,11 +179,18 @@ class ErrorDescription(ModelNormal):
|
|
|
142
179
|
Animal class but this time we won't travel
|
|
143
180
|
through its discriminator because we passed in
|
|
144
181
|
_visited_composed_classes = (Animal,)
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
182
|
+
calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.. [optional] # noqa: E501
|
|
183
|
+
colors (AdaptiveColors): [optional] # noqa: E501
|
|
184
|
+
description_font (str, none_type): Font of the description Valid supported font like \"Arial\". [optional] # noqa: E501
|
|
185
|
+
description_text (str, none_type): The description text of the banner. [optional] # noqa: E501
|
|
186
|
+
headline_font (str, none_type): Font of the headline Valid supported font like \"Arial\". [optional] # noqa: E501
|
|
187
|
+
headline_text (str, none_type): The headline text of the banner. [optional] # noqa: E501
|
|
188
|
+
image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501
|
|
189
|
+
image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional] # noqa: E501
|
|
190
|
+
landing_page_url (str, none_type): Web redirection of the landing page url. [optional] # noqa: E501
|
|
191
|
+
layouts ([str], none_type): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".. [optional] # noqa: E501
|
|
192
|
+
logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501
|
|
193
|
+
videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [optional] # noqa: E501
|
|
150
194
|
"""
|
|
151
195
|
|
|
152
196
|
_check_type = kwargs.pop('_check_type', True)
|
|
@@ -199,7 +243,7 @@ class ErrorDescription(ModelNormal):
|
|
|
199
243
|
|
|
200
244
|
@convert_js_args_to_python_args
|
|
201
245
|
def __init__(self, *args, **kwargs): # noqa: E501
|
|
202
|
-
"""
|
|
246
|
+
"""AdaptiveReadAttributes - a model defined in OpenAPI
|
|
203
247
|
|
|
204
248
|
Keyword Args:
|
|
205
249
|
_check_type (bool): if True, values for parameters in openapi_types
|
|
@@ -232,11 +276,18 @@ class ErrorDescription(ModelNormal):
|
|
|
232
276
|
Animal class but this time we won't travel
|
|
233
277
|
through its discriminator because we passed in
|
|
234
278
|
_visited_composed_classes = (Animal,)
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
279
|
+
calls_to_action ([str], none_type): A Call-to-Action (CTA) is an action-driven instruction to your audience intended to provoke an immediate response, such as “Buy now” or “Go!”.. [optional] # noqa: E501
|
|
280
|
+
colors (AdaptiveColors): [optional] # noqa: E501
|
|
281
|
+
description_font (str, none_type): Font of the description Valid supported font like \"Arial\". [optional] # noqa: E501
|
|
282
|
+
description_text (str, none_type): The description text of the banner. [optional] # noqa: E501
|
|
283
|
+
headline_font (str, none_type): Font of the headline Valid supported font like \"Arial\". [optional] # noqa: E501
|
|
284
|
+
headline_text (str, none_type): The headline text of the banner. [optional] # noqa: E501
|
|
285
|
+
image_display (str, none_type): Value can be \"ShowFullImage\" or \"ZoomOnImage\". Choose whether your image set should fit inside the allocated space (\"ShowFullImage\") or whether it should fill that space (\"ZoomOnImage\"). If you choose ZoomOnImage, there may be some image cropping.. [optional] # noqa: E501
|
|
286
|
+
image_sets ([ImageSet], none_type): Multiple image sets, each image set consists of multiple images and a headline text.. [optional] # noqa: E501
|
|
287
|
+
landing_page_url (str, none_type): Web redirection of the landing page url. [optional] # noqa: E501
|
|
288
|
+
layouts ([str], none_type): The Adaptive layouts that are enabled. It can contain any of the following values: \"Editorial\", “Montage“, \"InBannerVideo\".. [optional] # noqa: E501
|
|
289
|
+
logos ([ImageShape], none_type): Logo images uploaded on demostatic.criteo.com when deploying and then static.criteo.net. [optional] # noqa: E501
|
|
290
|
+
videos ([VideoDetail], none_type): Multiple videos potentially in different shapes.. [optional] # noqa: E501
|
|
240
291
|
"""
|
|
241
292
|
|
|
242
293
|
_check_type = kwargs.pop('_check_type', True)
|