python-amazon-ad-api 1.5.2__py3-none-any.whl → 1.5.3__py3-none-any.whl

ad_api/api/v1/__init__.py

@@ -12,6 +12,7 @@ from .brand_store_pages import BrandStorePages
 from .reports import Reports
 from .labels import Labels
 from .manager_accounts import ManagerAccounts
+from .recommendations import Recommendations
 
 __all__ = [
     "Campaigns",
@@ -28,4 +29,5 @@ __all__ = [
     "Reports",
     "Labels",
     "ManagerAccounts",
+    "Recommendations",
 ]

ad_api/api/v1/recommendations.py

@@ -0,0 +1,87 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class Recommendations(Client):
+    r"""
+    Recommendations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - recommendations
+
+    Three routes, two of them generic and one per product:
+
+        POST /adsApi/v1/query/recommendations      QueryRecommendation
+        GET  /adsApi/v1/recommendations            ListRecommendation
+        POST /adsApi/v1/create/recommendations/sb  SBCreateRecommendation
+
+    Only the create carries a product suffix in its path. The query and the
+    list are generic and take the product in ``adProductFilter``, so a
+    Sponsored Products or Sponsored Display create would sit beside the SB one
+    under its own suffix without touching these two.
+
+    The query requires ``accessRequestedAccounts``, the same account selector
+    the v1 reports family uses, so the account travels in the body and not only
+    in the headers.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/recommendations', method='POST')
+    def query_recommendations(self, **kwargs) -> ApiResponse:
+        r"""
+        query_recommendations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query Recommendations (operationId: QueryRecommendation)
+
+        Request Body [Required]
+            | **accessRequestedAccounts** (list<QueryRecommendationRequestAccessRequestedAccountItem>) : [required] 1..2000
+            | **adProductFilter** (dict) [optional]
+            | **recommendationTypeFilter** (dict) [optional]
+            | **recommendationTypeDetailsFilter** (dict) [optional]
+            | **marketplacesFilter** (dict) [optional]
+            | **languageFilter** (dict) [optional]
+            | **maxResults** (int) : 1..100, default 100
+            | **nextToken** (string)
+
+        Returns
+            | **recommendations** (list<Recommendation>) : 0..300
+            | **totalResults** (int)
+            | **nextToken** (string)
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/adsApi/v1/recommendations', method='GET')
+    def list_recommendations(self, **kwargs) -> ApiResponse:
+        r"""
+        list_recommendations(**params) -> ApiResponse
+
+        Amazon Ads API v1 - List Recommendations (operationId: ListRecommendation)
+
+        A GET with query parameters, not a body.
+
+        Returns
+            | **recommendations** (list<Recommendation>) : 0..300
+            | **totalResults** (int)
+            | **nextToken** (string)
+        """
+        path = kwargs.pop('path')
+        return self._request(path, params=kwargs)
+
+    @sp_endpoint('/adsApi/v1/create/recommendations/sb', method='POST')
+    def create_recommendations_sb(self, **kwargs) -> ApiResponse:
+        r"""
+        create_recommendations_sb(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create Sponsored Brands Recommendation (operationId: SBCreateRecommendation)
+
+        Request Body
+            | **recommendations** (list<SBRecommendationCreate>) : 1..1
+
+        Answer
+            207 MultiStatus with success[] and error[] indexed.
+
+        This route creates a recommendation in the account, so it is not a
+        read. It is the only route in the family with a product suffix.
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.5.2"
+__version__ = "1.5.3"

{python_amazon_ad_api-1.5.2.dist-info → python_amazon_ad_api-1.5.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.2
+Version: 1.5.3
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -314,6 +314,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/reports.html#ad_api.api.v1.Reports.Reports.create_report)
 * [Labels](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/labels.html#ad_api.api.v1.Labels.Labels.query_labels)
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/manager_accounts.html#ad_api.api.v1.ManagerAccounts.ManagerAccounts.query_manager_accounts)
+* [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendations.html#ad_api.api.v1.Recommendations.Recommendations.query_recommendations)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.2.dist-info → python_amazon_ad_api-1.5.3.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=NLrkQ2LAsgJRVGHe-rDXXXW41i69D_hoSh1yM92AX5M,22
+ad_api/version.py,sha256=Zp7MROdsvpLQ5mrGb8Sw1eImWsL_gO5A9AX2_i9Wo5E,22
 ad_api/api/__init__.py,sha256=M07SD5BRC1L4_PqxLc8cKPI9Iq5zC2jPhkFUeHoh6CM,1632
 ad_api/api/account.py,sha256=CmOvCfHoPWaeTUJvtB0pNoNulZVSz4oMMCKIpVTpHos,2931
 ad_api/api/account_budgets.py,sha256=jFce5eLWAFK3ydjnYR7_Sv7B0-gHTG5bMTx_TcHyy1A,2319
@@ -89,7 +89,7 @@ ad_api/api/sp/product_recommendations.py,sha256=vXoZIRqcFc5bo9MUprArKndxcEYe_Puy
 ad_api/api/sp/product_targeting_v3.py,sha256=vk_T0piHzP5uwt8HSHm5hFKP_0sXJD8nbyooPtM-BTs,9567
 ad_api/api/sp/ranked_keywords_recommendations.py,sha256=QYFje19TFmwhedh7sn5VJIypL8gp6d6tpBQCpf_SIXw,13094
 ad_api/api/sp/schedule_based_bid_optimization.py,sha256=G8VkS7iP1lTIAxZgbfRCLz8njw1DkVH9HQPOZ63pWNU,2371
-ad_api/api/v1/__init__.py,sha256=svMwDtx7QswApWJ1fJ0Giw9l2YiRCoyzGq0-lRebnq4,876
+ad_api/api/v1/__init__.py,sha256=cYjdTZTQcryokPlqvwdu4zqb1H0f3ovC5VtUEbUzcKo,944
 ad_api/api/v1/ad_associations.py,sha256=g5L8hAIagmsb-yQ09hP7z1zbVVe868NlpOOokv-Mouc,5812
 ad_api/api/v1/ad_extensions.py,sha256=kL-7xHaXXqb2jXTwZrY0oGttLAG0CW_IjBAqL_CI92U,5519
 ad_api/api/v1/ad_groups.py,sha256=pQhCVdve_O6kbL4mBA5bxxhKcKNl_BKqa7z9DvrxwaM,12626
@@ -102,6 +102,7 @@ ad_api/api/v1/brand_stores.py,sha256=zlBsKiOwmdSiIG9filgdqUlPnV6AX-gE6S5nNyAQACc
 ad_api/api/v1/campaigns.py,sha256=u5PlvoAhgVhMxbCvYkPgqtbYK3TXXcb7TMie0Qjrgwc,9573
 ad_api/api/v1/labels.py,sha256=jjPmafIQZTh99Ztj5MCcDC7UyoFFN0YuWdn2syqd3Yg,2438
 ad_api/api/v1/manager_accounts.py,sha256=cNAs1Qq6SYG0y4_4UpNBDfItqBJ1NvYACsIvFc8h-rw,4980
+ad_api/api/v1/recommendations.py,sha256=RJfmwUQ4YOcTdXiHz_U2ArJ01B29vKleRS_avJFjS14,3737
 ad_api/api/v1/reports.py,sha256=vJmWhIsALkX27HeijTsSUz3zrYhUBm4RodTCieJD8Y8,6657
 ad_api/api/v1/targets.py,sha256=a4BzPjg9m1JJwqphhpQOFkNIcgCw7v4-K0sNzOihMZI,12355
 ad_api/auth/__init__.py,sha256=B_yKdmsHENQaKfMFAIcSxQqG4aBUmNBm5orKIMUYObk,229
@@ -119,8 +120,8 @@ ad_api/base/exceptions.py,sha256=9D3M40ZIlLS0fA-aQh1BTWPOW-Nvf0tRhbA85jFnDJ4,438
 ad_api/base/helpers.py,sha256=UK7Q13vZ0mNdF54xzfzoGDn2O_cd2yPrK2X4rOzC41c,2334
 ad_api/base/marketplaces.py,sha256=44lvCcluXNpqTprWQ80e3weSQmQbJoWL-WDSOWVbCyQ,4657
 ad_api/base/utils.py,sha256=_qnCBOvyJTLgaZjJzUWTi38GGLHkQszXELs79133Rb4,5618
-python_amazon_ad_api-1.5.2.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.5.2.dist-info/METADATA,sha256=UYOy1zbCPXhih_Bl02eQ97h2J2mTUvKgN58w5XxjFXI,23251
-python_amazon_ad_api-1.5.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.5.2.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.5.2.dist-info/RECORD,,
+python_amazon_ad_api-1.5.3.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.5.3.dist-info/METADATA,sha256=8Lgm9W1OraN7Jrjt12c61YiOiqpRHQ7aonb0i3hz5jg,23418
+python_amazon_ad_api-1.5.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.5.3.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.5.3.dist-info/RECORD,,