python-amazon-ad-api 1.1.8__tar.gz → 1.2.0__tar.gz

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.8
+Version: 1.2.0
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -343,24 +343,35 @@ Warning: the campaign, ad group and product ad operations are deprecated in favo
 * [Ad Groups (deprecated)](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_keywords.html)
+* [Keywords Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords_recommendations.html)
 * [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/product_targeting.html)
 * [Negative Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_product_targeting.html)
 * [Targeting Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_recommendations.html)
 * [Bid Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/bid_recommendations.html)
+* [Benchmarks](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/benchmarks.html)
 * [Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/stores.html)
 * [Landing Page Asins](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/landing_page_asins.html)
 * [Media](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/media.html)
 * [Brands](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/brands.html)
-* [Moderation](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/moderation.html)
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
-* [Snapshots](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/snapshots.html)
 * [Themes](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/themes.html)
+* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
 
 ### [Modules Available Sponsored Brands 4.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sb_v4.html)
 
+> The 4.0 contract is fully covered: every operation is implemented except the campaign moderation route, which the service answers with a router `404`, and the report download, which resolves through the shared `_download` helper.
+
 * [Campaigns](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns_v4.html)
 * [Ad Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups_v4.html)
-* [Ads Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ad Creatives](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_creatives_v4.html)
+* [Forecast](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/forecast.html)
+* [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/recommendations.html)
+* [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/budget_rules.html)
+* [Optimization Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/optimization_rules.html)
+* [Targeting Categories](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_categories.html)
+* [Migration](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/migration.html)
+
+> Most 4.0 routes take a versioned media type and the service routes on it. With `application/json` they answer `404 Could not find resource`, which reads like a missing route but is only the wrong media type. This affects forecasts, budget recommendations, optimization rules, migrations, insights, negative brand recommendations and the collection creatives.
 
 ### [Modules Available Sponsored Display](https://python-amazon-ad-api.readthedocs.io/en/latest/sd.html)
 

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/README.md

@@ -315,24 +315,35 @@ Warning: the campaign, ad group and product ad operations are deprecated in favo
 * [Ad Groups (deprecated)](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_keywords.html)
+* [Keywords Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords_recommendations.html)
 * [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/product_targeting.html)
 * [Negative Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_product_targeting.html)
 * [Targeting Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_recommendations.html)
 * [Bid Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/bid_recommendations.html)
+* [Benchmarks](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/benchmarks.html)
 * [Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/stores.html)
 * [Landing Page Asins](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/landing_page_asins.html)
 * [Media](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/media.html)
 * [Brands](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/brands.html)
-* [Moderation](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/moderation.html)
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
-* [Snapshots](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/snapshots.html)
 * [Themes](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/themes.html)
+* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
 
 ### [Modules Available Sponsored Brands 4.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sb_v4.html)
 
+> The 4.0 contract is fully covered: every operation is implemented except the campaign moderation route, which the service answers with a router `404`, and the report download, which resolves through the shared `_download` helper.
+
 * [Campaigns](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns_v4.html)
 * [Ad Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups_v4.html)
-* [Ads Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ad Creatives](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_creatives_v4.html)
+* [Forecast](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/forecast.html)
+* [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/recommendations.html)
+* [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/budget_rules.html)
+* [Optimization Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/optimization_rules.html)
+* [Targeting Categories](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_categories.html)
+* [Migration](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/migration.html)
+
+> Most 4.0 routes take a versioned media type and the service routes on it. With `application/json` they answer `404 Could not find resource`, which reads like a missing route but is only the wrong media type. This affects forecasts, budget recommendations, optimization rules, migrations, insights, negative brand recommendations and the collection creatives.
 
 ### [Modules Available Sponsored Display](https://python-amazon-ad-api.readthedocs.io/en/latest/sd.html)
 

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/audiences.py

