criteo-api-retailmedia-sdk 2024.7.0.241029__py3-none-any.whl → 2024.7.0.250205__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of criteo-api-retailmedia-sdk might be problematic. Click here for more details.
- {criteo_api_retailmedia_sdk-2024.7.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.7.0.250205.dist-info}/METADATA +14 -5
- {criteo_api_retailmedia_sdk-2024.7.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.7.0.250205.dist-info}/RECORD +60 -63
- {criteo_api_retailmedia_sdk-2024.7.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.7.0.250205.dist-info}/WHEEL +1 -1
- criteo_api_retailmedia_v2024_07/__init__.py +1 -1
- criteo_api_retailmedia_v2024_07/api/accounts_api.py +30 -41
- criteo_api_retailmedia_v2024_07/api/campaign_api.py +25 -281
- criteo_api_retailmedia_v2024_07/api_client.py +1 -1
- criteo_api_retailmedia_v2024_07/configuration.py +1 -1
- criteo_api_retailmedia_v2024_07/model/async_campaigns_report.py +44 -0
- criteo_api_retailmedia_v2024_07/model/async_line_items_report.py +44 -0
- criteo_api_retailmedia_v2024_07/model/async_revenue_report.py +29 -2
- criteo_api_retailmedia_v2024_07/model/balance_response_v2_response.py +1 -1
- criteo_api_retailmedia_v2024_07/model/change_details_v1.py +8 -18
- criteo_api_retailmedia_v2024_07/model/choice_option.py +1 -8
- criteo_api_retailmedia_v2024_07/model/choice_variable_specification.py +1 -8
- criteo_api_retailmedia_v2024_07/model/choice_variable_value.py +1 -7
- criteo_api_retailmedia_v2024_07/model/color_variable_value.py +7 -19
- criteo_api_retailmedia_v2024_07/model/creative202110.py +7 -13
- criteo_api_retailmedia_v2024_07/model/creative202110_list_response.py +13 -20
- criteo_api_retailmedia_v2024_07/model/creative202210.py +12 -19
- criteo_api_retailmedia_v2024_07/model/creative202210_list_response.py +13 -20
- criteo_api_retailmedia_v2024_07/model/creative202210_response.py +10 -17
- criteo_api_retailmedia_v2024_07/model/creative_create_model202207.py +4 -11
- criteo_api_retailmedia_v2024_07/model/creative_update_model202207.py +4 -11
- criteo_api_retailmedia_v2024_07/model/{proposal_status_model_resource.py → entity_resource_of_retail_media_account.py} +17 -10
- criteo_api_retailmedia_v2024_07/model/{proposal_status_model_response.py → entity_resource_outcome_of_retail_media_account.py} +28 -21
- criteo_api_retailmedia_v2024_07/model/{retail_media_account.py → external_retail_media_account.py} +29 -23
- criteo_api_retailmedia_v2024_07/model/{retail_media_brand_account_creation.py → external_retail_media_brand_account_creation.py} +18 -12
- criteo_api_retailmedia_v2024_07/model/{retail_media_brands.py → external_retail_media_brands.py} +13 -7
- criteo_api_retailmedia_v2024_07/model/{retail_media_seller.py → external_retail_media_seller.py} +17 -11
- criteo_api_retailmedia_v2024_07/model/{retail_media_seller_account_creation.py → external_retail_media_seller_account_creation.py} +23 -16
- criteo_api_retailmedia_v2024_07/model/external_retailer.py +2 -0
- criteo_api_retailmedia_v2024_07/model/files_variable_value.py +2 -7
- criteo_api_retailmedia_v2024_07/model/files_variables_specification.py +7 -15
- criteo_api_retailmedia_v2024_07/model/hyperlink_variable_value.py +7 -19
- criteo_api_retailmedia_v2024_07/model/{page_type_environment.py → page_type_environment202210.py} +12 -16
- criteo_api_retailmedia_v2024_07/model/resource_of_creative202110.py +6 -13
- criteo_api_retailmedia_v2024_07/model/resource_of_creative202210.py +2 -9
- criteo_api_retailmedia_v2024_07/model/resource_of_template.py +2 -9
- criteo_api_retailmedia_v2024_07/model/section.py +6 -9
- criteo_api_retailmedia_v2024_07/model/template.py +13 -24
- criteo_api_retailmedia_v2024_07/model/template_list_response.py +13 -20
- criteo_api_retailmedia_v2024_07/model/template_response.py +10 -17
- criteo_api_retailmedia_v2024_07/model/template_variable.py +1 -8
- criteo_api_retailmedia_v2024_07/model/template_variable_value.py +7 -8
- criteo_api_retailmedia_v2024_07/model/text_variable_specification.py +2 -8
- criteo_api_retailmedia_v2024_07/model/text_variable_value.py +7 -19
- criteo_api_retailmedia_v2024_07/model/value_resource_collection_input_of_retail_media_seller.py +12 -5
- criteo_api_retailmedia_v2024_07/model/value_resource_collection_outcome_of_retail_media_seller.py +9 -2
- criteo_api_retailmedia_v2024_07/model/value_resource_input_of_retail_media_brand_account_creation.py +8 -1
- criteo_api_retailmedia_v2024_07/model/value_resource_input_of_retail_media_brands.py +9 -2
- criteo_api_retailmedia_v2024_07/model/value_resource_input_of_retail_media_seller_account_creation.py +9 -2
- criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_brand_account_creation.py +13 -6
- criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_brands.py +14 -7
- criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_seller.py +14 -7
- criteo_api_retailmedia_v2024_07/model/value_resource_of_retail_media_seller_account_creation.py +14 -7
- criteo_api_retailmedia_v2024_07/model/{resource_outcome_of_retail_media_account.py → value_resource_outcome_of_retail_media_brands.py} +17 -10
- criteo_api_retailmedia_v2024_07/model/{resource_of_retail_media_account.py → video_variable_value.py} +39 -22
- criteo_api_retailmedia_v2024_07/models/__init__.py +10 -13
- criteo_api_retailmedia_v2024_07/model/approval_status_model.py +0 -292
- criteo_api_retailmedia_v2024_07/model/negotiation_state_model.py +0 -293
- criteo_api_retailmedia_v2024_07/model/proposal_status_model.py +0 -284
- {criteo_api_retailmedia_sdk-2024.7.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.7.0.250205.dist-info}/top_level.txt +0 -0
|
@@ -65,7 +65,6 @@ from criteo_api_retailmedia_v2024_07.model.preferred_line_item_update_model20211
|
|
|
65
65
|
from criteo_api_retailmedia_v2024_07.model.product_resource_outcome import ProductResourceOutcome
|
|
66
66
|
from criteo_api_retailmedia_v2024_07.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput
|
|
67
67
|
from criteo_api_retailmedia_v2024_07.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome
|
|
68
|
-
from criteo_api_retailmedia_v2024_07.model.proposal_status_model_response import ProposalStatusModelResponse
|
|
69
68
|
from criteo_api_retailmedia_v2024_07.model.put_campaign_v202301 import PutCampaignV202301
|
|
70
69
|
from criteo_api_retailmedia_v2024_07.model.resource_outcome import ResourceOutcome
|
|
71
70
|
from criteo_api_retailmedia_v2024_07.model.set_bids_model_request import SetBidsModelRequest
|
|
@@ -440,58 +439,6 @@ class CampaignApi(object):
|
|
|
440
439
|
},
|
|
441
440
|
api_client=api_client
|
|
442
441
|
)
|
|
443
|
-
self.fetch_proposal_endpoint = _Endpoint(
|
|
444
|
-
settings={
|
|
445
|
-
'response_type': (ProposalStatusModelResponse,),
|
|
446
|
-
'auth': [
|
|
447
|
-
'oauth',
|
|
448
|
-
'oauth'
|
|
449
|
-
],
|
|
450
|
-
'endpoint_path': '/2024-07/retail-media/preferred-deal-line-items/{id}/proposal',
|
|
451
|
-
'operation_id': 'fetch_proposal',
|
|
452
|
-
'http_method': 'GET',
|
|
453
|
-
'servers': None,
|
|
454
|
-
},
|
|
455
|
-
params_map={
|
|
456
|
-
'all': [
|
|
457
|
-
'id',
|
|
458
|
-
],
|
|
459
|
-
'required': [
|
|
460
|
-
'id',
|
|
461
|
-
],
|
|
462
|
-
'nullable': [
|
|
463
|
-
],
|
|
464
|
-
'enum': [
|
|
465
|
-
],
|
|
466
|
-
'validation': [
|
|
467
|
-
]
|
|
468
|
-
},
|
|
469
|
-
root_map={
|
|
470
|
-
'validations': {
|
|
471
|
-
},
|
|
472
|
-
'allowed_values': {
|
|
473
|
-
},
|
|
474
|
-
'openapi_types': {
|
|
475
|
-
'id':
|
|
476
|
-
(str,),
|
|
477
|
-
},
|
|
478
|
-
'attribute_map': {
|
|
479
|
-
'id': 'id',
|
|
480
|
-
},
|
|
481
|
-
'location_map': {
|
|
482
|
-
'id': 'path',
|
|
483
|
-
},
|
|
484
|
-
'collection_format_map': {
|
|
485
|
-
}
|
|
486
|
-
},
|
|
487
|
-
headers_map={
|
|
488
|
-
'accept': [
|
|
489
|
-
'application/json'
|
|
490
|
-
],
|
|
491
|
-
'content_type': [],
|
|
492
|
-
},
|
|
493
|
-
api_client=api_client
|
|
494
|
-
)
|
|
495
442
|
self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint(
|
|
496
443
|
settings={
|
|
497
444
|
'response_type': (Creative202110ListResponse,),
|
|
@@ -538,7 +485,9 @@ class CampaignApi(object):
|
|
|
538
485
|
},
|
|
539
486
|
headers_map={
|
|
540
487
|
'accept': [
|
|
541
|
-
'
|
|
488
|
+
'text/plain',
|
|
489
|
+
'application/json',
|
|
490
|
+
'text/json'
|
|
542
491
|
],
|
|
543
492
|
'content_type': [],
|
|
544
493
|
},
|
|
@@ -1105,7 +1054,9 @@ class CampaignApi(object):
|
|
|
1105
1054
|
},
|
|
1106
1055
|
headers_map={
|
|
1107
1056
|
'accept': [
|
|
1108
|
-
'
|
|
1057
|
+
'text/plain',
|
|
1058
|
+
'application/json',
|
|
1059
|
+
'text/json'
|
|
1109
1060
|
],
|
|
1110
1061
|
'content_type': [],
|
|
1111
1062
|
},
|
|
@@ -1157,7 +1108,9 @@ class CampaignApi(object):
|
|
|
1157
1108
|
},
|
|
1158
1109
|
headers_map={
|
|
1159
1110
|
'accept': [
|
|
1160
|
-
'
|
|
1111
|
+
'text/plain',
|
|
1112
|
+
'application/json',
|
|
1113
|
+
'text/json'
|
|
1161
1114
|
],
|
|
1162
1115
|
'content_type': [],
|
|
1163
1116
|
},
|
|
@@ -1215,7 +1168,9 @@ class CampaignApi(object):
|
|
|
1215
1168
|
},
|
|
1216
1169
|
headers_map={
|
|
1217
1170
|
'accept': [
|
|
1218
|
-
'
|
|
1171
|
+
'text/plain',
|
|
1172
|
+
'application/json',
|
|
1173
|
+
'text/json'
|
|
1219
1174
|
],
|
|
1220
1175
|
'content_type': [],
|
|
1221
1176
|
},
|
|
@@ -1665,6 +1620,7 @@ class CampaignApi(object):
|
|
|
1665
1620
|
'account_id',
|
|
1666
1621
|
],
|
|
1667
1622
|
'nullable': [
|
|
1623
|
+
'limit_to_type',
|
|
1668
1624
|
],
|
|
1669
1625
|
'enum': [
|
|
1670
1626
|
'limit_to_type',
|
|
@@ -1677,7 +1633,7 @@ class CampaignApi(object):
|
|
|
1677
1633
|
},
|
|
1678
1634
|
'allowed_values': {
|
|
1679
1635
|
('limit_to_type',): {
|
|
1680
|
-
|
|
1636
|
+
'None': None,
|
|
1681
1637
|
"UNKNOWN": "Unknown",
|
|
1682
1638
|
"AUCTION": "Auction",
|
|
1683
1639
|
"PREFERRED": "Preferred"
|
|
@@ -1689,7 +1645,7 @@ class CampaignApi(object):
|
|
|
1689
1645
|
'limit_to_campaign_id':
|
|
1690
1646
|
([str],),
|
|
1691
1647
|
'limit_to_type':
|
|
1692
|
-
(str,),
|
|
1648
|
+
(str, none_type,),
|
|
1693
1649
|
'limit_to_id':
|
|
1694
1650
|
([str],),
|
|
1695
1651
|
'page_index':
|
|
@@ -2748,7 +2704,9 @@ class CampaignApi(object):
|
|
|
2748
2704
|
},
|
|
2749
2705
|
headers_map={
|
|
2750
2706
|
'accept': [
|
|
2751
|
-
'
|
|
2707
|
+
'text/plain',
|
|
2708
|
+
'application/json',
|
|
2709
|
+
'text/json'
|
|
2752
2710
|
],
|
|
2753
2711
|
'content_type': [
|
|
2754
2712
|
'application/json'
|
|
@@ -2808,7 +2766,9 @@ class CampaignApi(object):
|
|
|
2808
2766
|
},
|
|
2809
2767
|
headers_map={
|
|
2810
2768
|
'accept': [
|
|
2811
|
-
'
|
|
2769
|
+
'text/plain',
|
|
2770
|
+
'application/json',
|
|
2771
|
+
'text/json'
|
|
2812
2772
|
],
|
|
2813
2773
|
'content_type': [],
|
|
2814
2774
|
},
|
|
@@ -3276,7 +3236,9 @@ class CampaignApi(object):
|
|
|
3276
3236
|
},
|
|
3277
3237
|
headers_map={
|
|
3278
3238
|
'accept': [
|
|
3279
|
-
'
|
|
3239
|
+
'text/plain',
|
|
3240
|
+
'application/json',
|
|
3241
|
+
'text/json'
|
|
3280
3242
|
],
|
|
3281
3243
|
'content_type': [
|
|
3282
3244
|
'application/json'
|
|
@@ -3518,58 +3480,6 @@ class CampaignApi(object):
|
|
|
3518
3480
|
},
|
|
3519
3481
|
api_client=api_client
|
|
3520
3482
|
)
|
|
3521
|
-
self.submit_proposal_endpoint = _Endpoint(
|
|
3522
|
-
settings={
|
|
3523
|
-
'response_type': (ProposalStatusModelResponse,),
|
|
3524
|
-
'auth': [
|
|
3525
|
-
'oauth',
|
|
3526
|
-
'oauth'
|
|
3527
|
-
],
|
|
3528
|
-
'endpoint_path': '/2024-07/retail-media/preferred-deal-line-items/{id}/proposal/submit',
|
|
3529
|
-
'operation_id': 'submit_proposal',
|
|
3530
|
-
'http_method': 'POST',
|
|
3531
|
-
'servers': None,
|
|
3532
|
-
},
|
|
3533
|
-
params_map={
|
|
3534
|
-
'all': [
|
|
3535
|
-
'id',
|
|
3536
|
-
],
|
|
3537
|
-
'required': [
|
|
3538
|
-
'id',
|
|
3539
|
-
],
|
|
3540
|
-
'nullable': [
|
|
3541
|
-
],
|
|
3542
|
-
'enum': [
|
|
3543
|
-
],
|
|
3544
|
-
'validation': [
|
|
3545
|
-
]
|
|
3546
|
-
},
|
|
3547
|
-
root_map={
|
|
3548
|
-
'validations': {
|
|
3549
|
-
},
|
|
3550
|
-
'allowed_values': {
|
|
3551
|
-
},
|
|
3552
|
-
'openapi_types': {
|
|
3553
|
-
'id':
|
|
3554
|
-
(str,),
|
|
3555
|
-
},
|
|
3556
|
-
'attribute_map': {
|
|
3557
|
-
'id': 'id',
|
|
3558
|
-
},
|
|
3559
|
-
'location_map': {
|
|
3560
|
-
'id': 'path',
|
|
3561
|
-
},
|
|
3562
|
-
'collection_format_map': {
|
|
3563
|
-
}
|
|
3564
|
-
},
|
|
3565
|
-
headers_map={
|
|
3566
|
-
'accept': [
|
|
3567
|
-
'application/json'
|
|
3568
|
-
],
|
|
3569
|
-
'content_type': [],
|
|
3570
|
-
},
|
|
3571
|
-
api_client=api_client
|
|
3572
|
-
)
|
|
3573
3483
|
self.unpause_promoted_products_endpoint = _Endpoint(
|
|
3574
3484
|
settings={
|
|
3575
3485
|
'response_type': None,
|
|
@@ -4255,89 +4165,6 @@ class CampaignApi(object):
|
|
|
4255
4165
|
line_item_id
|
|
4256
4166
|
return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs)
|
|
4257
4167
|
|
|
4258
|
-
def fetch_proposal(
|
|
4259
|
-
self,
|
|
4260
|
-
id,
|
|
4261
|
-
**kwargs
|
|
4262
|
-
):
|
|
4263
|
-
"""fetch_proposal # noqa: E501
|
|
4264
|
-
|
|
4265
|
-
Includes the state of the proposal, the status of the booking and approval, as well as any comments explaining why it might have been rejected. # noqa: E501
|
|
4266
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
4267
|
-
asynchronous HTTP request, please pass async_req=True
|
|
4268
|
-
|
|
4269
|
-
>>> thread = api.fetch_proposal(id, async_req=True)
|
|
4270
|
-
>>> result = thread.get()
|
|
4271
|
-
|
|
4272
|
-
Args:
|
|
4273
|
-
id (str): ID of the line item
|
|
4274
|
-
|
|
4275
|
-
Keyword Args:
|
|
4276
|
-
_return_http_data_only (bool): response data without head status
|
|
4277
|
-
code and headers. Default is True.
|
|
4278
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
4279
|
-
will be returned without reading/decoding response data.
|
|
4280
|
-
Default is True.
|
|
4281
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
4282
|
-
one number provided, it will be total request timeout. It can also
|
|
4283
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
4284
|
-
Default is None.
|
|
4285
|
-
_check_input_type (bool): specifies if type checking
|
|
4286
|
-
should be done one the data sent to the server.
|
|
4287
|
-
Default is True.
|
|
4288
|
-
_check_return_type (bool): specifies if type checking
|
|
4289
|
-
should be done one the data received from the server.
|
|
4290
|
-
Default is True.
|
|
4291
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
4292
|
-
are serialized names, as specified in the OpenAPI document.
|
|
4293
|
-
False if the variable names in the input data
|
|
4294
|
-
are pythonic names, e.g. snake case (default)
|
|
4295
|
-
_content_type (str/None): force body content-type.
|
|
4296
|
-
Default is None and content-type will be predicted by allowed
|
|
4297
|
-
content-types and body.
|
|
4298
|
-
_host_index (int/None): specifies the index of the server
|
|
4299
|
-
that we want to use.
|
|
4300
|
-
Default is read from the configuration.
|
|
4301
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
4302
|
-
request; this effectively ignores the authentication
|
|
4303
|
-
in the spec for a single request.
|
|
4304
|
-
Default is None
|
|
4305
|
-
async_req (bool): execute request asynchronously
|
|
4306
|
-
|
|
4307
|
-
Returns:
|
|
4308
|
-
ProposalStatusModelResponse
|
|
4309
|
-
If the method is called asynchronously, returns the request
|
|
4310
|
-
thread.
|
|
4311
|
-
"""
|
|
4312
|
-
kwargs['async_req'] = kwargs.get(
|
|
4313
|
-
'async_req', False
|
|
4314
|
-
)
|
|
4315
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
4316
|
-
'_return_http_data_only', True
|
|
4317
|
-
)
|
|
4318
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
4319
|
-
'_preload_content', True
|
|
4320
|
-
)
|
|
4321
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
4322
|
-
'_request_timeout', None
|
|
4323
|
-
)
|
|
4324
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
4325
|
-
'_check_input_type', True
|
|
4326
|
-
)
|
|
4327
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
4328
|
-
'_check_return_type', True
|
|
4329
|
-
)
|
|
4330
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
4331
|
-
'_spec_property_naming', False
|
|
4332
|
-
)
|
|
4333
|
-
kwargs['_content_type'] = kwargs.get(
|
|
4334
|
-
'_content_type')
|
|
4335
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
4336
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
4337
|
-
kwargs['id'] = \
|
|
4338
|
-
id
|
|
4339
|
-
return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
|
|
4340
|
-
|
|
4341
4168
|
def get_api202110_external_account_creatives_by_account_id(
|
|
4342
4169
|
self,
|
|
4343
4170
|
account_id,
|
|
@@ -6036,7 +5863,7 @@ class CampaignApi(object):
|
|
|
6036
5863
|
|
|
6037
5864
|
Keyword Args:
|
|
6038
5865
|
limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional]
|
|
6039
|
-
limit_to_type (str): The campaign types that you would like to limit your result set to. [optional]
|
|
5866
|
+
limit_to_type (str, none_type): The campaign types that you would like to limit your result set to. [optional]
|
|
6040
5867
|
limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
|
|
6041
5868
|
page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
|
|
6042
5869
|
page_size (int): The maximum number of items you would like to receive in this request. [optional]
|
|
@@ -8711,89 +8538,6 @@ class CampaignApi(object):
|
|
|
8711
8538
|
id
|
|
8712
8539
|
return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
|
|
8713
8540
|
|
|
8714
|
-
def submit_proposal(
|
|
8715
|
-
self,
|
|
8716
|
-
id,
|
|
8717
|
-
**kwargs
|
|
8718
|
-
):
|
|
8719
|
-
"""submit_proposal # noqa: E501
|
|
8720
|
-
|
|
8721
|
-
Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501
|
|
8722
|
-
This method makes a synchronous HTTP request by default. To make an
|
|
8723
|
-
asynchronous HTTP request, please pass async_req=True
|
|
8724
|
-
|
|
8725
|
-
>>> thread = api.submit_proposal(id, async_req=True)
|
|
8726
|
-
>>> result = thread.get()
|
|
8727
|
-
|
|
8728
|
-
Args:
|
|
8729
|
-
id (str): ID of the line item
|
|
8730
|
-
|
|
8731
|
-
Keyword Args:
|
|
8732
|
-
_return_http_data_only (bool): response data without head status
|
|
8733
|
-
code and headers. Default is True.
|
|
8734
|
-
_preload_content (bool): if False, the urllib3.HTTPResponse object
|
|
8735
|
-
will be returned without reading/decoding response data.
|
|
8736
|
-
Default is True.
|
|
8737
|
-
_request_timeout (int/float/tuple): timeout setting for this request. If
|
|
8738
|
-
one number provided, it will be total request timeout. It can also
|
|
8739
|
-
be a pair (tuple) of (connection, read) timeouts.
|
|
8740
|
-
Default is None.
|
|
8741
|
-
_check_input_type (bool): specifies if type checking
|
|
8742
|
-
should be done one the data sent to the server.
|
|
8743
|
-
Default is True.
|
|
8744
|
-
_check_return_type (bool): specifies if type checking
|
|
8745
|
-
should be done one the data received from the server.
|
|
8746
|
-
Default is True.
|
|
8747
|
-
_spec_property_naming (bool): True if the variable names in the input data
|
|
8748
|
-
are serialized names, as specified in the OpenAPI document.
|
|
8749
|
-
False if the variable names in the input data
|
|
8750
|
-
are pythonic names, e.g. snake case (default)
|
|
8751
|
-
_content_type (str/None): force body content-type.
|
|
8752
|
-
Default is None and content-type will be predicted by allowed
|
|
8753
|
-
content-types and body.
|
|
8754
|
-
_host_index (int/None): specifies the index of the server
|
|
8755
|
-
that we want to use.
|
|
8756
|
-
Default is read from the configuration.
|
|
8757
|
-
_request_auths (list): set to override the auth_settings for an a single
|
|
8758
|
-
request; this effectively ignores the authentication
|
|
8759
|
-
in the spec for a single request.
|
|
8760
|
-
Default is None
|
|
8761
|
-
async_req (bool): execute request asynchronously
|
|
8762
|
-
|
|
8763
|
-
Returns:
|
|
8764
|
-
ProposalStatusModelResponse
|
|
8765
|
-
If the method is called asynchronously, returns the request
|
|
8766
|
-
thread.
|
|
8767
|
-
"""
|
|
8768
|
-
kwargs['async_req'] = kwargs.get(
|
|
8769
|
-
'async_req', False
|
|
8770
|
-
)
|
|
8771
|
-
kwargs['_return_http_data_only'] = kwargs.get(
|
|
8772
|
-
'_return_http_data_only', True
|
|
8773
|
-
)
|
|
8774
|
-
kwargs['_preload_content'] = kwargs.get(
|
|
8775
|
-
'_preload_content', True
|
|
8776
|
-
)
|
|
8777
|
-
kwargs['_request_timeout'] = kwargs.get(
|
|
8778
|
-
'_request_timeout', None
|
|
8779
|
-
)
|
|
8780
|
-
kwargs['_check_input_type'] = kwargs.get(
|
|
8781
|
-
'_check_input_type', True
|
|
8782
|
-
)
|
|
8783
|
-
kwargs['_check_return_type'] = kwargs.get(
|
|
8784
|
-
'_check_return_type', True
|
|
8785
|
-
)
|
|
8786
|
-
kwargs['_spec_property_naming'] = kwargs.get(
|
|
8787
|
-
'_spec_property_naming', False
|
|
8788
|
-
)
|
|
8789
|
-
kwargs['_content_type'] = kwargs.get(
|
|
8790
|
-
'_content_type')
|
|
8791
|
-
kwargs['_host_index'] = kwargs.get('_host_index')
|
|
8792
|
-
kwargs['_request_auths'] = kwargs.get('_request_auths', None)
|
|
8793
|
-
kwargs['id'] = \
|
|
8794
|
-
id
|
|
8795
|
-
return self.submit_proposal_endpoint.call_with_http_info(**kwargs)
|
|
8796
|
-
|
|
8797
8541
|
def unpause_promoted_products(
|
|
8798
8542
|
self,
|
|
8799
8543
|
line_item_id,
|
|
@@ -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/2024.07.0.
|
|
79
|
+
self.user_agent = 'OpenAPI-Generator/2024.07.0.250205/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: 2024-07\n"\
|
|
398
|
-
"SDK Package Version: 2024.07.0.
|
|
398
|
+
"SDK Package Version: 2024.07.0.250205".\
|
|
399
399
|
format(env=sys.platform, pyversion=sys.version)
|
|
400
400
|
|
|
401
401
|
def get_host_settings(self):
|
|
@@ -55,6 +55,18 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
+
('search_term_types',): {
|
|
59
|
+
'None': None,
|
|
60
|
+
'UNKNOWN': "unknown",
|
|
61
|
+
'SEARCHED': "searched",
|
|
62
|
+
'ENTERED': "entered",
|
|
63
|
+
},
|
|
64
|
+
('search_term_targetings',): {
|
|
65
|
+
'None': None,
|
|
66
|
+
'UNKNOWN': "unknown",
|
|
67
|
+
'AUTOMATIC': "automatic",
|
|
68
|
+
'MANUAL': "manual",
|
|
69
|
+
},
|
|
58
70
|
('campaign_type',): {
|
|
59
71
|
'None': None,
|
|
60
72
|
'ALL': "all",
|
|
@@ -84,6 +96,7 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
84
96
|
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
85
97
|
'ENVIRONMENT': "environment",
|
|
86
98
|
'SERVEDCATEGORY': "servedCategory",
|
|
99
|
+
'CAPOUT': "capout",
|
|
87
100
|
},
|
|
88
101
|
('click_attribution_window',): {
|
|
89
102
|
'None': None,
|
|
@@ -122,9 +135,18 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
122
135
|
'ENVIRONMENT': "environment",
|
|
123
136
|
'PAGETYPENAME': "pageTypeName",
|
|
124
137
|
'PAGECATEGORY': "pageCategory",
|
|
138
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
125
139
|
'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
|
|
126
140
|
'KEYWORD': "keyword",
|
|
127
141
|
'SEARCHTERM': "searchTerm",
|
|
142
|
+
'SEARCHTERMTYPE': "searchTermType",
|
|
143
|
+
'SEARCHTERMTARGETING': "searchTermTargeting",
|
|
144
|
+
'CREATIVEID': "creativeId",
|
|
145
|
+
'CREATIVENAME': "creativeName",
|
|
146
|
+
'CREATIVETYPEID': "creativeTypeId",
|
|
147
|
+
'CREATIVETYPENAME': "creativeTypeName",
|
|
148
|
+
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
149
|
+
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
128
150
|
},
|
|
129
151
|
('metrics',): {
|
|
130
152
|
'None': None,
|
|
@@ -149,6 +171,20 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
149
171
|
'VIDEOSPLAYEDTO100': "videosPlayedTo100",
|
|
150
172
|
'VIDEOPLAYINGRATE': "videoPlayingRate",
|
|
151
173
|
'VIDEOCOMPLETIONRATE': "videoCompletionRate",
|
|
174
|
+
'VIDEOIMPRESSIONS': "videoImpressions",
|
|
175
|
+
'VIDEOMUTED': "videoMuted",
|
|
176
|
+
'VIDEOUNMUTED': "videoUnmuted",
|
|
177
|
+
'VIDEOPAUSED': "videoPaused",
|
|
178
|
+
'VIDEORESUMED': "videoResumed",
|
|
179
|
+
'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
|
|
180
|
+
'VIDEOVIEWABILITY': "videoViewability",
|
|
181
|
+
'VIDEOSTARTINGRATE': "videoStartingRate",
|
|
182
|
+
'VIDEOCPC': "videoCPC",
|
|
183
|
+
'VIDEOCPCV': "videoCPCV",
|
|
184
|
+
'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
|
|
185
|
+
'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
|
|
186
|
+
'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
|
|
187
|
+
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
152
188
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
153
189
|
'FREQUENCY': "frequency",
|
|
154
190
|
},
|
|
@@ -182,6 +218,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
182
218
|
'end_date': (datetime,), # noqa: E501
|
|
183
219
|
'ids': ([str], none_type,), # noqa: E501
|
|
184
220
|
'id': (str, none_type,), # noqa: E501
|
|
221
|
+
'search_term_types': ([str], none_type,), # noqa: E501
|
|
222
|
+
'search_term_targetings': ([str], none_type,), # noqa: E501
|
|
185
223
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
186
224
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
187
225
|
'format': (str, none_type,), # noqa: E501
|
|
@@ -203,6 +241,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
203
241
|
'end_date': 'endDate', # noqa: E501
|
|
204
242
|
'ids': 'ids', # noqa: E501
|
|
205
243
|
'id': 'id', # noqa: E501
|
|
244
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
245
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
206
246
|
'campaign_type': 'campaignType', # noqa: E501
|
|
207
247
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
208
248
|
'format': 'format', # noqa: E501
|
|
@@ -261,6 +301,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
261
301
|
_visited_composed_classes = (Animal,)
|
|
262
302
|
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
263
303
|
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
304
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
305
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
264
306
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
265
307
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
266
308
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -363,6 +405,8 @@ class AsyncCampaignsReport(ModelNormal):
|
|
|
363
405
|
_visited_composed_classes = (Animal,)
|
|
364
406
|
ids ([str], none_type): Campaign ids to report on. [optional] # noqa: E501
|
|
365
407
|
id (str, none_type): Campaign id to report on. [optional] # noqa: E501
|
|
408
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
409
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
366
410
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
367
411
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
368
412
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -55,6 +55,18 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
55
55
|
"""
|
|
56
56
|
|
|
57
57
|
allowed_values = {
|
|
58
|
+
('search_term_types',): {
|
|
59
|
+
'None': None,
|
|
60
|
+
'UNKNOWN': "unknown",
|
|
61
|
+
'SEARCHED': "searched",
|
|
62
|
+
'ENTERED': "entered",
|
|
63
|
+
},
|
|
64
|
+
('search_term_targetings',): {
|
|
65
|
+
'None': None,
|
|
66
|
+
'UNKNOWN': "unknown",
|
|
67
|
+
'AUTOMATIC': "automatic",
|
|
68
|
+
'MANUAL': "manual",
|
|
69
|
+
},
|
|
58
70
|
('campaign_type',): {
|
|
59
71
|
'None': None,
|
|
60
72
|
'ALL': "all",
|
|
@@ -84,6 +96,7 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
84
96
|
'ATTRIBUTEDTRANSACTIONS': "attributedTransactions",
|
|
85
97
|
'ENVIRONMENT': "environment",
|
|
86
98
|
'SERVEDCATEGORY': "servedCategory",
|
|
99
|
+
'CAPOUT': "capout",
|
|
87
100
|
},
|
|
88
101
|
('click_attribution_window',): {
|
|
89
102
|
'None': None,
|
|
@@ -122,9 +135,18 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
122
135
|
'ENVIRONMENT': "environment",
|
|
123
136
|
'PAGETYPENAME': "pageTypeName",
|
|
124
137
|
'PAGECATEGORY': "pageCategory",
|
|
138
|
+
'SERVEDCATEGORY': "servedCategory",
|
|
125
139
|
'TAXONOMYBREADCRUMB': "taxonomyBreadcrumb",
|
|
126
140
|
'KEYWORD': "keyword",
|
|
127
141
|
'SEARCHTERM': "searchTerm",
|
|
142
|
+
'SEARCHTERMTYPE': "searchTermType",
|
|
143
|
+
'SEARCHTERMTARGETING': "searchTermTargeting",
|
|
144
|
+
'CREATIVEID': "creativeId",
|
|
145
|
+
'CREATIVENAME': "creativeName",
|
|
146
|
+
'CREATIVETYPEID': "creativeTypeId",
|
|
147
|
+
'CREATIVETYPENAME': "creativeTypeName",
|
|
148
|
+
'CREATIVETEMPLATEID': "creativeTemplateId",
|
|
149
|
+
'CREATIVETEMPLATENAME': "creativeTemplateName",
|
|
128
150
|
},
|
|
129
151
|
('metrics',): {
|
|
130
152
|
'None': None,
|
|
@@ -149,6 +171,20 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
149
171
|
'VIDEOSPLAYEDTO100': "videosPlayedTo100",
|
|
150
172
|
'VIDEOPLAYINGRATE': "videoPlayingRate",
|
|
151
173
|
'VIDEOCOMPLETIONRATE': "videoCompletionRate",
|
|
174
|
+
'VIDEOIMPRESSIONS': "videoImpressions",
|
|
175
|
+
'VIDEOMUTED': "videoMuted",
|
|
176
|
+
'VIDEOUNMUTED': "videoUnmuted",
|
|
177
|
+
'VIDEOPAUSED': "videoPaused",
|
|
178
|
+
'VIDEORESUMED': "videoResumed",
|
|
179
|
+
'VIDEOAVGINTERACTIONRATE': "videoAvgInteractionRate",
|
|
180
|
+
'VIDEOVIEWABILITY': "videoViewability",
|
|
181
|
+
'VIDEOSTARTINGRATE': "videoStartingRate",
|
|
182
|
+
'VIDEOCPC': "videoCPC",
|
|
183
|
+
'VIDEOCPCV': "videoCPCV",
|
|
184
|
+
'NEWTOBRANDATTRIBUTEDSALES': "newToBrandAttributedSales",
|
|
185
|
+
'NEWTOBRANDATTRIBUTEDSALESRATE': "newToBrandAttributedSalesRate",
|
|
186
|
+
'NEWTOBRANDATTRIBUTEDUNITS': "newToBrandAttributedUnits",
|
|
187
|
+
'NEWTOBRANDATTRIBUTEDUNITSRATE': "newToBrandAttributedUnitsRate",
|
|
152
188
|
'UNIQUEVISITORS': "uniqueVisitors",
|
|
153
189
|
'FREQUENCY': "frequency",
|
|
154
190
|
},
|
|
@@ -182,6 +218,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
182
218
|
'end_date': (datetime,), # noqa: E501
|
|
183
219
|
'ids': ([str], none_type,), # noqa: E501
|
|
184
220
|
'id': (str, none_type,), # noqa: E501
|
|
221
|
+
'search_term_types': ([str], none_type,), # noqa: E501
|
|
222
|
+
'search_term_targetings': ([str], none_type,), # noqa: E501
|
|
185
223
|
'campaign_type': (str, none_type,), # noqa: E501
|
|
186
224
|
'sales_channel': (str, none_type,), # noqa: E501
|
|
187
225
|
'format': (str, none_type,), # noqa: E501
|
|
@@ -203,6 +241,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
203
241
|
'end_date': 'endDate', # noqa: E501
|
|
204
242
|
'ids': 'ids', # noqa: E501
|
|
205
243
|
'id': 'id', # noqa: E501
|
|
244
|
+
'search_term_types': 'searchTermTypes', # noqa: E501
|
|
245
|
+
'search_term_targetings': 'searchTermTargetings', # noqa: E501
|
|
206
246
|
'campaign_type': 'campaignType', # noqa: E501
|
|
207
247
|
'sales_channel': 'salesChannel', # noqa: E501
|
|
208
248
|
'format': 'format', # noqa: E501
|
|
@@ -261,6 +301,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
261
301
|
_visited_composed_classes = (Animal,)
|
|
262
302
|
ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
|
|
263
303
|
id (str, none_type): Line Item id to report on. [optional] # noqa: E501
|
|
304
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
305
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
264
306
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
265
307
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
266
308
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|
|
@@ -363,6 +405,8 @@ class AsyncLineItemsReport(ModelNormal):
|
|
|
363
405
|
_visited_composed_classes = (Animal,)
|
|
364
406
|
ids ([str], none_type): Line Item ids to report on. [optional] # noqa: E501
|
|
365
407
|
id (str, none_type): Line Item id to report on. [optional] # noqa: E501
|
|
408
|
+
search_term_types ([str], none_type): Filter on the type of search term type: unknown, searched, entered. [optional] # noqa: E501
|
|
409
|
+
search_term_targetings ([str], none_type): Filter on the type of search term targeting: unknown, automatic, manual. [optional] # noqa: E501
|
|
366
410
|
campaign_type (str, none_type): Filter the type of campaigns to report on: sponsoredProducts or onSiteDisplays. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
367
411
|
sales_channel (str, none_type): Filter on specific sales channel: offline or online. [optional] if omitted the server will use the default value of "all" # noqa: E501
|
|
368
412
|
format (str, none_type): Format of the output. [optional] if omitted the server will use the default value of "json-compact" # noqa: E501
|