Route Matrix

Classe RouteMatrix

classe google.maps.routes.RouteMatrix
biblioteca "routes"

Uma matriz de rotas calculada para um conjunto de pares de origem/destino por RouteMatrix.computeRouteMatrix

const {RouteMatrix} = await google.maps.importLibrary("routes");
computeRouteMatrix
computeRouteMatrix(request)
Parâmetros:
Valor de retorno: Promise<{matrix:RouteMatrix}>
Usa uma lista de origens e destinos e retorna uma matriz com informações de rota 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 solicitação definindo a propriedade ComputeRouteMatrixRequest.fields. O valor é uma lista de caminhos de campo.

Por exemplo:
  • Máscara de todos os campos disponíveis: fields: ['*']
  • Máscara de campo de duração e distância no nível do trajeto: fields: ['durationMillis', 'distanceMeters']

O uso da máscara de campo de resposta curinga fields: ['*'] não é recomendado porque:
  • Selecionar apenas os campos necessários ajuda nosso servidor a economizar ciclos de computação, o que nos permite retornar o resultado com uma latência menor.
  • Selecionar apenas os campos necessários no job de produção garante uma 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 os campos no nível superior, poderá haver uma degradação do desempenho, porque qualquer novo campo que adicionarmos será incluído automaticamente na resposta.
  • Selecionar apenas os campos necessários resulta em uma resposta menor e, portanto, em um carregamento mais rápido na rede.
rows
somente leitura
As linhas da matriz. Cada linha corresponde a uma origem e contém uma matriz de RouteMatrixItems, cada uma representando um trajeto até um destino.
Herdado: toJSON

Classe RouteMatrixRow

classe google.maps.routes.RouteMatrixRow
biblioteca "routes"

Corresponde a uma origem transmitida para RouteMatrix.computeRouteMatrix. Contém uma lista de RouteMatrixItems, em que cada item representa um trajeto até um destino.

const {RouteMatrixRow} = await google.maps.importLibrary("routes");
items
somente leitura
As informações de rota para cada destino.
Herdado: toJSON

Classe RouteMatrixItem

classe google.maps.routes.RouteMatrixItem
biblioteca "routes"

Contém informações de trajeto calculadas para um par de origem/destino transmitido para RouteMatrix.computeRouteMatrix.

const {RouteMatrixItem} = await google.maps.importLibrary("routes");
condition
somente leitura
Indica se o trajeto foi encontrado ou não.
distanceMeters
somente leitura
Tipo: number optional
A distância do trajeto em metros.
durationMillis
somente leitura
Tipo: number optional
O tempo necessário para percorrer o trajeto em milissegundos. Se você definir ComputeRouteMatrixRequest.routingPreference como TRAFFIC_UNAWARE, esse valor será o mesmo que RouteMatrixItem.staticDurationMillis. Se você definir ComputeRouteMatrixRequest.routingPreference como TRAFFIC_AWARE ou TRAFFIC_AWARE_OPTIMAL, esse valor será calculado considerando as condições de trânsito.

Observação: se a duração exceder 2^53 milissegundos, esse valor será Number.POSITIVE_INFINITY.
error
somente leitura
Tipo: RouteMatrixItemError optional
Erro que ocorreu durante o cálculo do trajeto.
fallbackInfo
somente leitura
Tipo: FallbackInfo optional
Em alguns casos, quando o servidor não consegue calcular o trajeto com as preferências fornecidas para esse par de origem/destino específico, ele pode usar um modo de cálculo diferente. Quando um substituto é usado, esse campo contém informações detalhadas sobre a resposta substituta. Caso contrário, esse campo não será definido.
localizedValues
somente leitura
Representações de texto das propriedades do RouteMatrixItem.
staticDurationMillis
somente leitura
Tipo: number optional
A duração do trajeto sem considerar as condições de trânsito.

Observação: se a duração exceder 2^53 milissegundos, esse valor será Number.POSITIVE_INFINITY.
travelAdvisory
somente leitura
Tipo: RouteTravelAdvisory optional
Informações adicionais sobre o trajeto.

