python-amazon-ad-api 1.4.6__tar.gz → 1.4.8__tar.gz

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.6
+Version: 1.4.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -310,6 +310,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [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)
+* [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)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/README.md

@@ -282,6 +282,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [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)
+* [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)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/ad_api/api/v1/__init__.py

@@ -8,6 +8,7 @@ from .ad_associations import AdAssociations
 from .brand_store_edition_publish_versions import BrandStoreEditionPublishVersions
 from .brand_stores import BrandStores
 from .brand_store_editions import BrandStoreEditions
+from .brand_store_pages import BrandStorePages
 
 __all__ = [
     "Campaigns",
@@ -20,4 +21,5 @@ __all__ = [
     "BrandStoreEditionPublishVersions",
     "BrandStores",
     "BrandStoreEditions",
+    "BrandStorePages",
 ]

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/ad_api/api/v1/brand_store_edition_publish_versions.py

@@ -28,6 +28,15 @@ class BrandStoreEditionPublishVersions(Client):
 
     Unlike the rest of v1, the query has no fully optional body: store, edition
     and publish status are all required, each accepting exactly one value.
+
+    ``StorePublishStatus`` declares two values but the service accepts only one:
+    asking for ``REVIEW_IN_PROGRESS`` answers ``400 Only DRAFT status query is
+    supported``. The enum is honest about what exists in the data model, not
+    about what can be queried.
+
+    The ``storeEditionPublishId`` in the answer is not a plain identifier but a
+    base64 token holding the schema version, the store, ``editionIdVersion`` and
+    the status -- pass it back to update unchanged.
     """
 
     @sp_endpoint('/adsApi/v1/query/brandStoreEditionPublishVersions', method='POST')
@@ -45,8 +54,10 @@ class BrandStoreEditionPublishVersions(Client):
             | **storeIdFilter** (dict) [required]
                 | **include** (list<string>) : exactly one store id
             | **publishStatusFilter** (dict) [required]
-                | **include** (list<StorePublishStatus>) : exactly one of
-                  Enum [ DRAFT, REVIEW_IN_PROGRESS ]
+                | **include** (list<StorePublishStatus>) : exactly one value.
+                  The contract declares [ DRAFT, REVIEW_IN_PROGRESS ] but the
+                  service rejects the second one with
+                  "400 Only DRAFT status query is supported". Send DRAFT.
             | **maxResults** (int) [optional]
             | **nextToken** (string) [optional]
 

python_amazon_ad_api-1.4.8/ad_api/api/v1/brand_store_pages.py

@@ -0,0 +1,63 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class BrandStorePages(Client):
+    r"""
+    BrandStorePages(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified BrandStorePages endpoints
+
+    One route, the query:
+
+        POST /adsApi/v1/query/brandStorePages
+
+    Permissions (either): ``amazon_stores_edit`` or ``amazon_stores_view``.
+
+    Three filters are required and each accepts exactly one value:
+    ``storeIdFilter``, ``editionIdFilter`` and ``pageIdFilter``. There is no way to
+    list every page of a store through this route -- the page identifiers come
+    from :class:`~ad_api.api.v1.BrandStores`, whose ``pageInfos`` carries one
+    ``tag`` per page, and that tag is the ``pageId`` used here.
+
+    A fourth filter, ``storeEditionPublishIdFilter``, is optional and takes the
+    base64 token from BrandStoreEditionPublishVersions.
+
+    The answer carries ``content``, the page body itself, which is why this
+    contract is far larger than its siblings. Read the shape before dumping it.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/brandStorePages', method='POST')
+    def query_brand_store_pages(self, **kwargs) -> ApiResponse:
+        r"""
+        query_brand_store_pages(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query BrandStorePages (operationId: QueryBrandStorePage)
+
+        Requires one of these permissions: ["amazon_stores_edit", "amazon_stores_view"]
+
+        Request Body [Required]
+            | **storeIdFilter** (dict) [required]
+                | **include** (list<string>) : exactly one store id
+            | **editionIdFilter** (dict) [required]
+                | **include** (list<string>) : exactly one edition id, "default"
+                  for a store's default edition
+            | **pageIdFilter** (dict) [required]
+                | **include** (list<string>) : exactly one page id, the tag seen
+                  in BrandStores' pageInfos
+            | **storeEditionPublishIdFilter** (dict) [optional]
+                | **include** (list<string>) : one base64 publish token
+            | **maxResults** (int) [optional]
+            | **nextToken** (string) [optional]
+
+        Returns
+            ApiResponse. ``payload`` holds ``brandStorePages`` and ``nextToken``.
+            Each page carries ``storeId``, ``editionId``, ``pageId``, ``pageType``,
+            ``content`` and, when published, ``storeEditionPublishId`.
+        """
+        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.8/ad_api/version.py

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

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.6
+Version: 1.4.8
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -310,6 +310,7 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [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)
+* [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)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -102,6 +102,7 @@ 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_store_pages.py
 ad_api/api/v1/brand_stores.py
 ad_api/api/v1/campaigns.py
 ad_api/api/v1/targets.py

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/setup.cfg

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

{python_amazon_ad_api-1.4.6 → python_amazon_ad_api-1.4.8}/setup.py

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

python_amazon_ad_api-1.4.6/ad_api/version.py

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