Compartir a través de

Route - Post Route Directions Batch

Servicio:
Maps
Versión de la API:
2025-01-01

Se usa para enviar un lote de consultas a la API de indicaciones de ruta en una sola solicitud síncrona.
La Route Directions Batch API es una solicitud HTTP POST que envía lotes de hasta 100 consultas en una sola llamada a la API de indicaciones de ruta .

Enviar solicitud por lotes sincrónica

Se recomienda la API sincrónica para solicitudes por lotes ligeras. Cuando el servicio recibe una solicitud, responderá tan pronto como se calculen los elementos por lotes y no habrá posibilidad de recuperar los resultados más adelante. La API sincrónica devolverá un error de tiempo de espera (una respuesta 408) si la solicitud tarda más de 60 segundos. El número de elementos por lotes se limita a 100 para esta API.

POST https://atlas.microsoft.com/route/directions:batch?api-version=2025-01-01

Cuerpo POST para solicitud por lotes

Para enviar las consultas de direcciones, utilizará una POST solicitud en la que el cuerpo de la solicitud contendrá la batchItems matriz en formato y el json encabezado se establecerá en Content-Typeapplication/json. Este es un cuerpo de solicitud de ejemplo que contiene 2 consultas de instrucciones :

{
  "batchItems": [
    {
      "optionalId": "bbc9c0f6-ab52-49d8-a788-a658fa654c94",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "fastestWithoutTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 3,
      "travelMode": "driving"
    },
    {
      "optionalId": "a191de3c-1268-4986-98f0-03f0a5d9302a",
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.3368,
              47.614988
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "coordinates": [
              -122.316067,
              47.606356
            ],
            "type": "Point"
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "optimizeRoute": "shortest",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "maxRouteCount": 2,
      "travelMode": "driving"
    }
  ]
}

Un objeto batchItem de indicaciones puede aceptar cualquiera de las indicaciones admitidas Cuerpo de la solicitud

El lote debe contener al menos 1 consulta de.

Modelo de respuesta por lotes

La respuesta por lotes contiene un componente de summary que indica el totalRequests que formaron parte de la solicitud por lotes original y successfulRequests es decir, las consultas que se ejecutaron correctamente. La respuesta por lotes también incluye una matriz de batchItems que contiene una respuesta para cada consulta y cada consulta de la solicitud por lotes. El batchItems contendrá los resultados en el mismo orden en que se enviaron las consultas originales en la solicitud por lotes. Cada elemento es de uno de los siguientes tipos:

  • DirectionsResponse: si la consulta se completó correctamente.

  • Error: si se produjo un error en la consulta. La respuesta contendrá un code y un message en este caso.

POST {endpoint}/route/directions:batch?api-version=2025-01-01

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
 path True

string

api-version
 query True

string

minLength: 1

Versión de API que se usará para esta operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
x-ms-client-id

string

Indica la cuenta destinada a usarse con el modelo de seguridad Microsoft Entra ID. Este ID único para la cuenta de Azure Maps puede obtenerse desde la API de la cuenta Azure Maps plano de gestión. Para más información sobre el uso de la seguridad Microsoft Entra ID en Azure Maps, consulte Gestionar la autenticación en Azure Maps.
Accept-Language

string

Idioma en el que se deben devolver los resultados de enrutamiento.

Para más información, consulte Soporte de localización en Azure Maps.

Cuerpo de la solicitud

Nombre Tipo Description
batchItems

DirectionsBatchRequestItem[]

Lista de consultas que se van a procesar.

Respuestas

Nombre Tipo Description
200 OK

DirectionsBatchResponse

La solicitud se ha realizado correctamente.
Other Status Codes

MapsErrorResponse

Una respuesta de error inesperada.

Seguridad

AadToken

Estos son los flujos Microsoft Entra OAuth 2.0. Cuando se combina con el control de acceso basado en roles Azure puede usarse para controlar el acceso a Azure Maps APIs REST. Los controles de acceso basados en roles de Azure se utilizan para designar el acceso a una o más cuentas o subrecursos de recursos de Azure Maps. Cualquier usuario, grupo o principal de servicio puede recibir acceso mediante un rol incorporado o un rol personalizado compuesto por uno o más permisos para Azure Maps APIs REST.\n\nPara implementar escenarios, recomendamos consultar conceptos autenticación. En resumen, esta definición de seguridad proporciona una solución para modelar aplicaciones(es) mediante objetos capaces de control de acceso en APIs y ámbitos específicos.\n\n#### Notas\n* Esta definición de seguridad requiere el uso del encabezado x-ms-client-id para indicar a qué recurso Azure Maps solicita acceso la aplicación. Esto puede obtenerse de la API de gestión Maps.\n* \nEl Authorization URL es específico para la instancia Azure nube pública. Las nubes soberanas tienen URLs de Autorización y configuraciones de Microsoft Entra ID únicas. \n* \nEl control de acceso basado en roles Azure se configura desde el plano de gestión Azure a través de Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n* \nUso del Azure Maps Web SDK permite la configuración de una aplicación para múltiples casos de uso.\n* Para más información sobre Plataforma de identidad de Microsoft, véase Plataforma de identidad de Microsoft visión general.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre Description
https://atlas.microsoft.com/.default

subscription-key

Esta es una clave compartida que se provisiona cuando Crea una cuenta Azure Maps en el portal Azure o usando PowerShell, CLI, SDK de Azure o REST API.\n\n Con esta clave, cualquier aplicación puede acceder a toda la API REST. En otras palabras, esta clave puede usarse como una llave maestra en la cuenta en la que se emiten.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es utilizar el enfoque confidenciales para acceder a Azure Maps APIs REST y así almacenar tu clave de forma segura.

