python-amazon-ad-api 1.0.8__tar.gz → 1.1.0__tar.gz

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.0.8
+Version: 1.1.0
 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.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/__init__.py

@@ -6,7 +6,6 @@ from .ad_groups import AdGroups
 from .ad_groups_v4 import AdGroupsV4
 from .ad_creatives_v4 import AdCreativesV4
 from .ads_v4 import AdsV4
-from .moderation import Moderation
 from .keywords import Keywords
 from .recommendations import Recommendations
 from .keywords_recommendations import KeywordsRecommendations
@@ -19,7 +18,6 @@ from .bid_recommendations import BidRecommendations
 from .stores import Stores
 from .media import Media
 from .reports import Reports
-from .snapshots import Snapshots
 from .benchmarks import Benchmarks
 from .themes import Themes
 
@@ -32,7 +30,6 @@ __all__ = [
     "AdGroups",
     "AdGroupsV4",
     "AdsV4",
-    "Moderation",
     "Keywords",
     "Recommendations",
     "KeywordsRecommendations",
@@ -45,7 +42,6 @@ __all__ = [
     "Stores",
     "Media",
     "Reports",
-    "Snapshots",
     "Benchmarks",
     "Themes"
 ]

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/bid_recommendations.py

@@ -6,6 +6,13 @@ class BidRecommendations(Client):
     Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
     """
 
+    _ACCEPT = 'application/vnd.sbbidsrecommendation.v3+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
     @sp_endpoint('/sb/recommendations/bids', method='POST')
     def get_bid_recommendations(self, **kwargs) -> ApiResponse:
         r"""
@@ -32,4 +39,5 @@ class BidRecommendations(Client):
 
         """
 
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False),
+                             params=kwargs, headers=self._accept())

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/brands.py

@@ -6,6 +6,13 @@ class Brands(Client):
     Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
     """
 
+    _ACCEPT = 'application/vnd.brand.v3+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
     @sp_endpoint('/brands', method='GET')
     def list_brands(self, **kwargs) -> ApiResponse:
         """
@@ -22,4 +29,4 @@ class Brands(Client):
             | '**brandRegistryName**': *string*, {'description': 'The Brand name.'}
 
         """
-        return self._request(kwargs.pop('path'), params=kwargs)
+        return self._request(kwargs.pop('path'), params=kwargs, headers=self._accept())

python_amazon_ad_api-1.1.0/ad_api/api/sb/keywords_recommendations.py

@@ -0,0 +1,16 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class KeywordsRecommendations(Client):
+
+    _ACCEPT = 'application/vnd.sbkeywordrecommendation.v3+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
+    @sp_endpoint('/sb/recommendations/keyword', method='POST')
+    def list_keywords_recommendations(self, **kwargs) -> ApiResponse:
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False),
+                             params=kwargs, headers=self._accept())

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/landing_page_asins.py

@@ -6,6 +6,13 @@ class PageAsins(Client):
     Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
     """
 
+    _ACCEPT = 'application/vnd.pageasins.v3+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
     @sp_endpoint('/pageAsins', method='GET')
     def get_page_asins(self, **kwargs) -> ApiResponse:
         """
@@ -18,4 +25,4 @@ class PageAsins(Client):
         Returns
             asinList
         """
-        return self._request(kwargs.pop('path'), params=kwargs)
+        return self._request(kwargs.pop('path'), params=kwargs, headers=self._accept())

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/negative_keywords.py

@@ -6,6 +6,13 @@ class NegativeKeywords(Client):
     Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
     """
 
+    _ACCEPT = 'application/vnd.sbnegativekeyword.v3.2+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
     @sp_endpoint('/sb/negativeKeywords', method='GET')
     def list_negative_keywords(self, **kwargs) -> ApiResponse:
         r"""
@@ -26,7 +33,7 @@ class NegativeKeywords(Client):
             | ApiResponse
 
         """
