Classe DistanceMatrixService
Classe google.maps.DistanceMatrixService
Um serviço para distâncias de computação entre várias origens e destinos.
Acesse ligando para const {DistanceMatrixService} = await google.maps.importLibrary("routes").
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
|---|---|
DistanceMatrixService | DistanceMatrixService()Parâmetros:nenhum Cria uma nova instância de um DistanceMatrixService que envia consultas de matriz de distância aos servidores do Google. |
Métodos | |
|---|---|
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, além de várias opções para calcular métricas.
Propriedades | |
|---|---|
destinations | Tipo: Array<string|LatLng|LatLngLiteral|Place>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 | Tipo: Array<string|LatLng|LatLngLiteral|Place>Uma matriz que contém strings de endereço de origem, objetos LatLng ou Place, usados como origem para calcular a distância e o tempo. Obrigatório. |
travelMode | Tipo: TravelModeTipo de rota solicitada. Obrigatório. |
avoidFerries optional | Tipo: boolean optionalSe true, instrui o serviço Distance Matrix a evitar balsas sempre que possível. Opcional. |
avoidHighways optional | Tipo: boolean optionalSe true, instrui o serviço Distance Matrix a evitar rodovias sempre que possível. Opcional. |
avoidTolls optional | Tipo: boolean optionalSe true, instrui o serviço Distance Matrix a evitar vias com pedágio sempre que possível. Opcional. |
drivingOptions optional | Tipo: DrivingOptions optionalConfigurações que se aplicam apenas a solicitações em que travelMode é DRIVING. Esse objeto não terá efeito para outros modos de viagem. |
language optional | Tipo: string optionalUm identificador do idioma em que os resultados devem ser retornados, quando possível. Consulte a lista de idiomas compatíveis. |
region optional | Tipo: string optionalCódigo de região utilizado como polarização para solicitações de geocodificação. O código regional aceita um valor de dois caracteres 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), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte"). |
transitOptions optional | Tipo: TransitOptions optionalConfigurações que se aplicam apenas a solicitações em que travelMode é TRANSIT. Esse objeto não terá efeito para outros modos de viagem. |
unitSystem optional | Tipo: UnitSystem optionalSistema 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, um para cada endereço de origem correspondente.
Propriedades | |
|---|---|
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, consistindo em uma sequência de DistanceMatrixResponseElements, uma para cada endereço de destino correspondente.
Propriedades | |
|---|---|
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 a um destino.
Propriedades | |
|---|---|
distance | Tipo: DistanceA distância deste par de origem-destino. Esta propriedade pode ser indefinida quando a distância não for conhecida. |
duration | Tipo: DurationA duração deste par de origem-destino. Esta propriedade pode ser indefinida quando a duração não for conhecida. |
duration_in_traffic | Tipo: DurationA duração para esse 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 | Tipo: TransitFareA tarifa total para esse par origem-destino. Aplicável apenas a solicitações de transporte público. |
status | O status deste par de origem-destino específico. |
Constantes DistanceMatrixStatus
Constantes de google.maps.DistanceMatrixStatus
O status de nível superior sobre a solicitação em geral retornado pelo DistanceMatrixService após a conclusão de uma solicitação de matriz de distância. Especifique-os por valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.DistanceMatrixStatus.OK.
Acesse ligando para const {DistanceMatrixStatus} = await google.maps.importLibrary("routes").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
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. Tente de novo mais tarde. |
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 de google.maps.DistanceMatrixElementStatus
O status no nível do elemento sobre um determinado pareamento de origem e destino retornado pelo 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 ligando para const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes").
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
|---|---|
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. |