python-amazon-ad-api 1.2.0__py3-none-any.whl → 1.2.2__py3-none-any.whl

ad_api/api/sb/negative_keywords.py

@@ -20,17 +20,36 @@ class NegativeKeywords(Client):
         Gets an array of negative keywords, filtered by optional criteria.
 
         Keyword Args
-            | query **startIndex**:*integer* | Optional. 0-indexed record offset for the result set. Default value : 0
-            | query **count**:*integer* | Optional. Number of records to include in the paged response. Defaults to max page size.
-            | query **matchTypeFilter**:*string* | Optional. Restricts results to keywords with match types within the specified comma-separated list. Available values : negativePhrase, negativeExact.
-            | query **keywordText**:*string* | Optional. Restricts results to keywords that match the specified text exactly.
-            | query **stateFilter**:*string* | Optional. The returned array is filtered to include only ad groups with state set to one of the values in the specified comma-delimited list. Available values :  enabled, archived.
-            | query **campaignIdFilter**:*string* | Optional. A comma-delimited list of campaign identifiers.
-            | query **adGroupIdFilter**:*string* | Optional. Restricts results to keywords associated with ad groups specified by identifier in the comma-delimited list.
-            | query **keywordIdFilter**:*string* | Optional. Restricts results to keywords associated with campaigns specified by identifier in the comma-delimited list.
-            | query **creativeType**:*string* | Optional. Filter by the type of creative the campaign is associated with. To get negative keywords associated with non-video campaigns specify 'productCollection'. To get negative keywords associated with video campaigns, this must be set to 'video'. Returns all negative keywords if not specified. Available values : productCollection, video
+
+        - ``startIndex`` (integer): Optional. 0-indexed record offset for the
+          result set. Default value: 0.
+        - ``count`` (integer): Optional. Number of records to include in the
+          paged response. Defaults to max page size.
+        - ``matchTypeFilter`` (string): Optional. Restricts results to keywords
+          with match types within the specified comma-separated list. Available
+          values: negativePhrase, negativeExact.
+        - ``keywordText`` (string): Optional. Restricts results to keywords that
+          match the specified text exactly.
+        - ``stateFilter`` (string): Optional. The returned array is filtered to
+          include only ad groups with state set to one of the values in the
+          specified comma-delimited list. Available values: enabled, archived.
+        - ``campaignIdFilter`` (string): Optional. A comma-delimited list of
+          campaign identifiers.
+        - ``adGroupIdFilter`` (string): Optional. Restricts results to keywords
+          associated with ad groups specified by identifier in the
+          comma-delimited list.
+        - ``keywordIdFilter`` (string): Optional. Restricts results to keywords
+          associated with campaigns specified by identifier in the
+          comma-delimited list.
+        - ``creativeType`` (string): Optional. Filter by the type of creative the
+          campaign is associated with. To get negative keywords associated with
+          non-video campaigns specify 'productCollection'. To get negative
+          keywords associated with video campaigns, this must be set to 'video'.
+          Returns all negative keywords if not specified. Available values:
+          productCollection, video.
+
         Returns:
-            | ApiResponse
+            ApiResponse
 
         """
         return self._request(kwargs.pop('path'), params=kwargs, headers=self._accept())

ad_api/api/sp/ranked_keywords_recommendations.py

@@ -67,7 +67,7 @@ class RankedKeywordsRecommendations(Client):
             | ]
             | **campaignId**\*(string): The identifier of the campaign
             | **recommendationType**\*(string): The recommendationType to retrieve recommended keyword targets for an existing ad group. Enum: ['KEYWORDS_FOR_ADGROUP']
-            | **bidsEnabled**(boolean): Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true. default: true
+            | **bidsEnabled** (boolean): Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true. default: true
             | **dGroupId**\*(string): The identifier of the ad group
             | }
 
@@ -88,7 +88,7 @@ class RankedKeywordsRecommendations(Client):
             | **asins**\* (array) maxItems: 50. An array list of Asin.
             | **biddingStrategy** (string) The bid recommendations returned will depend on the bidding strategy. LEGACY_FOR_SALES - Dynamic Bids (Down only) AUTO_FOR_SALES - Dynamic Bids (Up or down) MANUAL - Fixed Bids. Enum: [ LEGACY_FOR_SALES, AUTO_FOR_SALES, MANUAL, RULE_BASED ] default: LEGACY_FOR_SALES
             | **recommendationType**\* (string): The recommendationType to retrieve recommended keyword targets for a list of ASINs. Enum: ['KEYWORDS_FOR_ASINS']
-            | **bidsEnabled**(boolean): Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true. default: true
+            | **bidsEnabled** (boolean): Set this parameter to false if you do not want to retrieve bid suggestions for your keyword targets. Defaults to true. default: true
             | }
 
         Version 4.0

ad_api/api/validation_configurations.py

@@ -16,14 +16,24 @@ class ValidationConfigurations(Client):
         Retrieves the campaign configuration values used for campaign validation for the requested marketplace, entityType, and programType context/contexts.
 
         Request body
-            | **countryCodesList** (Array): [optional] The list of countryCode enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN, IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
-            | **entityTypesList** (Array): [optional] The list of entityType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SELLER, VENDOR ]
-            | **programTypesList** (Array): [optional] The list of programType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SB, SP, SD ]
+
+        - ``countryCodesList`` (Array): [optional] The list of countryCode enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN,
+          IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
+        - ``entityTypesList`` (Array): [optional] The list of entityType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SELLER, VENDOR ]
+        - ``programTypesList`` (Array): [optional] The list of programType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SB, SP, SD ]
+
         Returns:
             ApiResponse
-
         """
