python-amazon-ad-api 1.5.0__tar.gz → 1.5.1__tar.gz

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/PKG-INFO

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

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/README.md

@@ -284,6 +284,7 @@ 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)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/ad_api/api/v1/__init__.py

@@ -10,6 +10,7 @@ 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
 
 __all__ = [
     "Campaigns",
@@ -24,4 +25,5 @@ __all__ = [
     "BrandStoreEditions",
     "BrandStorePages",
     "Reports",
+    "Labels",
 ]

python_amazon_ad_api-1.5.1/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)

python_amazon_ad_api-1.5.1/ad_api/version.py

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

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/python_amazon_ad_api.egg-info/PKG-INFO

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

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -105,6 +105,7 @@ ad_api/api/v1/brand_store_editions.py
 ad_api/api/v1/brand_store_pages.py
 ad_api/api/v1/brand_stores.py
 ad_api/api/v1/campaigns.py
+ad_api/api/v1/labels.py
 ad_api/api/v1/reports.py
 ad_api/api/v1/targets.py
 ad_api/auth/__init__.py

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/setup.cfg

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

{python_amazon_ad_api-1.5.0 → python_amazon_ad_api-1.5.1}/setup.py

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

python_amazon_ad_api-1.5.0/ad_api/version.py

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