Package google.maps.geocode.v4alpha

Índice

DestinationService

Um serviço para recuperar destinos.

Um destino fornece contexto hierárquico sobre um lugar, o que permite, por exemplo, encontrar edifícios de apartamentos dentro de um complexo maior e vice-versa. Ele também fornece pontos de navegação adequados para casos de uso como carona compartilhada ou entrega.

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

Esse método realiza uma pesquisa de destino e retorna uma lista de destinos.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

GeocodeService

Um serviço para realizar geocodificação.

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

Esse método realiza uma geocodificação de endereço, que mapeia um endereço para um LatLng. Ele também fornece informações estruturadas sobre o endereço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.address
GeocodeLocation

rpc GeocodeLocation(GeocodeLocationRequest) returns (GeocodeLocationResponse)

Esse método realiza uma geocodificação de local, que mapeia um LatLng para um endereço. Ele também fornece informações estruturadas sobre o endereço.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/maps-platform.geocode
  • https://www.googleapis.com/auth/maps-platform.geocode.location
GeocodePlace

rpc GeocodePlace(GeocodePlaceRequest) returns (GeocodeResult)

Esse método realiza uma pesquisa de geocodificação usando um ID de lugar.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Destino

Um destino. Isso inclui o lugar principal, lugares relacionados, entradas e pontos de navegação.

Campos
primary

PlaceView

O lugar principal identificado pelo primary_query na solicitação.
containing_places[]

PlaceView

Os lugares menos precisos que contêm o lugar principal. Por exemplo, o complexo de apartamentos que contém esse prédio.
sub_destinations[]

PlaceView

Subdestinos mais precisos do lugar principal. Por exemplo, unidades contidas em um prédio.

Observação: em comparação com o SubDestination retornado pela API Places, essa lista de subdestinos é mais completa, e cada subdestino contém mais informações.
landmarks[]

Landmark

Pontos de referência que podem ser usados para comunicar onde fica o destino ou ajudar na chegada.
entrances[]

Entrance

Entradas para esse destino.
navigation_points[]

NavigationPoint

Pontos de navegação para este destino.
arrival_summary

Destination.ArrivalSummary

Resumo gerado por IA da experiência de chegada ao destino.

ArrivalSummary

Resumo gerado por IA da experiência de chegada ao destino.

Campos
text

LocalizedText

O resumo da experiência de chegada ao destino.
flag_content_url

string

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

LocalizedText

Apenas saída. Contém o texto de divulgação do resumo de chegada.

Entrada

Uma entrada é um único par de coordenadas de latitude/longitude que define a localização de um ponto de entrada e saída de um lugar.

Campos
location

LatLng

O local da entrada.
tags[]

Entrance.Tag

Uma lista de tags que descrevem a entrada.
place

string

A estrutura em que essa entrada está localizada fisicamente, no formato places/{place_id}.

Tag

Características que descrevem uma entrada.

Tipos enumerados
TAG_UNSPECIFIED Não utilizado.
PREFERRED

A entrada provavelmente oferece acesso físico ao local principal no destino retornado. Um lugar pode ter várias entradas preferenciais. Se uma entrada não tiver essa tag, significa que ela está fisicamente no mesmo prédio do lugar principal, mas não necessariamente dá acesso a ele.

Por exemplo, se o lugar principal for um restaurante em um centro comercial, as entradas "PREFERRED" serão as que provavelmente levam ao restaurante, enquanto as outras entradas retornadas serão outras entradas do edifício, como as de outros restaurantes no centro comercial.

Se o lugar principal for um prédio, as entradas PREFERRED serão as que levam à parte "principal" do prédio. Por exemplo, em um shopping center, as entradas PREFERRED são as que permitem o acesso ao saguão principal. No entanto, se uma entrada só permitir o acesso a uma loja na lateral do prédio, ela não será uma entrada PREFERRED.

Observação: uma entrada PREFERRED pode não dar acesso ao local principal, e uma entrada não PREFERRED pode dar acesso ao local principal.

GeocodeAddressRequest

Mensagem de solicitação para "GeocodeService.GeocodeAddress".

Campos
location_bias

GeocodeAddressRequest.LocationBias

Opcional. A região a ser pesquisada. Esse local serve como uma tendência, o que significa que resultados próximos ao local especificado podem ser retornados.
language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.
region_code

string

Opcional. Código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável. Esse parâmetro também influencia, mas não restringe totalmente, os resultados do serviço.
Campo de união address_input. O endereço a ser geocodificado. address_input pode ser apenas de um dos tipos a seguir:
address_query