Tipo: apiKey
En: header

SAS Token

Este token de firma de acceso compartido se crea a partir de la operación List SAS en el recurso Azure Maps a través del plano de gestión de Azure mediante Azure portal, PowerShell, CLI, SDK de Azure o APIs REST.\n\n Con este token, cualquier aplicación está autorizada para acceder con Azure controles de acceso basados en roles y control detallado de la expiración, tasa y región(es) de uso para el token en particular. En otras palabras, el Token SAS puede usarse para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.\n\n Para aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta Map para limitar el abuso de renderizado y renovar regularmente el Token SAS.

Tipo: apiKey
En: header

Ejemplos

A Route Directions Batch request containing 2 queries

Solicitud de ejemplo

POST {endpoint}/route/directions:batch?api-version=2025-01-01

{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.3368,
              47.614988
            ]
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.316067,
              47.606356
            ]
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "maxRouteCount": 3,
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "travelMode": "driving"
    },
    {
      "type": "FeatureCollection",
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.3368,
              47.614988
            ]
          },
          "properties": {
            "pointIndex": 0,
            "pointType": "waypoint"
          }
        },
        {
          "type": "Feature",
          "geometry": {
            "type": "Point",
            "coordinates": [
              -122.316067,
              47.606356
            ]
          },
          "properties": {
            "pointIndex": 1,
            "pointType": "waypoint"
          }
        }
      ],
      "maxRouteCount": 3,
      "optimizeRoute": "fastestWithTraffic",
      "routeOutputOptions": [
        "routeSummary"
      ],
      "travelMode": "driving"
    }
  ]
}

Respuesta de muestra

status code:
200 
{
  "batchItems": [
    {
      "type": "FeatureCollection",
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "durationTrafficInSeconds": 682,
                "legs": [],
                "trafficCongestion": "Mild"
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "durationTrafficInSeconds": 754,
                "legs": [],
                "trafficCongestion": "Medium"
              }
            }
          ]
        }
      ],
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "departureAt": "2025-06-23T01:31:05+00:00",
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "durationTrafficInSeconds": 577,
            "legs": [],
            "trafficCongestion": "Mild"
          }
        }
      ]
    },
    {
      "type": "FeatureCollection",
      "alternativeRoutes": [
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:42:27+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 2297,
                "durationInSeconds": 586,
                "durationTrafficInSeconds": 682,
                "legs": [],
                "trafficCongestion": "Mild"
              }
            }
          ]
        },
        {
          "type": "FeatureCollection",
          "features": [
            {
              "type": "Feature",
              "geometry": {
                "type": "MultiLineString",
                "coordinates": []
              },
              "properties": {
                "type": "RoutePath",
                "arrivalAt": "2025-06-23T01:43:39+00:00",
                "departureAt": "2025-06-23T01:31:05+00:00",
                "distanceInMeters": 4253,
                "durationInSeconds": 621,
                "durationTrafficInSeconds": 754,
                "legs": [],
                "trafficCongestion": "Medium"
              }
            }
          ]
        }
      ],
      "features": [
        {
          "type": "Feature",
          "geometry": {
            "type": "MultiLineString",
            "coordinates": []
          },
          "properties": {
            "type": "RoutePath",
            "arrivalAt": "2025-06-23T01:40:42+00:00",
            "departureAt": "2025-06-23T01:31:05+00:00",
            "distanceInMeters": 2301,
            "durationInSeconds": 514,
            "durationTrafficInSeconds": 577,
            "legs": [],
            "trafficCongestion": "Mild"
          }
        }
      ]
    }
  ],
  "summary": {
    "successfulRequests": 2,
    "totalRequests": 2
  }
}

Definiciones

Nombre Description
AdminDistrict

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
AdrTunnelRestrictionCodeEnum

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.
AvoidEnum

Especifica las restricciones que debe respetar el cálculo de la ruta al determinar la ruta. Evitar soporta múltiples valores en una solicitud y solo se soporta para el modo de conducción y viaje de camión.\n\nEjemplo: "avoid": ["limitedAccessHighways", "TollRoads"]
CommonErrorDetail

Detalle del error.
CountryRegion

Representa un país o región que contiene detalles relacionados.
DirectionsBatchRequestBody

Lista de instrucciones que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.
DirectionsBatchRequestItem

Batch Query (objeto)
DirectionsBatchResponse

Este objeto se devuelve desde una llamada de servicio de Directions Batch correcta.
DirectionsBatchResponseItem

detalles del error
DirectionsBatchResponseSummary

Resumen de la solicitud por lotes
DrivingSideEnum

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.
ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.
FeatureCollection

GeoJSON FeatureCollection objeto que contiene una lista de características. Para obtener más información, vea RFC 7946, sección 3.3.
FeaturesItem

Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.
FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.
FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.
GeoJsonObjectType

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.
GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.
InputWaypointFeaturesItem

Especifica el punto de acceso de entrada y viaWaypoint GeoJSON objeto de característica y propiedades adicionales. Para obtener más información, vea RFC 7946.
InputWaypointProperties

Especifica las propiedades de un punto de acceso que es una ubicación o un punto específicos a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.
InputWaypointTypeEnum

Tipo de punto de acceso en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.
Instruction

Descripción de una maniobra en un conjunto de direcciones.
ManeuverPointProperties

Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta.
ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight
MapsErrorDetail

Detalle del error.
MapsErrorResponse

Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.
MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.
MultiLineStringGeometry

Especifica el GeoJSON objeto Geometry MultiLineString. Para obtener más información, vea RFC 7946.
NavigationPointPropertiesAddress

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.
OptimizedWaypoint

