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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.6
+Version: 1.1.8
 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.1.6 → python_amazon_ad_api-1.1.8}/ad_api/api/sb/ad_creatives_v4.py

@@ -128,6 +128,92 @@ class AdCreativesV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/ads/creatives/autoCollection', method='POST')
+    def create_auto_collection_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of an auto collection creative for an existing ad.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+                | **adId** (string): [required] Sponsored Brands ad identifier.
+                | **creative** ({}): [required]
+                    | **brandName** (string): [required]
+                    | **brandLogoAssetID** (string): [optional]
+                    | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                      ``width`` and ``height``.
+                    | **asinExclusions** (array of string): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            This route takes ``application/vnd.sbadresource.v4+json``, the same
+            media type as the ads family, not the creative one.
+        """
+        json_version = 'application/vnd.sbadresource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sb/ads/creatives/manualCollection', method='POST')
+    def create_manual_collection_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of a manual collection creative for an existing ad.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad, each with ``adId``
+              and a ``creative`` block.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            Also takes ``application/vnd.sbadresource.v4+json``.
+        """
+        json_version = 'application/vnd.sbadresource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sb/ads/creatives/productCollectionExtended', method='POST')
+    @Utils.deprecated
+    def create_new_version_product_collection_extended_ad_creative(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates a new version of an extended product collection creative.
+
+        This route is flagged deprecated in the 4.0 contract. It still answers on
+        the live service, which is why it stays available, but new integrations
+        should use ``create_auto_collection_ad_creative`` or
+        ``create_manual_collection_ad_creative``.
+
+        Request Body [Required]
+            | **adId** (string): [required] Sponsored Brands ad identifier.
+            | **creative** ({}): [required]
+                | **asins** (array of string): [required]
+                | **brandName** (string): [required]
+                | **brandLogoAssetId** (string): [required]
+                | **headline** (string): [required]
+                | **landingPage** ({}): [optional] ``type``, ``url`` or ``asins``.
+                | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                  ``width`` and ``height``.
+                | **customImages** (array): [optional] Each with ``assetId``,
+                  ``url`` and a ``crop``.
+                | **consentToTranslate** (boolean): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            Unlike its siblings this route takes a single ``adId`` and
+            ``creative``, not an ``ads`` list, and it uses
+            ``application/vnd.sbAdCreativeResource.v4+json``. An empty body names
+            both required members.
+        """
+        json_version = 'application/vnd.sbAdCreativeResource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
     @sp_endpoint('/sb/ads/creatives/list', method='POST')
     def list_ad_creatives(self, version: int = 4, **kwargs) -> ApiResponse:
         """

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

@@ -165,6 +165,85 @@ class AdsV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/v4/ads/autoCollection', method='POST')
+    def create_auto_collection_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands auto collection ads.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+                | **adGroupId** (string): [required] Ad group the ad belongs to.
+                | **name** (string): [required] Ad name.
+                | **state** (string): [required] ``ENABLED``, ``PAUSED`` or
+                  ``ARCHIVED``.
+                | **creative** ({}): [required]
+                    | **brandName** (string): [required]
+                    | **brandLogoAssetID** (string): [optional]
+                    | **brandLogoCrop** ({}): [optional] ``top``, ``left``,
+                      ``width`` and ``height``.
+                    | **asinExclusions** (array of string): [optional]
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*, and ``application/json`` answers
+            ``404 Could not find resource``, so the versioned media type is what
+            routes the call.
+        """
+        json_version = 'application/vnd.sbadresource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sb/v4/ads/manualCollection', method='POST')
+    def create_manual_collection_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands manual collection ads.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad, each with
+              ``adGroupId``, ``name``, ``state`` and a ``creative`` block.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*
+        """
+        json_version = 'application/vnd.sbadresource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/sb/v4/ads/productCollectionExtended', method='POST')
+    @Utils.deprecated
+    def create_product_collection_extended_ads(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Creates Sponsored Brands extended product collection ads.
+
+        This route is flagged deprecated in the 4.0 contract, together with the
+        creative side of the same name. It still answers on the live service,
+        which is why it stays available, but new integrations should use
+        ``create_auto_collection_ads`` or ``create_manual_collection_ads``.
+
+        Request Body [Required]
+            | **ads** (array): [required] One entry per ad.
+
+        Returns:
+            | ApiResponse
+
+        .. note::
+            An empty body answers ``400 INVALID_ARGUMENT`` with
+            *"Ad list cannot be empty."*
+        """
+        json_version = 'application/vnd.sbadresource.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
     @sp_endpoint('/sb/v4/ads/delete', method='POST')
     def delete_ads(self, version: int = 4, **kwargs) -> ApiResponse:
         """

{python_amazon_ad_api-1.1.6 → python_amazon_ad_api-1.1.8}/ad_api/api/sb/campaigns_v4.py

@@ -77,6 +77,34 @@ class CampaignsV4(Client):
 
         return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
 
+    @sp_endpoint('/sb/campaigns/insights', method='POST')
+    def get_campaign_insights(self, version: int = 4, **kwargs) -> ApiResponse:
+        """
+        Gets insights for campaign ad groups.
+
+        Request Body [Required]
+            | **adGroups** (array): [required] One entry per ad group.
+                | **adFormat** (string): [required] Ad format of the ad group.
+                | **keywords** (array): [optional] Each entry needs
+                  ``keywordText``, ``matchType`` and ``bid``.
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        .. note::
+            This route takes ``application/vnd.sbinsights.v4+json``, not the
+            campaigns media type. With ``application/json`` it answers ``404
+            Could not find resource``, so the versioned type is what routes it.
+
+        .. note::
+            An empty body answers ``400`` naming ``adGroups``, which is the only
+            required member.
+        """
+        json_version = 'application/vnd.sbinsights.v' + str(version) + "+json"
+        headers = {'Accept': json_version}
+
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
     @sp_endpoint('/sb/v4/campaigns/list', method='POST')
     def list_campaigns(self, version: int = 4, **kwargs) -> ApiResponse:
         """

{python_amazon_ad_api-1.1.6 → python_amazon_ad_api-1.1.8}/ad_api/api/sb/targeting_categories.py

@@ -67,6 +67,29 @@ class TargetingCategories(Client):
                              params=kwargs,
                              headers={'Accept': self._MEDIA, 'Content-Type': self._MEDIA})
 
+    @sp_endpoint('/sb/negativeTargets/brands/recommendations', method='GET')
+    def list_negative_brand_recommendations(self, **kwargs) -> ApiResponse:
+        """
+        Gets brand recommendations for negative targeting.
+
+        Keyword Args
+            | query **nextToken** (string): [optional] Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with brands under ``brands``, each carrying
+              ``brandRefinementId`` and ``name``.
+
+        Example::
+
+            {"brands": [{"brandRefinementId": "19897490031", "name": "YEYIAN"}]}
+
+        .. note::
+            Lives here because it shares this class media type. It is the one
+            route in this class that is not about the category tree.
+        """
+        return self._request(kwargs.pop('path'), params=kwargs,
+                             headers={'Accept': self._MEDIA, 'Content-Type': self._MEDIA})
+
     @sp_endpoint('/sb/targets/products/count', method='POST')
     def get_product_count(self, category, **kwargs) -> ApiResponse:
         """

python_amazon_ad_api-1.1.8/ad_api/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.6
+Version: 1.1.8
 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.1.6 → python_amazon_ad_api-1.1.8}/setup.cfg

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

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

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

python_amazon_ad_api-1.1.6/ad_api/version.py

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