string

O endereço não estruturado a ser geocodificado.
address

PostalAddress

O endereço estruturado a ser geocodificado no formato de endereço postal.

LocationBias

A região a ser pesquisada. Esse local serve como uma tendência, o que significa que resultados próximos ao local especificado podem ser retornados.

Campos
Campo de união type. Tipos de viés de local. 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 janela de visualização do retângulo. rectangle.low() precisa ser o ponto sudoeste da janela de visualização do retângulo. O campo rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma janela de visualização retangular não pode ter mais de 180 graus de largura.

GeocodeAddressResponse

Mensagem de resposta para GeocodeService.GeocodeAddress.

Campos
results[]

GeocodeResult

O resultado da geocodificação.

GeocodeLocationRequest

Mensagem de solicitação para "GeocodeService.GeocodeLocation".

Campos
language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.
region_code

string

Opcional. Código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável.
types[]

string

Opcional. Um conjunto de tags de tipo para restringir os resultados. Os resultados que não têm nenhum dos tipos especificados são removidos.

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.
granularity[]

GeocodeResult.Granularity

Opcional. Um filtro de um ou mais enums de granularidade de local.
Campo de união location_input. O local a ser geocodificado. location_input pode ser apenas de um dos tipos a seguir:
location_query

string

O local no formato de string "lat,lng". Por exemplo, "64.7611872,-18.4705364".
location

LatLng

O local no formato estruturado.

GeocodeLocationResponse

Mensagem de resposta para GeocodeService.GeocodeLocation.

Campos
results[]

GeocodeResult

O resultado da geocodificação.
plus_code

PlusCode

Plus Code do local na solicitação.

GeocodePlaceRequest

Mensagem de solicitação para "GeocodeService.GeocodePlace".

Campos
place

string

Obrigatório. Identificador do lugar para geocodificar no formato places/{place}.
language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.
region_code

string

Opcional. Código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável.

GeocodeResult

Um resultado de geocodificação contém informações geográficas sobre um lugar.

Campos
place

string

O identificador de lugar totalmente qualificado para este resultado. No formato "//places.googleapis.com/places/{placeID}". Consulte https://developers.google.com/maps/documentation/places/web-service/place-id para mais detalhes.
place_id

string

O ID do lugar para este resultado.
location

LatLng

O latlng deste endereço.
granularity

GeocodeResult.Granularity

A granularidade do local.
viewport

Viewport

Uma janela de visualização adequada para mostrar o resultado da geocodificação.
bounds

Viewport

Uma caixa delimitadora para o endereço.
formatted_address

string

O endereço formatado em uma linha.
postal_address

PostalAddress

O endereço no formato de endereço postal.
address_components[]

GeocodeResult.AddressComponent

Componentes repetidos para cada nível de localidade.
postal_code_localities[]

LocalizedText

Lista completa de localidades contidas no código postal.

Esse campo só é preenchido quando o resultado é do tipo "postal_code".
types[]

string

Um conjunto de tags de tipo para este resultado. Por exemplo, "political" e "administrative_area".

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.
plus_code

PlusCode

Plus Code do local nesta geocodificação.

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 o nome longo "Austrália".
short_text

string

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

string

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

Consulte https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types para mais detalhes.
language_code

string

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

Granularidade

A granularidade do local.

Tipos enumerados
GRANULARITY_UNSPECIFIED Não use.
ROOFTOP O local não interpolado de um terreno real correspondente ao endereço encontrado.
RANGE_INTERPOLATED Interpolado de um intervalo de números de rua. Por exemplo, se soubermos que um trecho da Amphitheatre Pkwy contém os números 1600 a 1699, o número 1650 poderá ser colocado na metade do caminho entre os endpoints.
GEOMETRIC_CENTER O centro geométrico de um elemento para o qual temos dados poligonais.
APPROXIMATE Todo o resto.

Ponto de referência

Os pontos de referência são usados para comunicar onde fica o destino ou ajudar a chegar lá.

Campos
relational_description

LocalizedText

Uma descrição legível de como o destino se relaciona ao ponto de referência. Por exemplo: "Perto do Empire State Building" ou "Em frente à Casa Branca".
tags[]

Landmark.Tag

Tags que descrevem como o ponto de referência pode ser usado no contexto do destino.
straight_line_distance_meters

double

Apenas saída. A distância em linha reta do ponto de referência até o destino em metros.
travel_distance_meters

double

