Quando você tiver um ID de lugar, poderá solicitar mais detalhes sobre um estabelecimento ou ponto de interesse específico iniciando uma solicitação de Place Details (novo). Uma solicitação do Place Details (New) retorna informações mais abrangentes sobre o lugar indicado, como endereço completo, número de telefone, notas e avaliações de usuários.
Há muitas maneiras de conseguir um ID de lugar. Você pode usar:
- Text Search (novo) ou Nearby Search (novo)
- API Geocoding
- API Routes
- API Address Validation
- Place Autocomplete
Com o API Explorer, é possível fazer solicitações em tempo real para se familiarizar com a API e as opções dela:
Faça um testeSolicitações do Place Details (novas)
Uma solicitação do Place Details é uma solicitação HTTP GET no formato:
https://places.googleapis.com/v1/places/PLACE_ID
Transmita todos os parâmetros como parâmetros de URL ou em cabeçalhos como parte da solicitação GET. Exemplo:
https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw?fields=id,displayName&key=API_KEY
Ou em um comando cURL:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Respostas do Place Details (novo)
O Place Details (New) retorna um objeto JSON como resposta. Na resposta:
- A resposta é representada por um objeto
Place
. O objetoPlace
contém informações detalhadas sobre o lugar. - O FieldMask transmitido na solicitação especifica a lista de campos retornados no objeto
Place
.
O objeto JSON completo está no formato:
{ "name": "places/ChIJkR8FdQNB0VQRm64T_lv1g1g", "id": "ChIJkR8FdQNB0VQRm64T_lv1g1g", "displayName": { "text": "Trinidad" } ... }
Parâmetros obrigatórios
-
FieldMask
Especifique a lista de campos a serem retornados na resposta criando uma máscara de campo de resposta. Transmita a máscara de campo de resposta para o método usando o parâmetro de URL
$fields
oufields
ou usando o cabeçalho HTTPX-Goog-FieldMask
. Não há uma lista padrão de campos retornados na resposta. Se você omitir a máscara de campo, o método retornará um erro.O mascaramento de campo é uma boa prática de design para garantir que você não solicite dados desnecessários, o que ajuda a evitar cobranças de faturamento e tempo de processamento desnecessários.
Especifique uma lista separada por vírgulas de tipos de dados de lugar a serem retornados. Por exemplo, para recuperar o nome de exibição e o endereço do local.
X-Goog-FieldMask: displayName,formattedAddress
Use
*
para recuperar todos os campos.X-Goog-FieldMask: *
Especifique um ou mais dos seguintes campos:
Os campos a seguir acionam a SKU do Place Details (somente IDs):
id
,name
*,photos
* O camponame
contém o nome do recurso do lugar no formato:places/PLACE_ID
. UsedisplayName
para acessar o texto do lugar.Os campos a seguir acionam a SKU do Place Details (somente local):
addressComponents
,adrFormatAddress
,formattedAddress
,location
,plusCode
,shortFormattedAddress
,types
,viewport
Os campos a seguir acionam a SKU do Place Details (Basic):
accessibilityOptions
,businessStatus
,displayName
,googleMapsUri
,iconBackgroundColor
,iconMaskBaseUri
,primaryType
,primaryTypeDisplayName
,subDestinations
,utcOffsetMinutes
Os campos a seguir acionam a SKU do Place Details (Advanced):
currentOpeningHours
,currentSecondaryOpeningHours
,internationalPhoneNumber
,nationalPhoneNumber
,priceLevel
,rating
,regularOpeningHours
,regularSecondaryOpeningHours
,userRatingCount
,websiteUri
Os campos a seguir acionam a SKU do Place Details (preferencial):
allowsDogs
,curbsidePickup
,delivery
,dineIn
,editorialSummary
,evChargeOptions
,fuelOptions
,goodForChildren
,goodForGroups
,goodForWatchingSports
,liveMusic
,menuForChildren
,parkingOptions
,paymentOptions
,outdoorSeating
,reservable
,restroom
,reviews
,servesBeer
,delivery
,delivery
,delivery
,delivery
,servesBreakfast
servesBrunch
servesCocktails
servesCoffee
servesDesserts
servesDinner
servesLunch
servesVegetarianFood
servesWine
takeout
-
placeId
Um identificador textual que identifica um local de forma exclusiva, retornado de um Text Search (novo) ou do Nearby Search (novo). Para mais informações sobre IDs de local, consulte a visão geral de IDs de local.
A string
places/PLACE_ID
também é chamada de nome do recurso do lugar. Na resposta de uma solicitação de Place Details (New), Nearby Search (New) e Text Search (New), essa string está contida no camponame
da resposta. O ID de lugar autônomo está contido no campoid
da resposta.
Parâmetros opcionais
languageCode
O idioma no qual os resultados serão retornados.
- Consulte a lista de idiomas compatíveis. O Google atualiza os idiomas compatíveis com frequência, portanto, essa lista pode não estar completa.
-
Se
languageCode
não for fornecido, o padrão da API seráen
. Se você especificar um código de idioma inválido, a API retornará um erroINVALID_ARGUMENT
. - A API faz o possível para fornecer um endereço legível tanto para o usuário quanto para os locais. Para isso, ele retorna endereços no idioma local, transliterados para um script que pode ser lido pelo usuário, se necessário, seguindo o idioma preferido. Todos os outros endereços são retornados no idioma de preferência. Os componentes de endereço são todos retornados no mesmo idioma, escolhido no primeiro componente.
- Se um nome não estiver disponível no idioma preferencial, a API usará a correspondência mais próxima.
- O idioma preferencial tem uma pequena influência no conjunto de resultados que a API escolhe retornar e na ordem em que são retornados. O geocodificador interpreta abreviações de maneiras diferentes dependendo do idioma, como abreviações de tipos de rua ou sinônimos, que podem ser válidos em um idioma, mas não em outro.
regionCode
O código regional usado para formatar a resposta, especificado como um valor de código CLDR de dois caracteres. Não há valor padrão.
Se o nome do país do campo
formattedAddress
na resposta corresponder aregionCode
, o código do país é omitido deformattedAddress
. Esse parâmetro não tem efeito emadrFormatAddress
, que sempre inclui o nome do país, ou emshortFormattedAddress
, que nunca o inclui.A maioria dos códigos CLDR é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" (.co.uk), enquanto o código ISO 3166-1 é "gb" (tecnicamente, para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte"). O parâmetro pode afetar os resultados com base na legislação aplicável.
-
sessionToken
Os tokens de sessão são strings geradas pelo usuário que rastreiam chamadas de preenchimento automático (novas) como "sessões". O Autocomplete (novo) usa tokens de sessão para agrupar as fases de consulta e seleção de lugar de uma pesquisa de preenchimento automático do usuário em uma sessão discreta para fins de faturamento. Os tokens de sessão são transmitidos para chamadas do Place Details (novo) que seguem as do Autocomplete (novo). Para mais informações, consulte Tokens de sessão.
Exemplo do Place Details
O exemplo a seguir solicita os detalhes de um lugar pelo placeId
:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
Observe que o cabeçalho X-Goog-FieldMask
especifica que a
resposta
contém os seguintes campos de dados: id,displayName
.
A resposta está no formato:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "displayName": { "text": "Googleplex", "languageCode": "en" } }
Adicione mais tipos de dados à máscara de campo para retornar mais informações.
Por exemplo, adicione formattedAddress,plusCode
para incluir o
endereço e o Plus Code na
resposta:
curl -X GET -H 'Content-Type: application/json' \ -H "X-Goog-Api-Key: API_KEY" \ -H "X-Goog-FieldMask: id,displayName,formattedAddress,plusCode" \ https://places.googleapis.com/v1/places/ChIJj61dQgK6j4AR4GeTYWZsKWw
A resposta agora está no formato:
{ "id": "ChIJj61dQgK6j4AR4GeTYWZsKWw", "formattedAddress": "1600 Amphitheatre Pkwy, Mountain View, CA 94043, USA", "plusCode": { "globalCode": "849VCWC7+RW", "compoundCode": "CWC7+RW Mountain View, CA, USA" }, "displayName": { "text": "Googleplex", "languageCode": "en" } }
Confira!
Com a API Explorer, você pode fazer solicitações de amostra para conhecer a API e as opções dela.
Para fazer uma solicitação:
- Selecione o ícone da API, , no lado direito da página.
- Se quiser, defina o parâmetro
name
como:places/PLACE_ID
- Se quiser, expanda Mostrar parâmetros padrão e defina o parâmetro
fields
como a máscara de campo. - Selecione o botão Executar. No pop-up, escolha a conta que você quer usar para fazer a solicitação.
No painel do APIs Explorer, selecione o ícone de expansão para expandir a janela dele.