criteo-api-retailmedia-sdk 2024.4.0.241029__py3-none-any.whl → 2024.4.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 (54) hide show
  1. {criteo_api_retailmedia_sdk-2024.4.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250205.dist-info}/METADATA +14 -5
  2. {criteo_api_retailmedia_sdk-2024.4.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250205.dist-info}/RECORD +51 -54
  3. {criteo_api_retailmedia_sdk-2024.4.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250205.dist-info}/WHEEL +1 -1
  4. criteo_api_retailmedia_v2024_04/__init__.py +1 -1
  5. criteo_api_retailmedia_v2024_04/api/accounts_api.py +19 -26
  6. criteo_api_retailmedia_v2024_04/api/campaign_api.py +25 -281
  7. criteo_api_retailmedia_v2024_04/api_client.py +1 -1
  8. criteo_api_retailmedia_v2024_04/configuration.py +1 -1
  9. criteo_api_retailmedia_v2024_04/model/async_campaigns_report.py +44 -0
  10. criteo_api_retailmedia_v2024_04/model/async_line_items_report.py +44 -0
  11. criteo_api_retailmedia_v2024_04/model/async_revenue_report.py +29 -2
  12. criteo_api_retailmedia_v2024_04/model/choice_option.py +1 -8
  13. criteo_api_retailmedia_v2024_04/model/choice_variable_specification.py +1 -8
  14. criteo_api_retailmedia_v2024_04/model/choice_variable_value.py +1 -7
  15. criteo_api_retailmedia_v2024_04/model/color_variable_value.py +7 -19
  16. criteo_api_retailmedia_v2024_04/model/creative202110.py +7 -13
  17. criteo_api_retailmedia_v2024_04/model/creative202110_list_response.py +13 -20
  18. criteo_api_retailmedia_v2024_04/model/creative202210.py +12 -19
  19. criteo_api_retailmedia_v2024_04/model/creative202210_list_response.py +13 -20
  20. criteo_api_retailmedia_v2024_04/model/creative202210_response.py +10 -17
  21. criteo_api_retailmedia_v2024_04/model/creative_create_model202207.py +4 -11
  22. criteo_api_retailmedia_v2024_04/model/creative_update_model202207.py +4 -11
  23. criteo_api_retailmedia_v2024_04/model/{proposal_status_model_resource.py → entity_resource_of_retail_media_account.py} +17 -10
  24. criteo_api_retailmedia_v2024_04/model/{proposal_status_model_response.py → entity_resource_outcome_of_retail_media_account.py} +28 -21
  25. criteo_api_retailmedia_v2024_04/model/{retail_media_account.py → external_retail_media_account.py} +29 -23
  26. criteo_api_retailmedia_v2024_04/model/{retail_media_brand_account_creation.py → external_retail_media_brand_account_creation.py} +18 -12
  27. criteo_api_retailmedia_v2024_04/model/{retail_media_brands.py → external_retail_media_brands.py} +13 -7
  28. criteo_api_retailmedia_v2024_04/model/external_retailer.py +2 -0
  29. criteo_api_retailmedia_v2024_04/model/files_variable_value.py +2 -7
  30. criteo_api_retailmedia_v2024_04/model/files_variables_specification.py +7 -15
  31. criteo_api_retailmedia_v2024_04/model/hyperlink_variable_value.py +7 -19
  32. criteo_api_retailmedia_v2024_04/model/{page_type_environment.py → page_type_environment202210.py} +12 -16
  33. criteo_api_retailmedia_v2024_04/model/resource_of_creative202110.py +6 -13
  34. criteo_api_retailmedia_v2024_04/model/resource_of_creative202210.py +2 -9
  35. criteo_api_retailmedia_v2024_04/model/resource_of_template.py +2 -9
  36. criteo_api_retailmedia_v2024_04/model/section.py +6 -9
  37. criteo_api_retailmedia_v2024_04/model/template.py +13 -24
  38. criteo_api_retailmedia_v2024_04/model/template_list_response.py +13 -20
  39. criteo_api_retailmedia_v2024_04/model/template_response.py +10 -17
  40. criteo_api_retailmedia_v2024_04/model/template_variable.py +1 -8
  41. criteo_api_retailmedia_v2024_04/model/template_variable_value.py +7 -8
  42. criteo_api_retailmedia_v2024_04/model/text_variable_specification.py +2 -8
  43. criteo_api_retailmedia_v2024_04/model/text_variable_value.py +7 -19
  44. criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brand_account_creation.py +8 -1
  45. criteo_api_retailmedia_v2024_04/model/value_resource_input_of_retail_media_brands.py +9 -2
  46. criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brand_account_creation.py +13 -6
  47. criteo_api_retailmedia_v2024_04/model/value_resource_of_retail_media_brands.py +14 -7
  48. criteo_api_retailmedia_v2024_04/model/{resource_outcome_of_retail_media_account.py → value_resource_outcome_of_retail_media_brands.py} +17 -10
  49. criteo_api_retailmedia_v2024_04/model/{resource_of_retail_media_account.py → video_variable_value.py} +39 -22
  50. criteo_api_retailmedia_v2024_04/models/__init__.py +8 -11
  51. criteo_api_retailmedia_v2024_04/model/approval_status_model.py +0 -292
  52. criteo_api_retailmedia_v2024_04/model/negotiation_state_model.py +0 -293
  53. criteo_api_retailmedia_v2024_04/model/proposal_status_model.py +0 -284
  54. {criteo_api_retailmedia_sdk-2024.4.0.241029.dist-info → criteo_api_retailmedia_sdk-2024.4.0.250205.dist-info}/top_level.txt +0 -0