-
         accept = 'application/vnd.AdsApiValidationConfigsServiceLambda.CampaignsResource.v1+json'
         contentType = 'application/vnd.AdsApiValidationConfigsServiceLambda.CampaignsResource.v1+json'
         headers = {'Accept': accept, 'Content-Type': contentType}
@@ -37,9 +47,21 @@ class ValidationConfigurations(Client):
         Retrieves the configuration values used in targeting clause validation for the requested inputted marketplace, entityType, and programType context/contexts.
 
         Request body
-            | **countryCodesList** (Array): [optional] The list of countryCode enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN, IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
-            | **entityTypesList** (Array): [optional] The list of entityType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SELLER, VENDOR ]
-            | **programTypesList** (Array): [optional] The list of programType enums defining the marketplaces whose configuration values are requested. When null is selected and no value is attributed to this key, all countryCode options are selected. [ SB, SP, SD ]
+
+        - ``countryCodesList`` (Array): [optional] The list of countryCode enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ US, CA, MX, BR, UK, DE, FR, ES, IN,
+          IT, NL, AE, SA, SE, TR, PL, EG, JP, AU, SG, CN ]
+        - ``entityTypesList`` (Array): [optional] The list of entityType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SELLER, VENDOR ]
+        - ``programTypesList`` (Array): [optional] The list of programType enums
+          defining the marketplaces whose configuration values are requested.
+          When null is selected and no value is attributed to this key, all
+          countryCode options are selected. [ SB, SP, SD ]
+
         Returns:
             ApiResponse
 

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.2.0"
+__version__ = "1.2.2"

