Com um ID de lugar, você pode: solicitar mais detalhes sobre um estabelecimento específico ou de interesse iniciando uma Place Details (novo) solicitação. Place Details (novo) request retorna informações mais abrangentes sobre o lugar indicado como endereço completo, número de telefone, avaliações e comentários de usuários.
Há muitas maneiras de se obter um ID de lugar. Você pode usar:
- Text Search (novo) ou Nearby Search (novo)
- API Geocoding
- API Routes
- API Address Validation
- Place Autocomplete
O APIs Explorer permite que você faça solicitações ativas para se familiarizar com a API e a Opções de API:
Faça um testeSolicitações de Place Details (novo)
Uma solicitação de Place Details é uma solicitação HTTP GET no formulário:
https://places.googleapis.com/v1/places/PLACE_ID
Transmita todos os parâmetros como parâmetros de URL ou em cabeçalhos como parte do 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)
Place Details (New) retorna um objeto JSON como resposta. Na resposta:
- A resposta é representada por um
Place
objeto. 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 um máscara do campo de resposta. Transmita a máscara do campo de resposta ao 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 prática recomendada de design para garantir que você não solicite dados desnecessários, o que ajuda a evitar tempo de processamento desnecessário e cobranças de faturamento adicionais.
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):
attributions
,id
,name
*photos
* O camponame
contém o nome do recurso do lugar. no formato:places/PLACE_ID
. Usar odisplayName
para acessar o texto nome 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
,servesBreakfast
,servesBrunch
,servesCocktails
,servesCoffee
,servesDessert
,servesDinner
,servesLunch
,servesVegetarianFood
,servesWine
,takeout
-
placeId
um identificador textual que identifica um local de forma exclusiva, retornado de um Text Search (novo) ou Nearby Search (novo). Para mais informações sobre IDs de lugar, consulte a visão geral do ID de lugar.
A string
places/PLACE_ID
também é chamada de local. nome do recurso. Na resposta de um Place Details (novo), Nearby Search (novo) e Text Search (novo) solicitação, essa string está contida no camponame
da resposta. O módulo o ID de lugar está contido no campoid
da resposta.
Parâmetros opcionais
languageCode
O idioma no qual os resultados serão retornados.
- Consulte a lista de idiomas com suporte. O Google atualiza com frequência os idiomas compatíveis, portanto, esta 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 que seja legível para o usuário e os locais. Para isso, ele retorna dados no idioma local e transliterado para um script que pode ser lido por o usuário, se necessário, observando o idioma preferido. Todos os outros são retornados no idioma de preferência. Os componentes de endereço são todos retornados no mesmo idioma, que é escolhido do primeiro componente.
- Se um nome não estiver disponível no idioma preferencial, a API usará o correspondência mais próxima.
- O idioma preferido tem uma pequena influência no conjunto de resultados que a API escolhe retornar e a ordem em que eles são retornados. O o geocodificador interpreta abreviações de formas diferentes dependendo do idioma. como abreviações de tipos de ruas ou sinônimos que possam ser válidos em um idioma, mas não em outro.
regionCode
O código da região usado para formatar a resposta, especificado como um de dois caracteres. Não há valor padrão.
Se o nome do país do campo
formattedAddress
na resposta corresponder aoregionCode
, o código do país é omitido deformattedAddress
. Esse parâmetro não tem efeito sobreadrFormatAddress
, que sempre inclui o país nome, 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 os "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 acompanham o preenchimento automático (Novo) chamadas como "sessões". O Autocomplete (novo) usa tokens de sessão para agrupar as fases de consulta e seleção de local 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 o Place Details (novo) chamadas que seguem as chamadas de preenchimento automático (novo). Para mais informações, consulte Tokens de sessão.
Exemplo de Place Details
O exemplo a seguir solicita os detalhes de um lugar pela
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
O cabeçalho X-Goog-FieldMask
especifica que
resposta
contém os seguintes campos de dados: id,displayName
.
A resposta estará 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
e 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 o APIs Explorer, você pode fazer solicitações de amostra para se familiarizar com a API e as opções de API.
Para fazer uma solicitação:
- Selecione o ícone da API,
, no lado direito da página.
- Opcionalmente, defina o parâmetro
name
como:places/PLACE_ID
- Como opção, expanda Mostrar parâmetros padrão e defina
O parâmetro
fields
à máscara de campo. - Selecione o botão Execute. 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 do APIs Explorer.