criteo-api-retailmedia-sdk 2024.10.0.241029__py3-none-any.whl → 2024.10.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.

Files changed (82) hide show
  1. {criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.10.0.250205.dist-info}/METADATA +14 -5
  2. {criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.10.0.250205.dist-info}/RECORD +70 -81
  3. {criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.10.0.250205.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_v2024_10/__init__.py +1 -1
  5. criteo_api_retailmedia_v2024_10/api/accounts_api.py +30 -41
  6. criteo_api_retailmedia_v2024_10/api/campaign_api.py +26 -285
  7. criteo_api_retailmedia_v2024_10/api_client.py +1 -1
  8. criteo_api_retailmedia_v2024_10/configuration.py +1 -1
  9. criteo_api_retailmedia_v2024_10/model/async_campaigns_report.py +44 -0
  10. criteo_api_retailmedia_v2024_10/model/async_line_items_report.py +44 -0
  11. criteo_api_retailmedia_v2024_10/model/async_revenue_report.py +29 -2
  12. criteo_api_retailmedia_v2024_10/model/balance_response_v2_response.py +1 -1
  13. criteo_api_retailmedia_v2024_10/model/change_details_v1.py +8 -18
  14. criteo_api_retailmedia_v2024_10/model/choice_option.py +1 -8
  15. criteo_api_retailmedia_v2024_10/model/choice_variable_specification.py +1 -8
  16. criteo_api_retailmedia_v2024_10/model/choice_variable_value.py +1 -7
  17. criteo_api_retailmedia_v2024_10/model/color_variable_value.py +7 -19
  18. criteo_api_retailmedia_v2024_10/model/{external_creative_v2.py → creative2.py} +23 -30
  19. criteo_api_retailmedia_v2024_10/model/creative202110.py +7 -13
  20. criteo_api_retailmedia_v2024_10/model/creative202110_list_response.py +13 -20
  21. criteo_api_retailmedia_v2024_10/model/creative202210.py +12 -19
  22. criteo_api_retailmedia_v2024_10/model/creative202210_response.py +10 -17
  23. criteo_api_retailmedia_v2024_10/model/{resource_outcome_of_retail_media_account.py → creative2_list_response.py} +9 -9
  24. criteo_api_retailmedia_v2024_10/model/{proposal_status_model_response.py → creative2_response.py} +20 -20
  25. criteo_api_retailmedia_v2024_10/model/creative_create_model202207.py +4 -11
  26. criteo_api_retailmedia_v2024_10/model/creative_update_model202207.py +4 -11
  27. criteo_api_retailmedia_v2024_10/model/{resource_of_creative_v2.py → entity_resource_of_retail_media_account.py} +14 -14
  28. criteo_api_retailmedia_v2024_10/model/{creative_v2_response.py → entity_resource_outcome_of_retail_media_account.py} +9 -9
  29. criteo_api_retailmedia_v2024_10/model/external_line_item_bid_multipliers_v2.py +1 -1
  30. criteo_api_retailmedia_v2024_10/model/{retail_media_account.py → external_retail_media_account.py} +29 -23
  31. criteo_api_retailmedia_v2024_10/model/{retail_media_brand_account_creation.py → external_retail_media_brand_account_creation.py} +18 -12
  32. criteo_api_retailmedia_v2024_10/model/{external_text_variable_value.py → external_retail_media_brands.py} +7 -7
  33. criteo_api_retailmedia_v2024_10/model/{external_hyperlink_variable_value.py → external_retail_media_seller.py} +12 -8
  34. criteo_api_retailmedia_v2024_10/model/external_retail_media_seller_account_creation.py +281 -0
  35. criteo_api_retailmedia_v2024_10/model/external_retailer.py +2 -0
  36. criteo_api_retailmedia_v2024_10/model/files_variable_value.py +2 -7
  37. criteo_api_retailmedia_v2024_10/model/files_variables_specification.py +7 -15
  38. criteo_api_retailmedia_v2024_10/model/hyperlink_variable_value.py +7 -19
  39. criteo_api_retailmedia_v2024_10/model/line_item_bid_multipliers_v2_request.py +1 -1
  40. criteo_api_retailmedia_v2024_10/model/line_item_bid_multipliers_v2_response.py +1 -1
  41. criteo_api_retailmedia_v2024_10/model/{external_page_type_environment.py → page_type_environment2.py} +4 -10
  42. criteo_api_retailmedia_v2024_10/model/{page_type_environment.py → page_type_environment202210.py} +12 -16
  43. criteo_api_retailmedia_v2024_10/model/{proposal_status_model_resource.py → resource_of_creative2.py} +14 -14
  44. criteo_api_retailmedia_v2024_10/model/resource_of_creative202110.py +6 -13
  45. criteo_api_retailmedia_v2024_10/model/resource_of_creative202210.py +2 -9
  46. criteo_api_retailmedia_v2024_10/model/resource_of_line_item_bid_multipliers_v2.py +1 -1
  47. criteo_api_retailmedia_v2024_10/model/resource_of_preferred_line_item_v2.py +1 -1
  48. criteo_api_retailmedia_v2024_10/model/resource_of_template.py +2 -9
  49. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment.py +31 -18
  50. criteo_api_retailmedia_v2024_10/model/section.py +6 -9
  51. criteo_api_retailmedia_v2024_10/model/template.py +13 -24
  52. criteo_api_retailmedia_v2024_10/model/template_list_response.py +13 -20
  53. criteo_api_retailmedia_v2024_10/model/template_response.py +10 -17
  54. criteo_api_retailmedia_v2024_10/model/template_variable.py +1 -8
  55. criteo_api_retailmedia_v2024_10/model/template_variable_value.py +7 -8
  56. criteo_api_retailmedia_v2024_10/model/text_variable_specification.py +2 -8
  57. criteo_api_retailmedia_v2024_10/model/text_variable_value.py +7 -19
  58. criteo_api_retailmedia_v2024_10/model/value_resource_collection_input_of_retail_media_seller.py +12 -5
  59. criteo_api_retailmedia_v2024_10/model/value_resource_collection_outcome_of_retail_media_seller.py +9 -2
  60. criteo_api_retailmedia_v2024_10/model/value_resource_input_of_retail_media_brand_account_creation.py +8 -1
  61. criteo_api_retailmedia_v2024_10/model/value_resource_input_of_retail_media_brands.py +9 -2
  62. criteo_api_retailmedia_v2024_10/model/value_resource_input_of_retail_media_seller_account_creation.py +9 -2
  63. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_brand_account_creation.py +13 -6
  64. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_brands.py +14 -7
  65. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_seller.py +14 -7
  66. criteo_api_retailmedia_v2024_10/model/value_resource_of_retail_media_seller_account_creation.py +14 -7
  67. criteo_api_retailmedia_v2024_10/model/{creative_v2_list_response.py → value_resource_outcome_of_retail_media_brands.py} +9 -9
  68. criteo_api_retailmedia_v2024_10/model/{external_video_variable_value.py → video_variable_value.py} +4 -10
  69. criteo_api_retailmedia_v2024_10/models/__init__.py +15 -26
  70. criteo_api_retailmedia_v2024_10/model/approval_status_model.py +0 -292
  71. criteo_api_retailmedia_v2024_10/model/external_choice_variable_value.py +0 -269
  72. criteo_api_retailmedia_v2024_10/model/external_color_variable_value.py +0 -268
  73. criteo_api_retailmedia_v2024_10/model/external_files_variable_value.py +0 -272
  74. criteo_api_retailmedia_v2024_10/model/external_template_variable_value.py +0 -309
  75. criteo_api_retailmedia_v2024_10/model/negotiation_state_model.py +0 -293
  76. criteo_api_retailmedia_v2024_10/model/proposal_status_model.py +0 -284
  77. criteo_api_retailmedia_v2024_10/model/resource_of_retail_media_account.py +0 -270
  78. criteo_api_retailmedia_v2024_10/model/retail_media_brands.py +0 -257
  79. criteo_api_retailmedia_v2024_10/model/retail_media_contactlist_amendment_attributes.py +0 -292
  80. criteo_api_retailmedia_v2024_10/model/retail_media_seller.py +0 -261
  81. criteo_api_retailmedia_v2024_10/model/retail_media_seller_account_creation.py +0 -274
  82. {criteo_api_retailmedia_sdk-2024.10.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.10.0.250205.dist-info}/top_level.txt +0 -0
@@ -41,10 +41,10 @@ from criteo_api_retailmedia_v2024_10.model.common_line_item_paged_list_response
41
41
  from criteo_api_retailmedia_v2024_10.model.common_line_item_response import CommonLineItemResponse
42
42
  from criteo_api_retailmedia_v2024_10.model.creative202110_list_response import Creative202110ListResponse
43
43
  from criteo_api_retailmedia_v2024_10.model.creative202210_response import Creative202210Response
44
+ from criteo_api_retailmedia_v2024_10.model.creative2_list_response import Creative2ListResponse
45
+ from criteo_api_retailmedia_v2024_10.model.creative2_response import Creative2Response
44
46
  from criteo_api_retailmedia_v2024_10.model.creative_create_model202207 import CreativeCreateModel202207
45
47
  from criteo_api_retailmedia_v2024_10.model.creative_update_model202207 import CreativeUpdateModel202207
46
- from criteo_api_retailmedia_v2024_10.model.creative_v2_list_response import CreativeV2ListResponse
47
- from criteo_api_retailmedia_v2024_10.model.creative_v2_response import CreativeV2Response
48
48
  from criteo_api_retailmedia_v2024_10.model.external_retailer_pages202110 import ExternalRetailerPages202110
49
49
  from criteo_api_retailmedia_v2024_10.model.json_api_page_response_of_brand import JsonApiPageResponseOfBrand
50
50
  from criteo_api_retailmedia_v2024_10.model.json_api_page_response_of_campaign_v202301 import JsonApiPageResponseOfCampaignV202301
@@ -66,7 +66,6 @@ from criteo_api_retailmedia_v2024_10.model.preferred_line_item_v2_response impor
66
66
  from criteo_api_retailmedia_v2024_10.model.product_resource_outcome import ProductResourceOutcome
67
67
  from criteo_api_retailmedia_v2024_10.model.promoted_product_resource_collection_input import PromotedProductResourceCollectionInput
68
68
  from criteo_api_retailmedia_v2024_10.model.promoted_product_resource_collection_outcome import PromotedProductResourceCollectionOutcome
69
- from criteo_api_retailmedia_v2024_10.model.proposal_status_model_response import ProposalStatusModelResponse
70
69
  from criteo_api_retailmedia_v2024_10.model.put_campaign_v202301 import PutCampaignV202301
71
70
  from criteo_api_retailmedia_v2024_10.model.resource_outcome import ResourceOutcome
72
71
  from criteo_api_retailmedia_v2024_10.model.set_bids_model_request import SetBidsModelRequest
@@ -441,58 +440,6 @@ class CampaignApi(object):
441
440
  },
