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

ad_api/api/v1/__init__.py

@@ -3,6 +3,7 @@ from .ad_groups import AdGroups
 from .ads import Ads
 from .targets import Targets
 from .ad_extensions import AdExtensions
+from .advertiser_accounts import AdvertiserAccounts
 
 __all__ = [
     "Campaigns",
@@ -10,4 +11,5 @@ __all__ = [
     "Ads",
     "Targets",
     "AdExtensions",
+    "AdvertiserAccounts",
 ]

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

ad_api/version.py

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

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

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

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

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=8UhoYEXHs1Oai7BW_ExBmuwWnRI-yMG_u1fQAXMizHQ,22
+ad_api/version.py,sha256=BqOI5y46o1G1RWC9bF1DPL-YM68lGYPmZt1pn6FZFZs,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,10 +89,11 @@ 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=DRSUR1Qk9I5oL6c_VqUZpOu5hHOcOd08NnJ8B26paso,249
+ad_api/api/v1/__init__.py,sha256=PZUV64EpTwGeZaEJQO5GBr4WKloUaFPh2H55IidNscM,327
 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/campaigns.py,sha256=u5PlvoAhgVhMxbCvYkPgqtbYK3TXXcb7TMie0Qjrgwc,9573
 ad_api/api/v1/targets.py,sha256=a4BzPjg9m1JJwqphhpQOFkNIcgCw7v4-K0sNzOihMZI,12355
 ad_api/auth/__init__.py,sha256=B_yKdmsHENQaKfMFAIcSxQqG4aBUmNBm5orKIMUYObk,229
@@ -110,8 +111,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.0.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.4.0.dist-info/METADATA,sha256=GozMi00VyHrkz9Hz8AGmsBNOL8yurYhF0PQrzdnfHEI,21708
-python_amazon_ad_api-1.4.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.4.0.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.4.0.dist-info/RECORD,,
+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,,