Package google.maps.geocode.v4alpha

Índice

DestinationService

Es un servicio para recuperar destinos.

Un destino proporciona contexto jerárquico sobre un lugar, lo que te permite, por ejemplo, encontrar edificios de departamentos dentro de un complejo de departamentos más grande y viceversa. También proporciona puntos de navegación adecuados para casos de uso como viajes compartidos o entregas.

SearchDestinations

rpc SearchDestinations(SearchDestinationsRequest) returns (SearchDestinationsResponse)

Este método realiza una búsqueda de destino y devuelve una lista de destinos.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

GeocodeService

Es un servicio para realizar la geocodificación.

GeocodeAddress

rpc GeocodeAddress(GeocodeAddressRequest) returns (GeocodeAddressResponse)

Este método realiza una geocodificación de dirección, que asigna una dirección a un objeto LatLng. También proporciona información estructurada sobre la dirección.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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)

Este método realiza una geocodificación de ubicación, que asigna un LatLng a una dirección. También proporciona información estructurada sobre la dirección.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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)

Este método realiza una búsqueda de geocodificación con un ID de lugar.

Permisos de autorización

Se necesita uno de los siguientes permisos de 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

Un destino Esto incluye el lugar principal, los lugares relacionados, las entradas y los puntos de navegación.

Campos
primary

PlaceView

Es el lugar principal que identifica el primary_query en la solicitud.
containing_places[]

PlaceView

Son los lugares menos precisos que contienen el lugar principal. Por ejemplo, el complejo de departamentos que contiene este edificio.
sub_destinations[]

PlaceView

Son destinos secundarios más precisos del lugar principal. Por ejemplo, las unidades que contiene un edificio.

Nota: En comparación con el objeto SubDestination que devuelve la API de Places, esta lista de subdestinos es más exhaustiva y cada subdestino contiene más información.
landmarks[]

Landmark

Puntos de referencia que se pueden usar para comunicar dónde está el destino o ayudar con la llegada.
entrances[]

Entrance

Son las entradas para este destino.
navigation_points[]

NavigationPoint

Son los puntos de navegación para este destino.
arrival_summary

Destination.ArrivalSummary

Resumen generado por IA de la experiencia de llegada al destino.

ArrivalSummary

Resumen generado por IA de la experiencia de llegada al destino.

Campos
text

LocalizedText

Es el resumen de la experiencia de llegada al destino.
flag_content_url

string

Un vínculo en el que los usuarios pueden marcar un problema con el resumen
disclosure_text

LocalizedText

Solo salida. Contiene el texto de divulgación del resumen de llegada.

Entrada

Una entrada es un solo par de coordenadas de latitud y longitud que define la ubicación de un punto de entrada y salida de un lugar.

Campos
location

LatLng

Ubicación de la entrada.
tags[]

Entrance.Tag

Es una lista de etiquetas que describen la entrada.
place

string

Es la estructura en la que se encuentra físicamente esta entrada, en formato places/{place_id}.

Etiqueta

Son las características que describen una entrada.

Enums
TAG_UNSPECIFIED No se usa.
PREFERRED

Es probable que la entrada proporcione acceso físico al lugar principal del destino devuelto. Un lugar puede tener varias entradas preferidas. Si una entrada no tiene esta etiqueta, significa que está físicamente en el mismo edificio que el lugar principal, pero no necesariamente proporciona acceso a él.

Por ejemplo, si el lugar principal es un restaurante en un centro comercial, las entradas "PREFERRED" serán las que probablemente conduzcan al restaurante, mientras que las otras entradas que se devuelvan serán otras entradas al edificio, como las que conducen a otros restaurantes del centro comercial.

Si el lugar principal es un edificio, las entradas PREFERRED serán las que conducen a la parte "principal" del edificio. Por ejemplo, en un centro comercial, las entradas PREFERRED serán las que permitan el acceso al área principal del vestíbulo, pero si una entrada solo proporciona acceso a una tienda en el costado del edificio, no será una entrada PREFERRED.

Nota: Una entrada PREFERRED podría no proporcionar acceso al lugar principal, y una entrada que no sea PREFERRED podría proporcionar acceso al lugar principal.

GeocodeAddressRequest

Es el mensaje de solicitud para GeocodeService.GeocodeAddress.

Campos
location_bias

