python-amazon-ad-api 1.5.4__py3-none-any.whl → 1.5.6__py3-none-any.whl

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",
 ]

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)

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)

ad_api/version.py

@@ -1 +1 @@
-__version__ = "1.5.4"
+__version__ = "1.5.6"

{python_amazon_ad_api-1.5.4.dist-info → python_amazon_ad_api-1.5.6.dist-info}/METADATA

@@ -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.dist-info → python_amazon_ad_api-1.5.6.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ad_api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-ad_api/version.py,sha256=6rozAm2Gs2qiJ0sE_ZKG2IERSD5Rh3ynVVW9TQr9YUU,22
+ad_api/version.py,sha256=u_3L7bjAA3w8BLRhTxxaVOCj_Cwsqn8JR4UZjPNAWbY,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=_fNoTMJHXxgcuoLy7vJZsj7f4YgU7mBpZW-u5SdbXYs,1013
+ad_api/api/v1/__init__.py,sha256=Y51M9bFX_nZhuiiJ1Co_9nQXi5fpCQSdK6BU75NPzqc,1167
 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/geo_locations.py,sha256=gH1kR1rPQuIdzStB6wvWI40-XRo5yFyVI9AYYcjN5_8,2641
+ad_api/api/v1/label_object_associations.py,sha256=zXuD5cUAfqL-PRObvjOM54KC356HFqnzA5ehpGSJPYk,2597
 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/recommendations.py,sha256=RJfmwUQ4YOcTdXiHz_U2ArJ01B29vKleRS_avJFjS14,3737
@@ -121,8 +123,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.4.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
-python_amazon_ad_api-1.5.4.dist-info/METADATA,sha256=rVLOOLuxFYPyj4ysENaOtgzKhYkVjGs80nZchxxSNfY,23588
-python_amazon_ad_api-1.5.4.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-python_amazon_ad_api-1.5.4.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
-python_amazon_ad_api-1.5.4.dist-info/RECORD,,
+python_amazon_ad_api-1.5.6.dist-info/licenses/LICENSE,sha256=h2rpqlmmLy-4l1tN6KpWAFxx1JEMYeEFrMrZUbx_B_o,1105
+python_amazon_ad_api-1.5.6.dist-info/METADATA,sha256=P-mpEe8OlzMB8dA-eu4MQkFh6nXHkr4Ey09arRKBTew,23957
+python_amazon_ad_api-1.5.6.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+python_amazon_ad_api-1.5.6.dist-info/top_level.txt,sha256=nN9twUos-8pkP514ZwpvRU9YL9L2XyQyHsMQFfudGTU,7
+python_amazon_ad_api-1.5.6.dist-info/RECORD,,