python-amazon-ad-api 1.5.0__py3-none-any.whl → 1.5.2__py3-none-any.whl

ad_api/api/v1/__init__.py

@@ -10,6 +10,8 @@ from .brand_stores import BrandStores
 from .brand_store_editions import BrandStoreEditions
 from .brand_store_pages import BrandStorePages
 from .reports import Reports
+from .labels import Labels
+from .manager_accounts import ManagerAccounts
 
 __all__ = [
     "Campaigns",
@@ -24,4 +26,6 @@ __all__ = [
     "BrandStoreEditions",
     "BrandStorePages",
     "Reports",
+    "Labels",
+    "ManagerAccounts",
 ]

ad_api/api/v1/labels.py

@@ -0,0 +1,56 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class Labels(Client):
+    r"""
+    Labels(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified Labels endpoints
+
+    Labels has a single route and it is read only: there is no create, update
+    or delete in the contract.
+
+    The required member is not the usual adProductFilter but
+    ``labelObjectTypeFilter``, and it takes exactly one value:
+
+        AD_GROUP, CAMPAIGN, DEAL, INVENTORY_GROUP
+
+    ``adProductFilter`` is optional here and also takes exactly one value.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/labels', method='POST')
+    def query_labels(self, **kwargs) -> ApiResponse:
+        r"""
+        query_labels(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query Labels (operationId: QueryLabel)
+
+        Request Body [Required]
+            | **labelObjectTypeFilter** (dict) : [required] exactly one value
+                | **include** (list<LabelObjectType>) : Enum [ AD_GROUP, CAMPAIGN, DEAL, INVENTORY_GROUP ]
+            | **adProductFilter** (dict) : [optional] exactly one value
+                | **include** (list<AdProduct>) : Enum [ AMAZON_DSP, SPONSORED_BRANDS, SPONSORED_DISPLAY, SPONSORED_PRODUCTS, SPONSORED_TELEVISION ]
+            | **labelIdFilter** (dict) : [optional] 1..50 ids
+                | **include** (list<string>)
+            | **labelNameFilter** (dict) : [optional] 1..10 names
+                | **include** (list<string>)
+            | **maxResults** (int) : 1..1000, default 100
+            | **nextToken** (string) : token to navigate to the next page
+
+        Returns
+            | **labels** (list<Label>) : 0..1000
+                | **labelId** (string) : [required]
+                | **labelName** (string) : [required]
+                | **adProduct** (AdProduct)
+            | **nextToken** (string)
+
+        A body without labelObjectTypeFilter is a rejected request, not an
+        empty answer, so every call needs that member even when the other
+        filters are left out.
+
+        Requires one of these permissions:
+            campaign_edit, campaign_view
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)

ad_api/api/v1/manager_accounts.py

@@ -0,0 +1,110 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class ManagerAccounts(Client):
+    r"""
+    ManagerAccounts(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - unified ManagerAccounts endpoints
+
+    Three routes, no delete in the contract:
+
+        POST /adsApi/v1/create/managerAccounts
+        POST /adsApi/v1/query/managerAccounts
+        POST /adsApi/v1/update/managerAccounts
+
+    This family is not about ad products, so no adProductFilter appears
+    anywhere. The query declares no required member at all: an empty body is a
+    valid request and returns every manager account the caller can see.
+
+    Both write routes take up to 10 accounts per call and answer a multi-status
+    with success[] and error[] indexed the same way.
+
+    Alongside this class the package keeps the legacy manager account reader as
+    ad_api.api.ManagerAccounts; the two live in different packages and do not
+    shadow each other.
+    """
+
+    @sp_endpoint('/adsApi/v1/query/managerAccounts', method='POST')
+    def query_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        query_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query Manager Accounts (operationId: QueryManagerAccount)
+
+        Request Body [All optional]
+            | **managerAccountIdFilter** (dict)
+                | **include** (list<string>) : 1..100 identifiers
+            | **maxResults** (int) : 10..100, default 100
+            | **nextToken** (string) : token to navigate to the next page
+
+        Returns
+            | **managerAccounts** (list<ManagerAccount>) : 0..100
+                | **displayName** (string)
+                | **managerAccountId** (string)
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **accountUsageType** (AccountUsageType)
+                | **businessDetails** (BusinessDetail)
+            | **nextToken** (string)
+
+        maxResults starts at 10: a value below that is a rejected body, not a
+        smaller page.
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/adsApi/v1/create/managerAccounts', method='POST')
+    def create_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        create_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create Manager Accounts (operationId: CreateManagerAccount)
+
+        Request Body [Required]
+            | **managerAccounts** (list<ManagerAccountCreate>) : [required] 1..10
+                | **displayName** (string) : required on create
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **accountUsageType** (AccountUsageType)
+                | **businessDetails** (CreateBusinessDetail)
+
+        Answer
+            207 MultiStatus: success[] carries the created accounts with their
+            index, error[] the index and reason of the refused ones.
+
+        This route creates an account in the manager hierarchy. It is not a
+        read and not something to fire to see what happens.
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        return self._request(kwargs.pop('path'), data=Utils.convert_body(kwargs.pop('body'), False), params=kwargs, headers=headers)
+
+    @sp_endpoint('/adsApi/v1/update/managerAccounts', method='POST')
+    def update_manager_accounts(self, **kwargs) -> ApiResponse:
+        r"""
+        update_manager_accounts(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Update Manager Accounts (operationId: UpdateManagerAccount)
+
+        Request Body [Required]
+            | **managerAccounts** (list<ManagerAccountUpdate>) : [required] 1..10
+                | **managerAccountId** (string) : the account to change
+                | **displayName** (string)
+                | **currencyCode** (CurrencyCode)
+                | **timeZoneIana** (TimeZoneIana)
+                | **industryVertical** (IndustryVertical)
+                | **businessDetails** (UpdateBusinessDetail)
+
+        Answer
+            207 MultiStatus, indexed the same way as create.
+
+        businessDetails uses the Update variant of each nested object, so a
+        body copied from create is not interchangeable here.
+        """
+        schema_version = 'application/json'
+        headers = {"Accept": schema_version, "Content-Type": schema_version}
+        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.5.0"
+__version__ = "1.5.2"

{python_amazon_ad_api-1.5.0.dist-info → python_amazon_ad_api-1.5.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.0
+Version: 1.5.2
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -312,6 +312,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Brand Store Editions](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_editions.html#ad_api.api.v1.BrandStoreEditions.BrandStoreEditions.list_brand_store_editions)
 * [Brand Store Pages](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/brand_store_pages.html#ad_api.api.v1.BrandStorePages.BrandStorePages.query_brand_store_pages)
 * [Reports](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/reports.html#ad_api.api.v1.Reports.Reports.create_report)
+* [Labels](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/labels.html#ad_api.api.v1.Labels.Labels.query_labels)
+* [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/manager_accounts.html#ad_api.api.v1.ManagerAccounts.ManagerAccounts.query_manager_accounts)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.0.dist-info → python_amazon_ad_api-1.5.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=X9pTeGHIYZtDOmfb9pnn2DEqWZMAyaPlqdFwEhsuSvk,22
+ad_api/version.py,sha256=NLrkQ2LAsgJRVGHe-rDXXXW41i69D_hoSh1yM92AX5M,22
 ad_api/api/__init__.py,sha256=M07SD5BRC1L4_PqxLc8cKPI9Iq5zC2jPhkFUeHoh6CM,1632
 ad_api/api/account.py,sha256=CmOvCfHoPWaeTUJvtB0pNoNulZVSz4oMMCKIpVTpHos,2931
 ad_api/api/account_budgets.py,sha256=jFce5eLWAFK3ydjnYR7_Sv7B0-gHTG5bMTx_TcHyy1A,2319
@@ -89,7 +89,7 @@ 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=1Pcd2suLJAL2yOFl_2p_rQe20ogRJEMIAdfGiLxlT90,766
+ad_api/api/v1/__init__.py,sha256=svMwDtx7QswApWJ1fJ0Giw9l2YiRCoyzGq0-lRebnq4,876
 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
@@ -100,6 +100,8 @@ ad_api/api/v1/brand_store_editions.py,sha256=xW4z2jDWhNJn86tWlT3eLIRr0NEpxLhW1eA
 ad_api/api/v1/brand_store_pages.py,sha256=TrSQbqlXqFv7i7RooxlFZOBrwYfEMPLvRPSJ9FjO87o,2765
 ad_api/api/v1/brand_stores.py,sha256=zlBsKiOwmdSiIG9filgdqUlPnV6AX-gE6S5nNyAQACc,2131
 ad_api/api/v1/campaigns.py,sha256=u5PlvoAhgVhMxbCvYkPgqtbYK3TXXcb7TMie0Qjrgwc,9573
+ad_api/api/v1/labels.py,sha256=jjPmafIQZTh99Ztj5MCcDC7UyoFFN0YuWdn2syqd3Yg,2438
+ad_api/api/v1/manager_accounts.py,sha256=cNAs1Qq6SYG0y4_4UpNBDfItqBJ1NvYACsIvFc8h-rw,4980
 ad_api/api/v1/reports.py,sha256=vJmWhIsALkX27HeijTsSUz3zrYhUBm4RodTCieJD8Y8,6657
 ad_api/api/v1/targets.py,sha256=a4BzPjg9m1JJwqphhpQOFkNIcgCw7v4-K0sNzOihMZI,12355
 ad_api/auth/__init__.py,sha256=B_yKdmsHENQaKfMFAIcSxQqG4aBUmNBm5orKIMUYObk,229
@@ -117,8 +119,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.5.0.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.5.0.dist-info/METADATA,sha256=ofNprBWjLQQyP6eWTdG4JRGzOJwxjU0fKGryodntY-c,22959
-python_amazon_ad_api-1.5.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.5.0.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.5.0.dist-info/RECORD,,
+python_amazon_ad_api-1.5.2.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.5.2.dist-info/METADATA,sha256=UYOy1zbCPXhih_Bl02eQ97h2J2mTUvKgN58w5XxjFXI,23251
+python_amazon_ad_api-1.5.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.5.2.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.5.2.dist-info/RECORD,,