442
441
  api_client=api_client
443
442
  )
444
- self.fetch_proposal_endpoint = _Endpoint(
445
- settings={
446
- 'response_type': (ProposalStatusModelResponse,),
447
- 'auth': [
448
- 'oauth',
449
- 'oauth'
450
- ],
451
- 'endpoint_path': '/2024-10/retail-media/preferred-deal-line-items/{id}/proposal',
452
- 'operation_id': 'fetch_proposal',
453
- 'http_method': 'GET',
454
- 'servers': None,
455
- },
456
- params_map={
457
- 'all': [
458
- 'id',
459
- ],
460
- 'required': [
461
- 'id',
462
- ],
463
- 'nullable': [
464
- ],
465
- 'enum': [
466
- ],
467
- 'validation': [
468
- ]
469
- },
470
- root_map={
471
- 'validations': {
472
- },
473
- 'allowed_values': {
474
- },
475
- 'openapi_types': {
476
- 'id':
477
- (str,),
478
- },
479
- 'attribute_map': {
480
- 'id': 'id',
481
- },
482
- 'location_map': {
483
- 'id': 'path',
484
- },
485
- 'collection_format_map': {
486
- }
487
- },
488
- headers_map={
489
- 'accept': [
490
- 'application/json'
491
- ],
492
- 'content_type': [],
493
- },
494
- api_client=api_client
495
- )
496
443
  self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint(
497
444
  settings={
498
445
  'response_type': (Creative202110ListResponse,),
@@ -539,7 +486,9 @@ class CampaignApi(object):
539
486
  },
540
487
  headers_map={
541
488
  'accept': [
542
- 'application/json'
489
+ 'text/plain',
490
+ 'application/json',
491
+ 'text/json'
543
492
  ],
544
493
  'content_type': [],
545
494
  },
@@ -986,7 +935,9 @@ class CampaignApi(object):
986
935
  },