Objeto de punto de forma optimizado.
Order

Secuencia para visitar waypoints.
PointGeometry

El punto de origen pasado como un objeto Geometry válido GeoJSON, desde el que se debe calcular el polígono de intervalo. Consulte RFC 7946 para obtener más información.

Note: la API ajustará el punto de origen solicitado a la red de carreteras más cercana y la usará para el cálculo del intervalo. Se devolverá como punto de center en la respuesta.
PropertiesTypeEnum

Tipo de salida.
RouteDirectionOptimizeRouteEnum

Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual.

Ejemplo: "optimizeRoute":"shortest"
RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

ISNote: solo se admite para truck travelMode.
RouteLeg

Información sobre una sección de una ruta entre dos puntos de referencia. Más información sobre los campos contenidos en un tramo de ruta:
RouteOutputOptionEnum

La información de ruta deseada de la respuesta.
RoutePathPoint

Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
RoutePathProperties

Especifica las propiedades que describen la ruta de acceso de la ruta en la respuesta.
RoutePathRange

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.
RoutePathTravelModeEnum

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
RouteStep

Una pierna de ruta contiene instrucciones de turno a paso. Un paso hace referencia a un intervalo de una ruta entre dos maniobras consecutivas.
SideOfStreetEnum

Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
TrafficCongestionEnum

Nivel de congestión del tráfico a lo largo de la ruta. Note: solo se admite para conducir travelMode
TravelModeEnum

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles.

Note: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro".

Ejemplo: "travelMode":"driving"
VehicleLoadTypeEnum

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras.
WaypointProperties

Especifica las propiedades de un punto de acceso que es una ubicación o un punto específicos a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

AdminDistrict

Objeto

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.

Nombre Tipo Description
shortName

string

Nombre corto del campo adminDistrict correspondiente, Para adminDistrict[0], podría ser un nombre corto de estado, como WA. Esto solo está disponible para estados Unidos, Canadá y México.

AdrTunnelRestrictionCodeEnum

Enumeración

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.

Valor Description
B

Los vehículos con código B están restringidos de carreteras con categorías de túnel ADR B, C, D y E.
C

Los vehículos con código C están restringidos de carreteras con categorías de túnel ADR C, D y E
D

Los vehículos con código D están restringidos a las carreteras con categorías de túnel ADR D y E.
E

Los vehículos con código E están restringidos a las carreteras con la categoría de túnel ADR E.

AvoidEnum

Enumeración

Especifica las restricciones que debe respetar el cálculo de la ruta al determinar la ruta. Evitar soporta múltiples valores en una solicitud y solo se soporta para el modo de conducción y viaje de camión.\n\nEjemplo: "avoid": ["limitedAccessHighways", "TollRoads"]

Valor Description
limitedAccessHighways

Evita el uso de autopistas de acceso limitado en la ruta.
tollRoads

Evita el uso de carreteras de peaje en la ruta.
ferries

Evita el uso de ferris en la ruta.
tunnels

Evita el uso de túneles en la ruta.
borderCrossings

Evita cruzar las fronteras del país en la ruta.
lowEmissionZones

Evita zonas de baja emisión en la ruta.
unpavedRoads

Evita carreteras sin pintar en la ruta.

CommonErrorDetail

Objeto

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.
code

string

Código de error.
details

CommonErrorDetail[]

Detalles del error.
message

string

El mensaje de error.
target

string

Destino del error.

CountryRegion

Objeto

Representa un país o región que contiene detalles relacionados.

Nombre Tipo Description
ISO

string

ISO de país o región representa un código de país o país ISO 3166-1 Alpha-2
name

string

nombre del país o región

DirectionsBatchRequestBody

Objeto

Lista de instrucciones que se van a procesar. La lista puede contener un máximo de 100 consultas y debe contener al menos 1 consulta.

Nombre Tipo Description
batchItems

DirectionsBatchRequestItem[]

Lista de consultas que se van a procesar.

DirectionsBatchRequestItem

Objeto

Batch Query (objeto)

Nombre Tipo Valor predeterminado Description
arriveAt

string (date-time)

Fecha y hora de llegada al punto de destino con formato de dateTime valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se asume la hora UTC.

No se puede usar el parámetro arriveAt junto con departAt.

Ejemplo: "arriveAt": "2023-06-01T09:30:00.000-07:00"
avoid

AvoidEnum[]

Especifica las restricciones que debe respetar el cálculo de la ruta al determinar la ruta. Evite admitir varios valores en una solicitud y solo se admite para la conducción y el travelMode del camión.

Ejemplo: "avoid": ["limitedAccessHighways", "tollRoads"]
departAt

string (date-time)

Fecha y hora de salida del punto de origen con formato de dateTime valor definido por RFC 3339, sección 5.6. Cuando no se especifica un desplazamiento de zona horaria, se asume la hora UTC.

Si no se establece el departAt, el valor predeterminado es la hora actual.

Ejemplo:

"salida": "2023-06-01T09:30:00.000-07:00"
features

InputWaypointFeaturesItem[]

Las rutas en automóvil, a pie y en camión están definidas por un conjunto de waypoints (paradas) y viaWaypoints (ubicaciones intermedias por las que debe pasar la ruta). Puede tener un máximo de 150 waypoints y un máximo de 10 viaWaypoints entre cada conjunto de waypoints.

Una ruta debe tener un mínimo de 2 puntos de acceso y los puntos iniciales y finales de la ruta no pueden ser viaWaypoints.

Tanto el punto de acceso como las ubicaciones viaWaypoint deben especificarse como un objeto de característica GeoJSON Point válido junto con pointIndex que especifica el orden de las ubicaciones. Para obtener más información sobre el formato GeoJSON, consulte RFC 7946.
heading