GeocodeAddressRequest.LocationBias

Opcional. Es la región en la que se realizará la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se pueden mostrar resultados alrededor de la ubicación proporcionada.
language_code

string

Opcional. Idioma en el que se deben mostrar los resultados.
region_code

string

Opcional. Es el código de región. Es el código de región, especificado como un valor de dos caracteres del ccTLD ("dominio de nivel superior"). El parámetro afecta los resultados según la legislación aplicable. Este parámetro también afectará los resultados del servicio, pero no los restringirá por completo.
Campo de unión address_input. Es la dirección que se geocodificará. address_input puede ser solo uno de los parámetros siguientes:
address_query

string

Es la dirección no estructurada que se geocodificará.
address

PostalAddress

Es la dirección estructurada que se geocodificará en formato de dirección postal.

LocationBias

Es la región en la que se realizará la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se pueden mostrar resultados alrededor de la ubicación proporcionada.

Campos
Campo de unión type. Tipos de sesgo de ubicación. type puede ser solo uno de los parámetros siguientes:
rectangle

Viewport

Es un cuadro rectangular definido por las esquinas noreste y suroeste. rectangle.high() debe ser el punto noreste de la ventana gráfica rectangular. rectangle.low() debe ser el punto suroeste de la ventana gráfica rectangular. rectangle.low().latitude() no puede ser mayor que rectangle.high().latitude(). Esto generará un rango de latitud vacío. Un viewport rectangular no puede tener un ancho superior a 180 grados.

GeocodeAddressResponse

Mensaje de respuesta para GeocodeService.GeocodeAddress.

Campos
results[]

GeocodeResult

Es el resultado de la geocodificación.

GeocodeLocationRequest

Es el mensaje de solicitud para GeocodeService.GeocodeLocation.

Campos
language_code

string

Opcional. Idioma en el que se deben mostrar los resultados.
region_code

string

Opcional. Es el código de región. Es el código de región, especificado como un valor de dos caracteres del ccTLD ("dominio de nivel superior"). El parámetro afecta los resultados según la legislación aplicable.
types[]

string

Opcional. Es un conjunto de etiquetas de tipo para restringir los resultados. Se quitan los resultados que no tienen ninguno de los tipos especificados.

Para obtener la lista completa de valores posibles, consulta la Tabla A y la Tabla B en https://developers.google.com/maps/documentation/places/web-service/place-types.
granularity[]

GeocodeResult.Granularity

Opcional. Es un filtro de uno o más valores de enumeración de granularidad de la ubicación.
Campo de unión location_input. Es la ubicación que se geocodificará. location_input puede ser solo uno de los parámetros siguientes:
location_query

string

Ubicación en formato de cadena "lat,lng". Por ejemplo, “64.7611872,-18.4705364”.
location

LatLng

Es la ubicación en formato estructurado.

GeocodeLocationResponse

Mensaje de respuesta para GeocodeService.GeocodeLocation.

Campos
results[]

GeocodeResult

Es el resultado de la geocodificación.
plus_code

PlusCode

Es el código plus de la ubicación en la solicitud.

GeocodePlaceRequest

Es el mensaje de solicitud para GeocodeService.GeocodePlace.

Campos
place

string

Obligatorio. Es el identificador de lugar para geocodificar en el formato places/{place}.
language_code

string

Opcional. Idioma en el que se deben mostrar los resultados.
region_code

string

Opcional. Es el código de región. Es el código de región, especificado como un valor de dos caracteres del ccTLD ("dominio de nivel superior"). El parámetro afecta los resultados según la legislación aplicable.

GeocodeResult

Un resultado de geocodificación contiene información geográfica sobre un lugar.

Campos
place

string

Es el identificador de lugar completamente calificado para este resultado. Tiene el formato "//places.googleapis.com/places/{placeID}". Consulta https://developers.google.com/maps/documentation/places/web-service/place-id para obtener más detalles.
place_id

string

Es el ID de lugar de este resultado.
location

LatLng

Es la LatLng de esta dirección.
granularity

GeocodeResult.Granularity

Es el nivel de detalle de la ubicación.
viewport

Viewport

Es un viewport adecuado para mostrar el resultado del geocódigo.
bounds

Viewport

Es un cuadro de límite para la dirección.
formatted_address

string

Es la dirección con formato de una sola línea.
postal_address

