criteo-api-retailmedia-sdk 0.0.250915__py3-none-any.whl → 0.0.251014__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 (34) hide show
  1. criteo_api_retailmedia_preview/__init__.py +1 -1
  2. criteo_api_retailmedia_preview/api/accounts_api.py +70 -73
  3. criteo_api_retailmedia_preview/api/analytics_api.py +137 -0
  4. criteo_api_retailmedia_preview/api/audience_api.py +12 -12
  5. criteo_api_retailmedia_preview/api/billing_api.py +18 -18
  6. criteo_api_retailmedia_preview/api/campaign_api.py +493 -325
  7. criteo_api_retailmedia_preview/api_client.py +4 -4
  8. criteo_api_retailmedia_preview/configuration.py +1 -1
  9. criteo_api_retailmedia_preview/model/async_fill_rate_report.py +5 -0
  10. criteo_api_retailmedia_preview/model/async_unfilled_placements_report.py +392 -0
  11. criteo_api_retailmedia_preview/model/async_unfilled_placements_report_request.py +269 -0
  12. criteo_api_retailmedia_preview/model/async_unfilled_placements_report_resource.py +273 -0
  13. criteo_api_retailmedia_preview/model/campaign_availability.py +289 -0
  14. criteo_api_retailmedia_preview/model/demand_managed_fee.py +1 -1
  15. criteo_api_retailmedia_preview/model/{value_resource_outcome_account_fees_update_result.py → entity_resource_collection_outcome_of_retailer_result_and_metadata.py} +14 -8
  16. criteo_api_retailmedia_preview/model/entity_resource_of_retailer_result.py +270 -0
  17. criteo_api_retailmedia_preview/model/files_variable_value.py +0 -3
  18. criteo_api_retailmedia_preview/model/managed_service_fee.py +1 -1
  19. criteo_api_retailmedia_preview/model/page_type_combination.py +287 -0
  20. criteo_api_retailmedia_preview/model/private_market_fees.py +6 -14
  21. criteo_api_retailmedia_preview/model/retailer_result.py +266 -0
  22. criteo_api_retailmedia_preview/model/{account_fees_update_result.py → retailer_search_request.py} +8 -12
  23. criteo_api_retailmedia_preview/model/rm_contact_list_create_v1.py +1 -0
  24. criteo_api_retailmedia_preview/model/rm_contact_list_v1.py +1 -0
  25. criteo_api_retailmedia_preview/model/sponsored_products_line_item.py +11 -2
  26. criteo_api_retailmedia_preview/model/sponsored_products_line_item_create_request_model.py +8 -0
  27. criteo_api_retailmedia_preview/model/sponsored_products_line_item_update_request_model.py +34 -28
  28. criteo_api_retailmedia_preview/model/value_resource_input_of_retailer_search_request.py +262 -0
  29. criteo_api_retailmedia_preview/model/{value_resource_account_fees_update_result.py → value_resource_of_retailer_search_request.py} +9 -9
  30. criteo_api_retailmedia_preview/models/__init__.py +11 -3
  31. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/METADATA +3 -3
  32. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/RECORD +34 -26
  33. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/WHEEL +0 -0
  34. {criteo_api_retailmedia_sdk-0.0.250915.dist-info → criteo_api_retailmedia_sdk-0.0.251014.dist-info}/top_level.txt +0 -0
@@ -32,6 +32,7 @@ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_bra
32
32
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204 import EntityResourceCollectionOutcomeCategory202204
33
33
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_category202204_metadata import EntityResourceCollectionOutcomeCategory202204Metadata
34
34
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_line_item_keyword_review_report_and_metadata import EntityResourceCollectionOutcomeLineItemKeywordReviewReportAndMetadata
35
+ from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_retailer_result_and_metadata import EntityResourceCollectionOutcomeOfRetailerResultAndMetadata
35
36
  from criteo_api_retailmedia_preview.model.entity_resource_collection_outcome_of_sponsored_products_line_item_and_metadata import EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
36
37
  from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_catalog_status_v2 import EntityResourceOutcomeOfCatalogStatusV2
37
38
  from criteo_api_retailmedia_preview.model.entity_resource_outcome_of_sponsored_products_line_item import EntityResourceOutcomeOfSponsoredProductsLineItem
@@ -55,6 +56,7 @@ from criteo_api_retailmedia_preview.model.sku_search_request_preview_request imp
55
56
  from criteo_api_retailmedia_preview.model.value_resource_input_brand_id_search_request import ValueResourceInputBrandIdSearchRequest
56
57
  from criteo_api_retailmedia_preview.model.value_resource_input_categories_search_request_v1 import ValueResourceInputCategoriesSearchRequestV1
57
58
  from criteo_api_retailmedia_preview.model.value_resource_input_of_brand_catalog_request_v2 import ValueResourceInputOfBrandCatalogRequestV2
59
+ from criteo_api_retailmedia_preview.model.value_resource_input_of_retailer_search_request import ValueResourceInputOfRetailerSearchRequest
58
60
  from criteo_api_retailmedia_preview.model.value_resource_input_of_seller_catalog_request_v2 import ValueResourceInputOfSellerCatalogRequestV2
59
61
  from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_products_line_item_create_request_model import ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel
60
62
  from criteo_api_retailmedia_preview.model.value_resource_input_of_sponsored_products_line_item_update_request_model import ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel
@@ -309,6 +311,64 @@ class CampaignApi(object):
309
311
  },
310
312
  api_client=api_client
311
313
  )
314
+ self.create_creative_endpoint = _Endpoint(
315
+ settings={
316
+ 'response_type': (Creative2Response,),
317
+ 'auth': [
318
+ 'oauth',
319
+ 'oauth'
320
+ ],
321
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives',
322
+ 'operation_id': 'create_creative',
323
+ 'http_method': 'POST',
324
+ 'servers': None,
325
+ },
326
+ params_map={
327
+ 'all': [
328
+ 'account_id',
329
+ 'creative_create_model2',
330
+ ],
331
+ 'required': [
332
+ 'account_id',
333
+ ],
334
+ 'nullable': [
335
+ ],
336
+ 'enum': [
337
+ ],
338
+ 'validation': [
339
+ ]
340
+ },
341
+ root_map={
342
+ 'validations': {
343
+ },
344
+ 'allowed_values': {
345
+ },
346
+ 'openapi_types': {
347
+ 'account_id':
348
+ (str,),
349
+ 'creative_create_model2':
350
+ (CreativeCreateModel2,),
351
+ },
352
+ 'attribute_map': {
353
+ 'account_id': 'account-id',
354
+ },
355
+ 'location_map': {
356
+ 'account_id': 'path',
357
+ 'creative_create_model2': 'body',
358
+ },
359
+ 'collection_format_map': {
360
+ }
361
+ },
362
+ headers_map={
363
+ 'accept': [
364
+ 'application/json'
365
+ ],
366
+ 'content_type': [
367
+ 'application/json'
368
+ ]
369
+ },
370
+ api_client=api_client
371
+ )
312
372
  self.create_preferred_line_item_by_campaign_id_endpoint = _Endpoint(
313
373
  settings={
314
374
  'response_type': (PreferredLineItemV2Response,),
@@ -896,64 +956,6 @@ class CampaignApi(object):
896
956
  },
897
957
  api_client=api_client
898
958
  )