Interface ComputeRouteMatrixRequest

interface google.maps.routes.ComputeRouteMatrixRequest

Solicitação de uma matriz de rotas.
destinations
Matriz de destinos, que determina as colunas da matriz de resposta. Um valor transmitido como uma string pode ser um endereço, um Plus Code ou um nome de recurso de lugar. Os valores de altitude não são considerados.
fields
Tipo: Iterable<string>
Coleção de campos a serem buscados. Especifique ["*"] para todos os campos.
origins
Matriz de origens, que determina as linhas da matriz de resposta. Um valor transmitido como uma string pode ser um endereço, um Plus Code ou um nome de recurso de lugar. Os valores de altitude não são considerados.

Várias restrições de tamanho se aplicam à cardinalidade de origens e destinos:
  • O número total de origens e destinos especificados como strings ou Places não pode ser maior que 50.
  • O produto do número de origens e do número de destinos não pode ser maior que 625.
  • O produto do número de origens e destinos não pode ser maior que 100 se ComputeRouteMatrixRequest.routingPreference estiver definido como TRAFFIC_AWARE_OPTIMAL.
  • O produto do número de origens e destinos não pode ser maior que 100 se ComputeRouteMatrixRequest.travelMode estiver definido como TRANSIT.
arrivalTime
opcional
Tipo: Date optional
O horário de chegada.

Observação: só pode ser definido quando ComputeRouteMatrixRequest.travelMode está definido como TRANSIT. É possível especificar ComputeRouteMatrixRequest.departureTime ou ComputeRouteMatrixRequest.arrivalTime, mas não ambos. As viagens de transporte público ficam disponíveis por até 7 dias no passado ou 100 dias no futuro.
departureTime
opcional
Tipo: Date optional
O horário de partida. Se você não definir esse valor, o padrão será o horário em que você fez a solicitação.

Observação: só é possível especificar um horário no passado quando ComputeRouteMatrixRequest.travelMode está definido como TRANSIT. As viagens de transporte público ficam disponíveis por até 7 dias no passado ou 100 dias no futuro.
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 adicionais na resposta. Esses campos extras também precisam ser especificados em ComputeRouteMatrixRequest.fields para serem retornados na resposta.
internalUsageAttributionIds
opcional
Tipo: Iterable<string> optional
Identificadores usados para atribuir chamadas a pacotes específicos ou bibliotecas de OSS.
language
opcional
Tipo: string optional
O código de idioma BCP-47, como "pt-BR" ou "en-US". Para saber mais, consulte Identificador de localidade Unicode. Consulte Suporte ao idioma para ver a lista de idiomas disponíveis. Quando você não fornece esse valor, o idioma é inferido das configurações de localização da API Google Maps JavaScript. Caso contrário, o idioma será inferido com base no local da primeira origem.
region
opcional
Tipo: string optional
O código regional, apresentado 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. Quando você não fornece esse valor, a região é inferida das configurações de localização da API Google Maps JavaScript. Caso contrário, a região será inferida do local da primeira origem.
routingPreference
opcional
Tipo: RoutingPreference optional
Especifica como calcular a matriz de rotas. O servidor tenta usar a preferência de roteamento selecionada para calcular a matriz de rotas. Se a preferência de roteamento resultar em um erro ou em uma latência muito longa, um erro será retornado. Só é possível especificar essa opção quando ComputeRouteMatrixRequest.travelMode é DRIVING ou TWO_WHEELER. Caso contrário, a solicitação falha.
trafficModel
opcional
Tipo: TrafficModel optional
Especifica as premissas que serão usadas no cálculo do tempo no trânsito. Essa configuração afeta o valor retornado em RouteMatrixItem.durationMillis, que contém o tempo previsto no trânsito com base nas médias históricas. ComputeRouteMatrixRequest.trafficModel só está disponível para solicitações que definiram ComputeRouteMatrixRequest.routingPreference como TRAFFIC_AWARE_OPTIMAL e ComputeRouteMatrixRequest.travelMode como DRIVING. O padrão é BEST_GUESS.
transitPreference
opcional
Tipo: TransitPreference optional
Especifica as preferências que influenciam o trajeto retornado para rotas TRANSIT.

