python-amazon-ad-api 1.1.3__py3-none-any.whl → 1.1.5__py3-none-any.whl

ad_api/api/sb/__init__.py

@@ -21,6 +21,8 @@ from .reports import Reports
 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",
@@ -46,4 +48,6 @@ __all__ = [
     "Benchmarks",
     "Themes",
     "BudgetRules",
+    "OptimizationRules",
+    "TargetingCategories",
 ]

ad_api/api/sb/optimization_rules.py

@@ -0,0 +1,153 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class OptimizationRules(Client):
+    """Sponsored Brands optimization rules.
+
+    Documentation: https://advertising.amazon.com/API/docs/en-us/sponsored-brands/4-0/openapi
+
+    Every route in this family takes a versioned media type on the way in, and the
+    service routes on it:
+
+    .. warning::
+        With ``application/json`` the router answers ``404 Could not find
+        resource`` on every route here, which reads like a missing route but is
+        only the wrong media type. Verified on ``list`` and ``recommendations``.
+
+    The two read routes were probed against a live account; the four write routes
+    are built from the contract and not exercised.
+    """
+
+    _MEDIA_RULES = 'application/vnd.sbruleoptimization.v4+json'
+    _MEDIA_RECS = 'application/vnd.sboptimizationrecommendationresource.v4+json'
+
+    @sp_endpoint('/sb/rules/optimization/list', method='POST')
+    def list_optimization_rules(self, **kwargs) -> ApiResponse:
+        """
+        Lists optimization rules.
+
+        Request Body [Optional]
+            | **entityFilter** ({}): ``entityType`` and ``entityId``.
+            | **optimizationRuleIdFilter** ({}): ``include``, a list of rule ids.
+            | **maxResults** (number): Page size.
+            | **nextToken** (string): Pagination token.
+
+        Returns:
+            | ApiResponse, ``200``, with ``optimizationRules`` and ``totalCount``.
+
+        Example::
+
+            {"optimizationRules": [], "totalCount": 0}
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(kwargs.pop('body', {}), False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/recommendations/optimization', method='POST')
+    def get_optimization_recommendation(self, costControlMetric, landingPages, **kwargs) -> ApiResponse:
+        """
+        Gets an optimization rule recommendation.
+
+        Request Body [Required]
+            | **costControlMetric** ({}): [required] Cost control metric.
+            | **landingPages** (array): [required] Each entry carries ``pageType``
+              and either ``asins`` or ``url``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            An empty body answers ``400`` with both members named:
+            *"Value null at 'costControlMetric' failed to satisfy constraint"*.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'costControlMetric': costControlMetric,
+                                                      'landingPages': landingPages}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RECS,
+                                                     'Content-Type': self._MEDIA_RECS})
+
+    @sp_endpoint('/sb/rules/optimization', method='POST')
+    def create_optimization_rules(self, optimizationRules, **kwargs) -> ApiResponse:
+        """
+        Creates optimization rules.
+
+        Request Body [Required]
+            | **optimizationRules** (array): [required]
+                | **entityType** (string): Type of the entity the rule applies to.
+                | **entityId** (string): Identifier of that entity.
+                | **conditions** (array): Each entry needs ``attributeName`` and
+                  ``criteria`` with ``comparisonOperator`` and ``value``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: creates optimization rules on the account.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'optimizationRules': optimizationRules}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization', method='PUT')
+    def update_optimization_rules(self, optimizationRules, **kwargs) -> ApiResponse:
+        """
+        Updates optimization rules.
+
+        Request Body [Required]
+            | **optimizationRules** (array): [required] Each entry needs
+              ``optimizationRuleId`` and ``conditions``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: updates live optimization rules.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body({'optimizationRules': optimizationRules}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization/associate', method='POST')
+    def associate_optimization_rules(self, optimizationRuleAssociations, **kwargs) -> ApiResponse:
+        """
+        Associates optimization rules with entities.
+
+        Request Body [Required]
+            | **optimizationRuleAssociations** (array): [required] Each entry needs
+              ``entityId``, ``entityType`` and ``optimizationRuleId``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: changes which rules apply to live campaigns.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(
+                                 {'optimizationRuleAssociations': optimizationRuleAssociations}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})
+
+    @sp_endpoint('/sb/rules/optimization/disassociate', method='POST')
+    def disassociate_optimization_rules(self, optimizationRuleDisassociations, **kwargs) -> ApiResponse:
+        """
+        Disassociates optimization rules from entities.
+
+        Request Body [Required]
+            | **optimizationRuleDisassociations** (array): [required] Each entry
+              needs ``entityId``, ``entityType`` and ``optimizationRuleId``.
+
+        Returns:
+            | ApiResponse, status ``207``.
+
+        .. note::
+            Not probed: changes which rules apply to live campaigns.
+        """
+        return self._request(kwargs.pop('path'),
+                             data=Utils.convert_body(
+                                 {'optimizationRuleDisassociations': optimizationRuleDisassociations}, False),
+                             params=kwargs, headers={'Accept': self._MEDIA_RULES,
+                                                     'Content-Type': self._MEDIA_RULES})

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})

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.1.3"
+__version__ = "1.1.5"

{python_amazon_ad_api-1.1.3.dist-info → python_amazon_ad_api-1.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.1.3
+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.3.dist-info → python_amazon_ad_api-1.1.5.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=u9ExJqoMv3fQc8WmLTw4I2FnQo6u4xRrBc6DLy6G1IE,22
+ad_api/version.py,sha256=KlgaVSJ1AQxCDJZgh4wFk-gpem-k9PfebW8U3hiKJD4,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
@@ -24,7 +24,7 @@ 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/sb/__init__.py,sha256=1M9GaWMkwb7_0G-JtgAEMjFRpsLs4Ls2-pVtFIyn9LM,1332
+ad_api/api/sb/__init__.py,sha256=O5D20u5EZdftFRLJLaVmkaLo_Ucs0f52ZEL5b1gkfW0,1488
 ad_api/api/sb/ad_creatives_v4.py,sha256=86sF2lhSc3AC6d4P5TXyEnJMBjn9HvsJe4bbCQbSWK0,10508
 ad_api/api/sb/ad_groups.py,sha256=W06Fk0CCsuEYen1Bd8obR6aHpOMhk6tGWNWApecw59c,2882
 ad_api/api/sb/ad_groups_v4.py,sha256=f6KpOrJ2RsCa4aznP8vdGbXp0HGsCmLOvC9yXX2pESc,3669
@@ -42,10 +42,12 @@ ad_api/api/sb/landing_page_asins.py,sha256=j3qi2-KccuEzGLZrl6EfZBSikW2R4B4l7Tixp
 ad_api/api/sb/media.py,sha256=5LTeM4AHSDKw_58aTB2nEZhIYdWkztH0syBXaovS1rs,2529
 ad_api/api/sb/negative_keywords.py,sha256=ww3IRbawidDHAaYIkX5SsH2OZKJj4UnCylqqFeq3OoY,6918
 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
 ad_api/api/sb/recommendations.py,sha256=_21L8tZPuArmJ30XyR1SKQHQH_yswvF0IMqwD9sLhgY,347
 ad_api/api/sb/reports.py,sha256=icw5DpRrqfj0idEo0NN1GPDpIWQun2h_c2Uwc7CpNUA,3801
 ad_api/api/sb/stores.py,sha256=sLdA6Lp37VR-ldu_sTUZIqc8MbMzysPhNOh05VaKBcA,4371
+ad_api/api/sb/targeting_categories.py,sha256=mTU3hMEW_orG_D2mlTqUX14DEDPn9A11vH-wntECklk,4212
 ad_api/api/sb/targeting_recommendations.py,sha256=_7NxD5kC-Od11QOuLT03qpLVxEOIZgy-BtzniWK4CI8,2862
 ad_api/api/sb/themes.py,sha256=rjxdGcllaqLOUMoTKKgBVSH5iKuxMdF0w-dHq0X3-yU,4618
 ad_api/api/sd/__init__.py,sha256=RulShFVpowt2L_ZMcifFVgVrQEg5Uf9_SlVRydUnTF4,911
@@ -105,8 +107,8 @@ ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,438
 ad_api/base/helpers.py,sha256=naUkDLK466x_OBCPXxMlzRc2nPC6iQ6H_vyUji0MJJ0,2282
 ad_api/base/marketplaces.py,sha256=44lvCcluXNpqTprWQ80e3weSQmQbJoWL-WDSOWVbCyQ,4657
 ad_api/base/utils.py,sha256=_qnCBOvyJTLgaZjJzUWTi38GGLHkQszXELs79133Rb4,5618
-python_amazon_ad_api-1.1.3.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.1.3.dist-info/METADATA,sha256=RB8aZ0VWmVNwW0nR_21GuKzyeNZQFCgFXSQgnKYIxdk,20486
-python_amazon_ad_api-1.1.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.1.3.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.1.3.dist-info/RECORD,,
+python_amazon_ad_api-1.1.5.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.1.5.dist-info/METADATA,sha256=Bv5SRj3TNj5OvxigNtRz_LataskuZX8W2VsBcKGrz_U,20486
+python_amazon_ad_api-1.1.5.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.1.5.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.1.5.dist-info/RECORD,,