integer (int64)

minimum: 0
maximum: 359

El encabezado direccional inicial del vehículo en grados a partir del verdadero Norte y continuando en dirección a las agujas del reloj. El norte es de 0 grados, el este es de 90 grados, el sur es de 180 grados, el oeste es de 270 grados.
maxRouteCount

integer (int64)

minimum: 1
maximum: 6

Número máximo de rutas que se van a devolver. Disponible para los modos de conducción y transporte de camión.

Predeterminado: "maxRouteCount":1
optimizeRoute

RouteDirectionOptimizeRouteEnum

fastestWithoutTraffic

Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual.

Ejemplo: "optimizeRoute":"shortest"
optimizeWaypointOrder

boolean

False

Vuelva a ordenar los puntos de ruta mediante un algoritmo heurístico rápido para reducir el costo de ruta especificado con el parámetro optimize. El origen y el destino se excluyen del punto de acceso optimizado y su posición se considera fija. Los valores aceptables son true o false.
optionalId

string

Identificador de la solicitud que se mostraría en batchItem correspondiente.
routeOutputOptions

RouteOutputOptionEnum[]

[ "itinerary" ]

Incluya la información de ruta deseada de la respuesta. De forma predeterminada, el itinerario se incluye en la respuesta.

Admite varios valores como "routeOutputOptions": ["routePath", "itinerary"]
travelMode

TravelModeEnum

driving

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles.

Note: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro".

Ejemplo: "travelMode":"driving"
type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.
vehicleSpec

RouteDirectionVehicleSpec

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

Note: solo se admite para truck travelMode

DirectionsBatchResponse

Objeto

Este objeto se devuelve desde una llamada de servicio de Directions Batch correcta.

Nombre Tipo Description
batchItems

DirectionsBatchResponseItem[]

Matriz que contiene los resultados del lote.
summary

DirectionsBatchResponseSummary

Resumen de la solicitud por lotes

DirectionsBatchResponseItem

Objeto

detalles del error

Nombre Tipo Description
alternativeRoutes

FeatureCollection[]

Ruta alternativa.
error

CommonErrorDetail

Detalle del error.
features

FeaturesItem[]

GeoJSON objeto de característica que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.
optionalId

string

Identificador de la solicitud que se mostraría en batchItem correspondiente.
type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.

DirectionsBatchResponseSummary

Objeto

Resumen de la solicitud por lotes

Nombre Tipo Description
successfulRequests

integer (int32)

Número de solicitudes correctas en el lote
totalRequests

integer (int32)

Número total de solicitudes en el lote

DrivingSideEnum

Enumeración

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.

Valor Description
Left

Conducción a la izquierda.
Right

Conducción a la derecha.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.
type

string

Tipo de información adicional.

FeatureCollection

Objeto

GeoJSON FeatureCollection objeto que contiene una lista de características. Para obtener más información, vea RFC 7946, sección 3.3.

Nombre Tipo Description
features

FeaturesItem[]

GeoJSON objeto de característica que contiene el objeto Geometry y propiedades adicionales. Para obtener más información, vea RFC 7946, Sección 3.2.
type

FeatureTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.

FeaturesItem

Objeto

Objeto de característica GeoJSON que contiene el objeto Geometry y propiedades adicionales de la ruta.

Nombre Tipo Description
bbox

number[] (double)

Un área rectangular en la tierra definida como un objeto de rectángulo delimitador. Los lados de los rectángulos se definen mediante valores de latitud y longitud. Para obtener más información, vea RFC 7946, Sección 5.

Ejemplo: "bbox": [-10.0, -10.0, 10.0, 10.0]
geometry RouteDirectionsGeometry:

Objeto Geometry válido GeoJSON. Para obtener más información, vea RFC 7946.
properties FeatureProperties:

Especifica las propiedades de características de la ruta, como el itinerario, las piernas de ruta y la geometría, el resumen de viaje.
type

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

FeaturesItemTypeEnum

Enumeración

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

Valor Description
Feature

Especifica el tipo de objeto feature de GeoJSON.

FeatureTypeEnum

Enumeración

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es FeatureCollection. Para obtener más información, vea RFC 7946.

Valor Description
FeatureCollection

Especifica el tipo de objeto GeoJSONFeatureCollection.

GeoJsonObjectType

Enumeración

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

Valor Description
Point

GeoJSON Point geometría.
MultiPoint

GeoJSON MultiPoint geometría.
LineString

GeoJSON LineString geometría.
MultiLineString

GeoJSON MultiLineString geometría.
Polygon

GeoJSON Polygon geometría.
MultiPolygon

GeoJSON MultiPolygon geometría.
GeometryCollection

GeoJSON GeometryCollection geometría.
Feature

Objeto GeoJSON Feature.
FeatureCollection

Objeto GeoJSON FeatureCollection.

GeoJsonPoint

Objeto

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.

Nombre Tipo Description
coordinates

number[] (double)

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type string:

Point

Especifica el tipo de GeoJSON. Debe ser uno de los nueve tipos de objeto GeoJSON válidos: Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Feature y FeatureCollection.

InputWaypointFeaturesItem

Objeto

Especifica el punto de acceso de entrada y viaWaypoint GeoJSON objeto de característica y propiedades adicionales. Para obtener más información, vea RFC 7946.

Nombre Tipo Description
geometry

GeoJsonPoint

Un tipo de geometría GeoJSON Point válido. Consulte RFC 7946 para obtener más información.
properties

InputWaypointProperties

Especifica las propiedades de un punto de acceso que es una ubicación o un punto específicos a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.
type

FeaturesItemTypeEnum