899
- self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
900
- settings={
901
- 'response_type': (Creative2Response,),
902
- 'auth': [
903
- 'oauth',
904
- 'oauth'
905
- ],
906
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
907
- 'operation_id': 'get_api_v2_external_account_by_account_id_creativescreative_id',
908
- 'http_method': 'GET',
909
- 'servers': None,
910
- },
911
- params_map={
912
- 'all': [
913
- 'account_id',
914
- 'creative_id',
915
- ],
916
- 'required': [
917
- 'account_id',
918
- 'creative_id',
919
- ],
920
- 'nullable': [
921
- ],
922
- 'enum': [
923
- ],
924
- 'validation': [
925
- ]
926
- },
927
- root_map={
928
- 'validations': {
929
- },
930
- 'allowed_values': {
931
- },
932
- 'openapi_types': {
933
- 'account_id':
934
- (str,),
935
- 'creative_id':
936
- (str,),
937
- },
938
- 'attribute_map': {
939
- 'account_id': 'account-id',
940
- 'creative_id': 'creative-id',
941
- },
942
- 'location_map': {
943
- 'account_id': 'path',
944
- 'creative_id': 'path',
945
- },
946
- 'collection_format_map': {
947
- }
948
- },
949
- headers_map={
950
- 'accept': [
951
- 'application/json'
952
- ],
953
- 'content_type': [],
954
- },
955
- api_client=api_client
956
- )
957
959
  self.get_auction_line_item_v2_endpoint = _Endpoint(
958
960
  settings={
959
961
  'response_type': (EntityResourceOutcomeOfSponsoredProductsLineItem,),
@@ -1086,6 +1088,64 @@ class CampaignApi(object):
1086
1088
  },
1087
1089
  api_client=api_client
1088
1090
  )
1091
+ self.get_creative_endpoint = _Endpoint(
1092
+ settings={
1093
+ 'response_type': (Creative2Response,),
1094
+ 'auth': [
1095
+ 'oauth',
1096
+ 'oauth'
1097
+ ],
1098
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
1099
+ 'operation_id': 'get_creative',
1100
+ 'http_method': 'GET',
1101
+ 'servers': None,
1102
+ },
1103
+ params_map={
1104
+ 'all': [
1105
+ 'account_id',
1106
+ 'creative_id',
1107
+ ],
1108
+ 'required': [
1109
+ 'account_id',
1110
+ 'creative_id',
1111
+ ],
1112
+ 'nullable': [
1113
+ ],
1114
+ 'enum': [
1115
+ ],
1116
+ 'validation': [
1117
+ ]
1118
+ },
1119
+ root_map={
1120
+ 'validations': {
1121
+ },
1122
+ 'allowed_values': {
1123
+ },
1124
+ 'openapi_types': {
1125
+ 'account_id':
1126
+ (str,),
1127
+ 'creative_id':
1128
+ (str,),
1129
+ },
1130
+ 'attribute_map': {
1131
+ 'account_id': 'account-id',
1132
+ 'creative_id': 'creative-id',
1133
+ },
1134
+ 'location_map': {
1135
+ 'account_id': 'path',
1136
+ 'creative_id': 'path',
1137
+ },
1138
+ 'collection_format_map': {
1139
+ }
1140
+ },
1141
+ headers_map={
1142
+ 'accept': [
1143
+ 'application/json'
1144
+ ],
1145
+ 'content_type': [],
1146
+ },
1147
+ api_client=api_client
1148
+ )
1089
1149
  self.get_preferred_line_items_by_campaign_id_endpoint = _Endpoint(
1090
1150
  settings={
1091
1151
  'response_type': (PreferredLineItemV2PagedListResponse,),
@@ -1784,25 +1844,25 @@ class CampaignApi(object):
1784
1844
  },
1785
1845
  api_client=api_client
1786
1846
  )
