Package google.maps.roads.selection.v1

Índice

RoadsSelection

Definição de serviço da API Roads Selection.

BatchCreateSelectedRoutes

rpc BatchCreateSelectedRoutes(BatchCreateSelectedRoutesRequest) returns (BatchCreateSelectedRoutesResponse)

Cria vários recursos SelectedRoute e inicia uma programação para recuperar periodicamente as informações de cache de cada uma das rotas.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • roads.selectedRoutes.batchCreate

Para mais informações, consulte a documentação do IAM.

BatchDeleteSelectedRoutes

rpc BatchDeleteSelectedRoutes(BatchDeleteSelectedRoutesRequest) returns (Empty)

Exclui vários recursos SelectedRoute do projeto especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • roads.selectedRoutes.batchDelete

Para mais informações, consulte a documentação do IAM.

BatchUpdateSelectedRoutes

rpc BatchUpdateSelectedRoutes(BatchUpdateSelectedRoutesRequest) returns (BatchUpdateSelectedRoutesResponse)

Atualiza vários recursos SelectedRoute conforme especificado pelos nomes deles.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • roads.selectedRoutes.batchUpdate

Para mais informações, consulte a documentação do IAM.

CreateSelectedRoute

rpc CreateSelectedRoute(CreateSelectedRouteRequest) returns (SelectedRoute)

Cria um SelectedRoute e inicia uma programação para recuperar periodicamente as informações de cache da rota.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • roads.selectedRoutes.create

Para mais informações, consulte a documentação do IAM.

DeleteSelectedRoute

rpc DeleteSelectedRoute(DeleteSelectedRouteRequest) returns (Empty)

Exclui o SelectedRoute especificado para o projeto especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • roads.selectedRoutes.delete

Para mais informações, consulte a documentação do IAM.

GetSelectedRoute

rpc GetSelectedRoute(GetSelectedRouteRequest) returns (SelectedRoute)

Recebe um SelectedRoute conforme especificado pelo nome.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • roads.selectedRoutes.get

Para mais informações, consulte a documentação do IAM.

ListSelectedRoutes

rpc ListSelectedRoutes(ListSelectedRoutesRequest) returns (ListSelectedRoutesResponse)

Lista todos os recursos SelectedRoute do projeto especificado com paginação.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • roads.selectedRoutes.list

Para mais informações, consulte a documentação do IAM.

UpdateSelectedRoute

rpc UpdateSelectedRoute(UpdateSelectedRouteRequest) returns (SelectedRoute)

Atualiza uma SelectedRoute conforme especificado pelo nome.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • roads.selectedRoutes.update

Para mais informações, consulte a documentação do IAM.

BatchCreateSelectedRoutesRequest

Solicitação para criar vários SelectedRoutes.

Campos
parent

string

Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas no lote. Ele é obrigatório porque a solicitação em lote só aceita um único parent. Formato: projects/{project}

requests[]

CreateSelectedRouteRequest

Obrigatório. A mensagem de solicitação que especifica a rota selecionada a ser criada. É possível criar no máximo 1.000 rotas selecionadas em um lote. O recurso pai de cada solicitação precisa estar vazio ou corresponder ao parent de nível superior.

BatchCreateSelectedRoutesResponse

Resposta da criação de vários SelectedRoutes.

Campos
selected_routes[]

SelectedRoute

Recursos de SelectedRoute criados.

BatchDeleteSelectedRoutesRequest

Solicitação para excluir vários SelectedRoutes.

Campos
parent

string

Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas para exclusão. Ele é obrigatório porque a solicitação em lote só aceita um único parent. Formato: projects/{project}

names[]

string

Obrigatório. Os nomes das rotas selecionadas para exclusão. É possível excluir até 1.000 rotas selecionadas em um lote. Formato: projects/{project}/selectedRoutes/{selected_route}

BatchUpdateSelectedRoutesRequest

Solicitação para atualizar vários SelectedRoutes.

Campos
parent

string

