- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- RouteMatrixOrigin
- RouteMatrixDestination
- ExtraComputation
- RouteMatrixElementCondition
- LocalizedValues
Recebe uma lista de origens e destinos e retorna um fluxo contendo informações de trajeto para cada combinação de origem e destino.
OBSERVAÇÃO: esse método exige que você especifique uma máscara de campo de resposta na entrada. É possível fornecer a máscara de campo de resposta usando o parâmetro de URL $fields
ou fields
ou o cabeçalho HTTP/gRPC X-Goog-FieldMask
. Consulte parâmetros e cabeçalhos de URL disponíveis. O valor é uma lista separada por vírgulas de caminhos de campo. Consulte esta documentação detalhada sobre como construir os caminhos do campo.
Por exemplo, neste método:
- Máscara de campo de todos os campos disponíveis (para inspeção manual):
X-Goog-FieldMask: *
- Máscara de campo de durações, distâncias, status do elemento, condição e índices de elementos (exemplo de configuração de produção):
X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration
É fundamental que você inclua status
na máscara de campo, caso contrário, todas as mensagens parecerão estar corretas. O Google não recomenda o uso da máscara de campo de resposta de caractere curinga (*
), porque:
- Selecionar apenas os campos necessários ajuda o servidor a economizar ciclos de computação, permitindo retornar o resultado com uma latência menor.
- A seleção apenas dos campos necessários no job de produção garante um desempenho de latência estável. Podemos adicionar mais campos de resposta no futuro, e esses novos campos podem exigir mais tempo de computação. Se você selecionar todos os campos ou todos no nível superior, poderá observar uma queda no desempenho, porque todos os novos campos adicionados serão incluídos automaticamente na resposta.
- A seleção apenas dos campos necessários resulta em um tamanho de resposta menor e, portanto, em maior capacidade de rede.
Solicitação HTTP
POST https://routes.googleapis.com/distanceMatrix/v2:computeRouteMatrix
O URL usa a sintaxe de transcodificação gRPC.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "origins": [ { object ( |
Campos | |
---|---|
origins[] |
Obrigatório. Matriz de origens, que determina as linhas da matriz de resposta. Várias restrições de tamanho se aplicam à cardinalidade das origens e destinos:
|
destinations[] |
Obrigatório. Matriz de destinos, que determina as colunas da matriz de resposta. |
travelMode |
Opcional. Especifica o meio de transporte. |
routingPreference |
Opcional. Especifica como calcular a rota. O servidor tenta usar a preferência de roteamento selecionada para calcular a rota. Se a preferência de roteamento resultar em um erro ou em uma latência extra longa, será retornado um erro. Só é possível especificar essa opção quando |
departureTime |
Opcional. O horário de partida. Se você não definir esse valor, o padrão será a hora em que você fez a solicitação. OBSERVAÇÃO: só será possível especificar um Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
arrivalTime |
Opcional. O horário de chegada. OBSERVAÇÃO: só pode ser definido quando Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
languageCode |
Opcional. O código de idioma BCP-47, como "en-US" ou "sr-Latn". Para saber mais, consulte Identificador de localidade Unicode. Para acessar a lista de idiomas compatíveis, consulte Suporte a idiomas. Quando esse valor não é informado, o idioma de exibição é inferido a partir do local da primeira origem. |
regionCode |
Opcional. O código regional, especificado como um valor ccTLD ("domínio de nível superior") de dois caracteres. Para mais informações, consulte Domínios de nível superior com código de país. |
units |
Opcional. Especifica as unidades de medida para os campos de exibição. |
extraComputations[] |
Opcional. Uma lista de cálculos extras que podem ser usados para concluir a solicitação. Observação: esses cálculos extras podem retornar campos extras na resposta. Esses campos extras também precisam ser especificados na máscara de campo a ser retornada na resposta. |
trafficModel |
Opcional. Especifica as premissas a serem usadas no cálculo do tempo no trânsito. Essa configuração afeta o valor retornado no campo de duração da |
transitPreferences |
Opcional. Especifica as preferências que influenciam o trajeto retornado para |
Corpo da resposta
Contém informações de rota calculadas para um par origem/destino na API v2.computeRouteMatrix. É possível fazer streaming desse proto para o cliente.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{ "status": { object ( |
Campos | |
---|---|
status |
Código de status de erro desse elemento. |
condition |
Indica se o trajeto foi encontrado ou não. Independente do status. |
distanceMeters |
A distância de viagem do trajeto, em metros. |
duration |
O tempo necessário para navegar no trajeto. Se você definir Uma duração em segundos com até nove dígitos fracionários, terminando em " |
staticDuration |
A duração do percurso no trajeto sem considerar as condições de trânsito. Uma duração em segundos com até nove dígitos fracionários, terminando em " |
travelAdvisory |
Outras informações sobre o trajeto. Por exemplo: informações sobre restrições e pedágios |
fallbackInfo |
Em alguns casos, quando o servidor não consegue computar a rota com as preferências determinadas para esse par de origem/destino específico, ele pode voltar a usar um modo de cálculo diferente. Quando o modo substituto é usado, esse campo contém informações detalhadas sobre a resposta de fallback. Caso contrário, o campo não será definido. |
localizedValues |
Representações de texto das propriedades do |
originIndex |
Índice baseado em zero da origem na solicitação. |
destinationIndex |
Índice baseado em zero do destino na solicitação. |
RouteMatrixOrigin
Uma única origem para ComputeRouteMatrixRequest
Representação JSON |
---|
{ "waypoint": { object ( |
Campos | |
---|---|
waypoint |
Obrigatório. Ponto de referência de origem |
routeModifiers |
Opcional. Modificadores para cada trajeto que considera isso a origem |
RouteMatrixDestination
Um único destino para ComputeRouteMatrixRequest
Representação JSON |
---|
{
"waypoint": {
object ( |
Campos | |
---|---|
waypoint |
Obrigatório. Ponto de referência de destino |
ExtraComputation
Computações extras a serem realizadas ao concluir a solicitação.
Enums | |
---|---|
EXTRA_COMPUTATION_UNSPECIFIED |
Não utilizado. As solicitações que contiverem esse valor vão falhar. |
TOLLS |
Informações de pedágio para os elementos da matriz. |
RouteMatrixElementCondition
A condição do trajeto retornado.
Enums | |
---|---|
ROUTE_MATRIX_ELEMENT_CONDITION_UNSPECIFIED |
Usado apenas quando o status do elemento não está OK. |
ROUTE_EXISTS |
Um trajeto foi encontrado, e as informações correspondentes foram preenchidas para o elemento. |
ROUTE_NOT_FOUND |
Nenhum trajeto foi encontrado. Os campos que contêm informações do trajeto, como distanceMeters ou duration , não serão preenchidos no elemento. |
LocalizedValues
Representações de texto de determinadas propriedades.
Representação JSON |
---|
{ "distance": { object ( |
Campos | |
---|---|
distance |
Distância do percurso representada em formato de texto. |
duration |
Duração representada em formato de texto considerando as condições de trânsito. Observação: se as informações de tráfego não tiverem sido solicitadas, esse valor será igual a StaticDuration. |
staticDuration |
Duração representada em formato de texto sem considerar as condições de trânsito. |
transitFare |
Tarifa de transporte público representada em formato de texto. |