@@ -65,7 +65,6 @@ from criteo_api_retailmedia_v2024_04.model.preferred_line_item_create_model20211
65
65
  from criteo_api_retailmedia_v2024_04.model.preferred_line_item_update_model202110_request import PreferredLineItemUpdateModel202110Request
66
66
  from criteo_api_retailmedia_v2024_04.model.promoted_product202110_list_request import PromotedProduct202110ListRequest
67
67
  from criteo_api_retailmedia_v2024_04.model.promoted_product202110_paged_list_response import PromotedProduct202110PagedListResponse
68
- from criteo_api_retailmedia_v2024_04.model.proposal_status_model_response import ProposalStatusModelResponse
69
68
  from criteo_api_retailmedia_v2024_04.model.put_campaign_v202301 import PutCampaignV202301
70
69
  from criteo_api_retailmedia_v2024_04.model.resource_outcome import ResourceOutcome
71
70
  from criteo_api_retailmedia_v2024_04.model.set_bids_model_request import SetBidsModelRequest
@@ -257,58 +256,6 @@ class CampaignApi(object):
257
256
  },
258
257
  api_client=api_client
259
258
  )
260
- self.fetch_proposal_endpoint = _Endpoint(
261
- settings={
262
- 'response_type': (ProposalStatusModelResponse,),
263
- 'auth': [
264
- 'oauth',
265
- 'oauth'
266
- ],
267
- 'endpoint_path': '/2024-04/retail-media/preferred-deal-line-items/{id}/proposal',
268
- 'operation_id': 'fetch_proposal',
269
- 'http_method': 'GET',
270
- 'servers': None,
271
- },
272
- params_map={
273
- 'all': [
274
- 'id',
275
- ],
276
- 'required': [
277
- 'id',
278
- ],
279
- 'nullable': [
280
- ],
281
- 'enum': [
282
- ],
283
- 'validation': [
284
- ]
285
- },
286
- root_map={
287
- 'validations': {
288
- },
289
- 'allowed_values': {
290
- },
291
- 'openapi_types': {
292
- 'id':
293
- (str,),
294
- },
295
- 'attribute_map': {
296
- 'id': 'id',
297
- },
298
- 'location_map': {
299
- 'id': 'path',
300
- },
301
- 'collection_format_map': {
302
- }
303
- },
304
- headers_map={
305
- 'accept': [
306
- 'application/json'
307
- ],
308
- 'content_type': [],
309
- },
310
- api_client=api_client
311
- )
312
259
  self.get_api202110_external_account_creatives_by_account_id_endpoint = _Endpoint(
313
260
  settings={
314
261
  'response_type': (Creative202110ListResponse,),
@@ -355,7 +302,9 @@ class CampaignApi(object):
355
302
  },
356
303
  headers_map={
357
304
  'accept': [
358
- 'application/json'
305
+ 'text/plain',
306
+ 'application/json',
307
+ 'text/json'
359
308
  ],
360
309
  'content_type': [],
361
310
  },
@@ -990,7 +939,9 @@ class CampaignApi(object):
990
939
  },