Especifica el tipo de GeoJSON. El único tipo de objeto admitido es Feature. Para obtener más información, vea RFC 7946.

InputWaypointProperties

Objeto

Especifica las propiedades de un punto de acceso que es una ubicación o un punto específicos a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

Nombre Tipo Valor predeterminado Description
pointIndex

integer (int64)

Identifique y ordene la secuencia de puntos de referencia en la ruta. El valor predeterminado es el index value de una matriz de características.
pointType

InputWaypointTypeEnum

waypoint

Tipo de punto de acceso en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.

InputWaypointTypeEnum

Enumeración

Tipo de punto de acceso en la ruta. Puede ser una parada o una ubicación intermedia a la que debe pasar la ruta.

Valor Description
waypoint

Un punto de referencia es una ubicación o punto específico a lo largo de una ruta o viaje que actúa como referencia o punto de detención.
viaWaypoint

Un viaWaypoint es un punto de acceso específico que debe pasarse o visitarse a lo largo de una ruta o viaje.

Instruction

Objeto

Descripción de una maniobra en un conjunto de direcciones.

Nombre Tipo Description
drivingSide

DrivingSideEnum

Indica la conducción a la izquierda frente a la derecha en el punto de la maniobra.
formattedText

string

Descripción del texto con formato de la instrucción.
maneuverType

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight
text

string

Descripción del texto sin formato de la instrucción.

ManeuverPointProperties

Objeto

Especifica las instrucciones de conducción y propiedades adicionales para cada punto de maniobra de la pierna de ruta.

Nombre Tipo Valor predeterminado Description
address

NavigationPointPropertiesAddress

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.
distanceInMeters

number (float)

Distancia física en metros cubiertos por este paso de ruta.
durationInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistancecorrespondiente.
exitIdentifier

string

Nombre o número de la salida asociada a este paso de ruta.
instruction

Instruction

Descripción de una maniobra en un conjunto de direcciones.
order

Order

Secuencia para visitar waypoints.
routePathPoint

RoutePathPoint

Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
sideOfStreet

SideOfStreetEnum

Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
signs

string[]

Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps

RouteStep[]

Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName

string

Nombre de la calle hacia la que va la ruta en el primer ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type string:

ManeuverPoint

Tipo de salida.

ManeuverTypeEnum

Enumeración

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight

Valor Description
ArriveFinish

Llegue al destino final.
ArriveIntermediate

Llega a un punto intermedio.
BearLeft

Manténgase a la izquierda.
BearLeftThenBearLeft

El oso se dejó y luego el oso se dejó de nuevo.
BearLeftThenBearRight

Oso a la izquierda y luego oso a la derecha.
BearLeftThenTurnLeft

Oso a la izquierda y luego gire a la izquierda.
BearLeftThenTurnRight

Oso a la izquierda y luego gire a la derecha.
BearRight

Manténgase a la derecha.
BearRightThenBearLeft

Oso a la derecha y luego oso a la izquierda.
BearRightThenBearRight

Oso justo y luego oso de nuevo.
BearRightThenTurnLeft

Oso a la derecha y luego gire a la izquierda.
BearRightThenTurnRight

Oso a la derecha y luego gire a la derecha.
BearThenKeep

Oso instrucción y, a continuación, una instrucción keep
DepartStart

Deje el punto de partida.
BearThenMerge

Lleve la instrucción y, a continuación, una instrucción de combinación.
Continue

Continúe en la carretera actual.
DepartIntermediateStop

Deje un punto de camino intermedio en una dirección y carretera diferente a la que llegó.
DepartIntermediateStopReturning

Deje un punto intermedio en la misma dirección y en la misma carretera en la que llegó.
EnterRoundabout

Escriba un redondeo.
ExitRoundabout

Salga de una rotonda.
EnterThenExitRoundabout

Escriba y salga de una rotonda.
ExitRoundaboutRight

En la rotonda, tome la salida a la derecha.
ExitRoundaboutLeft

En la rotonda, tome la salida a la izquierda.
Follow

Follow.
GoAroundRoundabout

Ve por la rotonda.
KeepLeft

Mantente a la izquierda en otra carretera.
KeepOnRampLeft

Manténgase a la izquierda y continúe con la rampa.
KeepOnRampRight

Mantenga la derecha y continúe con la rampa.
KeepOnRampStraight

Mantenga recto y continúe en la rampa.
KeepRight

Mantenga la derecha sobre una carretera diferente.
KeepStraight

Mantente recta sobre una carretera diferente.
KeepToStayLeft

Mantente a la izquierda para permanecer en la misma carretera.
KeepToStayRight

Mantenga el derecho de permanecer en la misma carretera.
KeepToStayStraight

Siga directamente para permanecer en la misma carretera.
MergeFreeway

Combinar en una autopista.
MergeHighway

Combinar en una autopista.
MergeMotorway

Combinar en una autopista.
MotorwayExitLeft

Tome la salida izquierda.
MotorwayExitRight

Tome la salida correcta.
None

Sin instrucción.
RampThenHighwayLeft

Tome la rampa izquierda a la autopista. Esto forma parte de una instrucción combinada.
RampThenHighwayRight

Tome la rampa derecha a la autopista. Esto forma parte de una instrucción combinada.
RampThenHighwayStraight

Manténgase directamente para tomar la rampa a la autopista. Esto forma parte de una instrucción combinada.
RoadNameChange

Cambia el nombre del camino.
SwitchToParallelRoad

Cambie a la carretera paralela.
SwitchToMainRoad

Cambie a la carretera principal.
Take

Tome el camino. Esta instrucción se usa cuando entras o sales de un ferry.
TakeFerry