{python_amazon_ad_api-1.2.0.dist-info → python_amazon_ad_api-1.2.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.2.0
+Version: 1.2.2
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro

{python_amazon_ad_api-1.2.0.dist-info → python_amazon_ad_api-1.2.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=MpAT5hgNoHnTtG1XRD_GV_A7QrHVU6vJjGSw_8qMGA4,22
+ad_api/version.py,sha256=uuf4VNtTNA93fMhoAur9YafzaKJFnczY-H1SSCSuRVQ,22
 ad_api/api/__init__.py,sha256=E9c0ZyK4vplMlKKEBF8CV5u7P4uSkTMSQsAuSQu5bfY,1514
 ad_api/api/account.py,sha256=CmOvCfHoPWaeTUJvtB0pNoNulZVSz4oMMCKIpVTpHos,2931
 ad_api/api/advertising_test_account.py,sha256=btOVbdk2tBDmyKSJaQbcIFyzNG8KFJVUmTe4p9xMhpU,1507
@@ -23,7 +23,7 @@ ad_api/api/recommendations.py,sha256=aVDnnX8GEhdOVSKypIs8lyUJCiFxo9ujMYVXqzHTvBc
 ad_api/api/reports.py,sha256=gNmDHLULD2uaJgsMpIbCX9kabwhMXRr9WfZBtHUdsOY,6043
 ad_api/api/stores.py,sha256=7W3RJKZyZOQ3nHzInvK9FDhWTXCH6Xe9a6dCBatEZ-o,2484
 ad_api/api/stream.py,sha256=JpnF8SKniOAHiEnEq1RPrh6tNy-Q2-8GPBTmnlxEXqQ,2989
-ad_api/api/validation_configurations.py,sha256=V3o06uWGwvA_Ly1x2lAiCk35Wo7DC_k8AtHgMdpm6wU,3830
+ad_api/api/validation_configurations.py,sha256=BBoUv7iWJjB33Wp4pClNbzSUX9iNW36lJEIDn6CqgD8,4008
 ad_api/api/sb/__init__.py,sha256=APbCAkWM1gzYuhpEUU98XDIKJKJx1NXALjLBXA9zdBU,1538
 ad_api/api/sb/ad_creatives_v4.py,sha256=zQzTivDkGzX3I5ZfCWIlzRUGWfTRsXJZCKQrKMaMDpc,14512
 ad_api/api/sb/ad_groups.py,sha256=W06Fk0CCsuEYen1Bd8obR6aHpOMhk6tGWNWApecw59c,2882
@@ -41,7 +41,7 @@ ad_api/api/sb/keywords_recommendations.py,sha256=oA4FRBwDtk52SZK0RgWvjNQ7K2GX0G2
 ad_api/api/sb/landing_page_asins.py,sha256=j3qi2-KccuEzGLZrl6EfZBSikW2R4B4l7TixpkAnTq8,1259
 ad_api/api/sb/media.py,sha256=5LTeM4AHSDKw_58aTB2nEZhIYdWkztH0syBXaovS1rs,2529
 ad_api/api/sb/migration.py,sha256=QfbtB9yhRDn6OyS-DSypETAhhp_WDJbELRUoBsxc07U,7086
-ad_api/api/sb/negative_keywords.py,sha256=ww3IRbawidDHAaYIkX5SsH2OZKJj4UnCylqqFeq3OoY,6918
+ad_api/api/sb/negative_keywords.py,sha256=uHLtOnu-OUHr23_Yh05qTSlVcnV2ITci6QvaY6n9f_I,6986
 ad_api/api/sb/negative_product_targeting.py,sha256=QbK1EhhzmnNOzGtbkrAZ4HS5OqiLU3nZBmsl1scd2D0,5085
 ad_api/api/sb/optimization_rules.py,sha256=aj9tZwKdaOzjnAN-8FHb49aiejNZKCCCcR8fjffH4k0,6802
 ad_api/api/sb/product_targeting.py,sha256=o6aB3hIh9jKvi_uTXFi--1hpnPFuXzQ-U9N7VUP_Bz4,5362
@@ -86,7 +86,7 @@ ad_api/api/sp/negative_product_targeting_v3.py,sha256=aAVwLialz5qxO1FfYwA1kJ8I6A
 ad_api/api/sp/product_ads_v3.py,sha256=Yi_5eUD-vlr87EYat_YVN9v7al9J--fJsr_c0QIZ6pA,5967
 ad_api/api/sp/product_recommendations.py,sha256=vXoZIRqcFc5bo9MUprArKndxcEYe_PuySUnw634Ed4U,499
 ad_api/api/sp/product_targeting_v3.py,sha256=vk_T0piHzP5uwt8HSHm5hFKP_0sXJD8nbyooPtM-BTs,9567
-ad_api/api/sp/ranked_keywords_recommendations.py,sha256=hVB3-pF0RDgX4ZeeblFk0F_pnRxM3JmulNGdIiKSzI0,13092
+ad_api/api/sp/ranked_keywords_recommendations.py,sha256=QYFje19TFmwhedh7sn5VJIypL8gp6d6tpBQCpf_SIXw,13094
 ad_api/api/sp/schedule_based_bid_optimization.py,sha256=G8VkS7iP1lTIAxZgbfRCLz8njw1DkVH9HQPOZ63pWNU,2371
 ad_api/api/v1/__init__.py,sha256=F2CvJLkWZDG_ykzVnivBb10CvmSWw2lVf-7dy5oH8LM,189
 ad_api/api/v1/ad_groups.py,sha256=pQhCVdve_O6kbL4mBA5bxxhKcKNl_BKqa7z9DvrxwaM,12626
@@ -108,8 +108,8 @@ ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,438
 ad_api/base/helpers.py,sha256=UK7Q13vZ0mNdF54xzfzoGDn2O_cd2yPrK2X4rOzC41c,2334
 ad_api/base/marketplaces.py,sha256=44lvCcluXNpqTprWQ80e3weSQmQbJoWL-WDSOWVbCyQ,4657
 ad_api/base/utils.py,sha256=_qnCBOvyJTLgaZjJzUWTi38GGLHkQszXELs79133Rb4,5618
-python_amazon_ad_api-1.2.0.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.2.0.dist-info/METADATA,sha256=CnTHBEa7ivhSIPvXS8ipa-__25esQpOpIfRntU7w6y8,21778
-python_amazon_ad_api-1.2.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.2.0.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.2.0.dist-info/RECORD,,
+python_amazon_ad_api-1.2.2.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.2.2.dist-info/METADATA,sha256=KPanEM-HPMFE2e2jnXwtaE6WqqtTX5u2qJsF3UFzw7M,21778
+python_amazon_ad_api-1.2.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.2.2.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.2.2.dist-info/RECORD,,