python-amazon-ad-api 1.5.6__tar.gz → 1.5.8__tar.gz

{python_amazon_ad_api-1.5.6/python_amazon_ad_api.egg-info → python_amazon_ad_api-1.5.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.6
+Version: 1.5.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -318,6 +318,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
 * [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
 * [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
+* [Recommendation Types](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendation_types.html#ad_api.api.v1.RecommendationTypes.RecommendationTypes.query_sb_recommendation_types)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8}/README.md

@@ -290,6 +290,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
 * [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
 * [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
+* [Recommendation Types](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendation_types.html#ad_api.api.v1.RecommendationTypes.RecommendationTypes.query_sb_recommendation_types)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

python_amazon_ad_api-1.5.8/ad_api/api/eligibility.py

@@ -0,0 +1,100 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+import logging
+
+
+class Eligibility(Client):
+    r"""Product and program eligibility for Amazon ads."""
+
+    @sp_endpoint('/eligibility/product/list', method='POST')
+    def get_eligibility(self, **kwargs) -> ApiResponse:
+        r"""
+        get_eligibility(body: (dict, str)) -> ApiResponse
+
+        Product eligibility for a set of ASINs. Only products sold by the
+        merchant behind the profile are accepted. The request carries ASINs,
+        but several SKUs may come back for one ASIN, and an ineligible
+        product comes back with the reasons rather than being left out.
+
+        body: | REQUIRED
+            '**adType**': *string* [dsp, sb, sd, sp] default sp
+            '**productDetailsList**': list of {asin, sku}
+            '**locale**': *string*
+        """
+        body = Utils.convert_body(kwargs.pop('body'), wrap=False)
+        return self._request(kwargs.pop('path'), data=body, params=kwargs)
+
+    @sp_endpoint('/eligibility/product/list', method='POST')
+    def get_eligibility_assistant(self, asin_list: list, sku_list: list = None,
+                                  ad_type: str = 'sp', locale: str = 'en-GB',
+                                  **kwargs) -> ApiResponse:
+        r"""
+        get_eligibility_assistant(asin_list, sku_list=None, ad_type='sp', locale='en-GB')
+
+        Builds the body for get_eligibility from plain lists.
+
+        sku_list is optional. When given it must be a list of the same length
+        as asin_list, so each entry pairs by position; a mismatch raises here
+        rather than sending a body the service will refuse.
+        """
+
+        if not asin_list:
+            raise ValueError('asin_list is empty; at least one ASIN is required')
+
+        if sku_list is not None:
+            if not isinstance(sku_list, list):
+                raise TypeError(
+                    'sku_list must be a list or None, got %s' % type(sku_list).__name__
+                )
+            if len(sku_list) != len(asin_list):
+                raise ValueError(
+                    'asin_list and sku_list must have the same length: %d != %d'
+                    % (len(asin_list), len(sku_list))
+                )
+
+        details = []
+
+        for index, asin in enumerate(asin_list):
+            entry = {'asin': asin}
+            if sku_list is not None:
+                entry['sku'] = sku_list[index]
+            details.append(entry)
+
+        body = {'adType': ad_type, 'productDetailsList': details, 'locale': locale}
+
+        logging.debug('get_eligibility_assistant body: %s', body)
+
+        return self.get_eligibility(body=body, **kwargs)
+
+    @sp_endpoint('/eligibility/programs', method='POST')
+    def get_program_eligibility(self, **kwargs) -> ApiResponse:
+        r"""
+        get_program_eligibility(body: dict) -> ApiResponse
+
+        Account level eligibility for the Amazon ad programs, not for a
+        product: Sponsored Products, Sponsored Brands, Sponsored Display,
+        Stores, DirectToConsumer, Amazon Attribution and the rest.
+
+        Two media types are declared:
+
+            application/json                      the default shape, with skipChecks
+            application/vnd.programeligibility.v2+json
+                                                  v2, with maxResults and nextToken
+
+        Pass media_type='v2' for the paginated one.
+        """
+
+        media_type = kwargs.pop('media_type', None)
+
+        if media_type == 'v2':
+            content_type = 'application/vnd.programeligibility.v2+json'
+        else:
+            content_type = 'application/json'
+
+        headers = {'Content-Type': content_type, 'Accept': 'application/json'}
+
+        return self._request(
+            kwargs.pop('path'),
+            data=Utils.convert_body(kwargs.pop('body'), wrap=False),
+            params=kwargs,
+            headers=headers,
+        )

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8}/ad_api/api/v1/__init__.py

@@ -16,6 +16,7 @@ from .recommendations import Recommendations
 from .selling_accounts import SellingAccounts
 from .label_object_associations import LabelObjectAssociations
 from .geo_locations import GeoLocations
+from .recommendation_types import RecommendationTypes
 
 __all__ = [
     "Campaigns",
@@ -36,4 +37,5 @@ __all__ = [
     "SellingAccounts",
     "LabelObjectAssociations",
     "GeoLocations",
+    "RecommendationTypes",
 ]

python_amazon_ad_api-1.5.8/ad_api/api/v1/recommendation_types.py

@@ -0,0 +1,48 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class RecommendationTypes(Client):
+    r"""
+    RecommendationTypes(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - recommendation types for Sponsored Brands
+
+    One route, read only, and the product is in the path:
+
+        POST /adsApi/v1/query/recommendationTypes/sb
+
+    This family lists the kinds of recommendation that exist. Recommendations
+    itself, in ad_api.api.v1.Recommendations, lists the ones the account
+    actually has.
+
+    Only the Sponsored Brands segment is published, and its schemas are
+    prefixed SB. The route keeps no SB in its name, so another product would
+    arrive as .../sp or .../sd beside it.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/recommendationTypes/sb', method='POST')
+    def query_sb_recommendation_types(self, **kwargs) -> ApiResponse:
+        r"""
+        query_sb_recommendation_types(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query SB Recommendation Types (operationId: SBQueryRecommendationType)
+
+        Request Body [All optional]
+            | **maxResults** (int) : 50..500, default 50
+            | **nextToken** (string) : token to navigate to the next page
+
+        Returns
+            | **recommendationTypes** (list<SBRecommendationType>) : 0..500
+                | **recommendationTypeId** (string) : [required] a UUID or a unique descriptive string
+                | **recommendationTypeTitle** (string) : [required]
+            | **nextToken** (string)
+
+        maxResults starts at 50, so a smaller value is a rejected body rather
+        than a shorter page. An empty body is valid and asks for the defaults.
+
+        Requires one of these permissions:
+            advertiser_campaign_view
+        """
+        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.8/ad_api/version.py

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

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8/python_amazon_ad_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.6
+Version: 1.5.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -318,6 +318,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
 * [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
 * [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
+* [Recommendation Types](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendation_types.html#ad_api.api.v1.RecommendationTypes.RecommendationTypes.query_sb_recommendation_types)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -109,6 +109,7 @@ ad_api/api/v1/geo_locations.py
 ad_api/api/v1/label_object_associations.py
 ad_api/api/v1/labels.py
 ad_api/api/v1/manager_accounts.py
+ad_api/api/v1/recommendation_types.py
 ad_api/api/v1/recommendations.py
 ad_api/api/v1/reports.py
 ad_api/api/v1/selling_accounts.py

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8}/setup.cfg

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

{python_amazon_ad_api-1.5.6 → python_amazon_ad_api-1.5.8}/setup.py

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

python_amazon_ad_api-1.5.6/ad_api/api/eligibility.py

@@ -1,72 +0,0 @@
-from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
-import json
-import logging
-
-
-class Eligibility(Client):
-    r""" """
-
-    @sp_endpoint('/eligibility/product/list', method='POST')
-    def get_eligibility(self, **kwargs) -> ApiResponse:
-        r"""
-
-        get_eligibility(body: (dict, str)) -> ApiResponse
-
-        Gets a list of advertising eligibility objects for a set of products. Requests are permitted only for products sold by the merchant associated with the profile. Note that the request object is a list of ASINs, but multiple SKUs are returned if there is more than one SKU associated with an ASIN. If a product is not eligible for advertising, the response includes an object describing the reasons for ineligibility.
-
-        body: | REQUIRED
-
-            '**adType**': *string*, {'description': 'Set to 'sp' to check product eligibility for Sponsored Products advertisements. Set to 'sb' to check product eligibility for Sponsored Brands advertisements. default: sp. [ sp, sb ]'}
-
-            '**productDetailsList**': *dict*, {'asin*': 'An Amazon product identifier.', 'sku': 'A seller product identifier'}
-
-            '**locale**': *string*, {'description': 'Set to the locale string in the table below to specify the language in which the response is returned.'}
-
-        Returns:
-
-            ApiResponse
-
-        """
-        body = Utils.convert_body(kwargs.pop('body'), wrap=False)
-        return self._request(kwargs.pop('path'), data=body, params=kwargs)
-
-    @sp_endpoint('/eligibility/product/list', method='POST')
-    def get_eligibility_assistant(self, asin_list: list, sku_list: list = None, ad_type: str = "sp", locale: str = "en-GB", **kwargs) -> ApiResponse:
-        r"""
-
-        get_eligibility_assistant(asin_list: list, sku_list: list = None, ad_type: str = "sp", locale:str = "en-GB") -> ApiResponse
-
-        Gets a list of advertising eligibility objects for a set of products. Requests are permitted only for products sold by the merchant associated with the profile. Note that the request object is a list of ASINs, but multiple SKUs are returned if there is more than one SKU associated with an ASIN. If a product is not eligible for advertising, the response includes an object describing the reasons for ineligibility.
-
-        | **asin_list**: 'A list of ASIN: An Amazon product identifier.'
-        | **sku_list**: 'A list of SKU: A seller product identifier'
-        | **adType**: *string*, {'description': 'Set to 'sp' to check product eligibility for Sponsored Products advertisements. Set to 'sb' to check product eligibility for Sponsored Brands advertisements. default: sp. [ sp, sb ]'}
-        | **locale**': *string*, {'description': 'Set to the locale string in the table below to specify the language in which the response is returned. default: en_GB'}
-
-        Returns:
-
-            ApiResponse
-
-        """
-
-        asin_dict = []
-
-        required = {}
-        required.update({'adType': ad_type})
-
-        if len(asin_list) > 0 and isinstance(sku_list, str) or sku_list is None:
-            for asin in asin_list:
-                asin_dict.append({'asin': asin})
-
-        if sku_list is not None and isinstance(sku_list, list):
-            if len(asin_list) == len(sku_list):
-                for i in range(len(asin_list)):
-                    asin_dict.append({'asin': asin_list[i], 'sku': sku_list[i]})
-            else:
-                logging.error("No coinciden las listas")
-
-        required.update({'productDetailsList': asin_dict})
-        required.update({'locale': locale})
-
-        data_str = json.dumps(required)
-        return self._request(kwargs.pop('path'), data=data_str, params=kwargs)

python_amazon_ad_api-1.5.6/ad_api/version.py

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