PostalAddress

Es la dirección en formato de dirección postal.
address_components[]

GeocodeResult.AddressComponent

Son componentes repetidos para cada nivel de localidad.
postal_code_localities[]

LocalizedText

Es la lista completa de las localidades incluidas en el código postal.

Este campo solo se propaga cuando el resultado es del tipo "postal_code".
types[]

string

Es un conjunto de etiquetas de tipo para este resultado. Por ejemplo, "political" y "administrative_area".

Para obtener la lista completa de valores posibles, consulta la Tabla A y la Tabla B en https://developers.google.com/maps/documentation/places/web-service/place-types.
plus_code

PlusCode

Es el Plus Code de la ubicación en esta geocodificación.

AddressComponent

Son los componentes estructurados que forman la dirección con formato, si esta información está disponible.

Campos
long_text

string

Es la descripción textual completa o el nombre del componente de la dirección. Por ejemplo, un componente de dirección para el país Australia puede tener un nombre largo de "Australia".
short_text

string

Es un nombre textual abreviado para el componente de la dirección, si está disponible. Por ejemplo, un componente de dirección para el país de Australia puede tener el nombre corto "AU".
types[]

string

Es un array que indica los tipos de componente de dirección.

Consulta https://developers.google.com/maps/documentation/geocoding/requests-geocoding#Types para obtener más detalles.
language_code

string

Es el idioma que se usa para dar formato a estos componentes, en notación de CLDR.

Nivel de detalle

Es el nivel de detalle de la ubicación.

Enums
GRANULARITY_UNSPECIFIED No lo utilices.
ROOFTOP Es la ubicación no interpolada de una parcela de tierra real que corresponde a la dirección coincidente.
RANGE_INTERPOLATED Se interpola a partir de un rango de números de calles. Por ejemplo, si sabemos que un tramo de Amphitheatre Pkwy contiene los números del 1600 al 1699, el 1650 podría colocarse a mitad de camino entre sus extremos.
GEOMETRIC_CENTER Es el centro geométrico de un componente para el que tenemos datos poligonales.
APPROXIMATE Todo lo demás.

Punto de referencia

Los puntos de referencia se usan para comunicar dónde está el destino o ayudar a llegar a él.

Campos
relational_description

LocalizedText

Es una descripción legible de cómo el destino se relaciona con el punto de referencia. Por ejemplo, "Cerca del Empire State Building" o "Frente a la Casa Blanca".
tags[]

Landmark.Tag

Son etiquetas que describen cómo se puede usar el punto de referencia en el contexto del destino.
straight_line_distance_meters

double

Solo salida. Es la distancia en línea recta desde este punto de referencia hasta el destino, en metros.
travel_distance_meters

double

Solo salida. Es la distancia de la red vial desde este punto de referencia hasta el destino en metros.
Campo de unión landmark. Es el punto de referencia. landmark puede ser solo uno de los parámetros siguientes:
place

PlaceView

Es el lugar que representa este punto de referencia.

Etiqueta

Es la lista de todas las etiquetas posibles que describen cómo se puede usar un punto de referencia en el contexto de un destino.

Si una dirección tiene las etiquetas ADDRESS y ARRIVAL, significa que el punto de referencia es destacado a nivel local y está cerca del destino.

Enums
TAG_UNSPECIFIED No se usa.
ADDRESS Es un lugar destacado a nivel local que se puede usar para identificar la ubicación general del destino. Por lo general, a unos cientos de metros del destino. Son similares a los puntos de referencia que devuelve la función Address Descriptors de la API de Geocoding: https://developers.google.com/maps/documentation/geocoding/address-descriptors/requests-address-descriptors.
ARRIVAL Es un lugar que se puede usar para ayudar a llegar al destino. Es útil para la navegación cuando estás cerca del destino. Por ejemplo, este punto de referencia podría ser un lugar que se encuentra frente al destino. Por lo general, un punto de referencia con esta etiqueta está más cerca del destino que los puntos de referencia con la etiqueta ADDRESS.

Un punto de navegación es una ubicación junto a una ruta donde puede finalizar la navegación.

Campos
navigation_point_token

string

Solo salida. Es un token que se puede usar para identificar este punto de navegación.
display_name

LocalizedText

Es el nombre visible de este punto de navegación. Por ejemplo, "5ª Ave." o "Puerta B".
location

