python-amazon-ad-api 1.4.7__py3-none-any.whl → 1.4.8__py3-none-any.whl

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",
 ]

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,
+        )

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.4.7"
+__version__ = "1.4.8"

{python_amazon_ad_api-1.4.7.dist-info → python_amazon_ad_api-1.4.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.7
+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.7.dist-info → python_amazon_ad_api-1.4.8.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=pHClr_RD94RdAO4nIJOBug2vXKKjcRzEGxsyrQcqnHY,22
+ad_api/version.py,sha256=F1u2mSK8Wly-J_mt7oHk_RJLir3nEN_Ri1OneijYSlc,22
 ad_api/api/__init__.py,sha256=TLMefdmuyrj3-vtxGlzX4Sl-lHmE3Rs6daYgw3zwO0c,1600
 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=Z4bhSFEyWu6SaSLH4kuYw_wAnp0tOR-KO2zqwqhAf0w,652
+ad_api/api/v1/__init__.py,sha256=leVUKT8N-3DriGfI-VDKFnIEtcqNSyFiHfeN2dfBAVQ,722
 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
@@ -97,6 +97,7 @@ ad_api/api/v1/ads.py,sha256=YwZGQ-4WuYquleELtwRI9L8w0fGw7FBRejQE-tZ5hKY,7941
 ad_api/api/v1/advertiser_accounts.py,sha256=_Y8GTHgQ2G-RhNg4cuvvfXvjIhLzstQAGSyr1WMRRfg,5405
 ad_api/api/v1/brand_store_edition_publish_versions.py,sha256=QFmcWMPwi0f7eW0Ox4pZCvMWHEzeeQc8dIq7_3eeg6Y,4898
 ad_api/api/v1/brand_store_editions.py,sha256=xW4z2jDWhNJn86tWlT3eLIRr0NEpxLhW1eA-T_hiXcI,2160
+ad_api/api/v1/brand_store_pages.py,sha256=TrSQbqlXqFv7i7RooxlFZOBrwYfEMPLvRPSJ9FjO87o,2765
 ad_api/api/v1/brand_stores.py,sha256=zlBsKiOwmdSiIG9filgdqUlPnV6AX-gE6S5nNyAQACc,2131
 ad_api/api/v1/campaigns.py,sha256=u5PlvoAhgVhMxbCvYkPgqtbYK3TXXcb7TMie0Qjrgwc,9573
 ad_api/api/v1/targets.py,sha256=a4BzPjg9m1JJwqphhpQOFkNIcgCw7v4-K0sNzOihMZI,12355
@@ -115,8 +116,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.4.7.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.4.7.dist-info/METADATA,sha256=5tMdLDA4qDoJbVVGFX0nEULMvAtu0ggqJW4Ke8D489I,22659
-python_amazon_ad_api-1.4.7.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.4.7.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.4.7.dist-info/RECORD,,
+python_amazon_ad_api-1.4.8.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.4.8.dist-info/METADATA,sha256=J5eizsL_okNqaRHdrfPb-y4IOyhQCxsGfUrbuxOlDXo,22832
+python_amazon_ad_api-1.4.8.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.4.8.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.4.8.dist-info/RECORD,,