python-amazon-ad-api 1.4.3__tar.gz → 1.4.5__tar.gz

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.3
+Version: 1.4.5
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -308,6 +308,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Advertiser Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/advertiser_accounts.html#ad_api.api.v1.AdvertiserAccounts.AdvertiserAccounts.query_advertiser_accounts)
 * [Ad Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ad_associations.html#ad_api.api.v1.AdAssociations.AdAssociations.query_ad_associations)
 * [Brand Store Edition Publish Versions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_edition_publish_versions.html#ad_api.api.v1.BrandStoreEditionPublishVersions.BrandStoreEditionPublishVersions.query_brand_store_edition_publish_versions)
+* [Brand Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_stores.html#ad_api.api.v1.BrandStores.BrandStores.query_brand_stores)
+* [Brand Store Editions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_editions.html#ad_api.api.v1.BrandStoreEditions.BrandStoreEditions.list_brand_store_editions)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/README.md

@@ -280,6 +280,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Advertiser Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/advertiser_accounts.html#ad_api.api.v1.AdvertiserAccounts.AdvertiserAccounts.query_advertiser_accounts)
 * [Ad Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ad_associations.html#ad_api.api.v1.AdAssociations.AdAssociations.query_ad_associations)
 * [Brand Store Edition Publish Versions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_edition_publish_versions.html#ad_api.api.v1.BrandStoreEditionPublishVersions.BrandStoreEditionPublishVersions.query_brand_store_edition_publish_versions)
+* [Brand Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_stores.html#ad_api.api.v1.BrandStores.BrandStores.query_brand_stores)
+* [Brand Store Editions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_editions.html#ad_api.api.v1.BrandStoreEditions.BrandStoreEditions.list_brand_store_editions)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/ad_api/api/v1/__init__.py

@@ -6,6 +6,8 @@ from .ad_extensions import AdExtensions
 from .advertiser_accounts import AdvertiserAccounts
 from .ad_associations import AdAssociations
 from .brand_store_edition_publish_versions import BrandStoreEditionPublishVersions
+from .brand_stores import BrandStores
+from .brand_store_editions import BrandStoreEditions
 
 __all__ = [
     "Campaigns",
@@ -16,4 +18,6 @@ __all__ = [
     "AdvertiserAccounts",
     "AdAssociations",
     "BrandStoreEditionPublishVersions",
+    "BrandStores",
+    "BrandStoreEditions",
 ]

python_amazon_ad_api-1.4.5/ad_api/api/v1/brand_store_editions.py

@@ -0,0 +1,52 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse
+
+
+class BrandStoreEditions(Client):
+    r"""
+    BrandStoreEditions(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified BrandStoreEditions endpoints
+
+    One route, and it is a ``GET`` with query parameters rather than the POST
+    body the rest of v1 uses:
+
+        GET /adsApi/v1/brandStoreEditions?brandStoreId=<id>
+
+    Permissions (either): ``amazon_stores_edit`` or ``amazon_stores_view``.
+
+    This is the middle link of the Stores chain:
+
+    - :class:`~ad_api.api.v1.BrandStores` gives the ``storeId``.
+    - here that becomes ``brandStoreId`` and returns the ``editionId``.
+    - :class:`~ad_api.api.v1.BrandStoreEditionPublishVersions` needs both.
+
+    ``maxResults`` is unusual: the range is 11 to 50 with a default of 50, not
+    the 1-based range the other families use.
+    """
+
+    @sp_endpoint('/adsApi/v1/brandStoreEditions', method='GET')
+    def list_brand_store_editions(self, brandStoreId, **kwargs) -> ApiResponse:
+        r"""
+        list_brand_store_editions(brandStoreId, **kwargs) -> ApiResponse
+
+        Amazon Ads API v1 - List BrandStoreEditions (operationId: ListBrandStoreEdition)
+
+        Requires one of these permissions: ["amazon_stores_edit", "amazon_stores_view"]
+
+        Query parameters
+            | **brandStoreId** (string) [required] the store id from BrandStores
+            | **maxResults** (int) [optional] range 11..50, default 50
+            | **nextToken** (string) [optional] token from a previous answer
+
+        Returns
+            ApiResponse. ``payload`` holds ``brandStoreEditions`` (0 to 50) and
+            ``nextToken``. Each edition carries ``editionId``, ``editionName``,
+            ``storeId`` and ``storeEditionSchedule``.
+
+            The ``editionId`` is what BrandStoreEditionPublishVersions filters on.
+        """
+        path = kwargs.pop('path')
+        kwargs.pop('method', None)
+        params = dict(kwargs)
+        params['brandStoreId'] = brandStoreId
+        return self._request(path, params=params)

python_amazon_ad_api-1.4.5/ad_api/api/v1/brand_stores.py

@@ -0,0 +1,52 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class BrandStores(Client):
+    r"""
+    BrandStores(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified BrandStores endpoints
+
+    One route: the query. A brand store is listed, never created here.
+
+    Permissions (any one): advertiser_campaign_edit, creatives_view,
+    account_view, creatives_edit, account_edit, campaign_view,
+    advertiser_campaign_view, campaign_edit.
+
+    ``storeNameFilter`` is required and takes exactly one name, so this route
+    cannot list every store on the account. The answer is the way in to the
+    rest of the Stores family: ``storeId`` from here is what
+    :class:`~ad_api.api.v1.BrandStoreEditionPublishVersions` needs as
+    ``storeIdFilter``.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/brandStores', method='POST')
+    def query_brand_stores(self, **kwargs) -> ApiResponse:
+        r"""
+        query_brand_stores(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query BrandStores (operationId: QueryBrandStore)
+
+        Requires one of these permissions: ["advertiser_campaign_edit",
+        "creatives_view", "account_view", "creatives_edit", "account_edit",
+        "campaign_view", "advertiser_campaign_view", "campaign_edit"]
+
+        Request Body [Required]
+            | **storeNameFilter** (dict) [required]
+                | **include** (list<string>) : exactly one store name
+            | **maxResults** (int) [optional]
+            | **nextToken** (string) [optional]
+
+        Returns
+            ApiResponse. ``payload`` holds ``brandStores`` and ``nextToken``.
+            Each store carries ``storeId`` (required), ``storeName`` and
+            ``pageInfos``. The ``storeId`` is what the publish-version family
+            filters on.
+        """
+        headers = {"Accept": "application/json", "Content-Type": "application/json"}
+        return self._request(
+            kwargs.pop('path'),
+            data=Utils.convert_body(kwargs.pop('body'), False),
+            params=kwargs,
+            headers=headers,
+        )

python_amazon_ad_api-1.4.5/ad_api/version.py

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

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.3
+Version: 1.4.5
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -308,6 +308,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Advertiser Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/advertiser_accounts.html#ad_api.api.v1.AdvertiserAccounts.AdvertiserAccounts.query_advertiser_accounts)
 * [Ad Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ad_associations.html#ad_api.api.v1.AdAssociations.AdAssociations.query_ad_associations)
 * [Brand Store Edition Publish Versions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_edition_publish_versions.html#ad_api.api.v1.BrandStoreEditionPublishVersions.BrandStoreEditionPublishVersions.query_brand_store_edition_publish_versions)
+* [Brand Stores](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_stores.html#ad_api.api.v1.BrandStores.BrandStores.query_brand_stores)
+* [Brand Store Editions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_editions.html#ad_api.api.v1.BrandStoreEditions.BrandStoreEditions.list_brand_store_editions)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -101,6 +101,8 @@ ad_api/api/v1/ad_groups.py
 ad_api/api/v1/ads.py
 ad_api/api/v1/advertiser_accounts.py
 ad_api/api/v1/brand_store_edition_publish_versions.py
+ad_api/api/v1/brand_store_editions.py
+ad_api/api/v1/brand_stores.py
 ad_api/api/v1/campaigns.py
 ad_api/api/v1/targets.py
 ad_api/auth/__init__.py

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/setup.cfg

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

{python_amazon_ad_api-1.4.3 → python_amazon_ad_api-1.4.5}/setup.py

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

python_amazon_ad_api-1.4.3/ad_api/version.py

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