Package google.maps.roads.selection.v1

Índice

RoadsSelection

Es la definición del servicio de la API de Roads Selection.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Crea varios objetos SelectedRoute y comienza una programación para recuperar periódicamente la información de la caché de cada una de las rutas.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Crea un SelectedRoute y comienza una programación para recuperar periódicamente la información de la caché de la ruta.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Borra el SelectedRoute especificado para el proyecto especificado.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Obtiene un objeto SelectedRoute según lo especificado por su nombre.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Enumera todos los SelectedRoutes del proyecto especificado con paginación.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

BatchCreateSelectedRoutesRequest

Es la solicitud para crear varios SelectedRoutes.

Campos
parent

string

Opcional. Es el recurso del proyecto que comparten todas las rutas seleccionadas. Formato: projects/{project}. Si se configura este campo, el campo principal de los mensajes de CreateSelectedRouteRequest debe estar vacío o coincidir con este campo.
requests[]

CreateSelectedRouteRequest

Es obligatorio. Es el mensaje de solicitud que especifica la ruta seleccionada para crear. Se puede crear un máximo de 1,000 rutas seleccionadas en un lote.

BatchCreateSelectedRoutesResponse

Es la respuesta a la creación de varios objetos SelectedRoute.

Campos
selected_routes[]

SelectedRoute

Se creó SelectedRoutes.

CreateSelectedRouteRequest

Es la solicitud para crear un SelectedRoute.

Campos
parent

string

Es obligatorio. Es el proyecto en el que se creará el SelectedRoute. Formato: projects/{project}
selected_route

SelectedRoute

Es obligatorio. Es el objeto SelectedRoute que se creará.
selected_route_id

string

Opcional. Es el ID que se usará para el SelectedRoute, que se convertirá en el componente final del nombre del recurso del SelectedRoute.

Este valor debe tener entre 4 y 63 caracteres, y los caracteres válidos son: "a-z", "A-Z", "0-9" o "-". Si no se proporciona o está vacío, se generará un UUID después de la creación del recurso.

DeleteSelectedRouteRequest

Es la solicitud para borrar un SelectedRoute.

Campos
name

string

Es obligatorio. Es el nombre del SelectedRoute que se borrará. Formato: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Es la solicitud para obtener un SelectedRoute.

Campos
name

string

Es obligatorio. Nombre del SelectedRoute que se recuperará. Formato: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Solicitud para enumerar SelectedRoutes.

Campos
parent

string

Es obligatorio. Es el elemento superior, es decir, el proyecto desde el que se consultarán todos los SelectedRoute. Formato: projects/{project}/selectedRoutes
page_size

int32

Opcional. Es la cantidad de resultados que se deben devolver para una página determinada. Si no se establece, el valor predeterminado es 100. Cuando se proporciona un valor de 0, se establece el valor predeterminado. El valor máximo es 5,000, y cualquier valor superior se establecerá en 5,000.
page_token

string

Opcional. Un token de página, recibido desde una llamada ListSelectedRoutes anterior.

ListSelectedRoutesResponse

Es la respuesta que enumera los objetos SelectedRoute.

Campos
selected_routes[]

SelectedRoute

Es una página de SelectedRoutes almacenada en el proyecto especificado en la solicitud.
next_page_token

string

Es un token que se puede enviar como page_token para recuperar la página siguiente. Si este campo está vacío, no hay páginas siguientes.

SelectedRoute

Un objeto SelectedRoute representa una ruta específica para la que un cliente desea recuperar información periódicamente (p.ej., la duración) para los casos de uso contratados.

Campos
name

string

Identificador. Es el nombre del recurso SelectedRoute.

Formato: projects/{project}/selectedRoutes/{selected_route}
display_name

string

Opcional. Es el nombre visible de la ruta. Este es un campo opcional que puede usar el cliente. No es necesario que sea único.
create_time

Timestamp

Solo salida. Fecha y hora en que se creó la ruta seleccionada.
state

State

Solo salida. Es el estado de la ruta seleccionada.
route_attributes

map<string, string>

Opcional. Son los atributos personalizados de la ruta seleccionada. Agregar estos parámetros permite filtrar o agrupar las rutas cuando se recupera información histórica y en tiempo real sobre las rutas. Se admiten hasta 10 atributos por ruta. Cada clave y valor debe ser una cadena no vacía y puede tener hasta 100 caracteres. Las claves no deben comenzar con “goog”.
Campo de unión route_type. Actualmente, solo se admite DynamicRoute. route_type puede ser solo uno de los siguientes:
dynamic_route

DynamicRoute

SelectedRoute es una ruta dinámica.
validation_error

ValidationError

Solo salida. Es el error de validación de la ruta seleccionada cuando el estado es STATE_INVALID.

DynamicRoute

Representa una ruta con puntos de referencia (origen, destino e intermedios). Se garantiza que la ruta real pasará por todos los puntos de referencia, pero podría cambiar de vez en cuando debido a las diferentes condiciones de tráfico.

Campos
origin

LatLng

Es obligatorio. Es la ubicación de origen de la ruta.
destination

LatLng

Es obligatorio. Ubicación final de la ruta.
intermediates[]

LatLng

Opcional. Es un conjunto de puntos de referencia intermedios a lo largo de la ruta (sin incluir los puntos terminales). Siempre son puntos de paso. Se admiten hasta 25 puntos de referencia intermedios. Si los agregas correctamente, se puede reducir la variación de la ruta real con el tiempo.

Estado

Es el estado de la ruta seleccionada.

Enumeraciones
STATE_UNSPECIFIED No se estableció el estado de esta ruta.
STATE_SCHEDULING Se creó la ruta y se está programando.
STATE_RUNNING La ruta se creó y tiene una programación activa.
STATE_DELETING La ruta se marcó para su eliminación.
STATE_VALIDATING La ruta está en proceso de validación.
STATE_INVALID La ruta no es válida según uno de los criterios de validación.

ValidationError

Es el error de validación de la ruta seleccionada.

Enumeraciones
VALIDATION_ERROR_UNSPECIFIED No se estableció el error de validación de esta ruta.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION La ruta está fuera de la jurisdicción del proyecto.
VALIDATION_ERROR_LOW_ROAD_USAGE La ruta tiene un uso vial bajo (pocas personas la transitan).