-        return self._request(kwargs.pop('path'), params=kwargs)
+        return self._request(kwargs.pop('path'), params=kwargs, headers=self._accept())
 
     @sp_endpoint('/sb/negativeKeywords', method='PUT')
     def edit_negative_keywords(self, **kwargs) -> ApiResponse:

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/negative_product_targeting.py

@@ -6,6 +6,13 @@ class NegativeTargets(Client):
     Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
     """
 
+    _ACCEPT = 'application/vnd.sblistnegativetargetsresponse.v3.2+json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for the listing route."""
+        return {'Accept': cls._ACCEPT}
+
     @sp_endpoint('/sb/negativeTargets/list', method='POST')
     def list_negative_targets(self, **kwargs) -> ApiResponse:
         r"""
@@ -28,7 +35,8 @@ class NegativeTargets(Client):
         Returns:
             ApiResponse
         """
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False),
+                             params=kwargs, headers=self._accept())
 
     @sp_endpoint('/sb/negativeTargets', method='PUT')
     def edit_negative_targets(self, **kwargs) -> ApiResponse:

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/ad_api/api/sb/reports.py

@@ -8,6 +8,13 @@ class Reports(Client):
 
     """
 
+    _ACCEPT = 'application/json'
+
+    @classmethod
+    def _accept(cls):
+        """Response media type the v3 contract declares for these routes."""
+        return {"Accept": cls._ACCEPT}
+
     @sp_endpoint('/v2/hsa/{}/report', method='POST')
     def post_report(self, recordType, **kwargs) -> ApiResponse:
         r"""Requests a Sponsored Brands report.
@@ -27,7 +34,8 @@ class Reports(Client):
             ApiResponse
 
         """
-        return self._request(fill_query_params(kwargs.pop('path'), recordType), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
+        return self._request(fill_query_params(kwargs.pop('path'), recordType), data=Utils.convert_body(kwargs.pop('body'), False),
+                             params=kwargs, headers=self._accept())
 
     @sp_endpoint('/v2/reports/{}', method='GET')
     def get_report(self, reportId, **kwargs) -> ApiResponse:
@@ -42,7 +50,7 @@ class Reports(Client):
         Returns:
             ApiResponse
         """
