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

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

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

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

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

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

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

python_amazon_ad_api-1.4.3/ad_api/api/v1/ad_associations.py

@@ -0,0 +1,138 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class AdAssociations(Client):
+    r"""
+    AdAssociations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified AdAssociations endpoints
+
+    An ad association links one ``adId`` to one ``adGroupId`` and decides how
+    much of the group's traffic that ad receives. ``weight`` is the relative
+    percentage directed to the creative, and ``startDateTime`` / ``endDateTime``
+    bound when the association applies.
+
+    This is the first v1 family in this client with all four operations: the
+    others stop at update, while this one also has a delete.
+
+    Update cannot move an association to another ad or ad group: only the dates,
+    the state and the weight are accepted, so reassigning means delete and
+    create.
+
+    Like AdvertiserAccounts, this is not an ad-product resource and takes no
+    ``adProductFilter`` -- the query filters by association, ad group or ad.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/adAssociations', method='POST')
+    def query_ad_associations(self, **kwargs) -> ApiResponse:
+        r"""
+        query_ad_associations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query AdAssociations (operationId: QueryAdAssociation)
+
+        Request Body
+            | **adAssociationIdFilter** (dict) [optional]
+                | **include** (list<string>) : association identifiers
+            | **adGroupIdFilter** (dict) [optional]
+                | **include** (list<string>) : ad group identifiers
+            | **adIdFilter** (dict) [optional]
+                | **include** (list<string>) : ad identifiers
+            | **maxResults** (int) [optional] Maximum number of records in the response
+            | **nextToken** (string) [optional] Token to navigate to the next page
+
+        Returns
+            ApiResponse. ``payload`` holds ``adAssociations`` and ``nextToken``.
+        """
+        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/create/adAssociations', method='POST')
+    def create_ad_associations(self, **kwargs) -> ApiResponse:
+        r"""
+        create_ad_associations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create AdAssociations (operationId: CreateAdAssociation)
+
+        Request Body [Required]
+            | **adAssociations** (list, 1..20) [required]
+
+              Each element:
+                | **adGroupId** (string) [required] the ad group the ad belongs to
+                | **adId** (string) [required] the ad being associated
+                | **state** (string) [required] Enum [ ENABLED, PAUSED ]
+                | **startDateTime** (string) [optional] when the association starts
+                | **endDateTime** (string) [optional] when it stops
+                | **weight** (integer) [optional] relative share of the ad
+                  group's traffic directed to this creative
+
+        Returns
+            ApiResponse. Per-entity result carrying ``success`` and ``error``,
+            not the created objects.
+        """
+        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/adAssociations', method='POST')
+    def update_ad_associations(self, **kwargs) -> ApiResponse:
+        r"""
+        update_ad_associations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Update AdAssociations (operationId: UpdateAdAssociation)
+
+        The ad and the ad group cannot be changed here. To point the same creative
+        at a different ad, delete the association and create a new one.
+
+        Request Body [Required]
+            | **adAssociations** (list, 1..20) [required]
+
+              Each element:
+                | **adAssociationId** (string) [required] association to update
+                | **startDateTime** (string) [optional]
+                | **endDateTime** (string) [optional]
+                | **state** (string) [optional] Enum [ ENABLED, PAUSED, ARCHIVED ]
+                | **weight** (integer) [optional]
+
+        Returns
+            ApiResponse. Per-entity result carrying ``success`` and ``error``.
+        """
+        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/delete/adAssociations', method='POST')
+    def delete_ad_associations(self, **kwargs) -> ApiResponse:
+        r"""
+        delete_ad_associations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Delete AdAssociations (operationId: DeleteAdAssociation)
+
+        The array is named ``adAssociationIds`` here, not ``adAssociations`` as in
+        create and update. Sending the wrong name is a rejected request.
+
+        Request Body [Required]
+            | **adAssociationIds** (list, 1..20) [required] associations to delete
+
+        Returns
+            ApiResponse. Per-entity result carrying ``success`` and ``error``.
+        """
+        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.3/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,
+        )

python_amazon_ad_api-1.4.3/ad_api/version.py

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

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

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

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

@@ -95,10 +95,12 @@ ad_api/api/sp/product_targeting_v3.py
 ad_api/api/sp/ranked_keywords_recommendations.py
 ad_api/api/sp/schedule_based_bid_optimization.py
 ad_api/api/v1/__init__.py
+ad_api/api/v1/ad_associations.py
 ad_api/api/v1/ad_extensions.py
 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/campaigns.py
 ad_api/api/v1/targets.py
 ad_api/auth/__init__.py

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

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

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

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

python_amazon_ad_api-1.4.1/ad_api/version.py

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