Tome el ferry.
TakeExit

Tome la salida.
TakeRamp

Tomemos la rampa.
TakeRampLeft

Tome la rampa a la izquierda.
TakeRampRight

Tome la rampa a la derecha.
TakeRampStraight

Quédate directamente para tomar rampa.
TurnBack

Gire hacia atrás de forma aguda.
TurnLeft

Gire a la izquierda.
TurnLeftSharp

Tome un giro a la izquierda afilado.
TurnLeftThenBearLeft

Gire a la izquierda y luego oso a la izquierda.
TurnLeftThenBearRight

Gire a la izquierda y, a continuación, oso a la derecha.
TurnLeftThenTurnLeft

Gire a la izquierda y vuelva a girar a la izquierda.
TurnLeftThenTurnRight

Gire a la izquierda y, a continuación, gire a la derecha.
TurnRight

Gire a la derecha.
TurnRightSharp

Tome un giro derecho afilado.
TurnRightThenBearLeft

Gire a la derecha y luego oso a la izquierda.
TurnRightThenBearRight

Gire a la derecha y luego oso a la derecha.
TurnRightThenTurnLeft

Gire a la derecha y, a continuación, gire a la izquierda.
TurnRightThenTurnRight

Gire a la derecha y vuelva a girar a la derecha
TurnThenMerge

Instrucciones de turno seguidas de una instrucción de combinación.
TurnToStayLeft

Gire a la izquierda para permanecer en la misma carretera.
TurnToStayRight

Gire a la derecha para permanecer en la misma carretera.
Unknown

La instrucción es desconocida.
UTurn

Haz un giro para ir en la dirección opuesta.
Wait

Wait
Walk

Walk

MapsErrorDetail

Objeto

Detalle del error.

Nombre Tipo Description
code

string

Uno de un conjunto definido por el servidor de códigos de error.
details

MapsErrorDetail[]

Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.
message

string

Una representación en lenguaje natural del error.
target

string

Destino del error.

MapsErrorResponse

Objeto

Respuesta común a errores para que las APIs de Azure Maps devolvan detalles de error por operaciones fallidas.

Nombre Tipo Description
error

MapsErrorDetail

Detalle del error.

MapsInnerError

Objeto

Objeto que contiene información más específica que el objeto actual sobre el error.

Nombre Tipo Description
code

string

Código de error.
innererror

MapsInnerError

Objeto que contiene información más específica que el objeto actual sobre el error.

MultiLineStringGeometry

Objeto

Especifica el GeoJSON objeto Geometry MultiLineString. Para obtener más información, vea RFC 7946.

Nombre Tipo Description
coordinates

number[] (double)

Coordenadas de la geometría GeoJson MultiLineString.
type string:

MultiLineString

Especifica el tipo de geometría del objeto geometry GeoJSON. Para obtener más información, vea RFC 7946.
Objeto

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.

Nombre Tipo Description
adminDistricts

AdminDistrict[]

Nombre de subdivisión en el país o región de una dirección. Este elemento normalmente se trata como la subdivisión administrativa de primer orden, pero en algunos casos también contiene la segunda, tercera o cuarta subdivisión de orden en un país, dependencia o región.
countryRegion

CountryRegion

Representa un país o región que contiene detalles relacionados.

OptimizedWaypoint

Objeto

Objeto de punto de forma optimizado.

Nombre Tipo Description
inputIndex

integer (int64)

Índice de punto de acceso proporcionado por el usuario.
optimizedIndex

integer (int64)

Índice de punto de forma optimizado desde el sistema.

Order

Objeto

Secuencia para visitar waypoints.

Nombre Tipo Description
inputIndex

integer (int64)

Índice proporcionado por el usuario para el punto de referencia
optimizedIndex

integer (int64)

Waypoint optimizado para el sistema

PointGeometry

Objeto

El punto de origen pasado como un objeto Geometry válido GeoJSON, desde el que se debe calcular el polígono de intervalo. Consulte RFC 7946 para obtener más información.

Note: la API ajustará el punto de origen solicitado a la red de carreteras más cercana y la usará para el cálculo del intervalo. Se devolverá como punto de center en la respuesta.

Nombre Tipo Description
coordinates

number[] (double)

Un Position es una matriz de números con dos o más elementos. Los dos primeros elementos son longitud y latitud, precisamente en ese orden. altitud/elevación es un tercer elemento opcional. Consulte RFC 7946 para obtener más información.
type string:

Point

Especifica el tipo de geometría del objeto geometry GeoJSON. Para obtener más información, vea RFC 7946.

PropertiesTypeEnum

Enumeración

Tipo de salida.

Valor Description
ManeuverPoint

Un maniobraPunto es un punto específico en una ruta o viaje donde se requiere o recomienda un cambio de dirección o de medio de transporte.
Waypoint

Un punto de referencia es una ubicación o punto específico a lo largo de una ruta o viaje que actúa como referencia o punto de detención.
RoutePath

Una ruta Path es una línea que representa la trayectoria de una ruta o viaje.

RouteDirectionOptimizeRouteEnum

Enumeración

Especifica el parámetro que se va a usar para optimizar la ruta. Si no se define, el valor predeterminado es "fastestWithoutTraffic", que devuelve la ruta para minimizar el tiempo de desplazamiento sin usar la información de tráfico actual.

Ejemplo: "optimizeRoute":"shortest"

Valor Description
short

La ruta está calculada para equilibrar el tiempo de viaje rápido y la distancia corta, en lugar de priorizar solo una. Está optimizado tanto para la velocidad como para la eficiencia. No se usa la información de tráfico.
shortest

La ruta se calcula para minimizar la distancia. No se usa la información de tráfico.
fastestWithoutTraffic