1787
- self.post_api_v2_external_account_creatives_by_account_id_endpoint = _Endpoint(
1847
+ self.recommended_keywords_endpoint = _Endpoint(
1788
1848
  settings={
1789
- 'response_type': (Creative2Response,),
1849
+ 'response_type': (ValueResourceOutcomeRecommendedKeywordsResponseV1,),
1790
1850
  'auth': [
1791
1851
  'oauth',
1792
1852
  'oauth'
1793
1853
  ],
1794
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives',
1795
- 'operation_id': 'post_api_v2_external_account_creatives_by_account_id',
1854
+ 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-keywords',
1855
+ 'operation_id': 'recommended_keywords',
1796
1856
  'http_method': 'POST',
1797
1857
  'servers': None,
1798
1858
  },
1799
1859
  params_map={
1800
1860
  'all': [
1801
- 'account_id',
1802
- 'creative_create_model2',
1861
+ 'retailer_id',
1862
+ 'value_resource_input_recommended_keywords_request_v1',
1803
1863
  ],
1804
1864
  'required': [
1805
- 'account_id',
1865
+ 'retailer_id',
1806
1866
  ],
1807
1867
  'nullable': [
1808
1868
  ],
@@ -1817,17 +1877,17 @@ class CampaignApi(object):
1817
1877
  'allowed_values': {
1818
1878
  },
1819
1879
  'openapi_types': {
1820
- 'account_id':
1880
+ 'retailer_id':
1821
1881
  (str,),
1822
- 'creative_create_model2':
1823
- (CreativeCreateModel2,),
1882
+ 'value_resource_input_recommended_keywords_request_v1':
1883
+ (ValueResourceInputRecommendedKeywordsRequestV1,),
1824
1884
  },
1825
1885
  'attribute_map': {
1826
- 'account_id': 'account-id',
1886
+ 'retailer_id': 'retailerId',
1827
1887
  },
1828
1888
  'location_map': {
1829
- 'account_id': 'path',
1830
- 'creative_create_model2': 'body',
1889
+ 'retailer_id': 'path',
1890
+ 'value_resource_input_recommended_keywords_request_v1': 'body',
1831
1891
  },
1832
1892
  'collection_format_map': {
1833
1893
  }
@@ -1842,7 +1902,7 @@ class CampaignApi(object):
1842
1902
  },
1843
1903
  api_client=api_client
1844
1904
  )
1845
- self.post_api_v2_external_account_creatives_search_by_account_id_endpoint = _Endpoint(
1905
+ self.search_account_creatives_endpoint = _Endpoint(
1846
1906
  settings={
1847
1907
  'response_type': (Creative2ListResponse,),
1848
1908
  'auth': [
@@ -1850,7 +1910,7 @@ class CampaignApi(object):
1850
1910
  'oauth'
1851
1911
  ],
1852
1912
  'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/search',
1853
- 'operation_id': 'post_api_v2_external_account_creatives_search_by_account_id',
1913
+ 'operation_id': 'search_account_creatives',
1854
1914
  'http_method': 'POST',
1855
1915
  'servers': None,
1856
1916
  },
@@ -1900,56 +1960,65 @@ class CampaignApi(object):
1900
1960
  },
1901
1961
  api_client=api_client
1902
1962
  )
1903
- self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint = _Endpoint(
1963
+ self.search_brands_endpoint = _Endpoint(
1904
1964
  settings={
1905
- 'response_type': (Creative2Response,),
1965
+ 'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata,),
1906
1966
  'auth': [
1907
1967
  'oauth',
1908
1968
  'oauth'
1909
1969
  ],
1910
- 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
1911
- 'operation_id': 'put_api_v2_external_account_by_account_id_creativescreative_id',
1912
- 'http_method': 'PUT',
1970
+ 'endpoint_path': '/preview/retail-media/brands/search',
1971
+ 'operation_id': 'search_brands',
1972
+ 'http_method': 'POST',
1913
1973
  'servers': None,
1914
1974
  },
1915
1975
  params_map={
1916
1976
  'all': [
1917
- 'account_id',
1918
- 'creative_id',
1919
- 'creative_update_model2',
1920
- ],
1921
- 'required': [
1922
- 'account_id',
1923
- 'creative_id',
1977
+ 'limit',
1978
+ 'offset',
1979
+ 'value_resource_input_brand_id_search_request',
1924
1980
  ],
1981
+ 'required': [],
1925
1982
  'nullable': [
1926
1983
  ],
1927
1984
  'enum': [
1928
1985
  ],
1929
1986
  'validation': [
1987
+ 'limit',
1988
+ 'offset',
1930
1989
  ]
1931
1990
  },
1932
1991
  root_map={
1933
1992
  'validations': {
1993
+ ('limit',): {
1994
+
1995
+ 'inclusive_maximum': 100,
1996
+ 'inclusive_minimum': 1,
1997
+ },
1998
+ ('offset',): {
1999
+
2000
+ 'inclusive_maximum': 2147483647,
2001
+ 'inclusive_minimum': 0,
2002
+ },
1934
2003
  },
1935
2004
  'allowed_values': {
1936
2005
  },
1937
2006
  'openapi_types': {
1938
- 'account_id':
1939
- (str,),
1940
- 'creative_id':
1941
- (str,),
1942
- 'creative_update_model2':
1943
- (CreativeUpdateModel2,),
2007
+ 'limit':
2008
+ (int,),
2009
+ 'offset':
2010
+ (int,),
2011
+ 'value_resource_input_brand_id_search_request':
2012
+ (ValueResourceInputBrandIdSearchRequest,),
1944
2013
  },
1945
2014
  'attribute_map': {
1946
- 'account_id': 'account-id',
1947
- 'creative_id': 'creative-id',
2015
+ 'limit': 'limit',
2016
+ 'offset': 'offset',
1948
2017
  },
1949
2018
  'location_map': {
1950
- 'account_id': 'path',
1951
- 'creative_id': 'path',
1952
- 'creative_update_model2': 'body',
2019
+ 'limit': 'query',
2020
+ 'offset': 'query',
2021
+ 'value_resource_input_brand_id_search_request': 'body',
1953
2022
  },
1954
2023
  'collection_format_map': {
1955
2024
  }
@@ -1964,22 +2033,24 @@ class CampaignApi(object):
1964
2033
  },
1965
2034
  api_client=api_client
1966
2035
  )
1967
- self.recommended_keywords_endpoint = _Endpoint(
2036
+ self.search_category_endpoint = _Endpoint(
1968
2037
  settings={
1969
- 'response_type': (ValueResourceOutcomeRecommendedKeywordsResponseV1,),
2038
+ 'response_type': (EntityResourceCollectionOutcomeCategory202204Metadata,),
1970
2039
  'auth': [
1971
2040
  'oauth',
1972
2041
  'oauth'
1973
2042
  ],
1974
- 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/recommend-keywords',
1975
- 'operation_id': 'recommended_keywords',
2043
+ 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/categories/search',
2044
+ 'operation_id': 'search_category',
1976
2045
  'http_method': 'POST',
1977
2046
  'servers': None,
1978
2047
  },
1979
2048
  params_map={
1980
2049
  'all': [
1981
2050
  'retailer_id',
1982
- 'value_resource_input_recommended_keywords_request_v1',
2051
+ 'limit',
2052
+ 'offset',
2053
+ 'value_resource_input_categories_search_request_v1',
1983
2054
  ],
1984
2055
  'required': [
1985
2056
  'retailer_id',
@@ -1988,63 +2059,6 @@ class CampaignApi(object):
1988
2059
  ],
1989
2060
  'enum': [
1990
2061
  ],
1991
- 'validation': [
1992
- ]
1993
- },
1994
- root_map={
1995
- 'validations': {
1996
- },
1997
- 'allowed_values': {
1998
- },
1999
- 'openapi_types': {
2000
- 'retailer_id':
2001
- (str,),
2002
- 'value_resource_input_recommended_keywords_request_v1':
2003
- (ValueResourceInputRecommendedKeywordsRequestV1,),
2004
- },
2005
- 'attribute_map': {
2006
- 'retailer_id': 'retailerId',
2007
- },
2008
- 'location_map': {
2009
- 'retailer_id': 'path',
2010
- 'value_resource_input_recommended_keywords_request_v1': 'body',
2011
- },
2012
- 'collection_format_map': {
2013
- }
2014
- },
2015
- headers_map={
2016
- 'accept': [
2017
- 'application/json'
2018
- ],
2019
- 'content_type': [
2020
- 'application/json'
2021
- ]
2022
- },
2023
- api_client=api_client
2024
- )
2025
- self.search_brands_endpoint = _Endpoint(
2026
- settings={
2027
- 'response_type': (EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata,),
2028
- 'auth': [
2029
- 'oauth',
2030
- 'oauth'
2031
- ],
2032
- 'endpoint_path': '/preview/retail-media/brands/search',
2033
- 'operation_id': 'search_brands',
2034
- 'http_method': 'POST',
2035
- 'servers': None,
2036
- },
2037
- params_map={
2038
- 'all': [
2039
- 'limit',
2040
- 'offset',
2041
- 'value_resource_input_brand_id_search_request',
2042
- ],
2043
- 'required': [],
2044
- 'nullable': [
2045
- ],
2046
- 'enum': [
2047
- ],
2048
2062
  'validation': [
2049
2063
  'limit',
2050
2064
  'offset',
@@ -2054,7 +2068,7 @@ class CampaignApi(object):
2054
2068
  'validations': {
2055
2069
  ('limit',): {
2056
2070
 
2057
- 'inclusive_maximum': 100,
2071
+ 'inclusive_maximum': 500,
2058
2072
  'inclusive_minimum': 1,
2059
2073
  },
2060
2074
  ('offset',): {
@@ -2066,21 +2080,25 @@ class CampaignApi(object):
2066
2080
  'allowed_values': {
2067
2081
  },
2068
2082
  'openapi_types': {
2083
+ 'retailer_id':
2084
+ (int,),
2069
2085
  'limit':
2070
2086
  (int,),
2071
2087
  'offset':
2072
2088
  (int,),
2073
- 'value_resource_input_brand_id_search_request':
2074
- (ValueResourceInputBrandIdSearchRequest,),
2089
+ 'value_resource_input_categories_search_request_v1':
2090
+ (ValueResourceInputCategoriesSearchRequestV1,),
2075
2091
  },
2076
2092
  'attribute_map': {
2093
+ 'retailer_id': 'retailerId',
2077
2094
  'limit': 'limit',
2078
2095
  'offset': 'offset',
2079
2096
  },
2080
2097
  'location_map': {
2098
+ 'retailer_id': 'path',
2081
2099
  'limit': 'query',
2082
2100
  'offset': 'query',
2083
- 'value_resource_input_brand_id_search_request': 'body',
2101
+ 'value_resource_input_categories_search_request_v1': 'body',
2084
2102
  },
2085
2103
  'collection_format_map': {
2086
2104
  }
@@ -2095,27 +2113,27 @@ class CampaignApi(object):
2095
2113
  },
2096
2114
  api_client=api_client
2097
2115
  )
2098
- self.search_category_endpoint = _Endpoint(
2116
+ self.search_retailers_v1_endpoint = _Endpoint(
2099
2117
  settings={
2100
- 'response_type': (EntityResourceCollectionOutcomeCategory202204Metadata,),
2118
+ 'response_type': (EntityResourceCollectionOutcomeOfRetailerResultAndMetadata,),
2101
2119
  'auth': [
2102
2120
  'oauth',
2103
2121
  'oauth'
2104
2122
  ],
2105
- 'endpoint_path': '/preview/retail-media/retailers/{retailerId}/categories/search',
2106
- 'operation_id': 'search_category',
2123
+ 'endpoint_path': '/preview/retail-media/accounts/{accountId}/retailers/search',
2124
+ 'operation_id': 'search_retailers_v1',
2107
2125
  'http_method': 'POST',
2108
2126
  'servers': None,
2109
2127
  },
2110
2128
  params_map={
2111
2129
  'all': [
2112
- 'retailer_id',
2130
+ 'account_id',
2113
2131
  'limit',
2114
2132
  'offset',
2115
- 'value_resource_input_categories_search_request_v1',
2133
+ 'value_resource_input_of_retailer_search_request',
2116
2134
  ],
2117
2135
  'required': [
2118
- 'retailer_id',
2136
+ 'account_id',
2119
2137
  ],
2120
2138
  'nullable': [
2121
2139
  ],
@@ -2130,7 +2148,7 @@ class CampaignApi(object):
2130
2148
  'validations': {
2131
2149
  ('limit',): {
2132
2150
 
2133
- 'inclusive_maximum': 500,
2151
+ 'inclusive_maximum': 10,
2134
2152
  'inclusive_minimum': 1,
2135
2153
  },
2136
2154
  ('offset',): {
@@ -2142,25 +2160,25 @@ class CampaignApi(object):
2142
2160
  'allowed_values': {
2143
2161
  },
2144
2162
  'openapi_types': {
2145
- 'retailer_id':
2146
- (int,),
2163
+ 'account_id':
2164
+ (str,),
2147
2165
  'limit':
2148
2166
  (int,),
2149
2167
  'offset':
2150
2168
  (int,),
2151
- 'value_resource_input_categories_search_request_v1':
2152
- (ValueResourceInputCategoriesSearchRequestV1,),
2169
+ 'value_resource_input_of_retailer_search_request':
2170
+ (ValueResourceInputOfRetailerSearchRequest,),
2153
2171
  },
2154
2172
  'attribute_map': {
2155
- 'retailer_id': 'retailerId',
2173
+ 'account_id': 'accountId',
2156
2174
  'limit': 'limit',
2157
2175
  'offset': 'offset',
2158
2176
  },
2159
2177
  'location_map': {
2160
- 'retailer_id': 'path',
2178
+ 'account_id': 'path',
2161
2179
  'limit': 'query',
2162
2180
  'offset': 'query',
2163
- 'value_resource_input_categories_search_request_v1': 'body',
2181
+ 'value_resource_input_of_retailer_search_request': 'body',
2164
2182
  },
2165
2183
  'collection_format_map': {
2166
2184
  }
@@ -2347,6 +2365,70 @@ class CampaignApi(object):
2347
2365
  },
2348
2366
  api_client=api_client
2349
2367
  )
2368
+ self.update_creative_endpoint = _Endpoint(
2369
+ settings={
2370
+ 'response_type': (Creative2Response,),
2371
+ 'auth': [
2372
+ 'oauth',
2373
+ 'oauth'
2374
+ ],
2375
+ 'endpoint_path': '/preview/retail-media/accounts/{account-id}/creatives/{creative-id}',
2376
+ 'operation_id': 'update_creative',
2377
+ 'http_method': 'PUT',
2378
+ 'servers': None,
2379
+ },
2380
+ params_map={
2381
+ 'all': [
2382
+ 'account_id',
2383
+ 'creative_id',
2384
+ 'creative_update_model2',
2385
+ ],
2386
+ 'required': [
2387
+ 'account_id',
2388
+ 'creative_id',
2389
+ ],
2390
+ 'nullable': [
2391
+ ],
2392
+ 'enum': [
2393
+ ],
2394
+ 'validation': [
2395
+ ]
2396
+ },
2397
+ root_map={
2398
+ 'validations': {
2399
+ },
2400
+ 'allowed_values': {
2401
+ },
2402
+ 'openapi_types': {
2403
+ 'account_id':
2404
+ (str,),
2405
+ 'creative_id':
2406
+ (str,),
2407
+ 'creative_update_model2':
2408
+ (CreativeUpdateModel2,),
2409
+ },
2410
+ 'attribute_map': {
2411
+ 'account_id': 'account-id',
2412
+ 'creative_id': 'creative-id',
2413
+ },
2414
+ 'location_map': {
2415
+ 'account_id': 'path',
2416
+ 'creative_id': 'path',
2417
+ 'creative_update_model2': 'body',
2418
+ },
2419
+ 'collection_format_map': {
2420
+ }
2421
+ },
2422
+ headers_map={
2423
+ 'accept': [
2424
+ 'application/json'
2425
+ ],
2426
+ 'content_type': [
2427
+ 'application/json'
2428
+ ]
2429
+ },
2430
+ api_client=api_client
2431
+ )
2350
2432
  self.update_keyword_reviews_v1_endpoint = _Endpoint(
2351
2433
  settings={
2352
2434
  'response_type': (ValueResourceOutcomeRetailMediaKeywordsReviewResult,),
@@ -2702,20 +2784,104 @@ class CampaignApi(object):
2702
2784
  line_item_id,
2703
2785
  **kwargs
2704
2786
  ):
2705
- """append_promoted_products # noqa: E501
2787
+ """append_promoted_products # noqa: E501
2788
+
2789
+ Append a collection of promoted products to a line item # noqa: E501
2790
+ This method makes a synchronous HTTP request by default. To make an
2791
+ asynchronous HTTP request, please pass async_req=True
2792
+
2793
+ >>> thread = api.append_promoted_products(line_item_id, async_req=True)
2794
+ >>> result = thread.get()
2795
+
2796
+ Args:
2797
+ line_item_id (str): ID of the line item
2798
+
2799
+ Keyword Args:
2800
+ promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
2801
+ _return_http_data_only (bool): response data without head status
2802
+ code and headers. Default is True.
2803
+ _preload_content (bool): if False, the urllib3.HTTPResponse object
2804
+ will be returned without reading/decoding response data.
2805
+ Default is True.
2806
+ _request_timeout (int/float/tuple): timeout setting for this request. If
2807
+ one number provided, it will be total request timeout. It can also
2808
+ be a pair (tuple) of (connection, read) timeouts.
2809
+ Default is None.
2810
+ _check_input_type (bool): specifies if type checking
2811
+ should be done one the data sent to the server.
2812
+ Default is True.
2813
+ _check_return_type (bool): specifies if type checking
2814
+ should be done one the data received from the server.
2815
+ Default is True.
2816
+ _spec_property_naming (bool): True if the variable names in the input data
2817
+ are serialized names, as specified in the OpenAPI document.
2818
+ False if the variable names in the input data
2819
+ are pythonic names, e.g. snake case (default)
2820
+ _content_type (str/None): force body content-type.
2821
+ Default is None and content-type will be predicted by allowed
2822
+ content-types and body.
2823
+ _host_index (int/None): specifies the index of the server
2824
+ that we want to use.
2825
+ Default is read from the configuration.
2826
+ _request_auths (list): set to override the auth_settings for an a single
2827
+ request; this effectively ignores the authentication
2828
+ in the spec for a single request.
2829
+ Default is None
2830
+ async_req (bool): execute request asynchronously
2831
+
2832
+ Returns:
2833
+ ProductResourceOutcome
2834
+ If the method is called asynchronously, returns the request
2835
+ thread.
2836
+ """
2837
+ kwargs['async_req'] = kwargs.get(
2838
+ 'async_req', False
2839
+ )
2840
+ kwargs['_return_http_data_only'] = kwargs.get(
2841
+ '_return_http_data_only', True
2842
+ )
2843
+ kwargs['_preload_content'] = kwargs.get(
2844
+ '_preload_content', True
2845
+ )
2846
+ kwargs['_request_timeout'] = kwargs.get(
2847
+ '_request_timeout', None
2848
+ )
2849
+ kwargs['_check_input_type'] = kwargs.get(
2850
+ '_check_input_type', True
2851
+ )
2852
+ kwargs['_check_return_type'] = kwargs.get(
2853
+ '_check_return_type', True
2854
+ )
2855
+ kwargs['_spec_property_naming'] = kwargs.get(
2856
+ '_spec_property_naming', False
2857
+ )
2858
+ kwargs['_content_type'] = kwargs.get(
2859
+ '_content_type')
2860
+ kwargs['_host_index'] = kwargs.get('_host_index')
2861
+ kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2862
+ kwargs['line_item_id'] = \
2863
+ line_item_id
2864
+ return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
2865
+
2866
+ def create_auction_line_item_v2(
2867
+ self,
2868
+ campaign_id,
2869
+ **kwargs
2870
+ ):
2871
+ """create_auction_line_item_v2 # noqa: E501
2706
2872
 
2707
- Append a collection of promoted products to a line item # noqa: E501
2873
+ Creates new auction line item with the specified settings # noqa: E501
2708
2874
  This method makes a synchronous HTTP request by default. To make an
2709
2875
  asynchronous HTTP request, please pass async_req=True
2710
2876
 
2711
- >>> thread = api.append_promoted_products(line_item_id, async_req=True)
2877
+ >>> thread = api.create_auction_line_item_v2(campaign_id, async_req=True)
2712
2878
  >>> result = thread.get()
2713
2879
 
2714
2880
  Args:
2715
- line_item_id (str): ID of the line item
2881
+ campaign_id (str): The given campaign id
2716
2882
 
2717
2883
  Keyword Args:
2718
- promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
2884
+ value_resource_input_of_sponsored_products_line_item_create_request_model (ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel): The line item settings to create a line item with. [optional]
2719
2885
  _return_http_data_only (bool): response data without head status
2720
2886
  code and headers. Default is True.
2721
2887
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -2748,7 +2914,7 @@ class CampaignApi(object):
2748
2914
  async_req (bool): execute request asynchronously
2749
2915
 
2750
2916
  Returns:
2751
- ProductResourceOutcome
2917
+ EntityResourceOutcomeOfSponsoredProductsLineItem
2752
2918
  If the method is called asynchronously, returns the request
2753
2919
  thread.
2754
2920
  """
@@ -2777,29 +2943,29 @@ class CampaignApi(object):
2777
2943
  '_content_type')
2778
2944
  kwargs['_host_index'] = kwargs.get('_host_index')
2779
2945
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2780
- kwargs['line_item_id'] = \
2781
- line_item_id
2782
- return self.append_promoted_products_endpoint.call_with_http_info(**kwargs)
2946
+ kwargs['campaign_id'] = \
2947
+ campaign_id
2948
+ return self.create_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
2783
2949
 
2784
- def create_auction_line_item_v2(
2950
+ def create_creative(
2785
2951
  self,
2786
- campaign_id,
2952
+ account_id,
2787
2953
  **kwargs
2788
2954
  ):
2789
- """create_auction_line_item_v2 # noqa: E501
2955
+ """create_creative # noqa: E501
2790
2956
 
2791
- Creates new auction line item with the specified settings # noqa: E501
2957
+ Create a creative for an account # noqa: E501
2792
2958
  This method makes a synchronous HTTP request by default. To make an
2793
2959
  asynchronous HTTP request, please pass async_req=True
2794
2960
 
2795
- >>> thread = api.create_auction_line_item_v2(campaign_id, async_req=True)
2961
+ >>> thread = api.create_creative(account_id, async_req=True)
2796
2962
  >>> result = thread.get()
2797
2963
 
2798
2964
  Args:
2799
- campaign_id (str): The given campaign id
2965
+ account_id (str): External account id to create a creative for
2800
2966
 
2801
2967
  Keyword Args:
2802
- value_resource_input_of_sponsored_products_line_item_create_request_model (ValueResourceInputOfSponsoredProductsLineItemCreateRequestModel): The line item settings to create a line item with. [optional]
2968
+ creative_create_model2 (CreativeCreateModel2): The creative to create. [optional]
2803
2969
  _return_http_data_only (bool): response data without head status
2804
2970
  code and headers. Default is True.
2805
2971
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -2832,7 +2998,7 @@ class CampaignApi(object):
2832
2998
  async_req (bool): execute request asynchronously
2833
2999
 
2834
3000
  Returns:
2835
- EntityResourceOutcomeOfSponsoredProductsLineItem
3001
+ Creative2Response
2836
3002
  If the method is called asynchronously, returns the request
2837
3003
  thread.
2838
3004
  """
@@ -2861,9 +3027,9 @@ class CampaignApi(object):
2861
3027
  '_content_type')
2862
3028
  kwargs['_host_index'] = kwargs.get('_host_index')
2863
3029
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
2864
- kwargs['campaign_id'] = \
2865
- campaign_id
2866
- return self.create_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
3030
+ kwargs['account_id'] = \
3031
+ account_id
3032
+ return self.create_creative_endpoint.call_with_http_info(**kwargs)
2867
3033
 
2868
3034
  def create_preferred_line_item_by_campaign_id(
2869
3035
  self,
@@ -3711,24 +3877,22 @@ class CampaignApi(object):
3711
3877
  retailer_id
3712
3878
  return self.get_api_v1_external_retailer_placements_by_retailer_id_endpoint.call_with_http_info(**kwargs)
3713
3879
 
3714
- def get_api_v2_external_account_by_account_id_creativescreative_id(
3880
+ def get_auction_line_item_v2(
3715
3881
  self,
3716
- account_id,
3717
- creative_id,
3882
+ line_item_id,
3718
3883
  **kwargs
3719
3884
  ):
3720
- """get_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
3885
+ """get_auction_line_item_v2 # noqa: E501
3721
3886
 
3722
- Get the specified creative # noqa: E501
3887
+ Gets a sponsored product line item by its id. # noqa: E501
3723
3888
  This method makes a synchronous HTTP request by default. To make an
3724
3889
  asynchronous HTTP request, please pass async_req=True
3725
3890
 
3726
- >>> thread = api.get_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
3891
+ >>> thread = api.get_auction_line_item_v2(line_item_id, async_req=True)
3727
3892
  >>> result = thread.get()
3728
3893
 
3729
3894
  Args:
3730
- account_id (str): External account id to retrieve creatives for
3731
- creative_id (str): Creative to get
3895
+ line_item_id (int): The id of the line item
3732
3896
 
3733
3897
  Keyword Args:
3734
3898
  _return_http_data_only (bool): response data without head status
@@ -3763,7 +3927,7 @@ class CampaignApi(object):
3763
3927
  async_req (bool): execute request asynchronously
3764
3928
 
3765
3929
  Returns:
3766
- Creative2Response
3930
+ EntityResourceOutcomeOfSponsoredProductsLineItem
3767
3931
  If the method is called asynchronously, returns the request
3768
3932
  thread.
3769
3933
  """
@@ -3792,30 +3956,31 @@ class CampaignApi(object):
3792
3956
  '_content_type')
3793
3957
  kwargs['_host_index'] = kwargs.get('_host_index')
3794
3958
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3795
- kwargs['account_id'] = \
3796
- account_id
3797
- kwargs['creative_id'] = \
3798
- creative_id
3799
- return self.get_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
3959
+ kwargs['line_item_id'] = \
3960
+ line_item_id
3961
+ return self.get_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
3800
3962
 
3801
- def get_auction_line_item_v2(
3963
+ def get_auction_line_items_by_campaign_id_v2(
3802
3964
  self,
3803
- line_item_id,
3965
+ campaign_id,
3804
3966
  **kwargs
3805
3967
  ):
3806
- """get_auction_line_item_v2 # noqa: E501
3968
+ """get_auction_line_items_by_campaign_id_v2 # noqa: E501
3807
3969
 
3808
- Gets a sponsored product line item by its id. # noqa: E501
3970
+ Gets a page of sponsored product line items by campaign id. # noqa: E501
3809
3971
  This method makes a synchronous HTTP request by default. To make an
3810
3972
  asynchronous HTTP request, please pass async_req=True
3811
3973
 
3812
- >>> thread = api.get_auction_line_item_v2(line_item_id, async_req=True)
3974
+ >>> thread = api.get_auction_line_items_by_campaign_id_v2(campaign_id, async_req=True)
3813
3975
  >>> result = thread.get()
3814
3976
 
3815
3977
  Args:
3816
- line_item_id (int): The id of the line item
3978
+ campaign_id (str): The id of the campaign
3817
3979
 
3818
3980
  Keyword Args:
3981
+ limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
3982
+ page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
3983
+ page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
3819
3984
  _return_http_data_only (bool): response data without head status
3820
3985
  code and headers. Default is True.
3821
3986
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -3848,7 +4013,7 @@ class CampaignApi(object):
3848
4013
  async_req (bool): execute request asynchronously
3849
4014
 
3850
4015
  Returns:
3851
- EntityResourceOutcomeOfSponsoredProductsLineItem
4016
+ EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
3852
4017
  If the method is called asynchronously, returns the request
3853
4018
  thread.
3854
4019
  """
@@ -3877,31 +4042,30 @@ class CampaignApi(object):
3877
4042
  '_content_type')
3878
4043
  kwargs['_host_index'] = kwargs.get('_host_index')
3879
4044
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3880
- kwargs['line_item_id'] = \
3881
- line_item_id
3882
- return self.get_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
4045
+ kwargs['campaign_id'] = \
4046
+ campaign_id
4047
+ return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
3883
4048
 
3884
- def get_auction_line_items_by_campaign_id_v2(
4049
+ def get_creative(
3885
4050
  self,
3886
- campaign_id,
4051
+ account_id,
4052
+ creative_id,
3887
4053
  **kwargs
3888
4054
  ):
3889
- """get_auction_line_items_by_campaign_id_v2 # noqa: E501
4055
+ """get_creative # noqa: E501
3890
4056
 
3891
- Gets a page of sponsored product line items by campaign id. # noqa: E501
4057
+ Get the specified creative # noqa: E501
3892
4058
  This method makes a synchronous HTTP request by default. To make an
3893
4059
  asynchronous HTTP request, please pass async_req=True
3894
4060
 
3895
- >>> thread = api.get_auction_line_items_by_campaign_id_v2(campaign_id, async_req=True)
4061
+ >>> thread = api.get_creative(account_id, creative_id, async_req=True)
3896
4062
  >>> result = thread.get()
3897
4063
 
3898
4064
  Args:
3899
- campaign_id (str): The id of the campaign
4065
+ account_id (str): External account id to retrieve creatives for
4066
+ creative_id (str): Creative to get
3900
4067
 
3901
4068
  Keyword Args:
3902
- limit_to_id ([str]): The ids that you would like to limit your result set to. [optional]
3903
- page_index (int): The 0 indexed page index you would like to receive given the page size. [optional] if omitted the server will use the default value of 0
3904
- page_size (int): The maximum number of items you would like to receive in this request. [optional] if omitted the server will use the default value of 25
3905
4069
  _return_http_data_only (bool): response data without head status
3906
4070
  code and headers. Default is True.
3907
4071
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -3934,7 +4098,7 @@ class CampaignApi(object):
3934
4098
  async_req (bool): execute request asynchronously
3935
4099
 
3936
4100
  Returns:
3937
- EntityResourceCollectionOutcomeOfSponsoredProductsLineItemAndMetadata
4101
+ Creative2Response
3938
4102
  If the method is called asynchronously, returns the request
3939
4103
  thread.
3940
4104
  """
@@ -3963,9 +4127,11 @@ class CampaignApi(object):
3963
4127
  '_content_type')
3964
4128
  kwargs['_host_index'] = kwargs.get('_host_index')
3965
4129
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
3966
- kwargs['campaign_id'] = \
3967
- campaign_id
3968
- return self.get_auction_line_items_by_campaign_id_v2_endpoint.call_with_http_info(**kwargs)
4130
+ kwargs['account_id'] = \
4131
+ account_id
4132
+ kwargs['creative_id'] = \
4133
+ creative_id
4134
+ return self.get_creative_endpoint.call_with_http_info(**kwargs)
3969
4135
 
3970
4136
  def get_preferred_line_items_by_campaign_id(
3971
4137
  self,
@@ -4889,25 +5055,25 @@ class CampaignApi(object):
4889
5055
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4890
5056
  return self.post_api_v1_external_catalogs_sku_search_endpoint.call_with_http_info(**kwargs)
4891
5057
 
4892
- def post_api_v2_external_account_creatives_by_account_id(
5058
+ def recommended_keywords(
4893
5059
  self,
4894
- account_id,
5060
+ retailer_id,
4895
5061
  **kwargs
4896
5062
  ):
4897
- """post_api_v2_external_account_creatives_by_account_id # noqa: E501
5063
+ """recommended_keywords # noqa: E501
4898
5064
 
4899
- Create a creative for an account # noqa: E501
5065
+ Recommend keywords by given retailer id and sku ids. # noqa: E501
4900
5066
  This method makes a synchronous HTTP request by default. To make an
4901
5067
  asynchronous HTTP request, please pass async_req=True
4902
5068
 
4903
- >>> thread = api.post_api_v2_external_account_creatives_by_account_id(account_id, async_req=True)
5069
+ >>> thread = api.recommended_keywords(retailer_id, async_req=True)
4904
5070
  >>> result = thread.get()
4905
5071
 
4906
5072
  Args:
4907
- account_id (str): External account id to create a creative for
5073
+ retailer_id (str): Retailer id.
4908
5074
 
4909
5075
  Keyword Args:
4910
- creative_create_model2 (CreativeCreateModel2): The creative to create. [optional]
5076
+ value_resource_input_recommended_keywords_request_v1 (ValueResourceInputRecommendedKeywordsRequestV1): Request of recommended keywords.. [optional]
4911
5077
  _return_http_data_only (bool): response data without head status
4912
5078
  code and headers. Default is True.
4913
5079
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -4940,7 +5106,7 @@ class CampaignApi(object):
4940
5106
  async_req (bool): execute request asynchronously
4941
5107
 
4942
5108
  Returns:
4943
- Creative2Response
5109
+ ValueResourceOutcomeRecommendedKeywordsResponseV1
4944
5110
  If the method is called asynchronously, returns the request
4945
5111
  thread.
4946
5112
  """
@@ -4969,22 +5135,22 @@ class CampaignApi(object):
4969
5135
  '_content_type')
4970
5136
  kwargs['_host_index'] = kwargs.get('_host_index')
4971
5137
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
4972
- kwargs['account_id'] = \
4973
- account_id
4974
- return self.post_api_v2_external_account_creatives_by_account_id_endpoint.call_with_http_info(**kwargs)
5138
+ kwargs['retailer_id'] = \
5139
+ retailer_id
5140
+ return self.recommended_keywords_endpoint.call_with_http_info(**kwargs)
4975
5141
 
4976
- def post_api_v2_external_account_creatives_search_by_account_id(
5142
+ def search_account_creatives(
4977
5143
  self,
4978
5144
  account_id,
4979
5145
  **kwargs
4980
5146
  ):
4981
- """post_api_v2_external_account_creatives_search_by_account_id # noqa: E501
5147
+ """search_account_creatives # noqa: E501
4982
5148
 
4983
5149
  Get account creatives # noqa: E501
4984
5150
  This method makes a synchronous HTTP request by default. To make an
4985
5151
  asynchronous HTTP request, please pass async_req=True
4986
5152
 
4987
- >>> thread = api.post_api_v2_external_account_creatives_search_by_account_id(account_id, async_req=True)
5153
+ >>> thread = api.search_account_creatives(account_id, async_req=True)
4988
5154
  >>> result = thread.get()
4989
5155
 
4990
5156
  Args:
@@ -5055,29 +5221,26 @@ class CampaignApi(object):
5055
5221
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5056
5222
  kwargs['account_id'] = \
5057
5223
  account_id
5058
- return self.post_api_v2_external_account_creatives_search_by_account_id_endpoint.call_with_http_info(**kwargs)
5224
+ return self.search_account_creatives_endpoint.call_with_http_info(**kwargs)
5059
5225
 
5060
- def put_api_v2_external_account_by_account_id_creativescreative_id(
5226
+ def search_brands(
5061
5227
  self,
5062
- account_id,
5063
- creative_id,
5064
5228
  **kwargs
5065
5229
  ):
5066
- """put_api_v2_external_account_by_account_id_creativescreative_id # noqa: E501
5230
+ """search_brands # noqa: E501
5067
5231
 
5068
- Update a creative # noqa: E501
5232
+ Search for brands given a retailer ID and search term. # noqa: E501
5069
5233
  This method makes a synchronous HTTP request by default. To make an
5070
5234
  asynchronous HTTP request, please pass async_req=True
5071
5235
 
5072
- >>> thread = api.put_api_v2_external_account_by_account_id_creativescreative_id(account_id, creative_id, async_req=True)
5236
+ >>> thread = api.search_brands(async_req=True)
5073
5237
  >>> result = thread.get()
5074
5238
 
5075
- Args:
5076
- account_id (str): External account id containing the creative
5077
- creative_id (str): Creative to update
5078
5239
 
5079
5240
  Keyword Args:
5080
- creative_update_model2 (CreativeUpdateModel2): The creative to create. [optional]
5241
+ limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
5242
+ offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
5243
+ value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
5081
5244
  _return_http_data_only (bool): response data without head status
5082
5245
  code and headers. Default is True.
5083
5246
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5110,7 +5273,7 @@ class CampaignApi(object):
5110
5273
  async_req (bool): execute request asynchronously
5111
5274
 
5112
5275
  Returns:
5113
- Creative2Response
5276
+ EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
5114
5277
  If the method is called asynchronously, returns the request
5115
5278
  thread.
5116
5279
  """
@@ -5139,31 +5302,29 @@ class CampaignApi(object):
5139
5302
  '_content_type')
5140
5303
  kwargs['_host_index'] = kwargs.get('_host_index')
5141
5304
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5142
- kwargs['account_id'] = \
5143
- account_id
5144
- kwargs['creative_id'] = \
5145
- creative_id
5146
- return self.put_api_v2_external_account_by_account_id_creativescreative_id_endpoint.call_with_http_info(**kwargs)
5305
+ return self.search_brands_endpoint.call_with_http_info(**kwargs)
5147
5306
 
5148
- def recommended_keywords(
5307
+ def search_category(
5149
5308
  self,
5150
5309
  retailer_id,
5151
5310
  **kwargs
5152
5311
  ):
5153
- """recommended_keywords # noqa: E501
5312
+ """search_category # noqa: E501
5154
5313
 
5155
- Recommend keywords by given retailer id and sku ids. # noqa: E501
5314
+ Search a retailer categories by given text substring and category ids. # noqa: E501
5156
5315
  This method makes a synchronous HTTP request by default. To make an
5157
5316
  asynchronous HTTP request, please pass async_req=True
5158
5317
 
5159
- >>> thread = api.recommended_keywords(retailer_id, async_req=True)
5318
+ >>> thread = api.search_category(retailer_id, async_req=True)
5160
5319
  >>> result = thread.get()
5161
5320
 
5162
5321
  Args:
5163
- retailer_id (str): Retailer id.
5322
+ retailer_id (int): Retailer id.
5164
5323
 
5165
5324
  Keyword Args:
5166
- value_resource_input_recommended_keywords_request_v1 (ValueResourceInputRecommendedKeywordsRequestV1): Request of recommended keywords.. [optional]
5325
+ limit (int): Limit of the search result.. [optional] if omitted the server will use the default value of 50
5326
+ offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
5327
+ value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
5167
5328
  _return_http_data_only (bool): response data without head status
5168
5329
  code and headers. Default is True.
5169
5330
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5196,7 +5357,7 @@ class CampaignApi(object):
5196
5357
  async_req (bool): execute request asynchronously
5197
5358
 
5198
5359
  Returns:
5199
- ValueResourceOutcomeRecommendedKeywordsResponseV1
5360
+ EntityResourceCollectionOutcomeCategory202204Metadata
5200
5361
  If the method is called asynchronously, returns the request
5201
5362
  thread.
5202
5363
  """
@@ -5227,26 +5388,29 @@ class CampaignApi(object):
5227
5388
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5228
5389
  kwargs['retailer_id'] = \
5229
5390
  retailer_id
5230
- return self.recommended_keywords_endpoint.call_with_http_info(**kwargs)
5391
+ return self.search_category_endpoint.call_with_http_info(**kwargs)
5231
5392
 
5232
- def search_brands(
5393
+ def search_retailers_v1(
5233
5394
  self,
5395
+ account_id,
5234
5396
  **kwargs
5235
5397
  ):
5236
- """search_brands # noqa: E501
5398
+ """search_retailers_v1 # noqa: E501
5237
5399
 
5238
- Search for brands given a retailer ID and search term. # noqa: E501
5400
+ Searches for retailers associated with the specified account based on provided search criteria # noqa: E501
5239
5401
  This method makes a synchronous HTTP request by default. To make an
5240
5402
  asynchronous HTTP request, please pass async_req=True
5241
5403
 
5242
- >>> thread = api.search_brands(async_req=True)
5404
+ >>> thread = api.search_retailers_v1(account_id, async_req=True)
5243
5405
  >>> result = thread.get()
5244
5406
 
5407
+ Args:
5408
+ account_id (str): The external account identifier
5245
5409
 
5246
5410
  Keyword Args:
5247
- limit (int): the number of brands to return. [optional] if omitted the server will use the default value of 25
5248
- offset (int): offset of paginated results. [optional] if omitted the server will use the default value of 0
5249
- value_resource_input_brand_id_search_request (ValueResourceInputBrandIdSearchRequest): BrandIdSearchRequest which contains the request parameters. [optional]
5411
+ limit (int): The maximum number of items to return. Must be between 1 and 10. Default is 5.. [optional] if omitted the server will use the default value of 5
5412
+ offset (int): The number of items to skip before starting to collect the result set. Default is 0.. [optional] if omitted the server will use the default value of 0
5413
+ value_resource_input_of_retailer_search_request (ValueResourceInputOfRetailerSearchRequest): The search request containing filtering parameters. [optional]
5250
5414
  _return_http_data_only (bool): response data without head status
5251
5415
  code and headers. Default is True.
5252
5416
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5279,7 +5443,7 @@ class CampaignApi(object):
5279
5443
  async_req (bool): execute request asynchronously
5280
5444
 
5281
5445
  Returns:
5282
- EntityResourceCollectionOutcomeBrandIdSearchResultPagingOffsetLimitMetadata
5446
+ EntityResourceCollectionOutcomeOfRetailerResultAndMetadata
5283
5447
  If the method is called asynchronously, returns the request
5284
5448
  thread.
5285
5449
  """
@@ -5308,29 +5472,29 @@ class CampaignApi(object):
5308
5472
  '_content_type')
5309
5473
  kwargs['_host_index'] = kwargs.get('_host_index')
5310
5474
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5311
- return self.search_brands_endpoint.call_with_http_info(**kwargs)
5475
+ kwargs['account_id'] = \
5476
+ account_id
5477
+ return self.search_retailers_v1_endpoint.call_with_http_info(**kwargs)
5312
5478
 
5313
- def search_category(
5479
+ def set_keyword_bids(
5314
5480
  self,
5315
- retailer_id,
5481
+ id,
5316
5482
  **kwargs
5317
5483
  ):
5318
- """search_category # noqa: E501
5484
+ """set_keyword_bids # noqa: E501
5319
5485
 
5320
- Search a retailer categories by given text substring and category ids. # noqa: E501
5486
+ Set bid overrides for associated keywords to the given line item in bulk # noqa: E501
5321
5487
  This method makes a synchronous HTTP request by default. To make an
5322
5488
  asynchronous HTTP request, please pass async_req=True
5323
5489
 
5324
- >>> thread = api.search_category(retailer_id, async_req=True)
5490
+ >>> thread = api.set_keyword_bids(id, async_req=True)
5325
5491
  >>> result = thread.get()
5326
5492
 
5327
5493
  Args:
5328
- retailer_id (int): Retailer id.
5494
+ id (str): ID of the line item
5329
5495
 
5330
5496
  Keyword Args:
5331
- limit (int): Limit of the search result.. [optional] if omitted the server will use the default value of 50
5332
- offset (int): Offset of the search result.. [optional] if omitted the server will use the default value of 0
5333
- value_resource_input_categories_search_request_v1 (ValueResourceInputCategoriesSearchRequestV1): Request of categories search.. [optional]
5497
+ set_bids_model_request (SetBidsModelRequest): [optional]
5334
5498
  _return_http_data_only (bool): response data without head status
5335
5499
  code and headers. Default is True.
5336
5500
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5363,7 +5527,7 @@ class CampaignApi(object):
5363
5527
  async_req (bool): execute request asynchronously
5364
5528
 
5365
5529
  Returns:
5366
- EntityResourceCollectionOutcomeCategory202204Metadata
5530
+ ResourceOutcome
5367
5531
  If the method is called asynchronously, returns the request
5368
5532
  thread.
5369
5533
  """
@@ -5392,29 +5556,29 @@ class CampaignApi(object):
5392
5556
  '_content_type')
5393
5557
  kwargs['_host_index'] = kwargs.get('_host_index')
5394
5558
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5395
- kwargs['retailer_id'] = \
5396
- retailer_id
5397
- return self.search_category_endpoint.call_with_http_info(**kwargs)
5559
+ kwargs['id'] = \
5560
+ id
5561
+ return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
5398
5562
 
5399
- def set_keyword_bids(
5563
+ def unpause_promoted_products(
5400
5564
  self,
5401
- id,
5565
+ line_item_id,
5402
5566
  **kwargs
5403
5567
  ):
5404
- """set_keyword_bids # noqa: E501
5568
+ """unpause_promoted_products # noqa: E501
5405
5569
 
5406
- Set bid overrides for associated keywords to the given line item in bulk # noqa: E501
5570
+ Un-pause a collection of promoted products associated with a line item # noqa: E501
5407
5571
  This method makes a synchronous HTTP request by default. To make an
5408
5572
  asynchronous HTTP request, please pass async_req=True
5409
5573
 
5410
- >>> thread = api.set_keyword_bids(id, async_req=True)
5574
+ >>> thread = api.unpause_promoted_products(line_item_id, async_req=True)
5411
5575
  >>> result = thread.get()
5412
5576
 
5413
5577
  Args:
5414
- id (str): ID of the line item
5578
+ line_item_id (str): ID of the line item
5415
5579
 
5416
5580
  Keyword Args:
5417
- set_bids_model_request (SetBidsModelRequest): [optional]
5581
+ promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
5418
5582
  _return_http_data_only (bool): response data without head status
5419
5583
  code and headers. Default is True.
5420
5584
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5447,7 +5611,7 @@ class CampaignApi(object):
5447
5611
  async_req (bool): execute request asynchronously
5448
5612
 
5449
5613
  Returns:
5450
- ResourceOutcome
5614
+ None
5451
5615
  If the method is called asynchronously, returns the request
5452
5616
  thread.
5453
5617
  """
@@ -5476,29 +5640,29 @@ class CampaignApi(object):
5476
5640
  '_content_type')
5477
5641
  kwargs['_host_index'] = kwargs.get('_host_index')
5478
5642
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5479
- kwargs['id'] = \
5480
- id
5481
- return self.set_keyword_bids_endpoint.call_with_http_info(**kwargs)
5643
+ kwargs['line_item_id'] = \
5644
+ line_item_id
5645
+ return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
5482
5646
 
5483
- def unpause_promoted_products(
5647
+ def update_auction_line_item_v2(
5484
5648
  self,
5485
5649
  line_item_id,
5486
5650
  **kwargs
5487
5651
  ):
5488
- """unpause_promoted_products # noqa: E501
5652
+ """update_auction_line_item_v2 # noqa: E501
5489
5653
 
5490
- Un-pause a collection of promoted products associated with a line item # noqa: E501
5654
+ Updates a Sponsored Products Line Item given a line item id and a request. # noqa: E501
5491
5655
  This method makes a synchronous HTTP request by default. To make an
5492
5656
  asynchronous HTTP request, please pass async_req=True
5493
5657
 
5494
- >>> thread = api.unpause_promoted_products(line_item_id, async_req=True)
5658
+ >>> thread = api.update_auction_line_item_v2(line_item_id, async_req=True)
5495
5659
  >>> result = thread.get()
5496
5660
 
5497
5661
  Args:
5498
- line_item_id (str): ID of the line item
5662
+ line_item_id (int): The external line item ID of the sponsored products line item.
5499
5663
 
5500
5664
  Keyword Args:
5501
- promoted_product_resource_collection_input (PromotedProductResourceCollectionInput): Request body whose {data} contains an array of promoted products.. [optional]
5665
+ value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
5502
5666
  _return_http_data_only (bool): response data without head status
5503
5667
  code and headers. Default is True.
5504
5668
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5531,7 +5695,7 @@ class CampaignApi(object):
5531
5695
  async_req (bool): execute request asynchronously
5532
5696
 
5533
5697
  Returns:
5534
- None
5698
+ EntityResourceOutcomeOfSponsoredProductsLineItem
5535
5699
  If the method is called asynchronously, returns the request
5536
5700
  thread.
5537
5701
  """
@@ -5562,27 +5726,29 @@ class CampaignApi(object):
5562
5726
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5563
5727
  kwargs['line_item_id'] = \
5564
5728
  line_item_id
5565
- return self.unpause_promoted_products_endpoint.call_with_http_info(**kwargs)
5729
+ return self.update_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
5566
5730
 
5567
- def update_auction_line_item_v2(
5731
+ def update_creative(
5568
5732
  self,
5569
- line_item_id,
5733
+ account_id,
5734
+ creative_id,
5570
5735
  **kwargs
5571
5736
  ):
5572
- """update_auction_line_item_v2 # noqa: E501
5737
+ """update_creative # noqa: E501
5573
5738
 
5574
- Updates a Sponsored Products Line Item given a line item id and a request. # noqa: E501
5739
+ Update a creative # noqa: E501
5575
5740
  This method makes a synchronous HTTP request by default. To make an
5576
5741
  asynchronous HTTP request, please pass async_req=True
5577
5742
 
5578
- >>> thread = api.update_auction_line_item_v2(line_item_id, async_req=True)
5743
+ >>> thread = api.update_creative(account_id, creative_id, async_req=True)
5579
5744
  >>> result = thread.get()
5580
5745
 
5581
5746
  Args:
5582
- line_item_id (int): The external line item ID of the sponsored products line item.
5747
+ account_id (str): External account id containing the creative
5748
+ creative_id (str): Creative to update
5583
5749
 
5584
5750
  Keyword Args:
5585
- value_resource_input_of_sponsored_products_line_item_update_request_model (ValueResourceInputOfSponsoredProductsLineItemUpdateRequestModel): An update request containing all details of the requested update.. [optional]
5751
+ creative_update_model2 (CreativeUpdateModel2): The creative to create. [optional]
5586
5752
  _return_http_data_only (bool): response data without head status
5587
5753
  code and headers. Default is True.
5588
5754
  _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -5615,7 +5781,7 @@ class CampaignApi(object):
5615
5781
  async_req (bool): execute request asynchronously
5616
5782
 
5617
5783
  Returns:
5618
- EntityResourceOutcomeOfSponsoredProductsLineItem
5784
+ Creative2Response
5619
5785
  If the method is called asynchronously, returns the request
5620
5786
  thread.
5621
5787
  """
@@ -5644,9 +5810,11 @@ class CampaignApi(object):
5644
5810
  '_content_type')
5645
5811
  kwargs['_host_index'] = kwargs.get('_host_index')
5646
5812
  kwargs['_request_auths'] = kwargs.get('_request_auths', None)
5647
- kwargs['line_item_id'] = \
5648
- line_item_id
5649
- return self.update_auction_line_item_v2_endpoint.call_with_http_info(**kwargs)
5813
+ kwargs['account_id'] = \
5814
+ account_id
5815
+ kwargs['creative_id'] = \
5816
+ creative_id
5817
+ return self.update_creative_endpoint.call_with_http_info(**kwargs)
5650
5818
 
5651
5819
  def update_keyword_reviews_v1(
5652
5820
  self,