python-amazon-ad-api 1.4.0__tar.gz → 1.4.2__tar.gz

{python_amazon_ad_api-1.4.0 → python_amazon_ad_api-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.0
+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
@@ -305,6 +305,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ads.html#ad_api.api.v1.Ads.Ads.query_ads)
 * [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.0 → python_amazon_ad_api-1.4.2}/README.md

@@ -277,6 +277,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ads.html#ad_api.api.v1.Ads.Ads.query_ads)
 * [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.0 → python_amazon_ad_api-1.4.2}/ad_api/api/v1/__init__.py

@@ -3,6 +3,8 @@ from .ad_groups import AdGroups
 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",
@@ -10,4 +12,6 @@ __all__ = [
     "Ads",
     "Targets",
     "AdExtensions",
+    "AdvertiserAccounts",
+    "AdAssociations",
 ]

python_amazon_ad_api-1.4.2/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.2/ad_api/api/v1/advertiser_accounts.py

@@ -0,0 +1,122 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class AdvertiserAccounts(Client):
+    r"""
+    AdvertiserAccounts(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified AdvertiserAccounts endpoints
+
+    Three routes and no delete, like the rest of the account family:
+
+    - ``create_advertiser_accounts`` -- 1 to 100 accounts per call.
+    - ``query_advertiser_accounts`` -- filter by identifier or by global flag.
+    - ``update_advertiser_accounts`` -- here the mutable fields really are
+      mutable: currency, time zone, display name, industry, manager link.
+
+    Unlike Ads, Targets or AdExtensions this is not an ad-product resource, so
+    there is no ``adProductFilter```; querying is by ``advertiserAccountIdFilter``
+    or ``isGlobalAccountFilter``.
+
+    ``managerAccountId`` decides what the account can run: without it the account
+    is created for Sponsored Ads only, and DSP needs it set.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/advertiserAccounts', method='POST')
+    def query_advertiser_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        query_advertiser_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query AdvertiserAccounts (operationId: QueryAdvertiserAccount)
+
+        Request Body
+            | **advertiserAccountIdFilter** (dict) [optional]
+                | **include** (list<string>) : advertiser account identifiers
+            | **isGlobalAccountFilter** (dict) [optional]
+                | **include** (list<boolean>) : true for global accounts
+            | **maxResults** (int) [optional] Maximum number of records in the response
+            | **nextToken** (string) [optional] Token to navigate to the next page
+
+        Returns
+            ApiResponse. ``payload`` holds ``advertiserAccounts`` 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/advertiserAccounts', method='POST')
+    def create_advertiser_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        create_advertiser_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create AdvertiserAccounts (operationId: CreateAdvertiserAccount)
+
+        Request Body [Required]
+            | **advertiserAccounts** (list, 1..100) [required]
+
+              Each element:
+                | **businessDetails** (list, exactly 1) [required]
+                  Carries either ``addressToken`` for an existing selling account
+                  address, or ``address`` when that account has none. Also accepts
+                  ``businessRegistrationNumber`` and ``website`.
+                | **currencyCode** (string) [optional] Enum of 34 ISO codes,
+                  including ``EUR``, ``USD``, ``GBP`
+                | **displayName** (string) [optional] name shown for the account
+                | **industryVertical** (string) [optional] Enum of 19 sectors
+                | **isGlobalAccount** (boolean) [optional]
+                | **isTestAccount** (boolean) [optional]
+                | **managerAccountId** (string) [optional] Required for
+                  ADSP-enabled accounts; without it the account is created for
+                  Sponsored Ads only.
+                | **sellingAccountLinkRequests** (list, 0..1) [optional]
+                | **timeZoneIana** (string) [optional] Enum of 42 IANA zones
+
+        The full enum lists live in the contract; they are not repeated here.
+
+        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,
+        )
+
+    @sp_endpoint('/adsApi/v1/update/advertiserAccounts', method='POST')
+    def update_advertiser_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        update_advertiser_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Update AdvertiserAccounts (operationId: UpdateAdvertiserAccount)
+
+        Request Body [Required]
+            | **advertiserAccounts** (list) [required]
+
+              Each element:
+                | **advertiserAccountId** (string) [required] account to update
+                | **businessDetails** (list) [optional]
+                | **currencyCode** (string) [optional]
+                | **displayName** (string) [optional]
+                | **industryVertical** (string) [optional]
+                | **isGlobalAccount** (boolean) [optional]
+                | **isTestAccount** (boolean) [optional]
+                | **managerAccountId** (string) [optional]
+                | **sellingAccountLinkRequests** (list) [optional]
+                | **timeZoneIana** (string) [optional]
+
+        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.2/ad_api/version.py

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

{python_amazon_ad_api-1.4.0 → python_amazon_ad_api-1.4.2}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.4.0
+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
@@ -305,6 +305,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Ads](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/ads.html#ad_api.api.v1.Ads.Ads.query_ads)
 * [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.0 → python_amazon_ad_api-1.4.2}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -95,9 +95,11 @@ 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/campaigns.py
 ad_api/api/v1/targets.py
 ad_api/auth/__init__.py

{python_amazon_ad_api-1.4.0 → python_amazon_ad_api-1.4.2}/setup.cfg

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

{python_amazon_ad_api-1.4.0 → python_amazon_ad_api-1.4.2}/setup.py

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

python_amazon_ad_api-1.4.0/ad_api/version.py

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