991
940
  headers_map={
992
941
  'accept': [
993
- 'application/json'
942
+ 'text/plain',
943
+ 'application/json',
944
+ 'text/json'
994
945
  ],
995
946
  'content_type': [],
996
947
  },
@@ -1042,7 +993,9 @@ class CampaignApi(object):
1042
993
  },
1043
994
  headers_map={
1044
995
  'accept': [
1045
- 'application/json'
996
+ 'text/plain',
997
+ 'application/json',
998
+ 'text/json'
1046
999
  ],
1047
1000
  'content_type': [],
1048
1001
  },
@@ -1100,7 +1053,9 @@ class CampaignApi(object):
1100
1053
  },
1101
1054
  headers_map={
1102
1055
  'accept': [
1103
- 'application/json'
1056
+ 'text/plain',
1057
+ 'application/json',
1058
+ 'text/json'
1104
1059
  ],
1105
1060
  'content_type': [],
1106
1061
  },
@@ -1550,6 +1505,7 @@ class CampaignApi(object):
1550
1505
  'account_id',
1551
1506
  ],
1552
1507
  'nullable': [
1508
+ 'limit_to_type',
1553
1509
  ],
1554
1510
  'enum': [
1555
1511
  'limit_to_type',
@@ -1562,7 +1518,7 @@ class CampaignApi(object):
1562
1518
  },
