Geo Locations

Amazon Ads API v1 - geographic locations for targeting

Documentation: https://advertising.amazon.com/API/docs/en-us/api-spec-v1-geo-locations Specification: https://d1y2lf8k3vrkfu.cloudfront.net/openapi/en-us/dest/AmazonAdsAPIALLGeoLocationsContract_prod_3p.json

One route, and it only creates:

POST /adsApi/v1/create/geoLocations

Warning

The contract declares no query and no delete, so a location created through this family cannot be read back or removed from it. Treat the call as a write that leaves an object in the account, not as a lookup, and do not fire it to see what happens.

Two shapes sit under location, exactly one of them per entry:

radiusLocation: A point of interest and a radius around it. pointOfInterestRadius and units are required, with units one of KILOMETERS or MILES. The centre is either coordinates (latitude and longitude) or pointOfInterestAddress, which accepts an address or a place name. The minimum radius is 0.37 miles (2000 ft, 0.6 km).
smartLocation: Postal codes chosen by a sales index percentile. locationIndexId and name are required; minIndexValuePercentile and maxIndexValuePercentile take 0 to 100 with the minimum below the maximum.

Up to 100 locations per call, and the answer is a 207 multi-status indexed the same way as the other write routes.

class ad_api.api.v1.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

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.