python-amazon-ad-api 1.4.2__py3-none-any.whl → 1.4.4__py3-none-any.whl

ad_api/api/v1/__init__.py

@@ -5,6 +5,8 @@ from .targets import Targets
 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
 
 __all__ = [
     "Campaigns",
@@ -14,4 +16,6 @@ __all__ = [
     "AdExtensions",
     "AdvertiserAccounts",
     "AdAssociations",
+    "BrandStoreEditionPublishVersions",
+    "BrandStores",
 ]

ad_api/api/v1/brand_store_edition_publish_versions.py

@@ -0,0 +1,98 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class BrandStoreEditionPublishVersions(Client):
+    r"""
+    BrandStoreEditionPublishVersions(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified BrandStoreEditionPublishVersions endpoints
+
+    Two routes, neither of which creates or deletes anything: a store edition
+    publish version is queried, and its state is moved between draft and
+    publish.
+
+    Permissions: ``amazon_stores_view`` or ``amazon_stores_edit`` for the
+    query, ``amazon_stores_edit`` alone for the update. This is Amazon Stores,
+    not DSP.
+
+    Two enums live here and they are not interchangeable:
+
+    - ``StorePublishState`` -- ``DRAFT`` or ``PUBLISH``. What the caller
+      decides, and the only one the update accepts.
+    - ``StorePublishStatus`` -- ``DRAFT`` or ``REVIEW_IN_PROGRESS``. Where
+      the content currently sits, and the only one the query filters on.
+
+    The two differ by one letter in the name and share the ``DRAFT`` value, so
+    sending one where the other belongs is a rejected request rather than a
+    silent mismatch.
+
+    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.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/brandStoreEditionPublishVersions', method='POST')
+    def query_brand_store_edition_publish_versions(self, **kwargs) -> ApiResponse:
+        r"""
+        query_brand_store_edition_publish_versions(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query (operationId: QueryBrandStoreEditionPublishVersion)
+
+        Requires one of these permissions: ["amazon_stores_edit", "amazon_stores_view"]
+
+        Request Body [Required]
+            | **editionIdFilter** (dict) [required]
+                | **include** (list<string>) : exactly one edition id
+            | **storeIdFilter** (dict) [required]
+                | **include** (list<string>) : exactly one store id
+            | **publishStatusFilter** (dict) [required]
+                | **include** (list<StorePublishStatus>) : exactly one of
+                  Enum [ DRAFT, REVIEW_IN_PROGRESS ]
+            | **maxResults** (int) [optional]
+            | **nextToken** (string) [optional]
+
+        Returns
+            ApiResponse. ``payload`` holds ``brandStoreEditionPublishVersions``
+            and ``nextToken``. Each entry carries ``editionId``, ``storeId``,
+            ``storeEditionPublishId``, ``publishState``, ``publishStatus`` and
+            ``pages`` -- the last one appears only in the answer.
+        """
+        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,
+        )
+
+    @sp_endpoint('/adsApi/v1/update/brandStoreEditionPublishVersions', method='POST')
+    def update_brand_store_edition_publish_versions(self, **kwargs) -> ApiResponse:
+        r"""
+        update_brand_store_edition_publish_versions(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Update (operationId: UpdateBrandStoreEditionPublishVersion)
+
+        Requires one of these permissions: ["amazon_stores_edit"]
+
+        The array holds exactly one element, not a range.
+
+        Request Body [Required]
+            | **brandStoreEditionPublishVersions** (list, exactly 1) [required]
+
+              Each element:
+                | **storeEditionPublishId** (string) [required] version to move
+                | **editionId** (string) [optional]
+                | **storeId** (string) [optional]
+                | **publishState** (string) [optional]
+                  Enum [ DRAFT, PUBLISH ] -- this is StorePublishState, not the
+                  StorePublishStatus the query filters on.
+
+        Returns
+            ApiResponse
+        """
+        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/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,
+        )

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.4.2"
+__version__ = "1.4.4"

{python_amazon_ad_api-1.4.2.dist-info → python_amazon_ad_api-1.4.4.dist-info}/METADATA

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

{python_amazon_ad_api-1.4.2.dist-info → python_amazon_ad_api-1.4.4.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=qjngKmjcwKn1c_BwAouVdai-TbnuKZo56EbqRdILxaI,22
+ad_api/version.py,sha256=6stz_YFBRP_lguydVylsTgSmj3VTb6WFq8Sp45WYQyY,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,12 +89,14 @@ 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=3fJ65Nj9aLyfLME_jXs6uAm7PlhfxBN4q-HDHmPuPcc,393
+ad_api/api/v1/__init__.py,sha256=uwEHyVmogxPwXbDqbL2iA2ev6aSamwHXUK4UPUgqFOY,573
 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
 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=Q8smB7zJJ1cEkYrCEo3_Ws9QICUcBOvB03eM77rlF4I,4258
+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
 ad_api/auth/__init__.py,sha256=B_yKdmsHENQaKfMFAIcSxQqG4aBUmNBm5orKIMUYObk,229
@@ -112,8 +114,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.2.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.4.2.dist-info/METADATA,sha256=TZgn0q-QwBVCAt_0gsLvXBZEsGjZ9UaGp6OFzlnk_aI,22058
-python_amazon_ad_api-1.4.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.4.2.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.4.2.dist-info/RECORD,,
+python_amazon_ad_api-1.4.4.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.4.4.dist-info/METADATA,sha256=7VgKYVOOth77rAC4lVNoSsX4sFn7wXq3TEc6-J1uTKU,22472
+python_amazon_ad_api-1.4.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.4.4.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.4.4.dist-info/RECORD,,