@@ -7,8 +7,6 @@ class Audiences(Client):
     @sp_endpoint('/audiences/taxonomy/list', method='POST')
     def list_audiences_taxonomy(self, **kwargs) -> ApiResponse:
         r"""
-        list_audiences_taxonomy(body: dict or str, **kwargs) -> ApiResponse:
-
         Returns a list of audience categories for a given category path
 
         Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]
@@ -22,18 +20,15 @@ class Audiences(Client):
         **maxResults**: *integer* (query) Sets the maximum number of categories in the returned array. Use in conjunction with the nextToken parameter to control pagination. For example, supplying maxResults=20 with a previously returned token will fetch up to the next 20 items. In some cases, fewer items may be returned. Default value : 250
 
         **body**: *dict or str* (data) REQUIRED
-        {
-
-            "adType": **string** Enum [ DSP, SD ]
 
-            "categoryPath":
-
-                [
-
-                **string**
+        .. code-block:: json
 
+            {
+                "adType": "DSP",
+                "categoryPath": [
+                    "string"
                 ]
-        }
+            }
 
         Returns ApiResponse
 
@@ -44,8 +39,6 @@ class Audiences(Client):
     @sp_endpoint('/audiences/list', method='POST')
     def list_audiences(self, **kwargs) -> ApiResponse:
         r"""
-        list_audiences(body: dict or str, **kwargs) -> ApiResponse:
-
         Returns a list of audience segments for an advertiser. The result set can be filtered by providing an array of Filter objects. Each item in the resulting set will match all specified filters.
 
         Requires one of these permissions: ["advertiser_campaign_edit","advertiser_campaign_view"]

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/sb/ad_groups_v4.py

