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

ad_api/api/v1/__init__.py

@@ -4,6 +4,7 @@ from .ads import Ads
 from .targets import Targets
 from .ad_extensions import AdExtensions
 from .advertiser_accounts import AdvertiserAccounts
+from .ad_associations import AdAssociations
 
 __all__ = [
     "Campaigns",
@@ -12,4 +13,5 @@ __all__ = [
     "Targets",
     "AdExtensions",
     "AdvertiserAccounts",
+    "AdAssociations",
 ]

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

ad_api/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.1
+Version: 1.4.2
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -306,6 +306,7 @@ 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)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

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

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=BqOI5y46o1G1RWC9bF1DPL-YM68lGYPmZt1pn6FZFZs,22
+ad_api/version.py,sha256=qjngKmjcwKn1c_BwAouVdai-TbnuKZo56EbqRdILxaI,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,8 @@ 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=PZUV64EpTwGeZaEJQO5GBr4WKloUaFPh2H55IidNscM,327
+ad_api/api/v1/__init__.py,sha256=3fJ65Nj9aLyfLME_jXs6uAm7PlhfxBN4q-HDHmPuPcc,393
+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
@@ -111,8 +112,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.1.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.4.1.dist-info/METADATA,sha256=60IbkJFCBtnuSn85xriw-jm_P-9LPPXvSvY9FmktSEw,21893
-python_amazon_ad_api-1.4.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.4.1.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.4.1.dist-info/RECORD,,
+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,,