LatLng

Es un punto junto al tramo de ruta en el que debería finalizar la navegación. El punto se desplaza intencionalmente un poco del centro de la ruta para marcar claramente el lado de la ruta en el que se encuentra el lugar.
travel_modes[]

NavigationPoint.TravelMode

Son los modos de viaje adecuados para este punto de navegación.
usages[]

NavigationPoint.Usage

Son los usos que admite este punto de navegación.

TravelMode

Son los modos de viaje adecuados para este punto de navegación.

Enums
TRAVEL_MODE_UNSPECIFIED No se usa.
DRIVE Apto para conducir
WALK Apto para caminar

Uso

Son los usos que admite este punto de navegación.

Enums
USAGE_UNSPECIFIED No se usa.
UNKNOWN Tipo de uso desconocido. La mayoría de los puntos de navegación serán UNKNOWN, y esto no significa necesariamente que su uso esté restringido de alguna manera. Es posible que esta navegación siga siendo adecuada para la recogida o la entrega.
DROPOFF Es apto para dejar a un pasajero. Por ejemplo, la ubicación de destino de un viaje compartido.
PICKUP Es adecuado para recoger a un pasajero. Por ejemplo, la ubicación de partida de un viaje compartido.

PlaceView

Representa una vista de un lugar en la API de Places. También proporciona información adicional específica para los destinos, como el tipo de estructura y el polígono de visualización.

En algunos casos, un PlaceView con el mismo ID de lugar puede diferir de lo que devuelve la API de Places para los campos types y display_name.

Campos
place

string

Nombre del recurso de este lugar, en formato places/{placeId}.
display_name

LocalizedText

Es una descripción del lugar legible por humanos. Por ejemplo, “Puerta B”, “McDonalds”
primary_type

string

Es el tipo de lugar principal de este lugar. Consulta https://developers.google.com/maps/documentation/places/web-service/place-types para ver la lista de valores posibles.

Nota: Este campo no siempre se propaga. Prepárate para usar el campo types en esas situaciones.
types[]

string

Son todos los tipos de lugares asociados a este lugar. Consulta https://developers.google.com/maps/documentation/places/web-service/place-types para ver la lista de valores posibles.
formatted_address

string

Dirección de una sola línea.
postal_address

PostalAddress

Dirección estructurada.
structure_type

PlaceView.StructureType

Es el tipo de estructura que corresponde a este lugar.
location

LatLng

Es la ubicación de este lugar. En el caso de los lugares con polígonos de visualización, esto puede representar un buen lugar para colocar un marcador en el mapa.
display_polygon

Struct

Es el contorno poligonal del lugar en formato GeoJSON, con el formato RFC 7946: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6.

Nota: El formato RFC 7946 admite MultiPolygons, por lo que un objeto display_polygon puede representar varios polígonos.

StructureType

Es el tipo de estructura que representa este lugar.

Enums
STRUCTURE_TYPE_UNSPECIFIED No se usa.
POINT Es una ubicación de punto.
SECTION Es una subsección de un edificio.
BUILDING Un edificio.
GROUNDS Es un área grande que suele contener varios edificios, como un campus universitario, un complejo de departamentos o un centro comercial.

PlusCode