987
936
  headers_map={
988
937
  'accept': [
989
- 'application/json'
938
+ 'text/plain',
939
+ 'application/json',
940
+ 'text/json'
990
941
  ],
991
942
  'content_type': [],
992
943
  },
@@ -1038,7 +989,9 @@ class CampaignApi(object):
1038
989
  },
1039
990
  headers_map={
1040
991
  'accept': [
1041
- 'application/json'
992
+ 'text/plain',
993
+ 'application/json',
994
+ 'text/json'
1042
995
  ],
1043
996
  'content_type': [],
1044
997
  },
@@ -1411,7 +1364,7 @@ class CampaignApi(object):
1411
1364
  )
1412
1365
  self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
1413
1366
  settings={
1414
- 'response_type': (CreativeV2Response,),
1367
+ 'response_type': (Creative2Response,),
1415
1368
  'auth': [
1416
1369
  'oauth',
1417
1370
  'oauth'
@@ -1494,6 +1447,7 @@ class CampaignApi(object):
1494
1447
  'account_id',
1495
1448
  ],
1496
1449
  'nullable': [
1450
+ 'limit_to_type',
1497
1451
  ],
1498
1452
  'enum': [
1499
1453
  'limit_to_type',
@@ -1506,7 +1460,7 @@ class CampaignApi(object):
1506
1460
  },
1507
1461
  'allowed_values': {
1508
1462
  ('limit_to_type',): {
1509
-
1463
+ 'None': None,
1510
1464
  "UNKNOWN": "Unknown",
1511
1465
  "AUCTION": "Auction",
1512
1466
  "PREFERRED": "Preferred"
@@ -1518,7 +1472,7 @@ class CampaignApi(object):
1518
1472
  'limit_to_campaign_id':
1519
1473
  ([str],),
1520
1474
  'limit_to_type':
1521
- (str,),
1475
+ (str, none_type,),
1522
1476
  'limit_to_id':
1523
1477
  ([str],),
1524
1478
  'page_index':
@@ -2752,7 +2706,9 @@ class CampaignApi(object):
2752
2706
  },
2753
2707
  headers_map={
2754
2708
  'accept': [
2755
- 'application/json'
2709
+ 'text/plain',
2710
+ 'application/json',
2711
+ 'text/json'
2756
2712
  ],
2757
2713
  'content_type': [
2758
2714
  'application/json'
@@ -2878,7 +2834,7 @@ class CampaignApi(object):
2878
2834
  )
2879
2835
  self.post_api_v2_external_account_creatives_search_by_account_id_endpoint = _Endpoint(
2880
2836
  settings={
2881
- 'response_type': (CreativeV2ListResponse,),
2837
+ 'response_type': (Creative2ListResponse,),
2882
2838
  'auth': [
2883
2839
  'oauth',
2884
2840
  'oauth'
@@ -3283,7 +3239,9 @@ class CampaignApi(object):
3283
3239
  },
3284
3240
  headers_map={
3285
3241
  'accept': [
3286
- 'application/json'
3242
+ 'text/plain',
3243
+ 'application/json',
3244
+ 'text/json'
3287
3245
  ],
3288
3246
  'content_type': [
3289
3247
  'application/json'
@@ -3428,6 +3386,7 @@ class CampaignApi(object):
3428
3386
  'line_item_id',
3429
3387
  ],
3430
3388
  'nullable': [
3389
+ 'line_item_bid_multipliers_v2_request',
3431
3390
  ],
3432
3391
  'enum': [
3433
3392
  ],
@@ -3525,58 +3484,6 @@ class CampaignApi(object):
3525
3484
  },
3526
3485
  api_client=api_client
3527
3486
  )
3528
- self.submit_proposal_endpoint = _Endpoint(
3529
- settings={
3530
- 'response_type': (ProposalStatusModelResponse,),
3531
- 'auth': [
3532
- 'oauth',
3533
- 'oauth'
3534
- ],
3535
- 'endpoint_path': '/2024-10/retail-media/preferred-deal-line-items/{id}/proposal/submit',
3536
- 'operation_id': 'submit_proposal',
3537
- 'http_method': 'POST',
3538
- 'servers': None,
3539
- },
3540
- params_map={
3541
- 'all': [
3542
- 'id',
3543
- ],
3544
- 'required': [
3545
- 'id',
3546
- ],
3547
- 'nullable': [
3548
- ],
3549
- 'enum': [
3550
- ],
3551
- 'validation': [
3552
- ]
3553
- },
3554
- root_map={
3555
- 'validations': {
3556
- },
3557
- 'allowed_values': {
3558
- },
3559
- 'openapi_types': {
3560
- 'id':
3561
- (str,),
3562
- },
3563
- 'attribute_map': {
3564
- 'id': 'id',
3565
- },
3566
- 'location_map': {
3567
- 'id': 'path',
3568
- },
3569
- 'collection_format_map': {
3570
- }
3571
- },
3572
- headers_map={
3573
- 'accept': [
3574
- 'application/json'
3575
- ],
3576
- 'content_type': [],
3577
- },
3578
- api_client=api_client
3579
- )
3580
3487
  self.unpause_promoted_products_endpoint = _Endpoint(
3581
3488
  settings={
3582
3489
  'response_type': None,
@@ -4262,89 +4169,6 @@ class CampaignApi(object):
4262
4169
  line_item_id
4263
4170
  return self.fetch_promoted_products_endpoint.call_with_http_info(**kwargs)
4264
4171
 
4265
- def fetch_proposal(
4266
- self,
4267
- id,
4268
- **kwargs
4269
- ):
4270
- """fetch_proposal # noqa: E501
4271
-
4272
- 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
4273
- This method makes a synchronous HTTP request by default. To make an
4274
- asynchronous HTTP request, please pass async_req=True
4275
-
4276
- >>> thread = api.fetch_proposal(id, async_req=True)
4277
- >>> result = thread.get()
4278
-
4279
- Args:
4280
- id (str): ID of the line item
4281
-
4282
- Keyword Args:
4283
- _return_http_data_only (bool): response data without head status
4284
- code and headers. Default is True.
4285
- _preload_content (bool): if False, the urllib3.HTTPResponse object
4286
- will be returned without reading/decoding response data.
4287
- Default is True.
4288
- _request_timeout (int/float/tuple): timeout setting for this request. If
4289
- one number provided, it will be total request timeout. It can also
4290
- be a pair (tuple) of (connection, read) timeouts.
4291
- Default is None.
4292
- _check_input_type (bool): specifies if type checking
4293
- should be done one the data sent to the server.
4294
- Default is True.
4295
- _check_return_type (bool): specifies if type checking
4296
- should be done one the data received from the server.
4297
- Default is True.
4298
- _spec_property_naming (bool): True if the variable names in the input data
4299
- are serialized names, as specified in the OpenAPI document.
4300
- False if the variable names in the input data
4301
- are pythonic names, e.g. snake case (default)
4302
- _content_type (str/None): force body content-type.
4303
- Default is None and content-type will be predicted by allowed
4304
- content-types and body.
4305
- _host_index (int/None): specifies the index of the server
4306
- that we want to use.
4307
- Default is read from the configuration.
4308
- _request_auths (list): set to override the auth_settings for an a single
4309
- request; this effectively ignores the authentication
4310
- in the spec for a single request.
4311
- Default is None
4312
- async_req (bool): execute request asynchronously
4313
-
4314
- Returns:
4315
- ProposalStatusModelResponse
4316
- If the method is called asynchronously, returns the request
4317
- thread.
4318
- """
4319
- kwargs['async_req'] = kwargs.get(
4320
- 'async_req', False
4321
- )
4322
- kwargs['_return_http_data_only'] = kwargs.get(
4323
- '_return_http_data_only', True
4324
- )
4325
- kwargs['_preload_content'] = kwargs.get(
4326
- '_preload_content', True
4327
- )
4328
- kwargs['_request_timeout'] = kwargs.get(
4329
- '_request_timeout', None
4330
- )
4331
- kwargs['_check_input_type'] = kwargs.get(
4332
- '_check_input_type', True
4333
- )
4334
- kwargs['_check_return_type'] = kwargs.get(
4335
- '_check_return_type', True
4336
- )
4337
- kwargs['_spec_property_naming'] = kwargs.get(
4338
- '_spec_property_naming', False
4339
- )
4340
- kwargs['_content_type'] = kwargs.get(
4341
- '_content_type')
4342
- kwargs['_host_index'] = kwargs.get('_host_index')
4343
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4344
- kwargs['id'] = \
4345
- id
4346
- return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
4347
-
4348
4172
  def get_api202110_external_account_creatives_by_account_id(
4349
4173
  self,
4350
4174
  account_id,
@@ -5737,7 +5561,7 @@ class CampaignApi(object):
5737
5561
  async_req (bool): execute request asynchronously
5738
5562
 
5739
5563
  Returns:
5740
- CreativeV2Response
5564
+ Creative2Response
5741
5565
  If the method is called asynchronously, returns the request
5742
5566
  thread.
5743
5567
  """
@@ -5791,7 +5615,7 @@ class CampaignApi(object):
5791
5615
 
5792
5616
  Keyword Args:
5793
5617
  limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional]
5794
- limit_to_type (str): The campaign types that you would like to limit your result set to. [optional]
5618
+ limit_to_type (str, none_type): The campaign types that you would like to limit your result set to. [optional]
5795
5619
  limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
5796
5620
  page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
5797
5621
  page_size (int): The maximum number of items you would like to receive in this request. [optional]
@@ -7844,7 +7668,7 @@ class CampaignApi(object):
7844
7668
  async_req (bool): execute request asynchronously
7845
7669
 
7846
7670
  Returns:
7847
- CreativeV2ListResponse
7671
+ Creative2ListResponse
7848
7672
  If the method is called asynchronously, returns the request
7849
7673
  thread.
7850
7674
  """
@@ -8724,89 +8548,6 @@ class CampaignApi(object):
8724
8548
  id
8725
8549
  return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
8726
8550
 
8727
- def submit_proposal(
8728
- self,
8729
- id,
8730
- **kwargs
8731
- ):
8732
- """submit_proposal # noqa: E501
8733
-
8734
- Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501
8735
- This method makes a synchronous HTTP request by default. To make an
8736
- asynchronous HTTP request, please pass async_req=True
8737
-
8738
- >>> thread = api.submit_proposal(id, async_req=True)
8739
- >>> result = thread.get()
8740
-
8741
- Args:
8742
- id (str): ID of the line item
8743
-
8744
- Keyword Args:
8745
- _return_http_data_only (bool): response data without head status
8746
- code and headers. Default is True.
8747
- _preload_content (bool): if False, the urllib3.HTTPResponse object
8748
- will be returned without reading/decoding response data.
8749
- Default is True.
8750
- _request_timeout (int/float/tuple): timeout setting for this request. If
8751
- one number provided, it will be total request timeout. It can also
8752
- be a pair (tuple) of (connection, read) timeouts.
8753
- Default is None.
8754
- _check_input_type (bool): specifies if type checking
8755
- should be done one the data sent to the server.
8756
- Default is True.
8757
- _check_return_type (bool): specifies if type checking
8758
- should be done one the data received from the server.
8759
- Default is True.
8760
- _spec_property_naming (bool): True if the variable names in the input data
8761
- are serialized names, as specified in the OpenAPI document.
8762
- False if the variable names in the input data
8763
- are pythonic names, e.g. snake case (default)
8764
- _content_type (str/None): force body content-type.
8765
- Default is None and content-type will be predicted by allowed
8766
- content-types and body.
8767
- _host_index (int/None): specifies the index of the server
8768
- that we want to use.
8769
- Default is read from the configuration.
8770
- _request_auths (list): set to override the auth_settings for an a single
8771
- request; this effectively ignores the authentication
8772
- in the spec for a single request.
8773
- Default is None
8774
- async_req (bool): execute request asynchronously
8775
-
8776
- Returns:
8777
- ProposalStatusModelResponse
8778
- If the method is called asynchronously, returns the request
8779
- thread.
8780
- """
8781
- kwargs['async_req'] = kwargs.get(
8782
- 'async_req', False
8783
- )
8784
- kwargs['_return_http_data_only'] = kwargs.get(
8785
- '_return_http_data_only', True
8786
- )
8787
- kwargs['_preload_content'] = kwargs.get(
8788
- '_preload_content', True
8789
- )
8790
- kwargs['_request_timeout'] = kwargs.get(
8791
- '_request_timeout', None
8792
- )
8793
- kwargs['_check_input_type'] = kwargs.get(
8794
- '_check_input_type', True
8795
- )
8796
- kwargs['_check_return_type'] = kwargs.get(
8797
- '_check_return_type', True
8798
- )
8799
- kwargs['_spec_property_naming'] = kwargs.get(
8800
- '_spec_property_naming', False
8801
- )
8802
- kwargs['_content_type'] = kwargs.get(
8803
- '_content_type')
8804
- kwargs['_host_index'] = kwargs.get('_host_index')
8805
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
8806
- kwargs['id'] = \
8807
- id
8808
- return self.submit_proposal_endpoint.call_with_http_info(**kwargs)
8809
-
8810
8551
  def unpause_promoted_products(
8811
8552
  self,
8812
8553
  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.10.0.241029/python'
79
+ self.user_agent = 'OpenAPI-Generator/2024.10.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-10\n"\
398
- "SDK Package Version: 2024.10.0.241029".\
398
+ "SDK Package Version: 2024.10.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