Package google.maps.places.v1

Índice

Lugares

Definição de serviço para a API Places. Observação: todas as solicitações (exceto as de preenchimento automático) exigem uma máscara de campo definida fora do proto de solicitação (all/*, não é assumido). A máscara de campo pode ser definida pelo cabeçalho HTTP X-Goog-FieldMask. Consulte: https://developers.google.com/maps/documentation/places/web-service/choose-fields

AutocompletePlaces

rpc AutocompletePlaces(AutocompletePlacesRequest) returns (AutocompletePlacesResponse)

Retorna previsões para a entrada especificada.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetPhotoMedia

rpc GetPhotoMedia(GetPhotoMediaRequest) returns (PhotoMedia)

Receba uma mídia de foto com uma string de referência de foto.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetPlace

rpc GetPlace(GetPlaceRequest) returns (Place)

Receba os detalhes de um lugar com base no nome do recurso, que é uma string no formato places/{place_id}.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
SearchNearby

rpc SearchNearby(SearchNearbyRequest) returns (SearchNearbyResponse)

Pesquise lugares perto de outros lugares.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
SearchText

rpc SearchText(SearchTextRequest) returns (SearchTextResponse)

Pesquisa de lugares com base em consultas de texto.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

AddressDescriptor

Uma descrição relacional de um local. Inclui um conjunto classificado de pontos de referência e áreas de contenção precisas nas proximidades e a relação deles com o local de destino.

Campos
landmarks[]

Landmark

Uma lista classificada de pontos de referência próximos. Os pontos de referência mais conhecidos e próximos são classificados primeiro.
areas[]

Area

Uma lista classificada de áreas adjacentes ou que contêm outras. As áreas mais reconhecíveis e precisas são classificadas primeiro.

Área

Informações sobre a área e a relação dela com o local de destino.

As áreas incluem sublocalidades precisas, bairros e grandes complexos que são úteis para descrever um local.

Campos
name

string

O nome do recurso da área.
place_id

string

O ID de lugar da área.
display_name

LocalizedText

O nome de exibição da área.
containment

Containment

Define a relação espacial entre o local de destino e a área.

Contenção

Define a relação espacial entre o local de destino e a área.

Enums
CONTAINMENT_UNSPECIFIED A contenção não foi especificada.
WITHIN O local de destino está dentro da região da área, próximo ao centro.
OUTSKIRTS O local de destino está dentro da área, perto da borda.
NEAR O local de destino está fora da área, mas por perto.

Ponto de referência

Informações básicas do marco e a relação dele com o local de destino.

Os pontos de referência são lugares importantes que podem ser usados para descrever um local.

Campos
name

string

O nome do recurso do marco.
place_id

string

O ID do lugar do marco.
display_name

LocalizedText

O nome de exibição do marco.
types[]

string

Um conjunto de tags de tipo para esse marco. Para conferir uma lista completa de valores possíveis, acesse https://developers.google.com/maps/documentation/places/web-service/place-types.
spatial_relationship

SpatialRelationship

Define a relação espacial entre o local de destino e o marco.
straight_line_distance_meters

float

A distância em linha reta, em metros, entre o ponto central do alvo e o ponto central do ponto de referência. Em algumas situações, esse valor pode ser maior que travel_distance_meters.
travel_distance_meters

float

A distância de deslocamento, em metros, ao longo da rede rodoviária do destino até o marco, se conhecido. Esse valor não considera o meio de transporte, como a pé, de carro ou de bicicleta.

SpatialRelationship

Define a relação espacial entre o local de destino e o marco.

Enums
NEAR Essa é a relação padrão quando nada mais específico abaixo se aplica.
WITHIN O ponto de referência tem uma geometria espacial, e o alvo está dentro dos limites dele.
BESIDE O alvo está diretamente ao lado do marco.
ACROSS_THE_ROAD O destino está diretamente oposto ao marco no outro lado da estrada.
DOWN_THE_ROAD Na mesma rota do ponto de referência, mas não ao lado ou em frente.
AROUND_THE_CORNER Não na mesma rota do ponto de referência, mas a uma única curva de distância.
BEHIND Perto da estrutura do ponto turístico, mas mais distante das entradas das ruas.

AuthorAttribution

Informações sobre o autor dos dados de UGC. Usada em Photo e Review.

Campos
display_name

string

Nome do autor do Photo ou Review.
uri

string

URI do autor do Photo ou Review.
photo_uri

string

URI da foto do perfil do autor do Photo ou Review.

AutocompletePlacesRequest

Solicitar proto para AutocompletePlaces.

Campos
input

string

Obrigatório. A string de texto em que pesquisar.
location_bias

LocationBias

Opcional. Direciona os resultados para um local especificado.

No máximo um de location_bias ou location_restriction precisa ser definido. Se nenhum deles estiver definido, os resultados serão enviesados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um sinal enviesado.
location_restriction

LocationRestriction

Opcional. Restringir os resultados a um local especificado.

No máximo um de location_bias ou location_restriction precisa ser definido. Se nenhum deles estiver definido, os resultados serão enviesados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um sinal enviesado.
included_primary_types[]

string

Opcional. Incluir o tipo de lugar principal (por exemplo, "restaurante" ou "posto_de_gasolina") nos tipos de lugar (https://developers.google.com/maps/documentation/places/web-service/place-types)), ou apenas (regions) ou (cities). Um lugar só é retornado se o tipo principal dele estiver incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos os tipos de lugar serão retornados.
included_region_codes[]

string

Opcional. Incluir apenas resultados nas regiões especificadas, especificadas como até 15 códigos de região de dois caracteres CLDR. Um conjunto vazio não restringe os resultados. Se location_restriction e included_region_codes estiverem definidos, os resultados serão localizados na área de interseção.
language_code

string

Opcional. O idioma em que os resultados serão retornados. O padrão é "en-US". Os resultados podem estar em idiomas diferentes se o idioma usado em input for diferente de language_code ou se o lugar retornado não tiver uma tradução do idioma local para language_code.
region_code

string

Opcional. O código da região, especificado como um código de região CLDR de dois caracteres. Isso afeta a formatação do endereço, a classificação dos resultados e pode influenciar quais resultados são retornados. Isso não restringe os resultados à região especificada. Para restringir os resultados a uma região, use region_code_restriction.
origin

LatLng

Opcional. O ponto de origem a partir do qual a distância geodésica é calculada até o destino (retornado como distance_meters). Se esse valor for omitido, a distância geodésica não será retornada.
input_offset

int32

Opcional. Um deslocamento de caractere Unicode com base em zero de input indicando a posição do cursor em input. A posição do cursor pode influenciar as previsões retornadas.

Se estiver vazio, o padrão será o comprimento de input.
include_query_predictions

bool

Opcional. Se verdadeiro, a resposta vai incluir as previsões de lugar e de consulta. Caso contrário, a resposta vai retornar apenas previsões de lugares.
session_token

string

Opcional. Uma string que identifica uma sessão de preenchimento automático para fins de faturamento. Precisa ser uma string base64 segura para URL e nome de arquivo com no máximo 36 caracteres ASCII. Caso contrário, um erro INVALID_ARGUMENT será retornado.

A sessão começa quando o usuário começa a digitar uma consulta e termina quando ele seleciona um lugar e uma chamada para o Place Details ou a Validação de endereço é feita. Cada sessão pode ter várias consultas, seguidas por uma solicitação de Place Details ou Address Validation. As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após a conclusão de uma sessão, o token perde a validade. Seu app precisa gerar um novo token para cada sessão. Se o parâmetro session_token for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido e cada solicitação será faturada separadamente.

Recomendamos as seguintes diretrizes:

  • Use tokens de sessão para todas as chamadas do Place Autocomplete.
  • Gere um novo token para cada sessão. Recomendamos o uso de um UUID da versão 4.
  • Verifique se as credenciais usadas para todas as solicitações de Place Autocomplete, Place Details e Address Validation em uma sessão pertencem ao mesmo projeto do Cloud Console.
  • Transmita um token de sessão exclusivo para cada sessão nova. Se você usar o mesmo token para mais de uma sessão, cada solicitação vai ser faturada individualmente.
include_pure_service_area_businesses

bool

Opcional. Inclua empresas de serviço local puro se o campo estiver definido como verdadeiro. Uma empresa de serviço local é aquela que faz visitas ou entregas, mas não atende no endereço comercial. Por exemplo, prestadores de serviços de limpeza ou encanadores. Essas empresas não têm um endereço físico ou local no Google Maps. O Places não vai retornar campos como location, plus_code e outros campos relacionados à localização para essas empresas.

LocationBias

A região a ser pesquisada. Os resultados podem ser tendenciosos na região especificada.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

Viewport

Uma viewport definida por um canto nordeste e um sudoeste.
circle

Circle

Um círculo definido por um ponto central e um raio.

LocationRestriction

A região a ser pesquisada. Os resultados serão restritos à região especificada.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

Viewport

Uma viewport definida por um canto nordeste e um sudoeste.
circle

Circle

Um círculo definido por um ponto central e um raio.

AutocompletePlacesResponse

Proto de resposta para AutocompletePlaces.

Campos
suggestions[]

Suggestion

Contém uma lista de sugestões, ordenadas em ordem decrescente de relevância.

Sugestão

Um resultado de sugestão de preenchimento automático.

Campos

Campo de união kind.

kind pode ser apenas de um dos tipos a seguir:
place_prediction

PlacePrediction

Uma previsão de um lugar.
query_prediction

QueryPrediction

Uma previsão para uma consulta.

FormattableText

Texto que representa uma previsão de lugar ou consulta. O texto pode ser usado como está ou formatado.

Campos
text

string

Texto que pode ser usado como está ou formatado com matches.
matches[]

StringRange

Uma lista de intervalos de string que identificam onde a solicitação de entrada correspondeu a text. Os intervalos podem ser usados para formatar partes específicas de text. As subcadeias podem não ser correspondências exatas de input se a correspondência foi determinada por outros critérios além da correspondência de string (por exemplo, correções ortográficas ou transliterações).

Esses valores são deslocamentos de caracteres Unicode de text. Os intervalos são ordenados em valores de deslocamento crescentes.

PlacePrediction

Resultados da previsão de um lugar do Place Autocomplete.

Campos
place

string

O nome do recurso do lugar sugerido. Esse nome pode ser usado em outras APIs que aceitam nomes de lugares.
place_id

string

O identificador exclusivo do lugar sugerido. Esse identificador pode ser usado em outras APIs que aceitam IDs de lugar.
text

FormattableText

Contém o nome legível para o resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa.

O text é recomendado para desenvolvedores que querem mostrar um único elemento da interface. Os desenvolvedores que querem mostrar dois elementos de interface separados, mas relacionados, podem usar structured_format. Elas são duas maneiras diferentes de representar uma previsão de lugar. Os usuários não devem tentar analisar structured_format em text ou vice-versa.

Esse texto pode ser diferente do display_name retornado por GetPlace.

Pode ser em idiomas diferentes se a solicitação input e language_code estiver em idiomas diferentes ou se o lugar não tiver uma tradução do idioma local para language_code.
structured_format

StructuredFormat

Um detalhamento da previsão do lugar em texto principal com o nome do lugar e texto secundário com recursos de eliminação de ambiguidade (como uma cidade ou região).

O structured_format é recomendado para desenvolvedores que querem mostrar dois elementos de interface separados, mas relacionados. Os desenvolvedores que querem mostrar um único elemento da interface podem usar text. Elas são duas maneiras diferentes de representar uma previsão de lugar. Os usuários não devem tentar analisar structured_format em text ou vice-versa.
types[]

string

Lista de tipos que se aplicam a esse lugar da Tabela A ou B em https://developers.google.com/maps/documentation/places/web-service/place-types.

Um tipo é uma categorização de um lugar. Os lugares com tipos compartilhados têm características semelhantes.
distance_meters

int32

O comprimento da geodésica em metros a partir de origin, se origin for especificado. Algumas previsões, como rotas, podem não preencher esse campo.

QueryPrediction

Resultados da previsão de preenchimento automático de consulta.

Campos
text

FormattableText

O texto previsto. Esse texto não representa um lugar, mas sim uma consulta de texto que pode ser usada em um endpoint de pesquisa (por exemplo, a pesquisa de texto).

O text é recomendado para desenvolvedores que querem mostrar um único elemento da interface. Os desenvolvedores que querem mostrar dois elementos de interface separados, mas relacionados, podem usar structured_format. Elas são duas maneiras diferentes de representar uma previsão de consulta. Os usuários não devem tentar analisar structured_format em text ou vice-versa.

Pode ser em idiomas diferentes se a solicitação input e language_code estiver em idiomas diferentes ou se parte da consulta não tiver uma tradução do idioma local para language_code.
structured_format

StructuredFormat

Um detalhamento da previsão da consulta em texto principal com a consulta e texto secundário com outros recursos de eliminação de ambiguidade (como uma cidade ou região).

O structured_format é recomendado para desenvolvedores que querem mostrar dois elementos de interface separados, mas relacionados. Os desenvolvedores que querem mostrar um único elemento da interface podem usar text. Elas são duas maneiras diferentes de representar uma previsão de consulta. Os usuários não devem tentar analisar structured_format em text ou vice-versa.

StringRange

Identifica uma substring em um determinado texto.

Campos
start_offset

int32

Deslocamento baseado em zero do primeiro caractere Unicode da string (inclusive).
end_offset

int32

Deslocamento baseado em zero do último caractere Unicode (exclusivo).

StructuredFormat

Contém um detalhamento da previsão de um lugar ou consulta em texto principal e secundário.

Para previsões de lugar, o texto principal contém o nome específico do lugar. Para previsões de consulta, o texto principal contém a consulta.

O texto secundário contém outros recursos de eliminação de ambiguidade (como uma cidade ou região) para identificar melhor o lugar ou refinar a consulta.

Campos
main_text

FormattableText

Representa o nome do lugar ou da consulta.
secondary_text

FormattableText

Representa outros recursos de eliminação de ambiguidade (como uma cidade ou região) para identificar melhor o lugar ou refinar a consulta.

Círculo

Círculo com uma LatLng como centro e raio.

Campos
center

LatLng

Obrigatório. Centralize a latitude e a longitude.

O intervalo de latitude precisa estar entre [-90,0, 90,0]. O intervalo da longitude precisa estar entre [-180,0, 180,0].
radius

double

Obrigatório. Raio medido em metros. O raio precisa estar entre [0,0, 50000,0].

ContentBlock

Um bloco de conteúdo que pode ser veiculado individualmente.

Campos
topic

string

O tema do conteúdo, por exemplo, "visão geral" ou "restaurante".
content

LocalizedText

Conteúdo relacionado ao tema.
references

References

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Referências relacionadas a este bloco de conteúdo.

ContextualContent

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Conteúdo contextual à consulta de lugar.

Campos
reviews[]

Review

Lista de avaliações sobre o lugar, com contexto para a consulta.
photos[]

Photo

Informações (incluindo referências) sobre as fotos desse lugar, contextualizadas à consulta de lugar.
justifications[]

Justification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Justificativas para o lugar.

Motivo

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Justificativas para o lugar. As justificativas respondem à pergunta de por que um lugar pode interessar a um usuário final.

Campos

Campo de união justification.

justification pode ser apenas de um dos tipos a seguir:
review_justification

ReviewJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.
business_availability_attributes_justification

BusinessAvailabilityAttributesJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

BusinessAvailabilityAttributesJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes. Justificativas de BusinessAvailabilityAttributes. Isso mostra alguns atributos de uma empresa que podem interessar a um usuário final.

Campos
takeout

bool

Se um lugar oferece comida para viagem.
delivery

bool

Se um lugar oferece entrega.
dine_in

bool

Se um lugar oferece refeições no local.

ReviewJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Justificativas de avaliações do usuário. Isso destaca uma seção da avaliação do usuário que interessaria a um usuário final. Por exemplo, se a consulta de pesquisa for "pizza de forno a lenha", a justificativa da avaliação vai destacar o texto relevante para a consulta.

Campos
highlighted_text

HighlightedText
review

Review

A avaliação em que o texto destacado foi gerado.

HighlightedText

O texto destacado pela justificação. Esse é um subconjunto da própria análise. A palavra exata a ser destacada é marcada pelo HighlightedTextRange. Várias palavras no texto podem ser destacadas.

Campos
text

string
highlighted_text_ranges[]

HighlightedTextRange

A lista dos intervalos do texto em destaque.

HighlightedTextRange

O intervalo do texto em destaque.

Campos
start_index

int32
end_index

int32

EVChargeOptions

Informações sobre a estação de recarga de VEs hospedada no Place. A terminologia segue https://afdc.energy.gov/fuels/electricity_infrastructure.html. Uma porta pode carregar um carro por vez. Uma porta tem um ou mais conectores. Uma estação tem uma ou mais portas.

Campos
connector_count

int32

Número de conectores na estação. No entanto, como algumas portas podem ter vários conectores, mas carregar apenas um carro por vez (por exemplo), o número de conectores pode ser maior do que o número total de carros que podem carregar simultaneamente.
connector_aggregation[]

ConnectorAggregation

Uma lista de agregações de conectores de carregamento de VE que contêm conectores do mesmo tipo e da mesma taxa de carga.

ConnectorAggregation

Informações de carregamento de VE agrupadas por [type, max_charge_rate_kw]. Mostra a agregação de recarga de VEs de conectores com o mesmo tipo e taxa de recarga máxima em kW.

Campos
type

EVConnectorType

O tipo de conector dessa agregação.
max_charge_rate_kw

double

A taxa de carregamento máxima estática em kW de cada conector na agregação.
count

int32

Número de conectores nesta agregação.
availability_last_update_time

Timestamp

O carimbo de data/hora da última atualização das informações de disponibilidade do conector nessa agregação.
available_count

int32

Número de conectores disponíveis na agregação.
out_of_service_count

int32

Número de conectores nessa agregação que estão fora de serviço no momento.

EVConnectorType

Consulte http://ieeexplore.ieee.org/stamp/stamp.jsp?arnumber=6872107 para mais informações/contexto sobre os tipos de conector de carregamento de VEs.

Enums
EV_CONNECTOR_TYPE_UNSPECIFIED Conector não especificado.
EV_CONNECTOR_TYPE_OTHER Outros tipos de conector.
EV_CONNECTOR_TYPE_J1772 Conector J1772 tipo 1.
EV_CONNECTOR_TYPE_TYPE_2 Conector IEC 62196 tipo 2. Muitas vezes chamado de MENNEKES.
EV_CONNECTOR_TYPE_CHADEMO Conector do tipo CHAdeMO.
EV_CONNECTOR_TYPE_CCS_COMBO_1 Sistema de carregamento combinado (CA e CC). Com base na SAE. Conector J-1772 tipo 1
EV_CONNECTOR_TYPE_CCS_COMBO_2 Sistema de carregamento combinado (CA e CC). Com base no conector Mennekes tipo 2
EV_CONNECTOR_TYPE_TESLA O conector TESLA genérico. Esse é o padrão NACS na América do Norte, mas pode não ser em outras partes do mundo (por exemplo, CCS Combo 2 (CCS2) ou GB/T). Esse valor é menos representativo de um tipo de conector real e mais representa a capacidade de carregar um veículo da marca Tesla em uma estação de carregamento da Tesla.
EV_CONNECTOR_TYPE_UNSPECIFIED_GB_T O tipo GB/T corresponde ao padrão GB/T da China. Esse tipo abrange todos os tipos de GB_T.
EV_CONNECTOR_TYPE_UNSPECIFIED_WALL_OUTLET Tomada não especificada.
EV_CONNECTOR_TYPE_NACS O sistema de recarga da América do Norte (NACS, na sigla em inglês), padronizado como SAE J3400.

FuelOptions

As informações mais recentes sobre as opções de combustível em um posto de gasolina. Essas informações são atualizadas regularmente.

Campos
fuel_prices[]

FuelPrice

O último preço de combustível conhecido para cada tipo de combustível que o posto tem. Há uma entrada para cada tipo de combustível que a estação tem. A ordem não é importante.

FuelPrice

Informações sobre o preço do combustível para um determinado tipo.

Campos
type

FuelType

O tipo de combustível.
price

Money

O preço do combustível.
update_time

Timestamp

A hora em que o preço do combustível foi atualizado pela última vez.

FuelType

Tipos de combustível.

Enums
FUEL_TYPE_UNSPECIFIED Tipo de combustível não especificado.
DIESEL Combustível diesel.
DIESEL_PLUS Diesel e combustível.
REGULAR_UNLEADED Gasolina comum.
MIDGRADE Aditivada.
PREMIUM Premium.
SP91 SP 91.
SP91_E10 SP 91 E10.
SP92 SP 92.
SP95 SP 95.
SP95_E10 SP95 E10.
SP98 SP 98.
SP99 SP 99.
SP100 SP 100.
LPG Gás liquefeito de petróleo.
E80 E 80.
E85 E 85.
E100 E 100.
METHANE Metano.
BIO_DIESEL Biodiesel.
TRUCK_DIESEL Diesel para caminhões.

GetPhotoMediaRequest

Solicitação para buscar uma foto de um lugar usando o nome de um recurso de foto.

Campos
name

string

Obrigatório. O nome do recurso de uma mídia de foto no formato: places/{place_id}/photos/{photo_reference}/media.

O nome do recurso de uma foto retornada no campo photos.name de um objeto do Place tem o formato places/{place_id}/photos/{photo_reference}. É necessário anexar /media ao final do recurso de foto para receber o nome do recurso de mídia de foto.
max_width_px

int32

Opcional. Especifica a largura máxima desejada, em pixels, da imagem. Se a imagem for menor que os valores especificados, a imagem original será retornada. Se a imagem for maior em qualquer dimensão, ela será redimensionada para corresponder à menor das duas dimensões, restrita à proporção original. As propriedades max_height_px e max_width_px aceitam um número inteiro entre 1 e 4800, inclusive. Se o valor não estiver dentro do intervalo permitido, um erro INVALID_ARGUMENT será retornado.

Pelo menos um entre max_height_px ou max_width_px precisa ser especificado. Se nem max_height_px nem max_width_px forem especificados, um erro INVALID_ARGUMENT será retornado.
max_height_px

int32

Opcional. Especifica a altura máxima desejada, em pixels, da imagem. Se a imagem for menor que os valores especificados, a imagem original será retornada. Se a imagem for maior em qualquer dimensão, ela será redimensionada para corresponder à menor das duas dimensões, restrita à proporção original. As propriedades max_height_px e max_width_px aceitam um número inteiro entre 1 e 4800, inclusive. Se o valor não estiver dentro do intervalo permitido, um erro INVALID_ARGUMENT será retornado.

Pelo menos um entre max_height_px ou max_width_px precisa ser especificado. Se nem max_height_px nem max_width_px forem especificados, um erro INVALID_ARGUMENT será retornado.
skip_http_redirect

bool

Opcional. Se definido, pule o comportamento de redirecionamento HTTP padrão e renderize uma resposta de formato de texto (por exemplo, no formato JSON para o caso de uso HTTP). Se não for definido, um redirecionamento HTTP será emitido para redirecionar a chamada para a mídia de imagem. Essa opção é ignorada para solicitações não HTTP.

GetPlaceRequest

Solicitação para buscar um lugar com base no nome do recurso, que é uma string no formato places/{place_id}.

Campos
name

string

Obrigatório. O nome do recurso de um lugar no formato places/{place_id}.
language_code

string

Opcional. Os detalhes do lugar serão mostrados no idioma preferido, se disponível.

Lista atual de idiomas aceitos: https://developers.google.com/maps/faq#languagesupport.
region_code

string

Opcional. O código de país/região Unicode (CLDR) do local de origem da solicitação. Esse parâmetro é usado para mostrar os detalhes do lugar, como o nome do lugar específico da região, se disponível. O parâmetro pode afetar os resultados com base na legislação aplicável. Para mais informações, consulte https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

No momento, não há suporte para códigos de região de três dígitos.
session_token

string

Opcional. Uma string que identifica uma sessão de preenchimento automático para fins de faturamento. Precisa ser uma string base64 segura para URL e nome de arquivo com no máximo 36 caracteres ASCII. Caso contrário, um erro INVALID_ARGUMENT será retornado.

A sessão começa quando o usuário começa a digitar uma consulta e termina quando ele seleciona um lugar e uma chamada para o Place Details ou a Validação de endereço é feita. Cada sessão pode ter várias consultas, seguidas por uma solicitação de Place Details ou Address Validation. As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após a conclusão de uma sessão, o token perde a validade. Seu app precisa gerar um novo token para cada sessão. Se o parâmetro session_token for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido e cada solicitação será faturada separadamente.

Recomendamos as seguintes diretrizes:

  • Use tokens de sessão para todas as chamadas do Place Autocomplete.
  • Gere um novo token para cada sessão. Recomendamos o uso de um UUID da versão 4.
  • Verifique se as credenciais usadas para todas as solicitações de Place Autocomplete, Place Details e Address Validation em uma sessão pertencem ao mesmo projeto do Cloud Console.
  • Transmita um token de sessão exclusivo para cada sessão nova. Se você usar o mesmo token para mais de uma sessão, cada solicitação vai ser faturada individualmente.

Foto

Informações sobre uma foto de um lugar.

Campos
name

string

Identificador. Uma referência que representa essa foto de lugar e pode ser usada para procurar a foto de lugar novamente (também chamada de nome do "recurso" da API: places/{place_id}/photos/{photo}).
width_px

int32

A largura máxima disponível, em pixels.
height_px

int32

A altura máxima disponível, em pixels.
author_attributions[]

AuthorAttribution

Os autores da foto.
flag_content_uri

string

Um link em que os usuários podem sinalizar um problema com a foto.
google_maps_uri

string

Um link para mostrar a foto no Google Maps.

PhotoMedia

Uma mídia de foto da API Places.

Campos
name

string

O nome do recurso de uma mídia de foto no formato: places/{place_id}/photos/{photo_reference}/media.
photo_uri

string

Um URI de curta duração que pode ser usado para renderizar a foto.

Lugar

Todas as informações que representam um lugar.

Campos
name

string

O nome do recurso do lugar, no formato places/{place_id}. Pode ser usado para procurar o lugar.
id

string

O identificador exclusivo de um lugar.
display_name

LocalizedText

O nome localizado do lugar, adequado como uma descrição curta legível por humanos. Por exemplo, "Google Sydney", "Starbucks", "Pyrmont" etc.
types[]

string

Um conjunto de tags de tipo para esse resultado. Por exemplo, "político" e "localidade". Para conferir a lista completa de valores possíveis, consulte as tabelas A e B em https://developers.google.com/maps/documentation/places/web-service/place-types.
primary_type

string

O tipo principal do resultado fornecido. Esse tipo precisa ser um dos tipos aceitos pela API Places. Por exemplo, "restaurante", "café", "aeroporto" etc. Um lugar só pode ter um tipo principal. Para conferir a lista completa de valores possíveis, consulte as tabelas A e B em https://developers.google.com/maps/documentation/places/web-service/place-types.
primary_type_display_name

LocalizedText

O nome de exibição do tipo principal, localizado para o idioma da solicitação, se aplicável. Para conferir a lista completa de valores possíveis, consulte as tabelas A e B em https://developers.google.com/maps/documentation/places/web-service/place-types.
national_phone_number

string

Um número de telefone legível por humanos para o local, no formato nacional.
international_phone_number

string

Um número de telefone legível por seres humanos para o local, no formato internacional.
formatted_address

string

Um endereço completo e legível para humanos.
short_formatted_address

string

Um endereço curto e legível para esse lugar.
address_components[]

AddressComponent

Componentes repetidos para cada nível de localidade. Observe os seguintes fatos sobre a matriz address_components[]: - A matriz de componentes de endereço pode conter mais componentes do que o formatted_address. - A matriz não inclui necessariamente todas as entidades políticas que contêm um endereço, além daquelas incluídas em "formatted_address". Para recuperar todas as entidades políticas que contêm um endereço específico, use a geocodificação inversa, transmitindo a latitude/longitude do endereço como um parâmetro para a solicitação. - Não há garantia de que o formato da resposta vai permanecer o mesmo entre as solicitações. Especificamente, o número de address_components varia de acordo com o endereço solicitado e pode mudar para o mesmo endereço. Um componente pode mudar a posição na matriz. O tipo do componente pode mudar. Pode faltar um componente específico em uma resposta posterior.
plus_code

PlusCode

Plus Code do local (lat/long).
location

LatLng

A posição do lugar.
viewport

Viewport

Uma janela de visualização adequada para mostrar o lugar em um mapa de tamanho médio. Essa viewport não deve ser usada como limite físico ou área de cobertura da empresa.
rating

double

Uma classificação entre 1,0 e 5,0, com base nas avaliações dos usuários sobre o lugar.
google_maps_uri

string

Um URL com mais informações sobre o lugar.
website_uri

string

O site oficial do lugar, por exemplo, a página inicial da empresa. Para lugares que fazem parte de uma rede (por exemplo, uma loja IKEA), geralmente é o site da loja individual, e não da rede em geral.
reviews[]

Review

Lista de avaliações sobre esse lugar, classificadas por relevância. É possível retornar no máximo 5 avaliações.
regular_opening_hours

OpeningHours

O horário de funcionamento normal. Se um lugar estiver sempre aberto (24 horas), o campo close não será definido. Os clientes podem confiar que o status "sempre aberto" (24 horas) é representado como um período [open][google.maps.places.v1.Place.OpeningHours.Period.open] contendo [day][Point.day] com valor 0, [hour][Point.hour] com valor 0 e [minute][Point.minute] com valor 0.
time_zone

TimeZone

Fuso horário do banco de dados IANA. Por exemplo, "America/New_York".
photos[]

Photo

Informações (incluindo referências) sobre as fotos desse lugar. É possível retornar no máximo 10 fotos.
adr_format_address

string

O endereço do lugar no microformato adr: http://microformats.org/wiki/adr.
business_status

BusinessStatus

O status da empresa para o lugar.
price_level

PriceLevel

Nível de preço do lugar.
attributions[]

Attribution

Um conjunto de provedores de dados que precisa ser mostrado com esse resultado.
icon_mask_base_uri

string

Um URL truncado para uma máscara de ícone. O usuário pode acessar diferentes tipos de ícone anexando o sufixo de tipo ao final (por exemplo, ".svg" ou ".png").
icon_background_color

string

Cor de plano de fundo para icon_mask no formato hexadecimal, por exemplo, #909CE1.
current_opening_hours

OpeningHours

O horário de funcionamento para os próximos sete dias (incluindo hoje). O período começa à meia-noite da data da solicitação e termina às 23h59 seis dias depois. Esse campo inclui o subcampo "special_days" de todas as horas, definido para datas com horários excepcionais.
current_secondary_opening_hours[]

OpeningHours

Contém uma matriz de entradas para os próximos sete dias, incluindo informações sobre os horários secundários de uma empresa. Os horários secundários são diferentes dos principais de uma empresa. Por exemplo, um restaurante pode especificar o horário de funcionamento do drive-thru ou de entrega como horário secundário. Esse campo preenche o subcampo "type", que é extraído de uma lista predefinida de tipos de horário de funcionamento (como DRIVE_THROUGH, PICKUP ou TAKEOUT) com base nos tipos do lugar. Esse campo inclui o subcampo "special_days" de todas as horas, definido para datas com horários excepcionais.
regular_secondary_opening_hours[]

OpeningHours

Contém uma matriz de entradas com informações sobre o horário de funcionamento secundário regular de uma empresa. Os horários secundários são diferentes dos principais de uma empresa. Por exemplo, um restaurante pode especificar o horário de funcionamento do drive-thru ou de entrega como horário secundário. Esse campo preenche o subcampo "type", que é extraído de uma lista predefinida de tipos de horário de funcionamento (como DRIVE_THROUGH, PICKUP ou TAKEOUT) com base nos tipos do lugar.
editorial_summary

LocalizedText

Contém um resumo do lugar. Um resumo é composto por uma visão geral textual e também inclui o código de idioma, se aplicável. O texto do resumo precisa ser apresentado como está e não pode ser modificado.
payment_options

PaymentOptions

Opções de pagamento aceitas pelo lugar. Se os dados de uma opção de pagamento não estiverem disponíveis, o campo da opção de pagamento não será definido.
parking_options

ParkingOptions

Opções de estacionamento oferecidas pelo lugar.
sub_destinations[]

SubDestination

Uma lista de subdestinos relacionados ao lugar.
fuel_options

FuelOptions

As informações mais recentes sobre as opções de combustível em um posto de gasolina. Essas informações são atualizadas regularmente.
ev_charge_options

EVChargeOptions

Informações sobre as opções de carregamento de VEs.
generative_summary

GenerativeSummary

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Resumo do lugar gerado por IA.
area_summary

AreaSummary

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Resumo gerado por IA da área em que o lugar está.
containing_places[]

ContainingPlace

Lista de lugares em que o lugar atual está localizado.
address_descriptor

AddressDescriptor

O descritor de endereço do lugar. Os descritores de endereço incluem informações adicionais que ajudam a descrever um local usando pontos de referência e áreas. Consulte a cobertura regional do descritor de endereço em https://developers.google.com/maps/documentation/geocoding/address-descriptors/coverage.
price_range

PriceRange

O intervalo de preços associado a um lugar.
utc_offset_minutes

int32

Número de minutos em que o fuso horário do lugar está atualmente deslocado do UTC. Isso é expresso em minutos para oferecer suporte a fusos horários que são compensados por frações de uma hora, por exemplo, X horas e 15 minutos.
user_rating_count

int32

O número total de avaliações (com ou sem texto) para este lugar.
takeout

bool

Especifica se a empresa oferece comida para viagem.
delivery

bool

Especifica se a empresa oferece entrega.
dine_in

bool

Especifica se a empresa oferece mesas internas ou externas.
curbside_pickup

bool

Especifica se a empresa aceita retirada na calçada.
reservable

bool

Especifica se o lugar aceita reservas.
serves_breakfast

bool

Especifica se o lugar serve café da manhã.
serves_lunch

bool

Especifica se o local serve almoço.
serves_dinner

bool

Especifica se o lugar serve jantar.
serves_beer

bool

Especifica se o local serve cerveja.
serves_wine

bool

Especifica se o lugar serve vinho.
serves_brunch

bool

Especifica se o lugar serve brunch.
serves_vegetarian_food

bool

Especifica se o lugar serve comida vegetariana.
outdoor_seating

bool

O lugar tem mesas ao ar livre.
live_music

bool

O lugar tem música ao vivo.
menu_for_children

bool

O lugar tem um cardápio infantil.
serves_cocktails

bool

O lugar serve coquetéis.
serves_dessert

bool

O lugar serve sobremesa.
serves_coffee

bool

O lugar serve café.
good_for_children

bool

O lugar é bom para crianças.
allows_dogs

bool

O lugar permite cães.
restroom

bool

O lugar tem banheiro.
good_for_groups

bool

O local acomoda grupos.
good_for_watching_sports

bool

O lugar é adequado para assistir esportes.
accessibility_options

AccessibilityOptions

Informações sobre as opções de acessibilidade oferecidas por um lugar.
pure_service_area_business

bool

Indica se o lugar é uma empresa de serviço local. Uma empresa de serviço local é aquela que faz visitas ou entregas, mas não atende no endereço comercial. Por exemplo, prestadores de serviços de limpeza ou encanadores. Essas empresas podem não ter um endereço físico ou local no Google Maps.

AccessibilityOptions

Informações sobre as opções de acessibilidade oferecidas por um lugar.

Campos
wheelchair_accessible_parking

bool

O lugar oferece estacionamento com acessibilidade para cadeirantes.
wheelchair_accessible_entrance

bool

O lugar tem entrada acessível para cadeirantes.
wheelchair_accessible_restroom

bool

O lugar tem banheiro acessível a pessoas em cadeira de rodas.
wheelchair_accessible_seating

bool

O lugar tem assentos acessíveis a pessoas em cadeira de rodas.

AddressComponent

Os componentes estruturados que formam o endereço formatado, se essas informações estiverem disponíveis.

Campos
long_text

string

A descrição completa em texto ou o nome do componente do endereço. Por exemplo, um componente de endereço para o país Austrália pode ter um long_name de "Austrália".
short_text

string

Um nome abreviado, no formato de texto, para o componente de endereço, se disponível. Por exemplo, um componente de endereço para o país da Austrália pode ter um short_name de "AU".
types[]

string

Uma matriz que indica os tipos do componente de endereço.
language_code

string

A linguagem usada para formatar esses componentes, na notação CLDR.

AreaSummary

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Resumo gerado por IA da área em que o lugar está.

Campos
content_blocks[]

ContentBlock

Blocos de conteúdo que compõem o resumo da área. Cada bloco tem um tópico separado sobre a área.
flag_content_uri

string

Um link em que os usuários podem sinalizar um problema com o resumo.

Atribuição

Informações sobre os provedores de dados desse lugar.

Campos
provider

string

Nome do provedor de dados do lugar.
provider_uri

string

URI do provedor de dados do lugar.

BusinessStatus

Status da empresa para o local.

Enums
BUSINESS_STATUS_UNSPECIFIED Valor padrão. Esse valor não é usado.
OPERATIONAL O estabelecimento está operacional, mas não necessariamente aberto.
CLOSED_TEMPORARILY O estabelecimento está temporariamente fechado.
CLOSED_PERMANENTLY O estabelecimento está permanentemente fechado.

ContainingPlace

Informações sobre o lugar em que o lugar está localizado.

Campos
name

string

O nome do recurso do lugar em que esse lugar está localizado.
id

string

O ID do lugar em que o lugar está localizado.

GenerativeSummary

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Resumo do lugar gerado por IA.

Campos
overview

LocalizedText

Informações gerais do lugar.
overview_flag_content_uri

string

Um link em que os usuários podem sinalizar um problema com o resumo da visão geral.
description

LocalizedText

A descrição detalhada do lugar.
description_flag_content_uri

string

Um link em que os usuários podem sinalizar um problema com o resumo da descrição.
references

References

Referências usadas para gerar a descrição resumida.

OpeningHours

Informações sobre o horário de funcionamento do local.

Campos
periods[]

Period

Os períodos em que o local fica aberto durante a semana. Os períodos estão em ordem cronológica, começando no domingo no fuso horário local. Um valor vazio (mas não ausente) indica um lugar que nunca está aberto, por exemplo, porque está fechado temporariamente para reformas.
weekday_descriptions[]

string

Strings localizadas que descrevem o horário de funcionamento do local, uma string para cada dia da semana. Vai estar vazio se os horários forem desconhecidos ou não puderem ser convertidos em texto localizado. Exemplo: "Dom: 18:00–06:00"
secondary_hours_type

SecondaryHoursType

Uma string de tipo usada para identificar o tipo de horas secundárias.
special_days[]

SpecialDay

Informações estruturadas sobre dias especiais que ocorrem no período coberto pelo horário de funcionamento retornado. Dias especiais são aqueles que podem afetar o horário de funcionamento de um lugar, por exemplo, o Natal. Defina para current_opening_hours e current_secondary_opening_hours se houver horários excepcionais.
next_open_time

Timestamp

A próxima vez que o período de funcionamento atual começará em até sete dias. Esse campo só é preenchido se o período de horário de funcionamento não estiver ativo no momento da veiculação da solicitação.
next_close_time

Timestamp

A próxima vez que o período de funcionamento atual terminar até sete dias no futuro. Esse campo só é preenchido se o período de horário de funcionamento estiver ativo no momento da veiculação da solicitação.
open_now

bool

Indica se o período de funcionamento está ativo no momento. Para horários de funcionamento normais e atuais, esse campo indica se o lugar está aberto. Para os horários de funcionamento secundários e atuais, esse campo indica se o horário secundário do lugar está ativo.

Período

Um período em que o lugar permanece no status "open_now".

Campos
open

Point

O horário em que o lugar começa a abrir.
close

Point

O horário em que o lugar começa a ficar fechado.

Ponto

Pontos de mudança de status.

Campos
date

Date

Data no fuso horário local do lugar.
truncated

bool

Indica se esse endpoint foi truncado ou não. O truncamento ocorre quando as horas reais estão fora dos horários que queremos retornar. Por isso, truncamos as horas de volta para esses limites. Isso garante que, no máximo, 24 * 7 horas a partir da meia-noite do dia da solicitação sejam retornadas.
day

int32

Um dia da semana, como um número inteiro no intervalo de 0 a 6. 0 é domingo, 1 é segunda-feira etc.
hour

int32

A hora no formato de 24 horas. Varia de 0 a 23.
minute

int32

O minuto. Varia de 0 a 59.

SecondaryHoursType

Um tipo usado para identificar o tipo de horas secundárias.

Enums
SECONDARY_HOURS_TYPE_UNSPECIFIED Valor padrão quando o tipo de hora secundária não é especificado.
DRIVE_THROUGH O horário de atendimento para drive-thru de bancos, restaurantes ou farmácias.
HAPPY_HOUR O happy hour.
DELIVERY O horário de entrega.
TAKEOUT O horário de retirada.
KITCHEN O horário da cozinha.
BREAKFAST A hora do café da manhã.
LUNCH A hora do almoço.
DINNER A hora do jantar.
BRUNCH O horário do brunch.
PICKUP O horário de retirada.
ACCESS Horários de acesso aos locais de armazenamento.
SENIOR_HOURS O horário especial para idosos.
ONLINE_SERVICE_HOURS O horário de atendimento on-line.

SpecialDay

Informações estruturadas sobre dias especiais que ocorrem no período coberto pelo horário de funcionamento retornado. Dias especiais são aqueles que podem afetar o horário de funcionamento de um lugar, por exemplo, o Natal.

Campos
date

Date

A data desse dia especial.

ParkingOptions

Informações sobre as opções de estacionamento do lugar. Um estacionamento pode oferecer mais de uma opção ao mesmo tempo.

Campos
free_parking_lot

bool

O lugar oferece estacionamento gratuito.
paid_parking_lot

bool

O lugar oferece estacionamento pago.
free_street_parking

bool

O lugar oferece estacionamento público sem custo financeiro.
paid_street_parking

bool

O lugar oferece estacionamento público pago.
valet_parking

bool

O lugar oferece estacionamento com manobrista.
free_garage_parking

bool

O lugar oferece estacionamento gratuito na garagem.
paid_garage_parking

bool

O lugar oferece estacionamento em garagem pago.

PaymentOptions

Opções de pagamento aceitas pelo lugar.

Campos
accepts_credit_cards

bool

O lugar aceita cartões de crédito como forma de pagamento.
accepts_debit_cards

bool

O local aceita cartões de débito como forma de pagamento.
accepts_cash_only

bool

O lugar só aceita pagamentos em dinheiro. Os lugares com esse atributo ainda podem aceitar outras formas de pagamento.
accepts_nfc

bool

O lugar aceita pagamentos por NFC.

PlusCode

O Plus Code (http://plus.codes) é uma referência de local com dois formatos: o código global, que define um retângulo de 14 m x 14 m (1/8000 de um grau) ou menor, e o código composto, que substitui o prefixo por um local de referência.

Campos
global_code

string

O código global (completo) do lugar, como "9FWM33GV+HQ", que representa uma área de 1/8000 por 1/8000 grau (aproximadamente 14 x 14 metros).
compound_code

string

O código composto do lugar, como "33GV+HQ, Ramberg, Noruega", que contém o sufixo do código global e substitui o prefixo por um nome formatado de uma entidade de referência.

SubDestination

Os subdestinos são lugares específicos associados a um lugar principal. Eles fornecem destinos mais específicos para usuários que procuram um lugar grande ou complexo, como um aeroporto, um parque nacional, uma universidade ou um estádio. Por exemplo, os subdestinos em um aeroporto podem incluir terminais e estacionamentos associados. Os subdestinos retornam o ID e o nome do recurso do lugar, que podem ser usados em solicitações de Place Details (New) subsequentes para buscar detalhes mais completos, incluindo o nome e a localização do subdestino.

Campos
name

string

O nome do recurso do subdestino.
id

string

O ID do lugar do subdestino.

Polilinha

Uma polilinha de rota. Suporta apenas uma polilinha codificada, que pode ser transmitida como uma string e inclui compactação com perda mínima. Essa é a saída padrão da API Routes.

Campos
Campo de união polyline_type. Encapsula o tipo de polilinha. A saída da API Routes é padrão para encoded_polyline. polyline_type pode ser apenas de um dos tipos a seguir:
encoded_polyline

string

Uma polilinha codificada, retornada pela API Routes por padrão. Consulte as ferramentas de codificador e decodificador.

PriceLevel

Nível de preço do lugar.

Enums
PRICE_LEVEL_UNSPECIFIED O nível de preço do lugar é não especificado ou desconhecido.
PRICE_LEVEL_FREE O lugar oferece serviços sem custo financeiro.
PRICE_LEVEL_INEXPENSIVE O lugar oferece serviços baratos.
PRICE_LEVEL_MODERATE O lugar oferece serviços com preços moderados.
PRICE_LEVEL_EXPENSIVE O lugar oferece serviços caros.
PRICE_LEVEL_VERY_EXPENSIVE O lugar oferece serviços muito caros.

PriceRange

O intervalo de preços associado a um lugar. end_price pode não ser definido, o que indica um intervalo sem limite superior (por exemplo, "Mais de US $100").

Campos
start_price

Money

O valor mínimo da faixa de preço (inclusive). O preço precisa ser igual ou superior a esse valor.
end_price

Money

O limite máximo do intervalo de preço (exclusivo). O preço precisa ser menor que esse valor.

Referências

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Referência relacionada ao conteúdo generativo.

Campos
reviews[]

Review

Avaliações que servem como referência.
places[]

string

A lista de nomes de recursos dos lugares referenciados. Esse nome pode ser usado em outras APIs que aceitam nomes de recursos do Place.

Revisão

Informações sobre uma avaliação de um lugar.

Campos
name

string

Uma referência que representa essa avaliação de lugar e pode ser usada para procurar essa avaliação de lugar novamente (também chamada de nome do "recurso" da API: places/{place_id}/reviews/{review}).
relative_publish_time_description

string

Uma string de horário recente formatado, que expressa o horário da avaliação em relação ao horário atual de forma adequada ao idioma e ao país.
text

LocalizedText

O texto localizado da avaliação.
original_text

LocalizedText

O texto da avaliação no idioma original.
rating

double

Um número entre 1,0 e 5,0, também chamado de número de estrelas.
author_attribution

AuthorAttribution

Autor da avaliação.
publish_time

Timestamp

Carimbo de data/hora da avaliação.
flag_content_uri

string

Um link para os usuários sinalizarem um problema com a avaliação.
google_maps_uri

string

Um link para mostrar a avaliação no Google Maps.

RouteModifiers

Encapsula um conjunto de condições opcionais a serem atendidas ao calcular as rotas.

Campos
avoid_tolls

bool

Opcional. Quando definido como "verdadeiro", evita vias com pedágio sempre que possível, preferência a rotas que não contenham vias com pedágio. Aplicável apenas ao DRIVE e TWO_WHEELER TravelMode.
avoid_highways

bool

Opcional. Quando definido como "true", evita rodovias sempre que possível, preferência a rotas que não contenham rodovias. Aplicável apenas ao DRIVE e TWO_WHEELER TravelMode.
avoid_ferries

bool

Opcional. Quando definido como "verdadeiro", evita balsas sempre que possível, preferência a rotas que não as contenham. Aplicável apenas ao DRIVE e TWO_WHEELER TravelMode.
avoid_indoor

bool

Opcional. Quando definida como "true", evita a navegação em ambientes fechados quando razoável, preferência a rotas que não contêm navegação em ambientes fechados. Aplicável apenas ao TravelMode WALK.

RoutingParameters

Parâmetros para configurar os cálculos de roteamento para os lugares na resposta, tanto ao longo de uma rota (em que a classificação dos resultados é influenciada) quanto para calcular os tempos de viagem nos resultados.

Campos
origin

LatLng

Opcional. Uma origem de roteamento explícita que substitui a origem definida na polilinha. Por padrão, a origem da polilinha é usada.
travel_mode

TravelMode

Opcional. O modo de transporte.
route_modifiers

RouteModifiers

Opcional. Os modificadores de rota.
routing_preference

RoutingPreference

Opcional. Especifica como calcular os resumos de roteamento. O servidor tenta usar a preferência de roteamento selecionada para calcular a rota. A preferência de roteamento com informações de trânsito só está disponível para o DRIVE ou TWO_WHEELER travelMode.

RoutingPreference

Um conjunto de valores que especificam os fatores a serem considerados ao calcular a rota.

Enums
ROUTING_PREFERENCE_UNSPECIFIED Nenhuma preferência de roteamento especificada. O padrão é TRAFFIC_UNAWARE.
TRAFFIC_UNAWARE Calcula rotas sem considerar as condições de trânsito em tempo real. Adequado quando as condições de trânsito não importam ou não são aplicáveis. O uso desse valor produz a menor latência. Observação: para TravelMode DRIVE e TWO_WHEELER, a rota e a duração escolhidas se baseiam na rede viária e nas condições médias de trânsito (independente da hora), não nas condições de trânsito atuais. Assim, os trajetos podem incluir vias que estão temporariamente interditadas. Os resultados das solicitações variam ao longo do tempo devido a mudanças na rede viária, atualizações nas condições de trânsito e da natureza distribuída do serviço. Eles também variam entre trajetos quase equivalentes a qualquer momento ou frequência.
TRAFFIC_AWARE Calcula rotas considerando as condições de trânsito em tempo real. Ao contrário do TRAFFIC_AWARE_OPTIMAL, algumas otimizações são aplicadas para reduzir significativamente a latência.
TRAFFIC_AWARE_OPTIMAL Calcula as rotas considerando as condições de trânsito em tempo real, sem aplicar a maioria das otimizações de performance. O uso desse valor produz a maior latência.

RoutingSummary

A duração e a distância da origem do trajeto até um lugar na resposta e uma segunda etapa desse lugar até o destino, se solicitado. Observação:adicionar routingSummaries na máscara de campo sem incluir o parâmetro routingParameters.origin ou searchAlongRouteParameters.polyline.encodedPolyline na solicitação causa um erro.

Campos
legs[]

Leg

Os trechos da viagem.

Quando você calcula a duração e a distância da viagem a partir de uma origem definida, o legs contém um único trecho com a duração e a distância da origem ao destino. Quando você faz uma pesquisa ao longo do trajeto, legs contém dois trechos: um da origem até o lugar e outro do lugar até o destino.
directions_uri

string

Um link para mostrar direções no Google Maps usando os pontos de passagem do resumo de trajeto. Não há garantia de que a rota gerada por esse link seja a mesma usada para gerar o resumo de roteamento. O link usa informações fornecidas na solicitação, de campos como routingParameters e searchAlongRouteParameters, quando aplicável, para gerar o link de trajeto.

Perna

Um trecho é uma única parte de uma viagem de um local a outro.

Campos
duration

Duration

O tempo que leva para concluir esta etapa da viagem.
distance_meters

int32

A distância deste trecho da viagem.

SearchNearbyRequest

Solicitar proto para o Search Nearby.

Campos
language_code

string

Os detalhes do lugar serão mostrados no idioma preferido, se disponível. Se o código de idioma não for especificado ou reconhecido, os detalhes do lugar em qualquer idioma poderão ser retornados, com preferência pelo inglês, se esses detalhes existirem.

Lista atual de idiomas aceitos: https://developers.google.com/maps/faq#languagesupport.
region_code

string

O código de país/região Unicode (CLDR) do local de origem da solicitação. Esse parâmetro é usado para mostrar os detalhes do lugar, como o nome do lugar específico da região, se disponível. O parâmetro pode afetar os resultados com base na legislação aplicável.

Para mais informações, consulte https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

No momento, não há suporte para códigos de região de três dígitos.
included_types[]

string

Incluir o tipo de lugar (por exemplo, "restaurante" ou "gasolina") de https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da Tabela A.

Se houver tipos conflitantes, ou seja, um tipo aparece em included_types e em excluded_types, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam principalmente como "restaurantes".
excluded_types[]

string

Tipo de lugar excluído (por exemplo, "restaurante" ou "posto_de_gasolina") em https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da Tabela A.

Se o cliente fornecer os dois tipos incluídos (por exemplo, restaurante) e excluídos (por exemplo, café), a resposta precisará incluir lugares que são restaurantes, mas não cafés. A resposta inclui lugares que correspondem a pelo menos um dos tipos incluídos e a nenhum dos tipos excluídos.

Se houver tipos conflitantes, ou seja, um tipo aparece em included_types e em excluded_types, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam principalmente como "restaurantes".
included_primary_types[]

string

Incluiu o tipo de lugar principal (por exemplo, "restaurante" ou "gasolina") de https://developers.google.com/maps/documentation/places/web-service/place-types. Um lugar só pode ter um único tipo principal da tabela de tipos compatíveis associada a ele.

É possível especificar até 50 tipos da Tabela A.

Se houver tipos principais conflitantes, ou seja, um tipo aparece em included_primary_types e em excluded_primary_types, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam principalmente como "restaurantes".
excluded_primary_types[]

string

Exclusão do tipo de lugar principal (por exemplo, "restaurante" ou "gas_station") em https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da Tabela A.

Se houver tipos principais conflitantes, ou seja, um tipo aparece em included_primary_types e em excluded_primary_types, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {included_types = ["restaurant"], excluded_primary_types = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam principalmente como "restaurantes".
max_result_count

int32

Número máximo de resultados a serem retornados. Precisa estar entre 1 e 20 (padrão), inclusive. Se o número não for definido, ele vai voltar para o limite superior. Se o número for definido como negativo ou exceder o limite máximo, será retornado um erro INVALID_ARGUMENT.
location_restriction

LocationRestriction

Obrigatório. A região a ser pesquisada.
rank_preference

RankPreference

Como os resultados serão classificados na resposta.
routing_parameters

RoutingParameters

Opcional. Parâmetros que afetam o roteamento para os resultados da pesquisa.

LocationRestriction

A região a ser pesquisada.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
circle

Circle

Um círculo definido pelo ponto central e pelo raio.

RankPreference

Como os resultados serão classificados na resposta.

Enums
RANK_PREFERENCE_UNSPECIFIED O valor de RankPreference não foi definido. Vai usar a classificação por POPULARITY por padrão.
DISTANCE Classifica os resultados por distância.
POPULARITY Classifica os resultados por popularidade.

SearchNearbyResponse

Proto de resposta para a Pesquisa nas proximidades.

Campos
places[]

Place

Uma lista de lugares que atende aos requisitos do usuário, como tipos de lugares, número de lugares e restrição de local específico.
routing_summaries[]

RoutingSummary

Uma lista de resumos de roteamento em que cada entrada é associada ao lugar correspondente no mesmo índice no campo places. Se o resumo do trajeto não estiver disponível para um dos lugares, ele vai conter uma entrada vazia. Essa lista precisa ter tantas entradas quanto a lista de lugares, se solicitada.

SearchTextRequest

Proto de solicitação para SearchText.

Campos
text_query

string

Obrigatório. A consulta de texto para pesquisa textual.
language_code

string

Os detalhes do lugar serão mostrados no idioma preferido, se disponível. Se o código de idioma não for especificado ou reconhecido, os detalhes do lugar em qualquer idioma poderão ser retornados, com preferência pelo inglês, se esses detalhes existirem.

Lista atual de idiomas aceitos: https://developers.google.com/maps/faq#languagesupport.
region_code

string

O código de país/região Unicode (CLDR) do local de origem da solicitação. Esse parâmetro é usado para mostrar os detalhes do lugar, como o nome do lugar específico da região, se disponível. O parâmetro pode afetar os resultados com base na legislação aplicável.

Para mais informações, consulte https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

No momento, não há suporte para códigos de região de três dígitos.
rank_preference

RankPreference

Como os resultados serão classificados na resposta.
included_type

string

O tipo de lugar solicitado. Lista completa de tipos com suporte: https://developers.google.com/maps/documentation/places/web-service/place-types. Suporte a apenas um tipo incluído.
open_now

bool

Usado para restringir a pesquisa a lugares que estão abertos no momento. O valor padrão é falso.
min_rating

double

Filtrar os resultados com a classificação média do usuário menor que esse limite. Um valor válido precisa ser um número flutuante entre 0 e 5 (inclusive) com uma cadência de 0,5, ou seja, [0, 0,5, 1,0, ... , 5,0]. A classificação de entrada será arredondada para o 0,5 mais próximo(teto). Por exemplo, uma classificação de 0,6 vai eliminar todos os resultados com uma classificação inferior a 1,0.
max_result_count
(deprecated)

int32

Descontinuado: use page_size.

O número máximo de resultados por página que podem ser retornados. Se o número de resultados disponíveis for maior que max_result_count, um next_page_token será retornado e poderá ser transmitido para page_token para receber a próxima página de resultados em solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão de 20 será usado. O valor máximo é 20. Valores acima disso serão convertidos para 20. Valores negativos vão retornar um erro INVALID_ARGUMENT.

Se max_result_count e page_size forem especificados, max_result_count será ignorado.
page_size

int32

Opcional. O número máximo de resultados por página que podem ser retornados. Se o número de resultados disponíveis for maior que page_size, um next_page_token será retornado e poderá ser transmitido para page_token para receber a próxima página de resultados em solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão de 20 será usado. O valor máximo é 20. Valores acima disso serão definidos como 20. Valores negativos vão retornar um erro INVALID_ARGUMENT.

Se max_result_count e page_size forem especificados, max_result_count será ignorado.
page_token

string

Opcional. Um token de página recebido de uma chamada TextSearch anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os parâmetros, exceto page_token, page_size e max_result_count, fornecidos para TextSearch precisam corresponder à chamada inicial que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.
price_levels[]

PriceLevel

Usado para restringir a pesquisa a lugares marcados como determinados níveis de preço. Os usuários podem escolher qualquer combinação de níveis de preço. Por padrão, selecione todos os níveis de preço.
strict_type_filtering

bool

Usado para definir a filtragem de tipo estrito para "included_type". Se definido como "true", apenas os resultados do mesmo tipo serão retornados. O padrão é "false".
location_bias

LocationBias

A região a ser pesquisada. Esse local serve como viés, o que significa que os resultados em torno do local podem ser retornados. Não pode ser definido com "location_restriction".
location_restriction

LocationRestriction

A região a ser pesquisada. Esse local serve como uma restrição, o que significa que os resultados fora do local especificado não serão retornados. Não pode ser definido com "location_bias".
ev_options

EVOptions

Opcional. Defina as opções pesquisáveis de EV de uma solicitação de pesquisa de lugar.
routing_parameters

RoutingParameters

Opcional. Parâmetros adicionais para encaminhar para resultados.
search_along_route_parameters

SearchAlongRouteParameters

Opcional. Proto de parâmetros adicionais para pesquisar ao longo de uma rota.
include_pure_service_area_businesses

bool

Opcional. Inclua empresas de serviço local puro se o campo estiver definido como verdadeiro. Uma empresa de serviço local é aquela que faz visitas ou entregas, mas não atende no endereço comercial. Por exemplo, prestadores de serviços de limpeza ou encanadores. Essas empresas não têm um endereço físico ou local no Google Maps. O Places não vai retornar campos como location, plus_code e outros campos relacionados à localização para essas empresas.

EVOptions

Opções de VE pesquisáveis de uma solicitação de pesquisa de lugar.

Campos
minimum_charging_rate_kw

double

Opcional. Taxa de recarga mínima necessária em quilowatts. Um lugar com uma taxa de carregamento menor que a especificada é filtrado.
connector_types[]

EVConnectorType

Opcional. A lista de tipos de conector de VE preferidos. Um lugar que não oferece suporte a nenhum dos tipos de conector listados é filtrado.

LocationBias

A região a ser pesquisada. Esse local serve como viés, o que significa que os resultados em torno do local podem ser retornados.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

Viewport

Uma caixa retangular definida pelos cantos nordeste e sudoeste. rectangle.high() precisa ser o ponto nordeste da viewport retangular. rectangle.low() precisa ser o ponto sudoeste da viewport retangular. rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma viewport retangular não pode ter mais de 180 graus de largura.
circle

Circle

Um círculo definido pelo ponto central e pelo raio.

LocationRestriction

A região a ser pesquisada. Esse local serve como uma restrição, o que significa que os resultados fora do local especificado não serão retornados.

Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

Viewport

Uma caixa retangular definida pelos cantos nordeste e sudoeste. rectangle.high() precisa ser o ponto nordeste da viewport retangular. rectangle.low() precisa ser o ponto sudoeste da viewport retangular. rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma viewport retangular não pode ter mais de 180 graus de largura.

RankPreference

Como os resultados serão classificados na resposta.

Enums
RANK_PREFERENCE_UNSPECIFIED Para uma consulta categórica, como "Restaurantes em Nova York", a RELEVÂNCIA é o padrão. Para consultas não categóricas, como "Mountain View, CA", recomendamos que você não defina a rankPreference.
DISTANCE Classifica os resultados por distância.
RELEVANCE Classifica os resultados por relevância. Ordem de classificação determinada pela pilha de classificação normal.

SearchAlongRouteParameters

Especifica uma polilinha precalculada da API Routes que define a rota a ser pesquisada. Pesquisar ao longo de uma rota é semelhante a usar a opção de solicitação locationBias ou locationRestriction para enviesar os resultados da pesquisa. No entanto, enquanto as opções locationBias e locationRestriction permitem especificar uma região para enviesar os resultados da pesquisa, essa opção permite enviesar os resultados ao longo de um trajeto.

Não há garantia de que os resultados vão estar na rota fornecida, mas eles são classificados na área de pesquisa definida pela poligonal e, opcionalmente, pelo locationBias ou locationRestriction com base nos tempos mínimos de desvio da origem ao destino. Os resultados podem estar em um trajeto alternativo, principalmente se a poligonal fornecida não definir um trajeto ideal da origem ao destino.

Campos
polyline

Polyline

Obrigatório. A polilinha da rota.

SearchTextResponse

Proto de resposta para SearchText.

Campos
places[]

Place

Uma lista de lugares que atendem aos critérios de pesquisa de texto do usuário.
routing_summaries[]

RoutingSummary

Uma lista de resumos de roteamento em que cada entrada é associada ao lugar correspondente no mesmo índice no campo places. Se o resumo do trajeto não estiver disponível para um dos lugares, ele vai conter uma entrada vazia. Essa lista terá tantas entradas quanto a lista de lugares, se solicitada.
contextual_contents[]

ContextualContent

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.

Uma lista de conteúdos contextuais em que cada entrada é associada ao lugar correspondente no mesmo índice no campo "Lugares". Os conteúdos relevantes para o text_query na solicitação são preferidos. Se o conteúdo contextual não estiver disponível para um dos lugares, ele vai retornar conteúdo não contextual. Ele só vai estar vazio quando o conteúdo não estiver disponível para esse lugar. Essa lista terá tantas entradas quanto a lista de lugares, se solicitada.
next_page_token

string

Um token que pode ser enviado como page_token para recuperar a próxima página. Se o campo for omitido ou estiver vazio, não haverá páginas subsequentes.
search_uri

string

Um link permite que o usuário pesquise com a mesma consulta de texto especificada na solicitação no Google Maps.

TravelMode

Opções de modo de viagem. Essas opções são mapeadas para o que a API Routes oferece.

Enums
TRAVEL_MODE_UNSPECIFIED Nenhum modo de transporte especificado. O valor padrão é DRIVE.
DRIVE Viajar de carro de passeio.
BICYCLE Viajar de bicicleta. Não é compatível com search_along_route_parameters.
WALK Caminhar. Não é compatível com search_along_route_parameters.
TWO_WHEELER Veículos motorizados de duas rodas de todos os tipos, como scooters e motocicletas. Isso é diferente do meio de transporte BICYCLE, que abrange transporte por pessoas. Não é compatível com search_along_route_parameters. Somente nos países listados em Países e regiões com suporte para veículos de duas rodas.