As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
# Como usar a SearchNearby
Esta seção contém uma variedade de guias e exemplos de como usar a SearchNearby.
**Topics**
+ [Como pesquisar nas proximidades a partir de uma posição](how-to-search-nearby.md)
+ [Como pesquisar lugares próximos com base na categoria](how-to-search-nearby-category.md)
+ [Como pesquisar lugares próximos com base no tipo de alimento](how-to-search-nearby-food.md)
+ [Como pesquisar nas proximidades com base na rede de negócios](how-to-search-nearby-business.md)
+ [Como pesquisar nas proximidades dentro de um país](how-to-search-nearby-country.md)
+ [Como pesquisar nas proximidades usando o contexto geoespacial](how-to-search-nearby-geospatial.md)
# Como pesquisar nas proximidades a partir de uma posição
A SearchNearby API permite consultar todos os lugares e pontos de interesse (POI) próximos sem inserir nenhum texto específico. Os usuários podem explorar bairros POIs, descobrir e muito mais usando essa API. Isso exige um `QueryPosition`, que pode representar a localização de um dispositivo, a posição baseada em IP ou o centro da janela de visualização do mapa. Como alternativa, os usuários podem especificar uma cidade ou local para influenciar os resultados com base nas coordenadas geográficas desse local.
## Casos de uso possíveis
+ **Explore nas proximidades POIs:** veja todos os pontos de interesse próximos à posição atual.
+ **Explorar lugares próximos:** veja todas as localizações ou lugares próximos a determinada posição.
## Exemplos
### Pesquisar nas proximidades a partir de uma posição
Neste exemplo, a pesquisa é feita a partir de uma posição em Dubai com latitude 25.26951 e longitude 55.30884.
------
#### [ Sample request ]
```
{
"QueryPosition": [
55.30884,
25.26951
]
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "هما",
"Address": {
"Label": "هما, شارع مستشفى آل مكتوم, نايف دبي, الإمارات العربية المتحدة",
"Country": {
"Code2": "AE",
"Code3": "ARE",
"Name": "الإمارات العربية المتحدة"
},
"SubRegion": {
"Name": "دبي"
},
"Locality": "دبي",
"District": "نايف",
"Street": "شارع مستشفى آل مكتوم",
"StreetComponents": [
{
"BaseName": "مستشفى آل مكتوم",
"Type": "شارع",
"TypePlacement": "BeforeBaseName",
"TypeSeparator": " ",
"Language": "ar"
}
]
},
"Position": [
55.30884,
25.26951
],
"Distance": 0,
"Categories": [
{
"Id": "department_store",
"Name": "Department Store",
"LocalizedName": "مول تجاري",
"Primary": true
}
],
"BusinessChains": [
{
"Name": "HEMA",
"Id": "HEMA"
}
]
},
{
"PlaceId": "",
"PlaceType": "Locality",
"Title": "دبي, الإمارات العربية المتحدة",
"Address": {
"Label": "دبي, الإمارات العربية المتحدة",
"Country": {
"Code2": "AE",
"Code3": "ARE",
"Name": "الإمارات العربية المتحدة"
},
"SubRegion": {
"Name": "دبي"
},
"Locality": "دبي"
},
"Position": [
55.30884,
25.26951
],
"Distance": 0,
"MapView": [
54.64906,
24.62308,
55.7371,
25.36995
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
55.30884,
25.26951
],
"MaxResults": 2
}'
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position 55.30884 25.26951 \
--max-results 2
```
------
# Como pesquisar lugares próximos com base na categoria
A SearchNearby API permite a consulta de pontos de interesse (POI) com a inclusão ou exclusão de categorias especificadas. Isso pode ajudar os usuários a explorar bairros, descobrir locais POIs e muito mais. A API exige um `QueryPosition`, que pode se basear na localização do dispositivo, na posição do IP ou no centro da janela do mapa. Como alternativa, os usuários podem especificar uma cidade ou local, e a aplicação desviará os resultados com base nas coordenadas desse local.
Para saber mais sobre as categorias permitidas, consulte [Filtros de categorias](places-filtering.md#place-categories).
## Casos de uso possíveis
+ **Explorar as instalações locais:** encontre as instalações disponíveis em um bairro.
+ **Descobrir atrações turísticas:** identifique pontos turísticos em uma cidade.
+ **Planeje viagens em uma cidade:** organize viagens diferentes POIs dentro de uma cidade escolhida.
## Exemplos
### Incluir categoria
------
#### [ Sample request ]
```
{
"QueryPosition": [
4.35609,
50.84439
],
"Filter": {
"IncludeCategories": ["airport"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Brussels Airport",
"Address": {
"Label": "Brussels Airport, A201, 1930 Zaventem, België",
"Country": {
"Code2": "BE",
"Code3": "BEL",
"Name": "België"
},
"Region": {
"Code": "VLG",
"Name": "Vlaanderen"
},
"SubRegion": {
"Name": "Vlaams Brabant"
},
"Locality": "Zaventem",
"PostalCode": "1930",
"Street": "A201",
"StreetComponents": [
{
"BaseName": "A201",
"Language": "nl"
}
]
},
"Position": [
4.47767,
50.89452
],
"Distance": 10191,
"Categories": [
{
"Id": "airport",
"Name": "Airport",
"LocalizedName": "Luchthaven",
"Primary": true
}
]
},
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Internationale Luchthaven Antwerpen",
"Address": {
"Label": "Internationale Luchthaven Antwerpen, Luchthavenlei 1, 2100 Antwerpen, België",
"Country": {
"Code2": "BE",
"Code3": "BEL",
"Name": "België"
},
"Region": {
"Code": "VLG",
"Name": "Vlaanderen"
},
"SubRegion": {
"Name": "Antwerpen"
},
"Locality": "Antwerpen",
"District": "Deurne",
"PostalCode": "2100",
"Street": "Luchthavenlei",
"StreetComponents": [
{
"BaseName": "Luchthaven",
"Type": "lei",
"TypePlacement": "AfterBaseName",
"TypeSeparator": "",
"Language": "nl"
}
],
"AddressNumber": "1"
},
"Position": [
4.45083,
51.18867
],
"Distance": 38852,
"Categories": [
{
"Id": "airport",
"Name": "Airport",
"LocalizedName": "Luchthaven",
"Primary": true
}
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
4.35609,
50.84439
],
"Filter": {
"IncludeCategories": ["airport"]
},
"MaxResults": 2
}
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position 4.35609 50.84439 \
--filter '{"IncludeCategories": ["airport"]}' \
--max-results 2
```
------
### Excluir categoria
------
#### [ Sample request ]
```
{
"QueryPosition": [
4.35609,
50.84439
],
"Filter": {
"ExcludeCategories": ["airport"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Socialbrands Module 2",
"Address": {
"Label": "Socialbrands Module 2, Albertinaplein, 1000 Brussel, België",
"Country": {
"Code2": "BE",
"Code3": "BEL",
"Name": "België"
},
"Region": {
"Code": "BRU",
"Name": "Brussel"
},
"SubRegion": {
"Name": "Brussel"
},
"Locality": "Brussel",
"District": "Koningswijk",
"PostalCode": "1000",
"Street": "Albertinaplein",
"StreetComponents": [
{
"BaseName": "Albertina",
"Type": "plein",
"TypePlacement": "AfterBaseName",
"TypeSeparator": "",
"Language": "nl"
}
]
},
"Position": [
4.35609,
50.84439
],
"Distance": 0,
"Categories": [
{
"Id": "commercial_services",
"Name": "Commercial Services",
"LocalizedName": "Commerciële diensten",
"Primary": true
}
],
"Contacts": {
"Websites": [
{
"Value": "https://oneread.net"
}
]
},
"AccessPoints": [
{
"Position": [
4.35609,
50.84439
]
}
]
},
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Barman Privé",
"Address": {
"Label": "Barman Privé, Albertinaplein, 1000 Brussel, België",
"Country": {
"Code2": "BE",
"Code3": "BEL",
"Name": "België"
},
"Region": {
"Code": "BRU",
"Name": "Brussel"
},
"SubRegion": {
"Name": "Brussel"
},
"Locality": "Brussel",
"District": "Koningswijk",
"PostalCode": "1000",
"Street": "Albertinaplein",
"StreetComponents": [
{
"BaseName": "Albertina",
"Type": "plein",
"TypePlacement": "AfterBaseName",
"TypeSeparator": "",
"Language": "nl"
}
]
},
"Position": [
4.35609,
50.84439
],
"Distance": 0,
"Categories": [
{
"Id": "catering_and_other_food_services",
"Name": "Catering and Other Food Services",
"LocalizedName": "Catering- en horecadiensten",
"Primary": true
}
],
"Contacts": {
"Phones": [
{
"Value": "+32476891634"
}
]
},
"OpeningHours": [
{
"Display": [
"ma-zo: 00:00 - 24:00"
],
"OpenNow": true,
"Components": [
{
"OpenTime": "T000000",
"OpenDuration": "PT24H00M",
"Recurrence": "FREQ:DAILY;BYDAY:MO,TU,WE,TH,FR,SA,SU"
}
]
}
],
"AccessPoints": [
{
"Position": [
4.35609,
50.84439
]
}
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
4.35609,
50.84439
],
"Filter": {
"ExcludeCategories": ["airport"]
}
}
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position 4.35609 50.84439 \
--filter '{"ExcludeCategories": ["airport"]}' \
--max-results 2
```
------
# Como pesquisar lugares próximos com base no tipo de alimento
A API `SearchNearby` permite consultar restaurantes próximos que servem um tipo específico de alimento. Você também pode excluir os tipos de alimentos dos resultados.
Você pode usar a SearchNearby API para permitir que os usuários finais explorem bairros e descubram locais de interesse. A API exige QueryPosition, que pode ser a posição do dispositivo, a posição do IP ou o centro da porta de visualização do mapa. Outra forma é permitir que os usuários finais informem o nome da cidade ou do local, e a aplicação pode desviar os resultados com base nas coordenadas geográficas.
Para obter mais informações sobre os tipos de alimentos, consulte [Filtros de Tipo de comida](places-filtering.md#food-type).
## Casos de uso possíveis
+ Explorar os tipos de alimentos disponíveis nas proximidades.
+ Excluir opções de restaurantes que servem tipos de alimentos aos quais você tem alergia.
## Exemplo
### Pesquisar lugares próximos por tipo de alimento
O exemplo a seguir demonstra como pesquisar lugares próximos com base no tipo de alimento.
------
#### [ Sample request ]
Essa solicitação pesquisa restaurantes que servem comida chinesa perto das coordenadas especificadas.
```
{
"QueryPosition": [
12.49563,
41.90325
],
"Filter": {
"IncludeFoodTypes": ["chinese"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Bufala e Pachino",
"Address": {
"Label": "Bufala e Pachino, Via Firenze, 53, 00184 Roma RM, Italia",
"Country": {
"Code2": "IT",
"Code3": "ITA",
"Name": "Italia"
}
},
"Position": [
12.49409,
41.90237
],
"Distance": 161,
"Categories": [
{
"Id": "restaurant",
"Name": "Restaurant",
"LocalizedName": "Ristorante",
"Primary": true
}
],
"FoodTypes": [
{
"LocalizedName": "Pizza",
"Id": "pizza",
"Primary": true
},
{
"LocalizedName": "Cinese",
"Id": "chinese",
"Primary": false
}
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [12.49563, 41.90325],
"Filter": {
"IncludeFoodTypes": ["chinese"]
}
}'
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position 12.49563 41.90325 \
--filter '{"IncludeFoodTypes": ["chinese"]}'
```
------
### Dicas para o desenvolvedor
+ Você pode usar `ExludeFoodTypes` para excluir determinadas redes de negócios dos resultados.
+ Você pode excluir ou incluir vários tipos de alimentos.
# Como pesquisar nas proximidades com base na rede de negócios
A SearchNearby API permite que você consulte cadeias de negócios próximas. Você pode incluir ou excluir redes de negócios específicas em sua pesquisa. Esse atributo permite que os usuários finais explorem bairros, descubram pontos de interesse e muito mais.
Para usar a SearchNearby API, você precisa fornecer um QueryPosition, que pode ser:
+ Posição do dispositivo
+ Posição baseada em IP
+ O centro da janela de um mapa
Como alternativa, os usuários podem informar um nome de cidade ou local, e a aplicação pode desviar os resultados com base nas coordenadas geográficas desse local.
Para obter mais informações sobre as redes de negócios aceitas, consulte [Filtro de Cadeias de negócios](places-filtering.md#business-chains).
## Casos de uso possíveis
+ Explorar empresas nas proximidades
+ Expandir seus negócios encontrando clientes B2B próximos
## Exemplos
### Pesquisar lugares próximos com base na rede de negócios
O exemplo a seguir demonstra como pesquisar locais próximos do Starbucks.
------
#### [ Sample request ]
Essa solicitação pesquisa locais do Starbucks próximos às coordenadas especificadas.
```
{
"QueryPosition": [
12.49563,
41.90325
],
"Filter" : {
"IncludeBusinessChains": ["Starbucks"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Starbucks",
"Address": {
"Label": "Starbucks, Via Giovanni Giolitti, 2, 00185 Roma RM, Italia",
"Country": {
"Code2": "IT",
"Code3": "ITA",
"Name": "Italia"
},
"Region": {
"Name": "Lazio"
},
"SubRegion": {
"Code": "RM",
"Name": "Roma"
},
"Locality": "Roma",
"District": "Esquilino",
"PostalCode": "00185",
"Street": "Via Giovanni Giolitti",
"StreetComponents": [
{
"BaseName": "Giovanni Giolitti",
"Type": "Via",
"TypePlacement": "BeforeBaseName",
"TypeSeparator": " ",
"Language": "it"
}
],
"AddressNumber": "2"
},
"Position": [
12.50102,
41.90093
],
"Distance": 515,
"Categories": [
{
"Id": "coffee_shop",
"Name": "Coffee Shop",
"LocalizedName": "Bar",
"Primary": true
}
],
"BusinessChains": [
{
"Name": "Starbucks",
"Id": "Starbucks"
}
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
12.49563,
41.90325
],
"Filter" : {
"IncludeBusinessChains": ["Starbucks"]
}
}'
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position 12.49563 41.90325 \
--filter '{"IncludeBusinessChains": ["Starbucks"]}'
```
------
## Dicas para o desenvolvedor
+ Você pode usar `ExcludeBusinessChains` para excluir determinadas redes de negócios dos resultados.
+ Você pode excluir ou incluir várias redes de negócios.
# Como pesquisar nas proximidades dentro de um país
A SearchNearby API permite que você pesquise lugares próximos em um país específico. Para usar a API, você precisa fornecer um QueryPosition, que pode ser:
+ Posição do dispositivo
+ Posição baseada em IP
+ O centro da janela de um mapa
Como alternativa, os usuários podem fornecer um nome de cidade ou local, e a aplicação pode desviar os resultados com base nas coordenadas geográficas desse local.
## Casos de uso possíveis
+ Explorar empresas dentro de um país
+ Encontrar clientes B2B próximos em um país
+ Explorar lugares turísticos dentro de um país
## Exemplos
### Pesquisar campos de golfe no Canadá
O exemplo a seguir demonstra como pesquisar campos de golfe dentro do Canadá perto de coordenadas especificadas.
------
#### [ Sample request ]
Essa solicitação pesquisa campos de golfe no Canadá perto do local especificado.
```
{
"QueryPosition": [
-122.741803,
49.002478
],
"Filter" : {
"IncludeCategories": ["golf_course"],
"IncludeCountries": ["CAN"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Peace Portal Golf Course",
"Address": {
"Label": "Peace Portal Golf Course, 16900 * Ave, Surrey, BC V*Z *P*, Canada",
"Country": {
"Code2": "CA",
"Code3": "CAN",
"Name": "Canada"
},
"Region": {
"Code": "BC",
"Name": "British Columbia"
},
"SubRegion": {
"Name": "Metro Vancouver"
},
"Locality": "Surrey",
"District": "South Surrey",
"PostalCode": "V*Z *P*",
"Street": "* Ave",
"StreetComponents": [
{
"BaseName": "4",
"Type": "Ave",
"TypePlacement": "AfterBaseName",
"TypeSeparator": " ",
"Language": "en"
}
],
"AddressNumber": "16900"
},
"Position": [
-122.75086,
49.00921
],
"Distance": 998,
"Categories": [
{
"Id": "golf_course",
"Name": "Golf Course",
"LocalizedName": "Golf Course",
"Primary": true
}
],
"Contacts": {
"Phones": [
{
"Value": "+16045384818" }
],
"Websites": [
{
"Value": "http://www.peaceportalgolf.com"
}
]
},
"AccessPoints": [
{
"Position": [
-122.75087,
49.00935
]
}
]
}
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
-122.741803,
49.002478
],
"Filter" : {
"IncludeCategories": ["golf_course"],
"IncludeCountries": ["CAN"]
}
}'
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position -122.741803 49.002478 \
--filter '{"IncludeCategories": ["golf_course"], "IncludeCountries": ["CAN"]}'
```
------
# Como pesquisar nas proximidades usando o contexto geoespacial
A SearchNearby API permite que você explore as proximidades, ao mesmo tempo em que restringe os resultados dentro do contexto geoespacial (como um círculo ou uma caixa delimitadora).
A SearchNearby API permite filtrar resultados usando contextos geoespaciais, como círculos e caixas delimitadoras. Ao definir esses limites geográficos, você pode limitar os resultados da pesquisa a áreas específicas.
## Casos de uso possíveis
+ Limitar os resultados da pesquisa a uma área geográfica específica
+ Pesquisar dentro de limites personalizados
+ Priorizar resultados de bairros ou distritos segmentados
## Exemplos
### Pesquisar usando o raio de consulta
O exemplo a seguir demonstra como pesquisar escolas em um raio de 1000 metros das coordenadas especificadas.
------
#### [ Sample request ]
Essa solicitação pesquisa escolas em um raio de 1000 metros (1 quilômetro).
```
{
"QueryPosition": [
-122.741803,
49.002478
],
"QueryRadius":1000,
"Filter" : {
"IncludeCategories": ["school"]
}
}
```
------
#### [ Sample response ]
```
{
"ResultItems": [
{
"PlaceId": "",
"PlaceType": "PointOfInterest",
"Title": "Grace Lutheran Church",
"Address": {
"Label": "Grace Lutheran Church, 702 G St, Blaine, WA 98230-5125, United States",
"Country": {
"Code2": "US",
"Code3": "USA",
"Name": "United States"
},
"Region": {
"Code": "WA",
"Name": "Washington"
},
"SubRegion": {
"Name": "Whatcom"
},
"Locality": "Blaine",
"PostalCode": "98230-5125",
"Street": "G St",
"StreetComponents": [
{
"BaseName": "G",
"Type": "St",
"TypePlacement": "AfterBaseName",
"TypeSeparator": " ",
"Language": "en"
}
],
"AddressNumber": "702"
},
"Position": [
-122.74157,
48.99533
],
"Distance": 795,
"Categories": [
{
"Id": "church",
"Name": "Church",
"LocalizedName": "Church",
"Primary": true
},
{
"Id": "kindergarten_and_childcare",
"Name": "Kindergarten and Childcare",
"LocalizedName": "Kindergarten & Childcare",
"Primary": false
},
{
"Id": "school",
"Name": "School",
"LocalizedName": "School",
"Primary": false
}
]
}
...
]
}
```
------
#### [ cURL ]
```
curl --request POST \
--url 'https://places.geo.eu-central-1.amazonaws.com/v2/search-nearby?key=Your_Key' \
--header 'Content-Type: application/json' \
--data '{
"QueryPosition": [
-122.741803,
49.002478
],
"QueryRadius": 1000,
"Filter": {
"IncludeCategories": ["school"]
}
}'
```
------
#### [ AWS CLI ]
```
aws geo-places search-nearby --key ${YourKey} \
--query-position -122.741803 49.002478 \
--query-radius 1000 \
--filter '{"IncludeCategories": ["school"]}'
```
------
## Dicas para o desenvolvedor
+ Como alternativa, você pode usar um filtro de caixa delimitadora.