@@ -31,10 +31,13 @@ class AdGroupsV4(Client):
         """
         Update Sponsored Brand Ad groups.
 
-         Request Body
-        | campaignId (string) : The identifier of the campaign to which the keyword is associated. [optional]
-        | name (string) : The name of the ad group. [optional]
-        | state (CreateOrUpdateEntityState > string) : Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+        Request Body
+
+        - ``campaignId`` (string) : The identifier of the campaign to which the
+          keyword is associated. [optional]
+        - ``name`` (string) : The name of the ad group. [optional]
+        - ``state`` (CreateOrUpdateEntityState > string) : Entity state for
+          create or update operation. Enum : [ENABLED, PAUSED]
 
         Returns
             ApiResponse

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/sb/ads_v4.py

@@ -8,13 +8,13 @@ class AdsV4(Client):
         Lists all Sponsored Brands ads.
 
         Request Body (optional)
-        | **campaignIdFilter** (dict) : Filter entities by the list of objectIds.
-        | **stateFilter** (dict) : Filter entities by state.
-        | **maxResults** (int) : Number of records to include in the paginated response. Defaults to max page size for given API.
-        | **nextToken** (string) : Token value allowing to navigate to the next response page.
-        | **adIdFilter** (dict) : Filter entities by the list of objectIds.
-        | **adGroupIdFilter** (dict) : Filter entities by the list of objectIds.
-        | **nameFilter** (dict) : Filter entities by name.
+          | **campaignIdFilter** (dict) : Filter entities by the list of objectIds.
+          | **stateFilter** (dict) : Filter entities by state.
+          | **maxResults** (int) : Number of records to include in the paginated response. Defaults to max page size for given API.
+          | **nextToken** (string) : Token value allowing to navigate to the next response page.
+          | **adIdFilter** (dict) : Filter entities by the list of objectIds.
+          | **adGroupIdFilter** (dict) : Filter entities by the list of objectIds.
+          | **nameFilter** (dict) : Filter entities by name.
 
 
         Returns
@@ -33,13 +33,13 @@ class AdsV4(Client):
         Creates Sponsored Brand video ads.
 
         Request Body (required)
-        | **ads** ([{}]) :
-            **name** (string) : The name of the ad
-            **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
-            **adGroupId** (string) : The adGroup identifier.
-            **creative** (dict) :
-                asins ([string])  [optional]
-                videoAssetIds ([string])  [optional]
+          | **ads** ([{}]) :
+              **name** (string) : The name of the ad
+              **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+              **adGroupId** (string) : The adGroup identifier.
+              **creative** (dict) :
+                  asins ([string])  [optional]
+                  videoAssetIds ([string])  [optional]
 
         Returns
             ApiResponse
@@ -57,21 +57,21 @@ class AdsV4(Client):
         Creates Sponsored Brands product collection ads.
 
         Request Body (required)
-        | **ads** ([{}]) :
-            **landingPage** (dict) :
-                asins [string] [optional]
-                pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
-                url (string) : URL of an existing simple landing page or Store page. [optional]
-            **name** (string) : The name of the ad
-            **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
-            **adGroupId** (string) : The adGroup identifier.
-            **creative** (dict) :
-                brandLogoCrop (string) [optional]
-                brandName (string) [optional]
-                customImageAssetId	(string)
-                customImageCrop ({int})  [optional]
-                brandLogoAssetID (string) [optional]
-                headline (string) The headline text [optional]
+          | **ads** ([{}]) :
+              **landingPage** (dict) :
+                  asins [string] [optional]
+                  pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
+                  url (string) : URL of an existing simple landing page or Store page. [optional]
+              **name** (string) : The name of the ad
+              **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+              **adGroupId** (string) : The adGroup identifier.
+              **creative** (dict) :
+                  brandLogoCrop (string) [optional]
+                  brandName (string) [optional]
+                  customImageAssetId	(string)
+                  customImageCrop ({int})  [optional]
+                  brandLogoAssetID (string) [optional]
+                  headline (string) The headline text [optional]
 
         Returns
             ApiResponse
@@ -89,21 +89,21 @@ class AdsV4(Client):
         Creates Sponsored Brands brand video ads.
 
         Request Body (required)
-        | **ads** ([{}]) :
-            **landingPage** (dict) :
-                asins [string] [optional]
-                pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
-                url (string) : URL of an existing simple landing page or Store page. [optional]
-            **name** (string) : The name of the ad
-            **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
-            **adGroupId** (string) : The adGroup identifier.
-            **creative** (dict) :
-                asins ([string])
-                brandName (string) [optional]
-                brandLogoCrop ({}) [optional]
-                videoAssetIds ([string]) [optional]
-                brandLogoAssetID (string) [optional]
-                headline (string) The headline text [optional]
+          | **ads** ([{}]) :
+              **landingPage** (dict) :
+                  asins [string] [optional]
+                  pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
+                  url (string) : URL of an existing simple landing page or Store page. [optional]
+              **name** (string) : The name of the ad
+              **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+              **adGroupId** (string) : The adGroup identifier.
+              **creative** (dict) :
+                  asins ([string])
+                  brandName (string) [optional]
+                  brandLogoCrop ({}) [optional]
+                  videoAssetIds ([string]) [optional]
+                  brandLogoAssetID (string) [optional]
+                  headline (string) The headline text [optional]
 
         Returns
             ApiResponse
@@ -120,20 +120,20 @@ class AdsV4(Client):
         Creates Sponsored Brands store spotlight ads.
 
         Request Body (required)
-        | **ads** ([{}]) :
-            **landingPage** (dict) :
-                asins [string] [optional]
-                pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
-                url (string) : URL of an existing simple landing page or Store page. [optional]
-            **name** (string) : The name of the ad
-            **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
-            **adGroupId** (string) : The adGroup identifier.
-            **creative** (dict) :
-                brandLogoCrop (string) [optional]
-                brandName (string) [optional]
-                subpages (string) [optional]
-                brandLogoAssetID (string) [optional]
-                headline (string) The headline text [optional]
+          | **ads** ([{}]) :
+              **landingPage** (dict) :
+                  asins [string] [optional]
+                  pageType (LadingPageType > String ) : The type of landing page, such as store page, product list (simple landing page), custom url. [optional]
+                  url (string) : URL of an existing simple landing page or Store page. [optional]
+              **name** (string) : The name of the ad
+              **state** (CreateOrUpdateEntityState > String) Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+              **adGroupId** (string) : The adGroup identifier.
+              **creative** (dict) :
+                  brandLogoCrop (string) [optional]
+                  brandName (string) [optional]
+                  subpages (string) [optional]
+                  brandLogoAssetID (string) [optional]
+                  headline (string) The headline text [optional]
 
         Returns
             ApiResponse
@@ -150,10 +150,10 @@ class AdsV4(Client):
         Updates the Sponsored Brands ads.
 
         Request Body (required)
-        | **ads** ([{}]) :
-            **adsId** (string) [required] : The product ad identifier.
-            name (string) [optional] : The name of the ad
-            state (State>String) [optional] : Entity state for create or update operation. Enum : [ENABLED, PAUSED]
+          | **ads** ([{}]) :
+              **adsId** (string) [required] : The product ad identifier.
+              name (string) [optional] : The name of the ad
+              state (State>String) [optional] : Entity state for create or update operation. Enum : [ENABLED, PAUSED]
 
         Returns
             ApiResponse
@@ -250,8 +250,8 @@ class AdsV4(Client):
         Deletes Sponsored Brands ads.
 
         Request Body
-        | **adIdFilter** (dict) : Filter entities by the list of objectIds.
-            include : list of adIds as string
+          | **adIdFilter** (dict) : Filter entities by the list of objectIds.
+              include : list of adIds as string
 
         """
 

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/sb/migration.py

