python-amazon-ad-api 1.5.4__tar.gz → 1.5.6__tar.gz

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.4
+Version: 1.5.6
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -316,6 +316,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/manager_accounts.html#ad_api.api.v1.ManagerAccounts.ManagerAccounts.query_manager_accounts)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendations.html#ad_api.api.v1.Recommendations.Recommendations.query_recommendations)
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
+* [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
+* [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/README.md

@@ -288,6 +288,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/manager_accounts.html#ad_api.api.v1.ManagerAccounts.ManagerAccounts.query_manager_accounts)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendations.html#ad_api.api.v1.Recommendations.Recommendations.query_recommendations)
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
+* [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
+* [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/ad_api/api/v1/__init__.py

@@ -14,6 +14,8 @@ from .labels import Labels
 from .manager_accounts import ManagerAccounts
 from .recommendations import Recommendations
 from .selling_accounts import SellingAccounts
+from .label_object_associations import LabelObjectAssociations
+from .geo_locations import GeoLocations
 
 __all__ = [
     "Campaigns",
@@ -32,4 +34,6 @@ __all__ = [
     "ManagerAccounts",
     "Recommendations",
     "SellingAccounts",
+    "LabelObjectAssociations",
+    "GeoLocations",
 ]

python_amazon_ad_api-1.5.6/ad_api/api/v1/geo_locations.py

@@ -0,0 +1,54 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class GeoLocations(Client):
+    r"""
+    GeoLocations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - geographic locations for targeting
+
+    One route, and it only creates:
+
+        POST /adsApi/v1/create/geoLocations
+
+    The contract declares no query and no delete, so a location created here
+    cannot be read back or removed through this family. Treat it as a write
+    that leaves an object in the account rather than as a lookup.
+
+    Two shapes sit under ``location``, exactly one of them per entry:
+
+        radiusLocation   a point of interest and a radius around it
+        smartLocation    postal codes picked by a sales index percentile
+    """
+
+    @sp_endpoint('/adsApi/v1/create/geoLocations', method='POST')
+    def create_geo_locations(self, **kwargs) -> ApiResponse:
+        r"""
+        create_geo_locations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Create Geo Locations (operationId: CreateGeoLocation)
+
+        Request Body [Required]
+            | **geoLocations** (list<GeoLocationCreate>) : [required] 1..100
+                | **location** (CreateGeoLocationUnion) : [required] one of:
+                    | **radiusLocation** (CreateRadiusLocation)
+                        | **pointOfInterestRadius** (double) : [required] kilometres or miles
+                        | **units** (DistanceUnit) : [required] Enum [ KILOMETERS, MILES ]
+                        | **coordinates** (CreateGeoLocationCoordinates) : latitude and longitude
+                        | **pointOfInterestAddress** (string) : an address or a place name
+                    | **smartLocation** (CreateSmartLocation)
+                        | **locationIndexId** (string) : [required] the index the selection is based on
+                        | **name** (string) : [required]
+                        | **minIndexValuePercentile** (int) : 0..100
+                        | **maxIndexValuePercentile** (int) : 0..100, greater than the minimum
+
+        Answer
+            207 MultiStatus with success[] and error[] indexed the same way;
+            each success carries the created GeoLocation and its position.
+
+        A radius needs at least 0.37 miles (2000 ft, 0.6 km), and the two
+        percentile values must not cross.
+        """
+        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.6/ad_api/api/v1/label_object_associations.py

@@ -0,0 +1,57 @@
+from ad_api.base import Client, sp_endpoint, ApiResponse, Utils
+
+
+class LabelObjectAssociations(Client):
+    r"""
+    LabelObjectAssociations(account='default', marketplace: Marketplaces = Marketplaces.EU, credentials=None, debug=False)
+
+    Amazon Ads API v1 - label to object associations
+
+    One route, read only:
+
+        POST /adsApi/v1/query/labelObjectAssociations
+
+    Labels itself lists the labels that exist. This family lists what each
+    label is applied to, so the pair answers "which labels do I have" and
+    "what is tagged".
+
+    The required member is ``labelObjectTypeFilter``, not the adProductFilter
+    the campaign families carry, and it takes exactly one value:
+
+        AD_GROUP, CAMPAIGN, DEAL, INVENTORY_GROUP
+    """
+
+    @sp_endpoint('/adsApi/v1/query/labelObjectAssociations', method='POST')
+    def query_label_object_associations(self, **kwargs) -> ApiResponse:
+        r"""
+        query_label_object_associations(body: dict) -> ApiResponse
+
+        Amazon Ads API v1 - Query Label Object Associations (operationId: QueryLabelObjectAssociation)
+
+        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
+            | **labelIdFilter** (dict) : [optional] 1..50 ids
+            | **labelObjectIdFilter** (dict) : [optional] 1..50 ids
+            | **maxResults** (int) : 1..5000, default 100
+            | **nextToken** (string)
+
+        Returns
+            | **labelObjectAssociations** (list<LabelObjectAssociation>) : 0..5000
+                | **labelObjectAssociationId** (string) : [required]
+                | **labelId** (string) : [required] the label being applied
+                | **labelObjectId** (string) : [required] the object, e.g. a deal id or an ad group id
+                | **labelObjectType** (LabelObjectType) : [required]
+                | **adProduct** (AdProduct)
+            | **nextToken** (string)
+
+        maxResults reaches 5000 here, far above the 100 of the campaign
+        families, because associations grow with the number of tagged objects.
+
+        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.6/ad_api/version.py

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

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/python_amazon_ad_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-amazon-ad-api
-Version: 1.5.4
+Version: 1.5.6
 Summary: Python wrapper for the Amazon Advertising API
 Home-page: https://github.com/denisneuf/python-amazon-ad-api
 Author: Daniel Alvaro
@@ -316,6 +316,8 @@ The v1 API lives under `/adsApi/v1/` and is **not** split by product: every call
 * [Manager Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/manager_accounts.html#ad_api.api.v1.ManagerAccounts.ManagerAccounts.query_manager_accounts)
 * [Recommendations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/recommendations.html#ad_api.api.v1.Recommendations.Recommendations.query_recommendations)
 * [Selling Accounts](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/selling_accounts.html#ad_api.api.v1.SellingAccounts.SellingAccounts.query_selling_accounts)
+* [Label Object Associations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/label_object_associations.html#ad_api.api.v1.LabelObjectAssociations.LabelObjectAssociations.query_label_object_associations)
+* [Geo Locations](https://python-amazon-ad-api.readthedocs.io/en/latest/v1/geo_locations.html#ad_api.api.v1.GeoLocations.GeoLocations.create_geo_locations)
 
 
 ### [Modules Available Sponsored Products](https://python-amazon-ad-api.readthedocs.io/en/latest/sp.html)

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/python_amazon_ad_api.egg-info/SOURCES.txt

@@ -105,6 +105,8 @@ 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/geo_locations.py
+ad_api/api/v1/label_object_associations.py
 ad_api/api/v1/labels.py
 ad_api/api/v1/manager_accounts.py
 ad_api/api/v1/recommendations.py

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/setup.cfg

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

{python_amazon_ad_api-1.5.4 → python_amazon_ad_api-1.5.6}/setup.py

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

python_amazon_ad_api-1.5.4/ad_api/version.py

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