Apenas saída. A distância da rede viária desse ponto de referência até o destino em metros.
Campo de união landmark. O ponto de referência. landmark pode ser apenas de um dos tipos a seguir:
place

PlaceView

O lugar que representa esse ponto de referência.

Tag

A lista de todas as tags possíveis que descrevem como um ponto de referência pode ser usado no contexto de um destino.

Se um endereço tiver as tags ADDRESS e ARRIVAL, isso significa que o ponto de referência é proeminente localmente e está perto do destino.

Tipos enumerados
TAG_UNSPECIFIED Não utilizado.
ADDRESS Um lugar de destaque local que pode ser usado para identificar a localização geral do destino. Normalmente, a poucos metros do destino. Eles são semelhantes aos pontos de referência retornados pelo recurso de descritores de endereço da API Geocoding: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Um lugar que pode ser usado para ajudar a chegar ao destino. Útil para navegação quando você está perto do destino. Por exemplo, pode ser um lugar que fica do outro lado da rua do destino. Um ponto de referência com essa tag geralmente está mais perto do destino do que os pontos com a tag ADDRESS.

Um ponto de navegação é um local ao lado de uma via em que a navegação pode terminar.

Campos
navigation_point_token

string

Apenas saída. Um token que pode ser usado para identificar esse ponto de navegação.
display_name

LocalizedText

O nome de exibição deste ponto de navegação. Por exemplo, "5ª Avenida" ou "Portão B".
location

LatLng

Um ponto ao lado do trecho da via onde a navegação deve terminar. O ponto é intencionalmente ligeiramente deslocado da linha central da via para marcar claramente o lado da via em que o lugar está localizado.
travel_modes[]

NavigationPoint.TravelMode

Modos de viagem adequados para este ponto de navegação.
usages[]

NavigationPoint.Usage

Usos compatíveis com este ponto de navegação.

TravelMode

Modos de viagem adequados para este ponto de navegação.

Tipos enumerados
TRAVEL_MODE_UNSPECIFIED Não utilizado.
DRIVE Adequado para dirigir.
WALK Adequado para caminhadas.

Uso

Usos compatíveis com este ponto de navegação.

Tipos enumerados
USAGE_UNSPECIFIED Não utilizado.
UNKNOWN Tipo de uso desconhecido. A maioria dos pontos de navegação será UNKNOWN, o que não significa necessariamente que o uso deles seja restrito de alguma forma. Essa navegação ainda pode ser adequada para retirada e/ou entrega.
DROPOFF Adequado para desembarcar um passageiro. Por exemplo, um local de desembarque de carona compartilhada.
PICKUP Adequado para pegar um passageiro. Por exemplo, um local de embarque e desembarque de passageiros de aplicativos de transporte.

PlaceView

Representa uma visualização de um Lugar na API Places. Ele também fornece informações adicionais específicas para destinos, como o tipo de estrutura e o polígono de exibição.

Em alguns casos, um PlaceView com o mesmo ID de lugar pode ser diferente do que é retornado pela API Places para os campos types e display_name.

Campos
place

string

O nome do recurso deste lugar, no formato places/{placeId}.
display_name

LocalizedText

Descrição do lugar legível por humanos. Por exemplo, "Portão B", "McDonalds"
primary_type

string

O tipo de lugar principal deste lugar. Consulte https://developers.google.com/maps/documentation/places/web-service/place-types para ver a lista de valores possíveis.

Observação: esse campo nem sempre é preenchido. Esteja preparado para usar o campo types nessas situações.
types[]

string

Todos os tipos de lugar associados a este lugar. Consulte https://developers.google.com/maps/documentation/places/web-service/place-types para ver a lista de valores possíveis.
formatted_address

string

Endereço de uma linha.
postal_address

PostalAddress

Endereço estruturado.
structure_type

PlaceView.StructureType

O tipo de estrutura correspondente a este lugar.
location

LatLng

O local deste lugar. Para lugares com polígonos de exibição, isso pode representar um bom ponto para colocar um marcador no mapa.
display_polygon

Struct

O contorno do polígono do lugar no formato GeoJSON, usando o formato RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Observação: o formato RFC 7946 é compatível com MultiPolygons. Portanto, um objeto display_polygon pode representar vários polígonos.

StructureType

O tipo de estrutura que este lugar representa.

Tipos enumerados
STRUCTURE_TYPE_UNSPECIFIED Não utilizado.
POINT Um local de ponto.
SECTION Uma subseção de um edifício.
BUILDING Um edifício.
GROUNDS Uma área grande que normalmente contém vários edifícios, como um campus universitário, um complexo de apartamentos ou um shopping center.