Busca la ruta más rápida, sin factorizar la información de tráfico.
fastestWithTraffic

La ruta se calcula para minimizar el tiempo mediante la información de tráfico actual. Note: solo se admite para conducir y camión travelMode.

RouteDirectionVehicleSpec

Objeto

Especifica los atributos del vehículo, como el tamaño, el peso, la velocidad máxima, el tipo de carga, etc. solo para el enrutamiento de camiones. Esto ayuda a evitar bajas distancias de puente, restricciones de carretera, giros difíciles a la derecha para proporcionar la ruta optimizada del camión en función de las especificaciones del vehículo.

ISNote: solo se admite para truck travelMode.

Nombre Tipo Valor predeterminado Description
adrTunnelRestrictionCode

AdrTunnelRestrictionCodeEnum

Código de restricción del túnel ADR. ADR es un acuerdo europeo relativo al transporte internacional de mercancías peligrosas por carretera. El código de restricción del túnel ADR se utiliza para determinar si se permite que un vehículo pase a través de un túnel con restricciones sobre el transporte de mercancías peligrosas.
axleCount

integer (int64)

Número de ejes del vehículo.
axleWeight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso por eje del vehículo en kg. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso por eje.
height

number (double)

minimum: 0
maximum: 1000000 		0

Altura del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de altura.
isVehicleCommercial

boolean

False

Si el vehículo se utiliza para fines comerciales. Es posible que los vehículos comerciales no puedan conducir en algunas carreteras.
length

number (double)

minimum: 0
maximum: 1000000 		0

Longitud del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de longitud.
loadType

VehicleLoadTypeEnum[]

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras. Los valores de vehicleLoadType disponibles son clases hazmat de EE. UU. de 1 a 9, además de clasificaciones genéricas para su uso en otros países. Los valores que comienzan con USHazmat son para el enrutamiento de EE. UU., mientras que otroshazmat deben usarse para todos los demás países. vehicleLoadType admite varios valores en una solicitud.
maxSpeed

integer (int64)

minimum: 0
maximum: 250 		0

Velocidad máxima del vehículo en km/hora. La velocidad máxima en el perfil del vehículo se utiliza para comprobar si se permite un vehículo en las autopistas.

Un valor de 0 significa que se determinará y aplicará un valor adecuado para el vehículo durante el planeamiento de rutas.

Un valor distinto de cero se puede invalidar durante el planeamiento de rutas. Por ejemplo, el flujo de tráfico actual es de 60 km/hora. Si la velocidad máxima del vehículo se establece en 50 km/hora, el motor de enrutamiento considerará 60 km/hora, ya que esta es la situación actual. Si la velocidad máxima del vehículo se proporciona como 80 km/hora, pero el flujo de tráfico actual es de 60 km/hora, el motor de enrutamiento volverá a usar 60 km/hora.
weight

integer (int64)

minimum: 0
maximum: 1000000 		0

Peso del vehículo en kilogramos. Un valor de 0 significa que no se tienen en cuenta las restricciones de peso.
width

number (double)

minimum: 0
maximum: 1000000 		0

Ancho del vehículo en metros. Un valor de 0 significa que no se tienen en cuenta las restricciones de ancho.

RouteLeg

Objeto

Información sobre una sección de una ruta entre dos puntos de referencia. Más información sobre los campos contenidos en un tramo de ruta:

Nombre Tipo Description
arrivalAt

string (date-time)

La hora estimada de llegada para la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.
departureAt

string (date-time)

La hora estimada de salida de la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.
distanceInMeters

number (float)

Distancia física en metros cubiertos por una pierna de ruta.
durationInSeconds

integer (int64)

Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistance correspondiente con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
routePathRange

RoutePathRange

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

RouteOutputOptionEnum

Enumeración

La información de ruta deseada de la respuesta.

Valor Description
routeSummary

Incluya solo el tiempo de viaje y la distancia para la ruta y no proporcione otra información.
routePath

Incluya una GeoJSON MultiLineString RFC 7946, sección 3.1.5 que describa la ruta de acceso de la ruta en la respuesta.
itinerary

Incluya instrucciones detalladas en la respuesta. Las instrucciones detalladas se proporcionan como "Puntos de maniobra" y contienen detalles como instrucciones de turno a turno.

RoutePathPoint

Objeto

Hace referencia al índice de un punto dentro de una pierna específica de una ruta.

Nombre Tipo Description
legIndex

integer (int64)

El índice de recorrido de ruta es un número secuencial asignado a cada tramo de la ruta para ayudar a identificar y distinguir entre distintos segmentos de la ruta.
pointIndex

integer (int64)

Índice de un punto dentro de una pierna específica.

RoutePathProperties

Objeto

Especifica las propiedades que describen la ruta de acceso de la ruta en la respuesta.

Nombre Tipo Description
arrivalAt

string (date-time)

La hora estimada de llegada de la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor de dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.
departureAt

string (date-time)

El tiempo de salida estimado para la pierna, que tiene en cuenta las condiciones de tráfico, tiene el formato de un valor dateTime definido por RFC 3339, sección 5.6. Hará referencia al desplazamiento de zona horaria mediante departAt o arrivalAt. Si no es así, se usará la hora UTC.
distanceInMeters

number (float)

Distancia física en metros cubiertos por toda la ruta.
durationInSeconds

integer (int64)

Tiempo estimado de viaje en segundos que no incluye retrasos en la ruta debido a las condiciones de tráfico.
durationTrafficInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistance correspondiente con las condiciones de tráfico actuales. Este valor se proporciona si optimizeRoute incluye consideraciones sobre el tráfico.
legs

RouteLeg[]