El Plus Code (http://plus.codes) es una referencia de ubicación con dos formatos: código global que define un rectángulo de 14 m x 14 m (1/8,000 de un grado) o más pequeño, y código compuesto, que reemplaza el prefijo por una ubicación de referencia.

Campos
global_code

string

Es el código global (completo) del lugar, como "9FWM33GV+HQ", que representa un área de 1/8,000 por 1/8,000 de grado (aproximadamente 14 por 14 metros).
compound_code

string

Es el código compuesto del lugar, como "33GV+HQ, Ramberg, Norway", que contiene el sufijo del código global y reemplaza el prefijo por el nombre con formato de una entidad de referencia.

SearchDestinationsRequest

Es el mensaje de solicitud para DestinationService.SearchDestinations.

Campos
travel_modes[]

NavigationPoint.TravelMode

Opcional. Son los medios de transporte para los que se filtrarán los puntos de navegación. Esto influye en el campo navigation_points que se devuelve en la respuesta. Si está vacío, se pueden devolver los puntos de navegación de todos los medios de transporte.
language_code

string

Opcional. Idioma en el que se deben mostrar los resultados.
region_code

string

Opcional. Es el código de región. Es el código de región, especificado como un valor de dos caracteres del ccTLD ("dominio de nivel superior"). El parámetro afecta los resultados según la legislación aplicable. Este parámetro también influye en los resultados del servicio, pero no los restringe por completo.

Campo de unión primary_query. Consulta para el destino principal. Puede ser un lugar, una dirección completamente especificada o una ubicación de LatLng. Algunos lugares y direcciones con información mínima no se podrán convertir en destinos.

Los destinos se basan en la búsqueda principal especificada.

Nota: Solo se admiten los lugares y las direcciones que pueden tener un destino de navegación. Por ejemplo, un lugar que representa una casa o un complejo de apartamentos se puede usar como la búsqueda principal, pero los lugares que representan una localidad o un área administrativa no se pueden usar como la búsqueda principal. primary_query puede ser una de las siguientes opciones:
place

string

Es el nombre del recurso de un lugar, en formato places/{place_id}.
address_query

SearchDestinationsRequest.AddressQuery

Una dirección.
location_query

SearchDestinationsRequest.LocationQuery

Una ubicación precisa

AddressQuery

Es la dirección de la calle que deseas buscar. Especifica una dirección conforme al formato usado por el servicio postal nacional del país en cuestión.

Campos
Campo de unión kind. Es la consulta de dirección. kind puede ser solo uno de los parámetros siguientes:
address

PostalAddress

Una dirección en formato de dirección postal.
address_query

string

Es una dirección con formato de una sola línea.

LocationQuery

Es una búsqueda de ubicación para identificar un destino principal cercano.

Nota: Si la búsqueda de ubicación se realiza dentro de un edificio que contiene subinstalaciones, es posible que el lugar principal devuelto sea una subinstalación. En estos casos, el campo containing_places incluirá el edificio.

Campos
place_filter

SearchDestinationsRequest.LocationQuery.PlaceFilter

Opcional. Son los filtros que se aplicarán a los candidatos de destino.
Campo de unión kind. Es la búsqueda de ubicación. kind puede ser solo uno de los parámetros siguientes:
location

LatLng

Es una ubicación de LatLng precisa.

PlaceFilter

Son los filtros que se aplicarán a los candidatos de destino.

Campos
structure_type

PlaceView.StructureType

Opcional. Si se especifica, se garantiza que todos los destinos tienen un lugar principal con este tipo de estructura. Esto puede provocar que se filtren algunos destinos o que se mejoren o refinen los destinos devueltos.

Por ejemplo, si se especifica GROUNDS, todos los destinos devueltos tendrán un lugar principal con el tipo de estructura GROUNDS. Esto puede provocar que se filtren algunos destinos que no forman parte de un motivo o que se simplifiquen los destinos devueltos al nivel de los motivos.

Otro uso de este campo es extraer con mayor facilidad los polígonos de visualización de edificios. Por ejemplo, si se especifica BUILDING, el polígono de visualización del lugar principal será el del edificio en la ubicación especificada.
addressability

SearchDestinationsRequest.LocationQuery.PlaceFilter.Addressability

Opcional. Si se especifica, solo se muestran los destinos que cumplen con los criterios de segmentación correspondientes.

Capacidad de segmentación

Define opciones para el filtrado de segmentación. Es posible que se agreguen valores nuevos en el futuro.

Enums
ADDRESSABILITY_UNSPECIFIED Cuando no se especifica, el servicio elegirá un valor predeterminado adecuado.
ANY La segmentación no es un criterio de filtrado. Los destinos se muestran independientemente de su capacidad de direccionamiento.
PRIMARY Todos los destinos que se devuelvan tendrán un lugar principal con una dirección o un nombre a nivel de la calle.
WEAK Todos los destinos que se devuelvan tendrán un lugar principal o un subdestino con una dirección o un nombre a nivel de la calle.

SearchDestinationsResponse

Es el mensaje de respuesta para DestinationService.SearchDestinations.

Campos
destinations[]

Destination

Es una lista de destinos.

El servicio devuelve un resultado si se puede identificar de forma inequívoca un destino principal a partir de la búsqueda principal. De lo contrario, el servicio podría devolver varios resultados para la desambiguación o ningún resultado.