Como geocodificar usando filtros

A API Geocode permite que você use filtros para obter os resultados desejados.

Uso potencial

Use filtros para restringir os resultados com base nas necessidades da sua empresa.

Exemplos

Limitar os resultados dentro de um país

Especifique um valor IncludeCountries para retornar valores desse país nos resultados.

Sample request

Sem issoIncludeCountries": ["USA"], a API Geocode retornará Vancouver, BC, Canadá.

{
  "QueryText": "Vancouver",
    "Filter" : {
        "IncludeCountries": ["USA"]
    }
}

Sample response

{
    "ResultItems": [
        {
            "PlaceId": "<Redacted>",
            "PlaceType": "Locality",
            "Title": "Vancouver, WA, United States",
            "Address": {
                "Label": "Vancouver, WA, United States",
                "Country": {
                    "Code2": "US",
                    "Code3": "USA",
                    "Name": "United States"
                },
                "Region": {
                    "Code": "WA",
                    "Name": "Washington"
                },
                "SubRegion": {
                    "Name": "Clark"
                },
                "Locality": "Vancouver",
                "PostalCode": "98660"
            },
            "Position": [
                -122.67156,
                45.63248
            ],
            "MapView": [
                -122.77466,
                45.57714,
                -122.46451,
                45.69803
            ],
            "MatchScores": {
                "Overall": 1,
                "Components": {
                    "Address": {
                        "Locality": 1
                    }
                }
            }
        }
    ]
}

cURL

curl --request POST \
  --url 'https://places.geo.eu-central-1.amazonaws.com/v2/geocode?key=Your_Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "QueryText": "Vancouver",
    "Filter" : {
        "IncludeCountries": ["USA"]
    }
}'

AWS CLI

aws geo-places geocode --key ${YourKey} --query-text "Vancouver" --filter '{"IncludeCountries": ["USA"]}'

Refine os resultados com filtros de tipo de local

Especifique um valor IncludePlaceTypes para retornar valores para aquela posição nos resultados.

Sample request

Sem issoIncludePlaceTypes": ["Street"], a API de Geocode retornará a Geórgia, um país. Você pode refinar ainda mais os resultados adicionando valores "IncludeCountries" de CAN e EUA e comparando os resultados.

{
  "QueryText": "Georgia", 
    "Filter" : {
        "IncludePlaceTypes": ["Street"]
    }
    
}

Sample response

{
    "ResultItems": [
        {
            "PlaceId": "<Redacted>",
            "PlaceType": "Street",
            "Title": "Georgia, Benito Juárez, CDMX, México",
            "Address": {
                "Label": "Georgia, Benito Juárez, CDMX, México",
                "Country": {
                    "Code2": "MX",
                    "Code3": "MEX",
                    "Name": "México"
                },
                "Region": {
                    "Code": "CDMX",
                    "Name": "Ciudad de México"
                },
                "SubRegion": {
                    "Name": "Ciudad de México"
                },
                "Locality": "Benito Juárez",
                "Street": "Georgia",
                "StreetComponents": [
                    {
                        "BaseName": "Georgia",
                        "Language": "es"
                    }
                ]
            },
            "Position": [
                -99.17754,
                19.38887
            ],
            "MapView": [
                -99.18133,
                19.38755,
                -99.17374,
                19.39016
            ],
            "MatchScores": {
                "Overall": 1,
                "Components": {
                    "Address": {
                        "Intersection": [
                            1
                        ]
                    }
                }
            }
        }
    ]
}

cURL

curl --request POST \
  --url 'https://places.geo.eu-central-1.amazonaws.com/v2/geocode?key=Your_Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "QueryText": "Georgia", 
    "Filter" : {
        "IncludePlaceTypes": ["Street"]
    }
    
}'

AWS CLI

aws geo-places geocode --key ${YourKey} --query-text "Georgia" --filter '{"IncludePlaceTypes": ["Street"]}'

Dicas para desenvolvedores

Para geocodificação de endereços, tente usar endereços completos ou um componente de consulta com uma combinação de posição tendenciosa, incluindo país e local. Para saber mais, consulte Como geocodificar um endereço.