-        return self._request(fill_query_params(kwargs.pop('path'), reportId), params=kwargs)
+        return self._request(fill_query_params(kwargs.pop('path'), reportId), params=kwargs, headers=self._accept())
 
     def download_report(self, **kwargs) -> ApiResponse:
         r"""Downloads the report previously get report specified by location

python_amazon_ad_api-1.1.0/ad_api/api/sb/stores.py

@@ -0,0 +1,89 @@
+import json
+import mimetypes
+
+import requests
+
+from ad_api.base import Client, sp_endpoint, ApiResponse
+
+
+class Stores(Client):
+    """
+    Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
+    """
+
+    @sp_endpoint('/stores/assets', method='GET')
+    def list_assets(self, **kwargs) -> ApiResponse:
+        """
+        For sellers or vendors, gets an array of assets associated with the specified brand entity identifier. Vendors are not required to specify a brand entity identifier, and in this case all assets associated with the vendor are returned.
+
+        Keyword Args
+            | query **brandEntityId** (string): For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the getBrands operation. For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the difference between a seller and a vendor, see the Amazon Advertising FAQ. [required]
+
+            | query **mediaType** (string): Specifies the media types used to filter the returned array. Currently, only the brandLogo type is supported. If not specified, all media types are returned. Available values : brandLogo, image [optional]
+
+        Returns:
+            | ApiResponse
+        """
+        return self._request(kwargs.pop('path'), params=kwargs,
+                             headers={'Accept': 'application/vnd.mediaasset.v3+json'})
+
+    @sp_endpoint('/stores/assets', method='POST')
+    def create_asset(self, image, brandEntityId, mediaType='brandLogo', filename=None, **kwargs) -> ApiResponse:
+        """
+        Creates a new image asset and stores it in the Store Assets Library.
+
+        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.
+
+        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]
+
+        Returns:
+            | ApiResponse
+
+        Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/3-0/openapi#tag/Stores
+        """
+        if isinstance(image, (str, bytes)):
+            if isinstance(image, bytes):
+                data = image
+            else:
+                filename = filename or image.split('/')[-1]
+                with open(image, 'rb') as handle:
+                    data = handle.read()
+        else:
+            data = image.read()
+
+        filename = filename or 'image'
+
+        content_type = mimetypes.guess_type(filename)[0] or 'image/png'
+        if content_type not in ('image/png', 'image/jpeg', 'image/gif'):
+            raise ValueError(f"Unsupported image type {content_type}; use PNG, JPEG or GIF.")
+
+        asset_info = {'brandEntityId': brandEntityId, 'mediaType': mediaType}
+
+        headers = self.headers.copy()
+        # requests must set Content-Type itself to add the multipart boundary
+        headers.pop('Content-Type', None)
+        headers['Accept'] = '*/*'
+        headers['Content-Disposition'] = f'attachment; filename="{filename}"'
+
+        response = requests.post(
+            self.endpoint + '/stores/assets',
+            headers=headers,
+            files={
+                'assetInfo': (None, json.dumps(asset_info), 'application/json'),
+                'asset': (filename, data, content_type),
+            },
+            params=kwargs,
+            timeout=self.timeout or 60,
+            proxies=self.proxies,
+            verify=self.verify,
+        )
+
+        return self._check_response(response)

python_amazon_ad_api-1.1.0/ad_api/version.py

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

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.0.8
+Version: 1.1.0
 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.0.8 → python_amazon_ad_api-1.1.0}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -44,13 +44,11 @@ ad_api/api/sb/keywords.py
 ad_api/api/sb/keywords_recommendations.py
 ad_api/api/sb/landing_page_asins.py
 ad_api/api/sb/media.py
-ad_api/api/sb/moderation.py
 ad_api/api/sb/negative_keywords.py
 ad_api/api/sb/negative_product_targeting.py
 ad_api/api/sb/product_targeting.py
 ad_api/api/sb/recommendations.py
 ad_api/api/sb/reports.py
-ad_api/api/sb/snapshots.py
 ad_api/api/sb/stores.py
 ad_api/api/sb/targeting_recommendations.py
 ad_api/api/sb/themes.py

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/setup.cfg

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

{python_amazon_ad_api-1.0.8 → python_amazon_ad_api-1.1.0}/setup.py

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

python_amazon_ad_api-1.0.8/ad_api/api/sb/keywords_recommendations.py

@@ -1,7 +0,0 @@
-from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
-
-
-class KeywordsRecommendations(Client):
-    @sp_endpoint('/sb/recommendations/keyword', method='POST')
-    def list_keywords_recommendations(self, **kwargs) -> ApiResponse:
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)

python_amazon_ad_api-1.0.8/ad_api/api/sb/moderation.py

@@ -1,18 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse
-
-
-class Moderation(Client):
-    """
-    Use this interface to request and retrieve store information. This can be used for Sponsored Brands campaign creation, to pull the store URL information, and for asset registration for Stores.
-    """
-
-    @sp_endpoint('/sb/moderation/campaigns/{}', method='GET')
-    def get_moderation(self, campaignId, **kwargs) -> ApiResponse:
-        """
-        Gets the moderation result for a campaign specified by identifier.
-
-        Keyword Args
-            | path **campaignId** (integer): The campaign identifier. [required]
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), campaignId), params=kwargs)

python_amazon_ad_api-1.0.8/ad_api/api/sb/snapshots.py

