Distance Matrix

Classe DistanceMatrixService

Classe google.maps.DistanceMatrixService

Um serviço para distâncias de computação entre várias origens e destinos.

Acesse chamando const {DistanceMatrixService} = await google.maps.importLibrary("routes"). Consulte Bibliotecas na API Maps JavaScript.
DistanceMatrixService
DistanceMatrixService()
Parâmetros:nenhum
Cria uma nova instância de um DistanceMatrixService que envia consultas de matriz de distância para os servidores do Google.
getDistanceMatrix
getDistanceMatrix(request[, callback])
Parâmetros:
Valor de retorno:Promise<DistanceMatrixResponse>
Emite uma solicitação de matriz de distância.

Interface DistanceMatrixRequest

Interface google.maps.DistanceMatrixRequest

Uma consulta de matriz de distância enviada pelo DistanceMatrixService que contém matrizes de locais de origem e destino e várias opções para calcular métricas.
destinations
Uma matriz que contém strings de endereço de destino, objetos LatLng ou Place para calcular a distância e o tempo. Obrigatório.
origins
Uma matriz que contém strings de endereço de origem, objetos LatLng ou Place para calcular a distância e o tempo. Obrigatório.
travelMode
Tipo de rota solicitada. Obrigatório.
avoidFerries optional
Tipo:boolean optional
Se true, instrui o serviço Distance Matrix a evitar balsas sempre que possível. Opcional.
avoidHighways optional
Tipo:boolean optional
Se true, instrui o serviço Distance Matrix a evitar rodovias sempre que possível. Opcional.
avoidTolls optional
Tipo:boolean optional
Se true, instrui o serviço Distance Matrix a evitar vias com pedágio sempre que possível. Opcional.
drivingOptions optional
Tipo:DrivingOptions optional
Configurações que se aplicam apenas a solicitações em que travelMode é DRIVING. Esse objeto não vai ter efeito em outros modos de transporte.
language optional
Tipo:string optional
Um identificador de idioma para o idioma em que os resultados precisam ser retornados, quando possível. Consulte a lista de idiomas compatíveis.
region optional
Tipo:string optional
Código de região utilizado como polarização para solicitações de geocodificação. O código regional aceita um valor de dois caracteres de ccTLD ("domínio de nível superior"). A maioria dos códigos ccTLD é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" (.co.uk), e o código ISO 3166-1 é "gb" (tecnicamente, para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte").
transitOptions optional
Tipo:TransitOptions optional
Configurações que se aplicam apenas a solicitações em que travelMode é TRANSIT. Esse objeto não vai ter efeito em outros modos de transporte.
unitSystem optional
Tipo:UnitSystem optional
Sistema de medidas escolhido para ser usado ao exibir a distância. Opcional. A opção padrão é métrica.

Interface DistanceMatrixResponse

Interface google.maps.DistanceMatrixResponse

A resposta a uma solicitação DistanceMatrixService, que consiste nos endereços de origem e destino formatados e em uma sequência de DistanceMatrixResponseRows, uma para cada endereço de origem correspondente.
destinationAddresses
Tipo:Array<string>
Os endereços de destino formatados.
originAddresses
Tipo:Array<string>
Os endereços de origem formatados.
rows
As linhas da matriz, que correspondem aos endereços de origem.

Interface DistanceMatrixResponseRow

Interface google.maps.DistanceMatrixResponseRow

Uma linha da resposta a uma solicitação DistanceMatrixService, que consiste em uma sequência de DistanceMatrixResponseElements, uma para cada endereço de destino correspondente.
elements
Os elementos da linha, que correspondem aos endereços de destino.

Interface DistanceMatrixResponseElement

Interface google.maps.DistanceMatrixResponseElement

Um único elemento de uma resposta a uma solicitação DistanceMatrixService, que contém a duração e a distância de uma origem até um destino.
distance
A distância deste par de origem-destino. Esta propriedade pode ser indefinida quando a distância não for conhecida.
duration
A duração deste par de origem-destino. Esta propriedade pode ser indefinida quando a duração não for conhecida.
duration_in_traffic
A duração desse par origem-destino, considerando as condições de trânsito indicadas pela propriedade trafficModel. Essa propriedade pode ser undefined, porque a duração pode ser desconhecida. Disponível apenas para clientes do plano Premium quando drivingOptions é definido ao fazer a solicitação.
fare
A tarifa total para essa combinação de origem e destino. Aplicável apenas a solicitações de transporte público.
status
O status deste par de origem-destino específico.

Constantes DistanceMatrixStatus

Constantes google.maps.DistanceMatrixStatus

O status de nível superior sobre a solicitação em geral retornado por DistanceMatrixService após a conclusão de uma solicitação de matriz de distância. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.DistanceMatrixStatus.OK.

Acesse chamando const {DistanceMatrixStatus} = await google.maps.importLibrary("routes"). Consulte Bibliotecas na API Maps JavaScript.
INVALID_REQUEST A solicitação fornecida era inválida.
MAX_DIMENSIONS_EXCEEDED A solicitação contém mais de 25 origens ou mais de 25 destinos.
MAX_ELEMENTS_EXCEEDED O produto de origens e destinos excede o limite por consulta.
OK A resposta contém um resultado válido.
OVER_QUERY_LIMIT Um número excessivo de elementos foi solicitado dentro do prazo permitido. Se você tentar novamente, a solicitação poderá ser bem-sucedida.
REQUEST_DENIED O serviço negou o uso do serviço Google Distance Matrix pela sua página da web.
UNKNOWN_ERROR Não foi possível processar uma solicitação de matriz de distância devido a um erro no servidor. Se você tentar novamente, a solicitação poderá dar certo.

Constantes DistanceMatrixElementStatus

Constantes google.maps.DistanceMatrixElementStatus

O status no nível do elemento sobre um par de origem e destino específico retornado por DistanceMatrixService após a conclusão de uma solicitação de matriz de distância. Esses valores são especificados como strings, por exemplo, 'OK'.

Acesse chamando const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes"). Consulte Bibliotecas na API Maps JavaScript.
NOT_FOUND A origem e/ou o destino do par não puderam ser geocodificados.
OK A resposta contém um resultado válido.
ZERO_RESULTS Nenhum trajeto foi encontrado entre a origem e o destino.