python-amazon-ad-api 1.5.1__tar.gz → 1.5.3__tar.gz

{python_amazon_ad_api-1.5.1 → python_amazon_ad_api-1.5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.1
+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
@@ -313,6 +313,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Brand Store Pages](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_pages.html#ad_api.api.v1.BrandStorePages.BrandStorePages.query_brand_store_pages)
 * [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.1 → python_amazon_ad_api-1.5.3}/README.md

@@ -285,6 +285,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Brand Store Pages](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_pages.html#ad_api.api.v1.BrandStorePages.BrandStorePages.query_brand_store_pages)
 * [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.1 → python_amazon_ad_api-1.5.3}/ad_api/api/v1/__init__.py

@@ -11,6 +11,8 @@ from .brand_store_editions import BrandStoreEditions
 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",
@@ -26,4 +28,6 @@ __all__ = [
     "BrandStorePages",
     "Reports",
     "Labels",
+    "ManagerAccounts",
+    "Recommendations",
 ]

python_amazon_ad_api-1.5.3/ad_api/api/v1/manager_accounts.py

@@ -0,0 +1,110 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class ManagerAccounts(Client):
+    r"""
+    ManagerAccounts(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified ManagerAccounts endpoints
+
+    Three routes, no delete in the contract:
+
+        POST /adsApi/v1/create/managerAccounts
+        POST /adsApi/v1/query/managerAccounts
+        POST /adsApi/v1/update/managerAccounts
+
+    This family is not about ad products, so no adProductFilter appears
+    anywhere. The query declares no required member at all: an empty body is a
+    valid request and returns every manager account the caller can see.
+
+    Both write routes take up to 10 accounts per call and answer a multi-status
+    with success[] and error[] indexed the same way.
+
+    Alongside this class the package keeps the legacy manager account reader as
+    ad_api.api.ManagerAccounts; the two live in different packages and do not
+    shadow each other.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/managerAccounts', method='POST')
+    def query_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        query_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query Manager Accounts (operationId: QueryManagerAccount)
+
+        Request Body [All optional]
+            | **managerAccountIdFilter** (dict)
+                | **include** (list<string>) : 1..100 identifiers
+            | **maxResults** (int) : 10..100, default 100
+            | **nextToken** (string) : token to navigate to the next page
+
+        Returns
+            | **managerAccounts** (list<ManagerAccount>) : 0..100
+                | **displayName** (string)
+                | **managerAccountId** (string)
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **accountUsageType** (AccountUsageType)
+                | **businessDetails** (BusinessDetail)
+            | **nextToken** (string)
+
+        maxResults starts at 10: a value below that is a rejected body, not a
+        smaller page.
+        """
+        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/create/managerAccounts', method='POST')
+    def create_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        create_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create Manager Accounts (operationId: CreateManagerAccount)
+
+        Request Body [Required]
+            | **managerAccounts** (list<ManagerAccountCreate>) : [required] 1..10
+                | **displayName** (string) : required on create
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **accountUsageType** (AccountUsageType)
+                | **businessDetails** (CreateBusinessDetail)
+
+        Answer
+            207 MultiStatus: success[] carries the created accounts with their
+            index, error[] the index and reason of the refused ones.
+
+        This route creates an account in the manager hierarchy. It is not a
+        read and not something to fire to see what happens.
+        """
+        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/update/managerAccounts', method='POST')
+    def update_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        update_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Update Manager Accounts (operationId: UpdateManagerAccount)
+
+        Request Body [Required]
+            | **managerAccounts** (list<ManagerAccountUpdate>) : [required] 1..10
+                | **managerAccountId** (string) : the account to change
+                | **displayName** (string)
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **businessDetails** (UpdateBusinessDetail)
+
+        Answer
+            207 MultiStatus, indexed the same way as create.
+
+        businessDetails uses the Update variant of each nested object, so a
+        body copied from create is not interchangeable here.
+        """
+        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)

python_amazon_ad_api-1.5.3/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)

python_amazon_ad_api-1.5.3/ad_api/version.py

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

{python_amazon_ad_api-1.5.1 → python_amazon_ad_api-1.5.3}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.1
+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
@@ -313,6 +313,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Brand Store Pages](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_pages.html#ad_api.api.v1.BrandStorePages.BrandStorePages.query_brand_store_pages)
 * [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.1 → python_amazon_ad_api-1.5.3}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -106,6 +106,8 @@ ad_api/api/v1/brand_store_pages.py
 ad_api/api/v1/brand_stores.py
 ad_api/api/v1/campaigns.py
 ad_api/api/v1/labels.py
+ad_api/api/v1/manager_accounts.py
+ad_api/api/v1/recommendations.py
 ad_api/api/v1/reports.py
 ad_api/api/v1/targets.py
 ad_api/auth/__init__.py

{python_amazon_ad_api-1.5.1 → python_amazon_ad_api-1.5.3}/setup.cfg

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

{python_amazon_ad_api-1.5.1 → python_amazon_ad_api-1.5.3}/setup.py

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

python_amazon_ad_api-1.5.1/ad_api/version.py

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