@@ -1,47 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
-
-
-class Snapshots(Client):
-    """
-    Use the Amazon Advertising API for Sponsored Products for campaign, ad group, keyword, negative keyword, and product ad management operations. For more information about Sponsored Products, see the Sponsored Products Support Center. For onboarding information, see the account setup topic.
-    """
-
-    @sp_endpoint('/v2/hsa/{}/snapshot', method='POST')
-    @Utils.deprecated
-    def post_snapshot(self, recordType, **kwargs) -> ApiResponse:
-        """
-
-        Returns:
-            ApiResponse
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), recordType), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs)
-
-    @sp_endpoint('/v2/hsa/snapshots/{}', method='GET')
-    @Utils.deprecated
-    def get_snapshot(self, snapshotId, **kwargs) -> ApiResponse:
-        r"""
-        Gets the status of a requested snapshot.
-
-        Returns:
-            ApiResponse
-        """
-        return self._request(fill_query_params(kwargs.pop('path'), snapshotId), params=kwargs)
-
-    @Utils.deprecated
-    def download_snapshot(self, **kwargs) -> ApiResponse:
-        r"""
-        Downloads the snapshot previously get report specified by location (this is not part of the official Amazon Advertising API, is a helper method to download the snapshot). Take in mind that a direct download of location returned in get_snapshot will return 401 - Unauthorized.
-
-        kwarg parameter **file** if not provided will take the default amazon name from path download (add a path with slash / if you want a specific folder, do not add extension as the return will provide the right extension based on format choosed if needed)
-
-        kwarg parameter **format** if not provided a format will return a url to download the snapshot (this url has a expiration time)
-
-        Keyword Args
-            | **url** (string): The location obatined from get_snapshot [required]
-            | **file** (string): The path to save the file if mode is download json, zip or gzip. [optional]
-            | **format** (string): The mode to download the snapshot: data (list), raw, url, json, zip, gzip. Default (url) [optional]
-
-        Returns:
-            ApiResponse
-        """
-        return self._download(self, params=kwargs)

python_amazon_ad_api-1.0.8/ad_api/api/sb/stores.py

@@ -1,44 +0,0 @@
-from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
-
-
-class Stores(Client):
-    """
-    Use the Amazon Advertising API for Sponsored Brands for campaign, ad group, keyword, negative keyword, drafts, Stores, landing pages, and Brands management operations. For more information about Sponsored Brands, see the Sponsored Brands Support Center. For onboarding information, see the account setup topic.
-    """
-
-    @sp_endpoint('/stores/assets', method='GET')
-    def list_assets(self, **kwargs) -> ApiResponse:
-        """
-        For sellers or vendors, gets an array of assets associated with the specified brand entity identifier. Vendors are not required to specify a brand entity identifier, and in this case all assets associated with the vendor are returned.
-
-        Keyword Args
-            | path **brandEntityId** (string): For sellers, this field is required. It is the Brand entity identifier of the Brand for which assets are returned. This identifier is retrieved using the getBrands operation. For vendors, this field is optional. If a vendor does not specify this field, all assets associated with the vendor are returned. For more information about the difference between a seller and a vendor, see the Amazon Advertising FAQ. [required]
-
-            | query **mediaType** (string): Specifies the media types used to filter the returned array. Currently, only the brandLogo type is supported. If not specified, all media types are returned. Available values : brandLogo, image [optional]
-
-        Returns:
-            | ApiResponse
-        """
-        return self._request(fill_query_params(kwargs.pop('path')), params=kwargs)
-
-    @sp_endpoint('/v2/stores', method='GET')
-    def list_stores(self, **kwargs) -> ApiResponse:
-        """
-        List store information for all registered stores under an advertiser.
-
-        Keyword Args
-            None
-
-        """
-        return self._request(fill_query_params(kwargs.pop('path')), params=kwargs)
-
-    # It is not working the endpoint
-    @sp_endpoint('/v2/stores/{}', method='GET')
-    def get_store(self, brandEntityId, **kwargs) -> ApiResponse:
-        return self._request(fill_query_params(kwargs.pop('path'), brandEntityId), params=kwargs)
-
-    # It is not working Cannot consume content type
-    @sp_endpoint('/stores/assets', method='POST')
-    def create_asset(self, contentDisposition, contentType, **kwargs) -> ApiResponse:
-        headers = {'Content-Disposition': contentDisposition, 'Content-Type': contentType}
-        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

python_amazon_ad_api-1.0.8/ad_api/version.py

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