Obrigatório. O recurso do projeto compartilhado por todas as rotas selecionadas no lote. Ele é obrigatório porque a solicitação em lote só aceita um único parent. Formato: projects/{project}

requests[]

UpdateSelectedRouteRequest

Obrigatório. A mensagem de solicitação que especifica a rota selecionada para atualização. É possível atualizar até 1.000 rotas selecionadas em um lote. O recurso pai de cada solicitação precisa estar vazio ou corresponder ao parent de nível superior.

update_mask

FieldMask

Opcional. A lista de campos a serem atualizados compartilhados por todas as solicitações filhas no lote.

Os caminhos de campo são relativos a SelectedRoute. Atualize apenas display_name, route_attributes, dynamic_routing e dynamic_route (incluindo origin, destination e intermediates).

Exemplo: "display_name,route_attributes,dynamic_routing,dynamic_route".

Se definido, esse update_mask se aplica a todas as solicitações filhas que não especificam o próprio update_mask. Se * for especificado, todos os campos atualizáveis serão substituídos. Se os campos update_mask no nível do lote e da solicitação filha estiverem definidos, eles precisarão ser iguais.

Se omitido, o update_mask da solicitação filha vai entrar em vigor. Se o update_mask de uma solicitação filha também for omitido, todos os campos atualizáveis preenchidos no selected_route da solicitação filha serão atualizados.

BatchUpdateSelectedRoutesResponse

Resposta da atualização de vários SelectedRoutes.

Campos
selected_routes[]

SelectedRoute

SelectedRoute recurso foi atualizado.

CreateSelectedRouteRequest

Solicitação para criar um SelectedRoute.

Campos
parent

string

Obrigatório. O projeto em que o SelectedRoute será criado. Formato: projects/{project}

selected_route

SelectedRoute

Obrigatório. O SelectedRoute a ser criado.

selected_route_id

string

Opcional. O ID a ser usado para o SelectedRoute, que se tornará o componente final do nome do recurso do SelectedRoute.

Esse valor precisa ter de 4 a 63 caracteres, e os caracteres válidos são "a-z", "A-Z", "0-9", "-" ou "_". Se ele não for fornecido ou estiver vazio, um UUID será gerado após a criação do recurso.

DeleteSelectedRouteRequest

Solicitação para excluir um SelectedRoute.

Campos
name

string

Obrigatório. O nome da SelectedRoute a ser excluída. Formato: projects/{project}/selectedRoutes/{selected_route}

GetSelectedRouteRequest

Solicitação para receber um SelectedRoute.

Campos
name

string

Obrigatório. O nome do SelectedRoute a ser recuperado. Formato: projects/{project}/selectedRoutes/{selected_route}

ListSelectedRoutesRequest

Solicitação para listar SelectedRoutes.

Campos
parent

string

Obrigatório. O parent, que é o projeto em que todas as SelectedRoutes serão consultadas. Formato: projects/{project}/selectedRoutes

page_size

int32

Opcional. O número de resultados que devem ser retornados para uma determinada página. Se não for definido, o valor padrão será 100. Quando um valor de 0 é fornecido, o valor é definido como padrão. O valor máximo é 5.000. Qualquer valor acima disso é definido como 5.000.

page_token

string

Opcional. Um token de página recebido de uma chamada ListSelectedRoutes anterior.

ListSelectedRoutesResponse

Resposta que lista SelectedRoutes.

Campos
selected_routes[]

SelectedRoute

Uma página de recursos SelectedRoute armazenados no projeto especificado na solicitação.

next_page_token

string

Token que pode ser enviado como page_token para recuperar a próxima página. Se esse campo estiver vazio, não haverá páginas subsequentes.

SelectedRoute

Uma SelectedRoute representa uma rota específica em que um cliente quer recuperar periodicamente informações (por exemplo, duração) para casos de uso contratados.

Campos
name

string

Identificador. Nome do recurso do SelectedRoute.

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

display_name

string