1563
1519
  'allowed_values': {
1564
1520
  ('limit_to_type',): {
1565
-
1521
+ 'None': None,
1566
1522
  "UNKNOWN": "Unknown",
1567
1523
  "AUCTION": "Auction",
1568
1524
  "PREFERRED": "Preferred"
@@ -1574,7 +1530,7 @@ class CampaignApi(object):
1574
1530
  'limit_to_campaign_id':
1575
1531
  ([str],),
1576
1532
  'limit_to_type':
1577
- (str,),
1533
+ (str, none_type,),
1578
1534
  'limit_to_id':
1579
1535
  ([str],),
1580
1536
  'page_index':
@@ -2882,7 +2838,9 @@ class CampaignApi(object):
2882
2838
  },
2883
2839
  headers_map={
2884
2840
  'accept': [
2885
- 'application/json'
2841
+ 'text/plain',
2842
+ 'application/json',
2843
+ 'text/json'
2886
2844
  ],
2887
2845
  'content_type': [
2888
2846
  'application/json'
@@ -2942,7 +2900,9 @@ class CampaignApi(object):
2942
2900
  },
2943
2901
  headers_map={
2944
2902
  'accept': [
2945
- 'application/json'
2903
+ 'text/plain',
2904
+ 'application/json',
2905
+ 'text/json'
2946
2906
  ],
2947
2907
  'content_type': [],
2948
2908
  },
@@ -3410,7 +3370,9 @@ class CampaignApi(object):
3410
3370
  },
3411
3371
  headers_map={
3412
3372
  'accept': [
3413
- 'application/json'
3373
+ 'text/plain',
3374
+ 'application/json',
3375
+ 'text/json'
3414
3376
  ],
3415
3377
  'content_type': [
3416
3378
  'application/json'
@@ -3652,58 +3614,6 @@ class CampaignApi(object):
3652
3614
  },
3653
3615
  api_client=api_client
3654
3616
  )
3655
- self.submit_proposal_endpoint = _Endpoint(
3656
- settings={
3657
- 'response_type': (ProposalStatusModelResponse,),
3658
- 'auth': [
3659
- 'oauth',
3660
- 'oauth'
3661
- ],
3662
- 'endpoint_path': '/2024-04/retail-media/preferred-deal-line-items/{id}/proposal/submit',
3663
- 'operation_id': 'submit_proposal',
3664
- 'http_method': 'POST',
3665
- 'servers': None,
3666
- },
3667
- params_map={
3668
- 'all': [
3669
- 'id',
3670
- ],
3671
- 'required': [
3672
- 'id',
3673
- ],
3674
- 'nullable': [
3675
- ],
3676
- 'enum': [
3677
- ],
3678
- 'validation': [
3679
- ]
3680
- },
3681
- root_map={
3682
- 'validations': {
3683
- },
3684
- 'allowed_values': {
3685
- },
3686
- 'openapi_types': {
3687
- 'id':
3688
- (str,),
3689
- },
3690
- 'attribute_map': {
3691
- 'id': 'id',
3692
- },
3693
- 'location_map': {
3694
- 'id': 'path',
3695
- },
3696
- 'collection_format_map': {
3697
- }
3698
- },
3699
- headers_map={
3700
- 'accept': [
3701
- 'application/json'
3702
- ],
3703
- 'content_type': [],
3704
- },
3705
- api_client=api_client
3706
- )
3707
3617
  self.update_campaign_budget_overrides_endpoint = _Endpoint(
3708
3618
  settings={
3709
3619
  'response_type': (ValueResourceOutcomeOfCampaignBudgetOverrides,),
@@ -4077,89 +3987,6 @@ class CampaignApi(object):
4077
3987
  id
4078
3988
  return self.fetch_keywords_endpoint.call_with_http_info(**kwargs)
4079
3989
 
4080
- def fetch_proposal(
4081
- self,
4082
- id,
4083
- **kwargs
4084
- ):
4085
- """fetch_proposal # noqa: E501
4086
-
4087
- 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
4088
- This method makes a synchronous HTTP request by default. To make an
4089
- asynchronous HTTP request, please pass async_req=True
4090
-
4091
- >>> thread = api.fetch_proposal(id, async_req=True)
4092
- >>> result = thread.get()
4093
-
4094
- Args:
4095
- id (str): ID of the line item
4096
-
4097
- Keyword Args:
4098
- _return_http_data_only (bool): response data without head status
4099
- code and headers. Default is True.
4100
- _preload_content (bool): if False, the urllib3.HTTPResponse object
4101
- will be returned without reading/decoding response data.
4102
- Default is True.
4103
- _request_timeout (int/float/tuple): timeout setting for this request. If
4104
- one number provided, it will be total request timeout. It can also
4105
- be a pair (tuple) of (connection, read) timeouts.
4106
- Default is None.
4107
- _check_input_type (bool): specifies if type checking
4108
- should be done one the data sent to the server.
4109
- Default is True.
4110
- _check_return_type (bool): specifies if type checking
4111
- should be done one the data received from the server.
4112
- Default is True.
4113
- _spec_property_naming (bool): True if the variable names in the input data
4114
- are serialized names, as specified in the OpenAPI document.
4115
- False if the variable names in the input data
4116
- are pythonic names, e.g. snake case (default)
4117
- _content_type (str/None): force body content-type.
4118
- Default is None and content-type will be predicted by allowed
4119
- content-types and body.
4120
- _host_index (int/None): specifies the index of the server
4121
- that we want to use.
4122
- Default is read from the configuration.
4123
- _request_auths (list): set to override the auth_settings for an a single
4124
- request; this effectively ignores the authentication
4125
- in the spec for a single request.
4126
- Default is None
4127
- async_req (bool): execute request asynchronously
4128
-
4129
- Returns:
4130
- ProposalStatusModelResponse
4131
- If the method is called asynchronously, returns the request
4132
- thread.
4133
- """
4134
- kwargs['async_req'] = kwargs.get(
4135
- 'async_req', False
4136
- )
4137
- kwargs['_return_http_data_only'] = kwargs.get(
4138
- '_return_http_data_only', True
4139
- )
4140
- kwargs['_preload_content'] = kwargs.get(
4141
- '_preload_content', True
4142
- )
4143
- kwargs['_request_timeout'] = kwargs.get(
4144
- '_request_timeout', None
4145
- )
4146
- kwargs['_check_input_type'] = kwargs.get(
4147
- '_check_input_type', True
4148
- )
4149
- kwargs['_check_return_type'] = kwargs.get(
4150
- '_check_return_type', True
4151
- )
4152
- kwargs['_spec_property_naming'] = kwargs.get(
4153
- '_spec_property_naming', False
4154
- )
4155
- kwargs['_content_type'] = kwargs.get(
4156
- '_content_type')
4157
- kwargs['_host_index'] = kwargs.get('_host_index')
4158
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4159
- kwargs['id'] = \
4160
- id
4161
- return self.fetch_proposal_endpoint.call_with_http_info(**kwargs)
4162
-
4163
3990
  def get_api202110_external_account_creatives_by_account_id(
4164
3991
  self,
4165
3992
  account_id,
@@ -5944,7 +5771,7 @@ class CampaignApi(object):
5944
5771
 
5945
5772
  Keyword Args:
5946
5773
  limit_to_campaign_id ([str]): The campaign ids that you would like to limit your result set to. [optional]
5947
- limit_to_type (str): The campaign types that you would like to limit your result set to. [optional]
5774
+ limit_to_type (str, none_type): The campaign types that you would like to limit your result set to. [optional]
5948
5775
  limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
5949
5776
  page_index (int): The 0 indexed page index you would like to receive given the page size. [optional]
5950
5777
  page_size (int): The maximum number of items you would like to receive in this request. [optional]
@@ -8957,89 +8784,6 @@ class CampaignApi(object):
8957
8784
  id
8958
8785
  return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
8959
8786
 
8960
- def submit_proposal(
8961
- self,
8962
- id,
8963
- **kwargs
8964
- ):
8965
- """submit_proposal # noqa: E501
8966
-
8967
- Only the components of the Line Item that are in a valid state will be reviewed. # noqa: E501
8968
- This method makes a synchronous HTTP request by default. To make an
8969
- asynchronous HTTP request, please pass async_req=True
8970
-
8971
- >>> thread = api.submit_proposal(id, async_req=True)
8972
- >>> result = thread.get()
8973
-
8974
- Args:
8975
- id (str): ID of the line item
8976
-
8977
- Keyword Args:
8978
- _return_http_data_only (bool): response data without head status
8979
- code and headers. Default is True.
8980
- _preload_content (bool): if False, the urllib3.HTTPResponse object
8981
- will be returned without reading/decoding response data.
8982
- Default is True.
8983
- _request_timeout (int/float/tuple): timeout setting for this request. If
8984
- one number provided, it will be total request timeout. It can also
8985
- be a pair (tuple) of (connection, read) timeouts.
8986
- Default is None.
8987
- _check_input_type (bool): specifies if type checking
8988
- should be done one the data sent to the server.
8989
- Default is True.
8990
- _check_return_type (bool): specifies if type checking
8991
- should be done one the data received from the server.
8992
- Default is True.
8993
- _spec_property_naming (bool): True if the variable names in the input data
8994
- are serialized names, as specified in the OpenAPI document.
8995
- False if the variable names in the input data
8996
- are pythonic names, e.g. snake case (default)
8997
- _content_type (str/None): force body content-type.
8998
- Default is None and content-type will be predicted by allowed
8999
- content-types and body.
9000
- _host_index (int/None): specifies the index of the server
9001
- that we want to use.
9002
- Default is read from the configuration.
9003
- _request_auths (list): set to override the auth_settings for an a single
9004
- request; this effectively ignores the authentication
9005
- in the spec for a single request.
9006
- Default is None
9007
- async_req (bool): execute request asynchronously
9008
-
9009
- Returns:
9010
- ProposalStatusModelResponse
9011
- If the method is called asynchronously, returns the request
9012
- thread.
9013
- """
9014
- kwargs['async_req'] = kwargs.get(
9015
- 'async_req', False
9016
- )
9017
- kwargs['_return_http_data_only'] = kwargs.get(
9018
- '_return_http_data_only', True
9019
- )
9020
- kwargs['_preload_content'] = kwargs.get(
9021
- '_preload_content', True
9022
- )
9023
- kwargs['_request_timeout'] = kwargs.get(
9024
- '_request_timeout', None
9025
- )
9026
- kwargs['_check_input_type'] = kwargs.get(
9027
- '_check_input_type', True
9028
- )
9029
- kwargs['_check_return_type'] = kwargs.get(
9030
- '_check_return_type', True
9031
- )
9032
- kwargs['_spec_property_naming'] = kwargs.get(
9033
- '_spec_property_naming', False
9034
- )
9035
- kwargs['_content_type'] = kwargs.get(
9036
- '_content_type')
9037
- kwargs['_host_index'] = kwargs.get('_host_index')
9038
- kwargs['_request_auths'] = kwargs.get('_request_auths', None)
9039
- kwargs['id'] = \
9040
- id
9041
- return self.submit_proposal_endpoint.call_with_http_info(**kwargs)
9042
-
9043
8787
  def update_campaign_budget_overrides(
9044
8788
  self,
9045
8789
  campaign_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.04.0.241029/python'
79
+ self.user_agent = 'OpenAPI-Generator/2024.04.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-04\n"\
398
- "SDK Package Version: 2024.04.0.241029".\
398
+ "SDK Package Version: 2024.04.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