python-amazon-ad-api 1.1.4__tar.gz → 1.1.5__tar.gz

{python_amazon_ad_api-1.1.4 → python_amazon_ad_api-1.1.5}/PKG-INFO

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

@@ -22,6 +22,7 @@ from .benchmarks import Benchmarks
 from .themes import Themes
 from .budget_rules import BudgetRules
 from .optimization_rules import OptimizationRules
+from .targeting_categories import TargetingCategories
 
 __all__ = [
     "Brands",
@@ -48,4 +49,5 @@ __all__ = [
     "Themes",
     "BudgetRules",
     "OptimizationRules",
+    "TargetingCategories",
 ]

python_amazon_ad_api-1.1.5/ad_api/api/sb/targeting_categories.py

@@ -0,0 +1,98 @@
+from ad_api.base import Client, sp_endpoint, fill_query_params, ApiResponse, Utils
+
+
+class TargetingCategories(Client):
+    """Sponsored Brands targetable categories.
+
+    Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/4-0/openapi
+
+    All three routes are reads, and all three were probed against a live account.
+
+    .. note::
+        ``list_categories`` returns the tree under ``categoryTree``, which the
+        contract does not name. Each node carries ``categoryRefinementId``,
+        ``name``, ``parentCategoryRefinementId``, ``isTargetable`` and, where the
+        service knows it, ``asinCountRange`` with a ``min`` and ``max``.
+
+    .. note::
+        Large root categories come back with ``isTargetable`` set to ``false``:
+        they have to be narrowed down to their children before they can be used
+        as a target.
+    """
+
+    _MEDIA = 'application/vnd.sbtargeting.v4+json'
+
+    @sp_endpoint('/sb/targets/categories', method='GET')
+    def list_categories(self, supplySource, **kwargs) -> ApiResponse:
+        """
+        Gets the targetable category tree.
+
+        Keyword Args
+            | query **supplySource** (string): [required] ``AMAZON`` or
+              ``STREAMING_VIDEO``.
+            | query **locale** (string): [optional] Market locale, for instance
+              ``es_ES``, ``en_US`` or ``de_DE``.
+            | query **includeOnlyRootCategories** (boolean): [optional] Return
+              root categories only.
+            | query **parentCategoryRefinementId** (string): [optional] Return
+              the children of that category.
+            | query **nextToken** (string): [optional] Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with the tree under ``categoryTree``.
+
+        Example node::
+
+            {"categoryRefinementId": "1909624031", "name": "Chupetes",
+             "asinCountRange": {"min": 1247, "max": 2078},
+             "isTargetable": true, "parentCategoryRefinementId": "1862267031"}
+        """
+        return self._request(kwargs.pop('path'), params=kwargs,
+                             headers={'Accept': self._MEDIA, 'Content-Type': self._MEDIA})
+
+    @sp_endpoint('/sb/targets/categories/{}/refinements', method='GET')
+    def list_refinements(self, categoryRefinementId, **kwargs) -> ApiResponse:
+        """
+        Gets the refinements of a category.
+
+        Keyword Args
+            | path **categoryRefinementId** (string): [required]
+            | query **locale** (string): [optional]
+            | query **nextToken** (string): [optional]
+
+        Returns:
+            | ApiResponse, ``200``.
+        """
+        return self._request(fill_query_params(kwargs.pop('path'), categoryRefinementId),
+                             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:
+        """
+        Gets the number of products in a category.
+
+        Request Body [Required]
+            | **category** (string): [required] Category refinement identifier.
+            | **ageRanges** (array of string): [optional]
+            | **brands** (array of string): [optional]
+            | **genres** (array of string): [optional]
+            | **isPrimeShipping** (boolean): [optional]
+            | **ratingRange** ({}): [optional] ``min`` and ``max`` integers.
+            | **priceRange** ({}): [optional] ``min`` and ``max`` numbers.
+
+        Returns:
+            | ApiResponse, ``200``.
+
+        Raises:
+            | ``400`` when ``category`` is missing, naming that member.
+        """
+        body = {'category': category}
+        for key in ('ageRanges', 'brands', 'genres', 'isPrimeShipping',
+                    'ratingRange', 'priceRange'):
+            if key in kwargs:
+                body[key] = kwargs.pop(key)
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(body, False),
+                             params=kwargs, headers={'Accept': self._MEDIA,
+                                                     'Content-Type': self._MEDIA})

python_amazon_ad_api-1.1.5/ad_api/version.py

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

{python_amazon_ad_api-1.1.4 → python_amazon_ad_api-1.1.5}/python_amazon_ad_api.egg-info/PKG-INFO

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

@@ -52,6 +52,7 @@ ad_api/api/sb/product_targeting.py
 ad_api/api/sb/recommendations.py
 ad_api/api/sb/reports.py
 ad_api/api/sb/stores.py
+ad_api/api/sb/targeting_categories.py
 ad_api/api/sb/targeting_recommendations.py
 ad_api/api/sb/themes.py
 ad_api/api/sd/__init__.py

{python_amazon_ad_api-1.1.4 → python_amazon_ad_api-1.1.5}/setup.cfg

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

{python_amazon_ad_api-1.1.4 → python_amazon_ad_api-1.1.5}/setup.py

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

python_amazon_ad_api-1.1.4/ad_api/version.py

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