Opcional. Nome de exibição da rota. Esse campo é opcional e pode ser usado pelo cliente. Ele não precisa ser único. O comprimento é limitado a 100 caracteres (contados em pontos de código Unicode).

create_time

Timestamp

Apenas saída. Hora em que o trajeto selecionado foi criado.

state

State

Apenas saída. O estado da rota selecionada.

route_attributes

map<string, string>

Opcional. Os atributos personalizados da rota selecionada. Ao adicionar esses dados, é possível filtrar ou agrupar os trajetos ao recuperar informações históricas e em tempo real. Até 25 atributos são aceitos por rota. Cada chave e valor precisa ser uma string não vazia e pode ter até 100 caracteres (contados em pontos de código Unicode). As chaves não podem começar com goog.

Campo de união route_type. Somente DynamicRoute é aceito. route_type pode ser apenas de um dos tipos a seguir:
dynamic_route

DynamicRoute

O SelectedRoute é uma rota dinâmica.

validation_error

ValidationError

Apenas saída. O erro de validação da rota selecionada quando o estado é STATE_INVALID.

dynamic_routing

bool

Opcional. Se definido como true, a rota selecionada poderá ser recalculada dinamicamente com base no trânsito em tempo real de acordo com os pontos de passagem de entrada. Se definido como false, o trajeto selecionado será fixo, independente do trânsito em tempo real, e seguirá o caminho calculado no momento da criação, sem considerar o trânsito. Se omitido, o valor será false por padrão, indicando que é uma rota fixa.

DynamicRoute

Representa um trajeto com waypoints (origem, destino e intermediários). O trajeto real vai passar por todos os waypoints. Se dynamic_routing for definido como false, o trajeto real vai permanecer fixo, independentemente das condições de trânsito. Caso contrário, se dynamic_routing for definido como true, o trajeto real poderá mudar com base nas condições de trânsito.

Campos
origin

LatLng

Obrigatório. Local de origem da rota.

destination

LatLng

Obrigatório. Local de término do trajeto.

intermediates[]

LatLng

Opcional. Um conjunto de waypoints intermediários ao longo do trajeto (exceto os pontos terminais). Eles são sempre pontos de passagem. Até 25 waypoints intermediários são aceitos. Adicionar essas informações corretamente pode reduzir a variação do trajeto real periodicamente.

Estado

O estado da rota selecionada.

Tipos enumerados
STATE_UNSPECIFIED O estado desta rota não está definido.
STATE_SCHEDULING A rota foi criada e está sendo programada.
STATE_RUNNING A rota foi criada e tem uma programação ativa.
STATE_DELETING A rota foi marcada para exclusão.
STATE_VALIDATING A rota está em processo de validação.
STATE_INVALID A rota é inválida com base em um dos critérios de validação.

ValidationError

O erro de validação da rota selecionada.

Tipos enumerados
VALIDATION_ERROR_UNSPECIFIED O erro de validação dessa rota não está definido.
VALIDATION_ERROR_ROUTE_OUTSIDE_JURISDICTION A rota está fora da jurisdição do projeto.
VALIDATION_ERROR_LOW_ROAD_USAGE O trajeto tem baixo uso da via (poucas pessoas passam por ele).

UpdateSelectedRouteRequest

Solicitação para atualizar um SelectedRoute.

Campos
selected_route

SelectedRoute

Obrigatório. O SelectedRoute a ser atualizado. O campo name da rota é usado para identificar a rota a ser atualizada. Formato: projects/{project}/selectedRoutes/{selected_route}

update_mask

FieldMask

Opcional. Lista de campos a serem atualizados.

Os caminhos de campo são relativos a SelectedRoute. Atualize apenas display_name, route_attributes, dynamic_routing e dynamic_route (incluindo origin, destination e intermediates).

Exemplo: "display_name,route_attributes,dynamic_routing,dynamic_route".

Se * for especificado, todos os campos atualizáveis serão substituídos.

Se update_mask for omitido, todos os campos atualizáveis preenchidos em selected_route serão atualizados.