{"components":{"callbacks":{},"examples":{},"headers":{},"links":{},"parameters":{},"requestBodies":{},"responses":{"HexgateBadRequestV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Bad request"},"HexgateForbiddenV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Forbidden. The request failed because the user does not have access to the specified resource."},"HexgateInternalServerErrorV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Internal Server Error. Something went wrong on the server. Retry later and report an error if unresolved."},"HexgateNotFoundV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Not Found. The requested resource does not exist or is not visible for the user."},"HexgatePreconditionFailedV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"The input provided does not meet the required constraints for this operation to be performed successfully."},"HexgateTooManyRequestsV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Too Many Requests. The request was rate-limited. Retry later."},"HexgateUnauthorizedV1":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"description":"Unauthorized. The request failed because the user is not authenticated or is not allowed to invoke the operation."}},"schemas":{"DspGeoLocationV1":{"properties":{"category":{"description":"The geographic location category.","enum":["ARRONDISSEMENT","BEZIRK","CITY","COUNTRY","COUNTY","DEPARTMENT","DISTRICT","DMA","EMIRATE","KREIS","POSTAL_CODE","PREFECTURE","PROVINCE","RADIUS","REGION","SMART_LOCATION","STATE"],"type":"string"},"id":{"description":"The geographic location identifier.","type":"string"},"name":{"description":"The geographic location name.","type":"string"}},"type":"object"},"DspGeoLocationsV1":{"description":"List of the geoLocations.","properties":{"geoLocations":{"items":{"$ref":"#/components/schemas/DspGeoLocationV1"},"type":"array"},"nextToken":{"description":"Token used in following requests for pagination.","type":"string"}},"type":"object"},"Error":{"description":"The error response object.","properties":{"errors":{"items":{"$ref":"#/components/schemas/SubError"},"maxItems":10,"type":"array"},"message":{"description":"A human-readable description of the response.","type":"string"},"requestId":{"description":"Request Id that uniquely identifies your request.","type":"string"}}},"SubError":{"description":"The sub error object.","properties":{"errorType":{"type":"string"},"fieldName":{"type":"string"},"message":{"type":"string"}},"required":["errorType","message"],"type":"object"}},"securitySchemes":{}},"info":{"title":"DSP Discovery","version":"3.0"},"openapi":"3.0.1","paths":{"/dsp/geoLocations":{"get":{"description":"Gets location targeting objects based on geoLocationID(s) or a text query (country, state, city, postal code, or DMA). Either geoLocationIdFilter or textQuery must be supplied, but not both.\n\nText Query Examples:\n\nWhen you search for \"California States\", only the state of California is returned.\\\nWhen you search for \"California counties\" only the counties in California are returned.\\\nWhen you search for \"California postal\" only the zip codes in California are returned.\\\nWhen you search for \"California cities\" only the cities in California are returned.\\\nWhen you search for \"US states\" all of the US states are returned.\\\nWhen you search for \"US states A\" only the US states beginning with A are returned.\\\nWhen you search for \"US DMAs\" only the DMAs in the US are returned.\\\nWhen you search for \"US postal\" only the postal codes in the US are returned.\n","operationId":"getGeoLocations","parameters":[{"description":"The identifier of a client associated with a \"Login with Amazon\" account.","in":"header","name":"Amazon-Advertising-API-ClientId","required":true,"schema":{"type":"string"}},{"description":"The identifier of a profile associated with the advertiser account. Use `GET` method on Profiles resource to list profiles associated with the access token passed in the HTTP Authorization header.","in":"header","name":"Amazon-Advertising-API-Scope","required":true,"schema":{"type":"string"}},{"description":"The ID of the customer for which customer-saved geo locations will be queried. This should be the advertiser Id.","in":"header","name":"Amazon-Ads-AccountId","required":false,"schema":{"type":"string"}},{"description":"An array of location IDs to retrieve, up to 10 in one request.","in":"query","name":"geoLocationIdFilter","required":false,"schema":{"type":"string"}},{"description":"Filter by text such as city, state, country, dma, or postal code.","in":"query","name":"textQuery","required":false,"schema":{"type":"string"}},{"description":"Token from a previous request. Use in conjunction with the `maxResults` parameter to control pagination of the returned array.","in":"query","name":"nextToken","required":false,"schema":{"type":"string"}},{"description":"Sets the number of geoLocations in the returned array. Use in conjunction with the `nextToken` parameter to control pagination. The range for maxResults is [1,2000] with default as 10. For example, supplying maxResults\u003d20 with a previously returned token will fetch the next 20 items.","in":"query","name":"maxResults","required":false,"schema":{"default":"10","maximum":2000,"minimum":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DspGeoLocationsV1"}}},"description":"Successful operation."},"400":{"$ref":"#/components/responses/HexgateBadRequestV1"},"401":{"$ref":"#/components/responses/HexgateUnauthorizedV1"},"403":{"$ref":"#/components/responses/HexgateForbiddenV1"},"404":{"$ref":"#/components/responses/HexgateNotFoundV1"},"412":{"$ref":"#/components/responses/HexgatePreconditionFailedV1"},"429":{"$ref":"#/components/responses/HexgateTooManyRequestsV1"},"500":{"$ref":"#/components/responses/HexgateInternalServerErrorV1"}},"summary":"Gets locationTargeting objects based on locationTargetingId or text query.","tags":["GeoLocation"]}}}}