PlusCode

O Plus Code (http://plus.codes) é uma referência de local com dois formatos: código global que define um retângulo de 14 m x 14 m (1/8000 de um grau) ou menor, e 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 de grau (~14 por 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.

SearchDestinationsRequest

Mensagem de solicitação para DestinationService.SearchDestinations.

Campos
travel_modes[]

NavigationPoint.TravelMode

Opcional. Os meios de transporte para filtrar pontos de navegação. Isso influencia o campo navigation_points retornado na resposta. Se estiver vazio, os pontos de navegação de todos os meios de transporte poderão ser retornados.
language_code

string

Opcional. Idioma em que os resultados precisam ser retornados.
region_code

string

Opcional. Código da região. O código da região, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. O parâmetro afeta os resultados com base na legislação aplicável. Esse parâmetro também influencia, mas não restringe totalmente, os resultados do serviço.

Campo de união primary_query. Consulte o destino principal. Pode ser um lugar, um endereço totalmente especificado ou um local LatLng. Alguns lugares e endereços com poucas informações não podem ser transformados em um destino.

Os destinos são criados com base na consulta principal especificada.

Observação: somente lugares e endereços que podem ter um destino de navegação são aceitos. Por exemplo, um lugar que representa uma casa ou um complexo de apartamentos pode ser usado como a consulta principal, mas lugares que representam uma localidade ou uma área administrativa não podem ser usados como a consulta principal. primary_query pode ser apenas de um dos tipos a seguir:
place

string

O nome do recurso de um lugar, no formato places/{place_id}.
address_query

SearchDestinationsRequest.AddressQuery

Um endereço.
location_query

SearchDestinationsRequest.LocationQuery

Um local exato.

AddressQuery

O endereço que você quer pesquisar. Especifique endereços de acordo com o formato usado pelo serviço postal do país em questão.

Campos
Campo de união kind. A consulta de endereço. kind pode ser apenas de um dos tipos a seguir:
address

PostalAddress

Um endereço no formato de endereço postal.
address_query

string

Um endereço formatado como uma única linha.

LocationQuery

Uma consulta de local para identificar um destino principal próximo.

Observação: se a consulta de local estiver em um prédio com subunidades, é possível que o lugar principal retornado seja uma subunidade. Nesses casos, o campo "containing_places" vai incluir o edifício.

Campos
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

Opcional. Filtros a serem aplicados aos candidatos a destino.
Campo de união kind. A consulta de local. kind pode ser apenas de um dos tipos a seguir:
location

LatLng

Um local LatLng exato.

PlaceFilter

Filtros a serem aplicados aos candidatos a destino.

Campos
structure_type

PlaceView.StructureType

Opcional. Se especificado, todos os destinos terão um lugar principal com esse tipo de estrutura. Isso pode resultar na filtragem de alguns destinos ou no refinamento/refinamento dos destinos retornados.

Por exemplo, se GROUNDS for especificado, todos os destinos retornados terão um lugar principal com o tipo de estrutura GROUNDS. Isso pode resultar na filtragem de alguns destinos que não fazem parte de um complexo ou na simplificação dos destinos retornados para o nível do complexo.

Outro uso desse campo é facilitar a extração de polígonos de exibição de edifícios. Por exemplo, se BUILDING for especificado, o polígono de exibição do lugar principal será para o edifício no local especificado.
addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

Opcional. Se especificado, retorna apenas destinos que atendem aos critérios de capacidade de segmentação correspondentes.

Endereçabilidade

Define opções para filtragem de capacidade de endereçamento. Novos valores podem ser adicionados no futuro.

Tipos enumerados
ADDRESSABILITY_UNSPECIFIED Quando não especificado, o serviço escolhe um padrão adequado.
ANY A capacidade de segmentação não é um critério de filtragem. Os destinos são retornados independentemente da capacidade de endereçamento.
PRIMARY Todos os destinos retornados terão um lugar principal com um endereço ou nome de rua.
WEAK Todos os destinos retornados terão um lugar principal ou um subdestino com um endereço ou nome de rua.

SearchDestinationsResponse

Mensagem de resposta para DestinationService.SearchDestinations.

Campos
destinations[]

Destination

Uma lista de destinos.

O serviço retorna um resultado se um destino principal puder ser identificado de forma inequívoca na consulta principal. Caso contrário, o serviço poderá retornar vários resultados para desambiguação ou nenhum resultado.