@@ -113,10 +113,11 @@ class Migration(Client):
         Lists every campaign migration result for the advertiser.
 
         Request Body [Optional]
-            | **nextToken** (string): [optional]
+
+        - ``nextToken`` (string): [optional]
 
         Returns:
-            | ApiResponse, ``200``. With nothing migrated yet the service answers
+            ApiResponse, ``200``. With nothing migrated yet the service answers
             an empty object rather than a list, so do not assume a ``migrations``
             key is always present.
         """

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/sb/stores.py

@@ -34,15 +34,18 @@ class Stores(Client):
 
         The endpoint takes ``multipart/form-data`` with two parts, not JSON:
 
-            ``assetInfo``  A JSON string with ``brandEntityId`` and ``mediaType``.
-            ``asset``      The image bytes. PNG, JPEG or GIF, under 1MB and at
-                           least 400x400 pixels.
+        * ``assetInfo``  A JSON string with ``brandEntityId`` and ``mediaType``.
+        * ``asset``      The image bytes. PNG, JPEG or GIF, under 1MB and at
+          least 400x400 pixels.
 
         Keyword Args
-            | path **image** (str or bytes): A file path, or the raw image bytes. [required]
-            | path **brandEntityId** (string): The Brand entity identifier. Required for sellers, optional for vendors. [required]
-            | path **mediaType** (string): Only ``brandLogo`` is supported. [optional]
-            | path **filename** (string): Name sent in ``Content-Disposition``. Taken from the path when a path is given. [optional]
+
+        - ``image`` (str or bytes): A file path, or the raw image bytes. [required]
+        - ``brandEntityId`` (string): The Brand entity identifier. Required for
+          sellers, optional for vendors. [required]
+        - ``mediaType`` (string): Only ``brandLogo`` is supported. [optional]
+        - ``filename`` (string): Name sent in ``Content-Disposition``. Taken
+          from the path when a path is given. [optional]
 
         Returns:
             | ApiResponse

python_amazon_ad_api-1.2.0/ad_api/api/sp/campaign_negative_targets.py

@@ -0,0 +1,122 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class CampaignNegativeTargets(Client):
+    @sp_endpoint('/sp/campaignNegativeTargets/delete', method='POST')
+    def delete_campaign_negative_targets(self, version: int = 3, **kwargs) -> ApiResponse:
+        r"""
+        Deleting campaign negative targets.
+
+        Request Body (required)
+            | SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesRequestContent {
+            | campaignNegativeTargetIdFilter* SponsoredProductsObjectIdFilter {
+            | Filter entities by the list of objectIds
+            |       **include**\* (array) minItems: 0 maxItems: 1000 [
+            |           string entity object identifier
+            |       ]
+            |    }
+            | }
+
+        Returns
+            ApiResponse
+        """
+        json_version = 'application/vnd.spcampaignNegativeTargetingClause.v' + str(version) + "+json"
+        headers = {"Accept": json_version, "Content-Type": json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sp/campaignNegativeTargets', method='POST')
+    def create_campaign_negative_targets(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+        Create campaign negative targets.
+
+        Keyword Args
+
+        - ``prefer`` (bool): send ``Prefer: return=representation`` so create and
+          update return the full object rather than only the ids. [optional]
+
+        Request Body (required)
+
+        - ``campaignNegativeTargetingClauses`` (array): the clauses to create.
+
+          Each clause carries:
+
+          - ``campaignId`` (string): the campaign the target belongs to.
+          - ``state`` (string): ``ENABLED`` or ``PAUSED``.
+          - ``expression`` (array): one predicate with ``type`` and ``value``.
+            ``type`` is ``ASIN_BRAND_SAME_AS`` or ``ASIN_SAME_AS``.
+
+        Returns
+            ApiResponse
+        """
+        json_version = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + "+json"
+        headers = {"Accept": json_version, "Content-Type": json_version}
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sp/campaignNegativeTargets', method='PUT')
+    def edit_negative_product_targets(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
+        r"""
+        Update campaign negative targets.
+
+        Keyword Args
+
+        - ``prefer`` (bool): send ``Prefer: return=representation`` so create and
+          update return the full object rather than only the ids. [optional]
+
+        Request Body (required)
+
+        - ``campaignNegativeTargetingClauses`` (array): the clauses to update.
+
+          Each clause carries:
+
+          - ``targetId`` (string): the target to update.
+          - ``state`` (string): ``ENABLED`` or ``PAUSED``.
+          - ``expression`` (array): one predicate with ``type`` and ``value``.
+            ``type`` is ``ASIN_BRAND_SAME_AS`` or ``ASIN_SAME_AS``.
+
+        Returns
+            ApiResponse
+        """
+        json_version = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + "+json"
+        headers = {"Accept": json_version, "Content-Type": json_version}
+
+        prefer_value = 'return=representation'
+        if prefer:
+            headers.update({"Prefer": prefer_value})
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sp/campaignNegativeTargets/list', method='POST')
+    def list_campaign_negative_targets(self, version: int = 3, **kwargs) -> ApiResponse:
+        r"""
+        List campaign negative targets.
+
+        Request Body (optional)
+
+        - ``campaignIdFilter`` (object): narrow to those campaigns. Carries
+          ``include``, a list of campaign ids.
+        - ``campaignNegativeTargetIdFilter`` (object): narrow to those targets.
+          Carries ``include``, a list of target ids.
+        - ``stateFilter`` (object): narrow by state. Carries ``include``, a list
+          drawn from ``ENABLED``, ``PAUSED``, ``ARCHIVED``, ``ENABLING``,
+          ``USER_DELETED`` and ``OTHER``.
+        - ``asinFilter`` (object): narrow by ASIN. Carries ``include``, a list of
+          ASINs, and ``queryTermMatchType``, either ``BROAD_MATCH`` or
+          ``EXACT_MATCH``.
+        - ``maxResults`` (integer): page size. Defaults to the API maximum.
+        - ``nextToken`` (string): pagination token.
+        - ``includeExtendedDataFields`` (boolean): also return ``creationDate``,
+          ``lastUpdateDate`` and ``servingStatus``.
+
+        Returns
+            ApiResponse
+        """
+        content_type = 'application/vnd.spcampaignNegativeTargetingClause.v' + str(version) + '+json'
+        accept = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + '+json'
+        headers = {"Accept": accept, "Content-Type": content_type}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/api/sp/product_ads_v3.py

@@ -95,10 +95,12 @@ class ProductAdsV3(Client):
         r"""
         Delete one or multiple sponsored product ads.
 
-        Request Body (required) : a dictionary to filter with ad ids that should be deleted. Sets the state of a
-        specified product ad to archived
-            | **adIdFilter** ({})
-                | include [string] : string list of ad object identifier.
+        Request Body (required): a dictionary to filter with ad ids that should
+        be deleted. Sets the state of a specified product ad to archived.
+
+        **adIdFilter** ({})
+
+        - ``include`` [string] : string list of ad object identifier.
 
         Returns
             | ApiResponse

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/ad_api/base/helpers.py

@@ -1,3 +1,4 @@
+import functools
 from io import BytesIO
 from typing import TypeVar
 
@@ -17,6 +18,7 @@ T = TypeVar("T")
 
 def sp_endpoint(path, method="GET"):
     def decorator(function: T) -> T:
+        @functools.wraps(function)
         def wrapper(*args, **kwargs):
             kwargs.update({"path": path, "method": method})
             return function(*args, **kwargs)

python_amazon_ad_api-1.2.0/ad_api/version.py

@@ -0,0 +1 @@
+__version__ = "1.2.0"

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.8
+Version: 1.2.0
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -343,24 +343,35 @@ Warning: the campaign, ad group and product ad operations are deprecated in favo
 * [Ad Groups (deprecated)](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups.html)
 * [Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords.html)
 * [Negative Keywords](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_keywords.html)
+* [Keywords Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/keywords_recommendations.html)
 * [Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/product_targeting.html)
 * [Negative Product Targeting](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/negative_product_targeting.html)
 * [Targeting Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_recommendations.html)
 * [Bid Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/bid_recommendations.html)
+* [Benchmarks](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/benchmarks.html)
 * [Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/stores.html)
 * [Landing Page Asins](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/landing_page_asins.html)
 * [Media](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/media.html)
 * [Brands](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/brands.html)
-* [Moderation](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/moderation.html)
-* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
-* [Snapshots](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/snapshots.html)
 * [Themes](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/themes.html)
+* [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/reports.html)
 
 ### [Modules Available Sponsored Brands 4.0](https://python-amazon-ad-api.readthedocs.io/en/latest/sb_v4.html)
 
+> The 4.0 contract is fully covered: every operation is implemented except the campaign moderation route, which the service answers with a router `404`, and the report download, which resolves through the shared `_download` helper.
+
 * [Campaigns](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/campaigns_v4.html)
 * [Ad Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_groups_v4.html)
-* [Ads Groups](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ads_v4.html)
+* [Ad Creatives](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/ad_creatives_v4.html)
+* [Forecast](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/forecast.html)
+* [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/recommendations.html)
+* [Budget Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/budget_rules.html)
+* [Optimization Rules](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/optimization_rules.html)
+* [Targeting Categories](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/targeting_categories.html)
+* [Migration](https://python-amazon-ad-api.readthedocs.io/en/latest/sb/migration.html)
+
+> Most 4.0 routes take a versioned media type and the service routes on it. With `application/json` they answer `404 Could not find resource`, which reads like a missing route but is only the wrong media type. This affects forecasts, budget recommendations, optimization rules, migrations, insights, negative brand recommendations and the collection creatives.
 
 ### [Modules Available Sponsored Display](https://python-amazon-ad-api.readthedocs.io/en/latest/sd.html)
 

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = python-amazon-ad-api
-version = 1.1.8
+version = 1.2.0
 author = Daniel Alvaro
 author_email = denisneuf@hotmail.com
 description = Python wrapper for the Amazon Advertising API

{python_amazon_ad_api-1.1.8 → python_amazon_ad_api-1.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
     name='python-amazon-ad-api',
-    version='1.1.8',
+    version='1.2.0',
     install_requires=[
         "requests>=2.27.1,<2.35.0",
         "six>=1.16,<1.18",

python_amazon_ad_api-1.1.8/ad_api/api/sp/campaign_negative_targets.py

@@ -1,143 +0,0 @@
-from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
-
-
-class CampaignNegativeTargets(Client):
-    @sp_endpoint('/sp/campaignNegativeTargets/delete', method='POST')
-    def delete_campaign_negative_targets(self, version: int = 3, **kwargs) -> ApiResponse:
-        r"""
-        Deleting campaign negative targets.
-
-        Request Body (required)
-            | SponsoredProductsDeleteSponsoredProductsCampaignNegativeTargetingClausesRequestContent {
-            | campaignNegativeTargetIdFilter* SponsoredProductsObjectIdFilter {
-            | Filter entities by the list of objectIds
-            |       **include**\* (array) minItems: 0 maxItems: 1000 [
-            |           string entity object identifier
-            |       ]
-            |    }
-            | }
-
-        Returns
-            ApiResponse
-        """
-        json_version = 'application/vnd.spcampaignNegativeTargetingClause.v' + str(version) + "+json"
-        headers = {"Accept": json_version, "Content-Type": json_version}
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/sp/campaignNegativeTargets', method='POST')
-    def create_campaign_negative_targets(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
-        r"""
-        Create campaign negative targets.
-
-        Param:
-
-            | header **Prefer**\* (string). The "Prefer" header, as defined in [RFC7240], allows clients to request certain behavior from the service. The service ignores preference values that are either not supported or not known by the service. Either multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent Supported preferences: return=representation - return the full object when doing create/update/delete operations instead of ids
-
-        Request Body (required)
-            | SponsoredProductsCreateSponsoredProductsCampaignNegativeTargetingClausesRequestContent {
-            | **campaignNegativeTargetingClauses**\* SponsoredProductsCreateCampaignNegativeTargetingClause {
-            |       **expression**\* (array) The NegativeTargeting expression. minItems: 0 maxItems: 1000 [
-            |           SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate {
-            |               **type**\* (string) SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicateType. The type of negative targeting expression. Enum: ['ASIN_BRAND_SAME_AS', 'ASIN_SAME_AS'].
-            |               **value** (string): The expression value
-            |           }
-            |       ]
-            |       **campaignId**\* (string) The identifier of the campaign to which this target is associated.
-            |       **state**\* (string) SponsoredProductsCreateOrUpdateEntityState. Entity state for create or update operation. Enum: [ ENABLED, PAUSED ]
-            |    }
-            | }
-        Request Body (optional)
-
-        Returns
-            ApiResponse
-        """
-        json_version = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + "+json"
-        headers = {"Accept": json_version, "Content-Type": json_version}
-        prefer_value = 'return=representation'
-        if prefer:
-            headers.update({"Prefer": prefer_value})
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/sp/campaignNegativeTargets', method='PUT')
-    def edit_negative_product_targets(self, version: int = 3, prefer: bool = False, **kwargs) -> ApiResponse:
-        r"""
-        Update campaign negative targets.
-
-        Param:
-
-            | header **Prefer**\* (string). The "Prefer" header, as defined in [RFC7240], allows clients to request certain behavior from the service. The service ignores preference values that are either not supported or not known by the service. Either multiple Prefer headers are passed or single one with comma separated values, both forms are equivalent Supported preferences: return=representation - return the full object when doing create/update/delete operations instead of ids
-
-        Request Body (required)
-            | SponsoredProductsUpdateSponsoredProductsCampaignNegativeTargetingClausesRequestContent {
-            | **campaignNegativeTargetingClauses**\* SponsoredProductsUpdateCampaignNegativeTargetingClause {
-            |       **expression**\* (array) The NegativeTargeting expression. minItems: 0 maxItems: 1000 [
-            |           SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicate {
-            |               **type**\* (string) SponsoredProductsCreateOrUpdateNegativeTargetingExpressionPredicateType. The type of negative targeting expression. Enum: ['ASIN_BRAND_SAME_AS', 'ASIN_SAME_AS'].
-            |               **value** (string): The expression value
-            |           }
-            |       ]
-            |       **targetId**\* (string) The target identifier
-            |       **state**\* (string) SponsoredProductsCreateOrUpdateEntityState. Entity state for create or update operation. Enum: [ ENABLED, PAUSED ]
-            |    }
-            | }
-        Request Body (optional)
-
-        Returns
-            ApiResponse
-        """
-        json_version = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + "+json"
-        headers = {"Accept": json_version, "Content-Type": json_version}
-
-        prefer_value = 'return=representation'
-        if prefer:
-            headers.update({"Prefer": prefer_value})
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
-
-    @sp_endpoint('/sp/campaignNegativeTargets/list', method='POST')
-    def list_campaign_negative_targets(self, version: int = 3, **kwargs) -> ApiResponse:
-        r"""
-        List campaign negative targets.
-
-        Request Body (required)
-            | SponsoredProductsListSponsoredProductsCampaignNegativeTargetingClausesRequestContent {
-            | **campaignIdFilter** SponsoredProductsReducedObjectIdFilter {
-            |       Filter entities by the list of objectIds
-            |       **include**\* (array) minItems: 0 maxItems: 100 [
-            |           string entity object identifier
-            |       ]
-            |    }
-            | **campaignNegativeTargetIdFilter** SponsoredProductsObjectIdFilter {
-            |       Filter entities by the list of objectIds
-            |       **include**\* (array) minItems: 0 maxItems: 1000 [
-            |           string entity object identifier
-            |       ]
-            |    }
-            | **stateFilter** SponsoredProductsEntityStateFilter {
-            |       Filter entities by state
-            |       **include**\* (array) minItems: 0 maxItems: 10 [
-            |           SponsoredProductsEntityState (string) The current resource state. Enum: [ ENABLED, PAUSED, ARCHIVED, ENABLING, USER_DELETED, OTHER ]
-            |       ]
-            |    }
-            | **maxResults** integer($int32) Number of records to include in the paginated response. Defaults to max page size for given API
-            | **nextToken** (string) token value allowing to navigate to the next response page
-            | **asinFilter** SponsoredProductsAsinFilter {
-            |       **queryTermMatchType** SponsoredProductsQueryTermMatchType (string): Match type for query filters. Enum: [ BROAD_MATCH, EXACT_MATCH ]
-            |       **include** (array) maxItems: 100 [
-            |           string
-            |       ]
-            |    }
-            | **includeExtendedDataFields** (boolean) Whether to get entity with extended data fields such as creationDate, lastUpdateDate, servingStatus
-            | }
-        Request Body (optional)
-
-        Returns
-            ApiResponse
-        """
-        content_type = 'application/vnd.spcampaignNegativeTargetingClause.v' + str(version) + '+json'
-        accept = 'application/vnd.spCampaignNegativeTargetingClause.v' + str(version) + '+json'
-        headers = {"Accept": accept, "Content-Type": content_type}
-
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

python_amazon_ad_api-1.1.8/ad_api/version.py

@@ -1 +0,0 @@
-__version__ = "1.1.8"