Matriz de piernas de ruta. Consulte la descripción del objeto Route Leg para obtener más información.
optimizedWaypoints

OptimizedWaypoint[]

Secuencia optimizada de puntos de referencia. Muestra el índice de la secuencia de punto de acceso proporcionada por el usuario para las listas originales y optimizadas.
trafficCongestion

TrafficCongestionEnum

Nivel de congestión del tráfico a lo largo de la ruta. Note: solo se admite para conducir travelMode
type string:

RoutePath

Tipo de salida.

RoutePathRange

Objeto

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

Nombre Tipo Description
legIndex

integer (int64)

El índice de recorrido de ruta es un número secuencial asignado a cada tramo de la ruta para ayudar a identificar y distinguir entre distintos segmentos de la ruta.
range

integer[] (int64)

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

RoutePathTravelModeEnum

Enumeración

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.

Valor Description
driving

Rutas optimizadas para coches.
truck

Rutas optimizadas para camiones de gran tamaño en función de la especificación del vehículo.
walking

Rutas optimizadas para los peatones.
other

RouteAdvisorMode se devuelve como "otro" para el camión travelMode cuando la ruta del camión no está disponible para una sección determinada de una ruta.

RouteStep

Objeto

Una pierna de ruta contiene instrucciones de turno a paso. Un paso hace referencia a un intervalo de una ruta entre dos maniobras consecutivas.

Nombre Tipo Description
maneuverType

ManeuverTypeEnum

Tipo de maniobra descrito en esta colección detallada. El Tipo de maniobra proporciona información para una parte de la maniobra especificada por la instrucción correspondiente. Por ejemplo, el tipo de maniobra de una instrucción puede especificar TurnLeftThenTurnRight, mientras que los elementos de detalle asociados pueden proporcionar detalles sobre las maniobras TurnLeft y TurnRight
names

string[]

Una calle, autopista o intersección donde se produce la maniobra. Si la maniobra es compleja, puede haber más de un campo de nombre en la colección de detalles. El campo de nombre también puede no tener ningún valor. Esto puede ocurrir si el nombre no se conoce o si una calle, carretera o intersección no tiene un nombre.
routePathRange

RoutePathRange

Hace referencia al intervalo cubierto por una pierna específica de una ruta o ruta de acceso.

SideOfStreetEnum

Enumeración

Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.

Valor Description
Left

Izquierda.
Right

Exacto.
Unknown

Desconocido.

TrafficCongestionEnum

Enumeración

Nivel de congestión del tráfico a lo largo de la ruta. Note: solo se admite para conducir travelMode

Valor Description
Unknown

Desconocido.
None

Ninguno.
Mild

Mild.
Medium

Medium.
Heavy

Heavy.

TravelModeEnum

Enumeración

Modo de desplazamiento para la ruta solicitada. Si no se define, el valor predeterminado es "conducción" que devuelve la ruta optimizada para automóviles.

Note: para truck travelMode, es posible que la ruta de camión solicitada no esté disponible para toda la ruta. Cuando la ruta del camión no está disponible para una sección determinada, el elemento travelMode de la respuesta de esa sección será "otro".

Ejemplo: "travelMode":"driving"

Valor Description
driving

Las rutas devueltas están optimizadas para automóviles.
truck

Las rutas devueltas están optimizadas para camiones de gran tamaño en función de la especificación del vehículo.
walking

Las rutas devueltas están optimizadas para los peatones, incluido el uso de aceras.

VehicleLoadTypeEnum

Enumeración

Tipos de carga que se pueden clasificar como materiales peligrosos y restringidos de algunas carreteras.

Valor Description
USHazmatClass1

Explosivos
USHazmatClass2

Gas comprimido
USHazmatClass3

Líquidos inflamables
USHazmatClass4

Sólidos inflamables
USHazmatClass5

Oxidantes
USHazmatClass6

Venenos
USHazmatClass7

Radiactivo
USHazmatClass8

Corrosivos
USHazmatClass9

Varios
otherHazmatExplosive

Explosivos
otherHazmatGeneral

Varios
otherHazmatHarmfulToWater

Perjudicial para el agua

WaypointProperties

Objeto

Especifica las propiedades de un punto de acceso que es una ubicación o un punto específicos a lo largo de una ruta o un viaje que actúa como referencia o punto de detención.

Nombre Tipo Valor predeterminado Description
address

NavigationPointPropertiesAddress

El distrito administrativo y la región del país para los puntos de referencia y los puntos de maniobra en la ruta.
distanceInMeters

number (float)

Distancia física en metros cubiertos por este paso de ruta.
durationInSeconds

integer (int64)

El tiempo que tarda, en segundos, en viajar un TravelDistancecorrespondiente.
exitIdentifier

string

Nombre o número de la salida asociada a este paso de ruta.
instruction

Instruction

Descripción de una maniobra en un conjunto de direcciones.
order

Order

Secuencia para visitar waypoints.
routePathPoint

RoutePathPoint

Hace referencia al índice de un punto dentro de una pierna específica de una ruta.
sideOfStreet

SideOfStreetEnum

Lado de la calle donde se encuentra el destino en función de la dirección de llegada. Este campo solo se aplica a la última maniobraPoint.
signs

string[]

Texto de señalización para la ruta. Puede haber más de un valor de signo.
steps

RouteStep[]

Pasos entre dos puntos de maniobra consecutivos.
towardsRoadName

string

Nombre de la calle hacia la que va la ruta en el primer ManeuverPoint.
travelMode

RoutePathTravelModeEnum

driving

Modo de desplazamiento para la ruta de acceso de ruta en la respuesta.
type string:

Waypoint

Tipo de salida.