Observação: só pode ser especificado quando ComputeRouteMatrixRequest.travelMode está definido como TRANSIT.
travelMode
opcional
Tipo: TravelMode optional
Especifica o meio de transporte.
units
opcional
Tipo: UnitSystem optional
Especifica as unidades de medida para os campos de exibição. Se você não fornecer esse valor, as unidades de exibição serão inferidas com base no local da primeira origem.

Constantes ComputeRouteMatrixExtraComputation

constantes google.maps.routes.ComputeRouteMatrixExtraComputation
biblioteca "routes"

Cálculos extras a serem realizados ao concluir a solicitação. Consulte a documentação do serviço da Web para mais informações.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo ComputeRouteMatrixExtraComputationString.

const {ComputeRouteMatrixExtraComputation} = await google.maps.importLibrary("routes");
TOLLS Informações de pedágio para os elementos da matriz. Consulte a documentação do serviço da Web para mais informações.

Constantes de RouteMatrixItemCondition

constantes google.maps.routes.RouteMatrixItemCondition
biblioteca "routes"

A condição do trajeto que está sendo retornado. Consulte a documentação do serviço da Web para mais informações.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo RouteMatrixItemConditionString.

const {RouteMatrixItemCondition} = await google.maps.importLibrary("routes");
ROUTE_EXISTS Uma rota foi encontrada, e as informações correspondentes foram preenchidas para o elemento. Consulte a documentação do serviço da Web para mais informações.
ROUTE_NOT_FOUND Nenhum trajeto foi encontrado. Consulte a documentação do serviço da Web para mais informações.

Classe RouteMatrixItemError

classe google.maps.routes.RouteMatrixItemError estende Error
biblioteca "routes"

Um erro que ocorreu durante RouteMatrix.computeRouteMatrix para um par de origem/destino específico.

const {RouteMatrixItemError} = await google.maps.importLibrary("routes");
Herdado: toJSON

Classe RouteMatrixItemLocalizedValues

classe google.maps.routes.RouteMatrixItemLocalizedValues
biblioteca "routes"

Representações de texto do RouteMatrixItem.

const {RouteMatrixItemLocalizedValues} = await google.maps.importLibrary("routes");
distance
somente leitura
Tipo: string optional
Distância do trajeto do item da matriz de rotas em formato de texto.
distanceLanguage
somente leitura
Tipo: string optional
O código de idioma BCP-47 do texto de distância, como "en-US" ou "sr-Latn".

Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
duration
somente leitura
Tipo: string optional
Duração, representada em formato de texto e localizada para a região da consulta. Considera as condições de trânsito.

Observação: se você não solicitou informações de trânsito, esse valor é o mesmo que RouteMatrixItemLocalizedValues.staticDuration.
durationLanguage
somente leitura
Tipo: string optional
O código de idioma BCP-47 do texto de duração, como "en-US" ou "sr-Latn".

Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
staticDuration
somente leitura
Tipo: string optional
Duração sem considerar as condições de trânsito, representada em formato de texto.
staticDurationLanguage
somente leitura
Tipo: string optional
O código de idioma BCP-47 do texto de duração estática, como "en-US" ou "sr-Latn".
transitFare
somente leitura
Tipo: string optional
Tarifa de transporte público, representada em formato de texto.
transitFareLanguage
somente leitura
Tipo: string optional
O código de idioma BCP-47 do texto da tarifa de transporte público, como "en-US" ou "sr-Latn".

Para mais informações, consulte http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.
Herdado: toJSON

Interface RouteMatrixOrigin

interface google.maps.routes.RouteMatrixOrigin

Uma única origem para um ComputeRouteMatrixRequest.
waypoint
O local da origem. Um valor transmitido como uma string pode ser um endereço ou um Plus Code. Os valores de altitude não são considerados.
routeModifiers
opcional
Tipo: RouteModifiers optional
Modificadores para cada trajeto que usa esse ponto como origem.