Route - Post Route Directions
Użyj polecenia , aby uzyskać najlepszą trasę między miejscem pochodzenia a miejscem docelowym dla samochodów, ciężarówek komercyjnych i tras chodzących.
Interfejs Route Directions API to żądanie HTTP POST , które zwraca idealną trasę między punktem początkowym a docelowym dla samochodów (jazdy), ciężarówek komercyjnych i tras pieszych. Trasa przechodzi przez szereg punktów trasy, jeśli zostały określone. Punkt trasy to lokalizacja geograficzna zdefiniowana przez długość i szerokość geograficzną, która jest używana do celów nawigacyjnych. Trasa uwzględnia czynniki, takie jak bieżący ruch i typowe prędkości drogowe w żądanym dniu tygodnia i o porze dnia.
Interfejs API zwraca odległość, szacowany czas podróży i reprezentację geometrii trasy. W zależności od użytych parametrów dostępnych jest również więcej informacji o trasie, takich jak zoptymalizowana kolejność punktów trasy lub instrukcje zakręt po zakręcie.
Wskazówki dotyczące trasy uwzględniają lokalne przepisy, wymiary pojazdów, rodzaj ładunku, maksymalną prędkość, wysokości mostów i tuneli, aby obliczyć trasy specyficzne dla ciężarówek i uniknąć skomplikowanych manewrów i trudnych dróg. Nie wszystkie ciężarówki mogą pokonywać te same trasy, co inne pojazdy, ze względu na pewne ograniczenia wynikające z profilu pojazdu lub rodzaju ładunku. Na przykład autostrady często mają oddzielne ograniczenia prędkości dla ciężarówek, niektóre drogi nie zezwalają na wjazd ciężarówek z materiałami łatwopalnymi lub niebezpiecznymi, a na mostach mogą obowiązywać ograniczenia dotyczące wysokości i masy.
Obsługiwanych jest do 150 punktów trasy i 10 punktów via Waypoints między dowolnymi dwoma punktami trasy. Każdy zestaw punktów trasy tworzy osobny odcinek trasy. Punkty ViaWaypoints definiują ścieżkę trasy i mogą być używane do tworzenia tras przez określone lokalizacje, ale nie tworzą odcinków trasy.
Aby uzyskać informacje na temat routingu dostępności w krajach/regionach, zobacz pokrycie routingu usługi Azure Maps.
POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
Numer wersji interfejsu API usługi Azure Maps. |
Nagłówek żądania
Media Types: "application/geo+json"
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-id |
string |
Wskazuje konto przeznaczone do użycia z modelem zabezpieczeń Microsoft Entra ID. Ten unikatowy identyfikator konta Azure Maps można uzyskać z interfejsu API konta płaszczyzny zarządzania Azure Maps. Aby uzyskać więcej informacji na temat korzystania z zabezpieczeń Microsoft Entra ID w Azure Maps, zobacz Zarządzanie uwierzytelnianiem w Azure Maps. |
|
| Accept-Language |
string |
Język, w którym powinny być zwracane wyniki routingu. Aby uzyskać więcej informacji, zobacz Obsługa lokalizacji w usłudze Azure Maps. |
Treść żądania
Media Types: "application/geo+json"
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| features | True |
Trasy dla kierowców, pieszych i ciężarówek są definiowane przez zestaw punktów trasy (przystanków) i viaWaypoints (lokalizacji pośrednich, przez które musi przebiegać trasa). Możesz mieć maksymalnie 150 punktów trasy i maksymalnie 10 punktów via Waypoints między każdym zestawem punktów trasy. Trasa musi mieć co najmniej 2 punkty trasy, a punkty początkowe i końcowe trasy nie mogą być punktami trasy. Zarówno lokalizacje punktów trasy, jak i viaWaypoint muszą być określone jako prawidłowy obiekt funkcji GeoJSON Point wraz z parametrem pointIndex, który określa kolejność lokalizacji. Aby uzyskać więcej informacji na temat formatu GeoJSON, zobacz RFC 7946. |
|
| type | True |
Określa typ |
|
| arriveAt |
string (date-time) |
Data i godzina przybycia do punktu docelowego sformatowana jako Nie można użyć parametru Przykład: "arriveAt": "2023-06-01T09:30:00.000-07:00" |
|
| avoid |
Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas wyznaczania trasy. Opcja Avoid obsługuje wiele wartości w żądaniu i jest obsługiwana tylko w przypadku trybu jazdy i jazdy ciężarówki. Przykład: "unikać": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Data i godzina wyjazdu z punktu początkowego sformatowana jako Jeśli wartość nie Example: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| heading |
integer (int64) minimum: 0maximum: 359 |
Początkowy kierunek pojazdu w stopniach, rozpoczynający się na północy rzeczywistej i kontynuujący w kierunku zgodnym z ruchem wskazówek zegara. Północ jest 0 stopni, wschód jest 90 stopni, południe jest 180 stopni, zachód jest 270 stopni. |
|
| maxRouteCount |
integer (int64) minimum: 1maximum: 6 |
Maksymalna liczba tras do zwrócenia. Dostępne dla trybów jazdy i jazdy samochodem ciężarowym. Domyślnie: "maxRouteCount":1 |
|
| optimizeRoute |
Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym. Przykład: "optimizeRoute":"najkrótszy" |
||
| optimizeWaypointOrder |
boolean |
Zmień kolejność punktów trasy za pomocą szybkiego algorytmu heurystycznego, aby zmniejszyć koszt trasy określony za pomocą parametru optimize. Punkt początkowy i docelowy są wykluczone ze zoptymalizowanego punktu trasy, a ich pozycja jest uważana za stałą. Dopuszczalne wartości to prawda lub fałsz. |
|
| routeOutputOptions |
Dołącz żądane informacje o trasie z odpowiedzi. Domyślnie plan podróży jest uwzględniony w odpowiedzi. Obsługuje wiele wartości, takich jak "routeOutputOptions": ["routePath", "itinerary"] |
||
| travelMode |
Tryb podróży dla żądanej trasy. Jeśli nie zostanie zdefiniowana, wartością domyślną jest "jazda", która zwraca trasę zoptymalizowaną pod kątem samochodów.
Przykład: "travelMode":"jazda" |
||
| vehicleSpec |
Określa atrybuty pojazdu, takie jak rozmiar, masa, prędkość maksymalna, rodzaj ładunku itp., tylko dla tras dla ciężarówek. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu.
|
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
OK Media Types: "application/geo+json", "application/json" |
|
| Other Status Codes |
Wystąpił nieoczekiwany błąd. Media Types: "application/geo+json", "application/json" Nagłówki x-ms-error-code: string |
Zabezpieczenia
AADToken
Są to przepływy Microsoft Entra OAuth 2.0. Po połączeniu z dostępem opartym na rolach platformy Azure kontroli może służyć do kontrolowania dostępu do interfejsów API REST usługi Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego konta zasobu usługi Azure Maps lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi mogą mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do interfejsów API REST usługi Azure Maps.
Aby zaimplementować scenariusze, zalecamy wyświetlenie koncepcji uwierzytelniania . Podsumowując, ta definicja zabezpieczeń zawiera rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Note
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-idw celu wskazania, do którego zasobu usługi Azure Maps aplikacja żąda dostępu. Można to uzyskać za pomocą interfejsu API zarządzania usługami Maps. -
Authorization URLjest specyficzna dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje identyfikatorów Entra firmy Microsoft. - Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana na podstawie płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
- Użycie zestawu Web SDK usługi Azure Maps umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
- Aby uzyskać więcej informacji na temat platformy tożsamości firmy Microsoft, zobacz Microsoft identity platform overview.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Jest to klucz wspólny aprowizowany podczas tworzenia zasobów usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów SDK platformy Azure lub interfejsów API REST.
Za pomocą tego klucza każda aplikacja jest autoryzowana do uzyskiwania dostępu do wszystkich interfejsów API REST. Innymi słowy, mogą one być obecnie traktowane jako klucze główne do konta, dla którego są wystawiane.
W przypadku publicznie uwidocznionych aplikacji naszym zaleceniem jest użycie dostępu serwer-serwer interfejsów API REST usługi Azure Maps, w których ten klucz może być bezpiecznie przechowywany.
Typ:
apiKey
W:
header
SAS Token
Jest to token sygnatury dostępu współdzielonego tworzony na podstawie operacji List SAS na zasobie usługi Azure Maps za pośrednictwem płaszczyzny zarządzania platformy Azure za pośrednictwem witryny Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
Dzięki temu tokenowi każda aplikacja jest autoryzowana do uzyskiwania dostępu za pomocą kontroli dostępu opartej na rolach platformy Azure i szczegółowej kontroli wygaśnięcia, szybkości i regionów użycia dla określonego tokenu. Innymi słowy, token SAS może służyć do umożliwienia aplikacjom kontrolowania dostępu w sposób bardziej zabezpieczony niż klucz wspólny.
W przypadku publicznie uwidocznionych aplikacji zalecamy skonfigurowanie określonej listy dozwolonych źródeł w zasobie Mapowanie konta w celu ograniczenia nadużyć renderowania i regularnego odnawiania tokenu SAS.
Typ:
apiKey
W:
header
Przykłady
Successfully retrieve a route between an origin and a destination with additional parameters in the body
Przykładowe żądanie
POST https://atlas.microsoft.com/route/directions?api-version=2025-01-01
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.201399,
47.608678
],
"type": "Point"
},
"properties": {
"pointIndex": 0,
"pointType": "waypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.20687,
47.612002
],
"type": "Point"
},
"properties": {
"pointIndex": 1,
"pointType": "viaWaypoint"
}
},
{
"type": "Feature",
"geometry": {
"coordinates": [
-122.201669,
47.615076
],
"type": "Point"
},
"properties": {
"pointIndex": 2,
"pointType": "waypoint"
}
}
],
"optimizeRoute": "fastestWithTraffic",
"routeOutputOptions": [
"routePath"
],
"maxRouteCount": 3,
"travelMode": "driving"
}
Przykładowa odpowiedź
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20147,
47.60868
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 0
},
"order": {
"inputIndex": 0
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.2016,
47.61508
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 64
},
"order": {
"inputIndex": 2
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": [
[
[
-122.20147,
47.60868
],
[
-122.20148,
47.60884
],
[
-122.20148,
47.60906
],
[
-122.20148,
47.60919
],
[
-122.20148,
47.60953
],
[
-122.20148,
47.60967
],
[
-122.20149,
47.60997
],
[
-122.2015,
47.61011
],
[
-122.2015,
47.61019
],
[
-122.20192,
47.61021
],
[
-122.20199,
47.61021
],
[
-122.20252,
47.61019
],
[
-122.20264,
47.61018
],
[
-122.20271,
47.61015
],
[
-122.20276,
47.61015
],
[
-122.20281,
47.61015
],
[
-122.20286,
47.61015
],
[
-122.20329,
47.61016
],
[
-122.20346,
47.61016
],
[
-122.20414,
47.61017
],
[
-122.20416,
47.61057
],
[
-122.20418,
47.61083
],
[
-122.20418,
47.61092
],
[
-122.20419,
47.61103
],
[
-122.20419,
47.61121
],
[
-122.2042,
47.61126
],
[
-122.20478,
47.61127
],
[
-122.20555,
47.61128
],
[
-122.20569,
47.61128
],
[
-122.20596,
47.61128
],
[
-122.20617,
47.61127
],
[
-122.20624,
47.61125
],
[
-122.2066,
47.61126
],
[
-122.20669,
47.61127
],
[
-122.20686,
47.61129
],
[
-122.20687,
47.61158
],
[
-122.20689,
47.61187
],
[
-122.20691,
47.61233
],
[
-122.20691,
47.61247
],
[
-122.20694,
47.61317
],
[
-122.20695,
47.61342
],
[
-122.20696,
47.61362
],
[
-122.20697,
47.61384
],
[
-122.20683,
47.61384
],
[
-122.20638,
47.61384
],
[
-122.20612,
47.61384
],
[
-122.20568,
47.61383
],
[
-122.20559,
47.6138
],
[
-122.20467,
47.61379
],
[
-122.20443,
47.61379
],
[
-122.20405,
47.61379
],
[
-122.20325,
47.6138
],
[
-122.203,
47.6138
],
[
-122.20274,
47.6138
],
[
-122.20241,
47.61381
],
[
-122.20222,
47.6138
],
[
-122.20202,
47.6138
],
[
-122.20193,
47.6138
],
[
-122.20181,
47.61386
],
[
-122.20167,
47.61386
],
[
-122.20155,
47.61386
],
[
-122.20158,
47.61464
],
[
-122.20159,
47.61475
],
[
-122.2016,
47.61503
],
[
-122.2016,
47.61508
]
]
]
},
"properties": {
"distanceInMeters": 1520,
"durationInSeconds": 307,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:13:10+00:00",
"durationTrafficInSeconds": 300,
"trafficCongestion": "Medium",
"type": "RoutePath",
"legs": [
{
"distanceInMeters": 1520,
"durationInSeconds": 307,
"durationTrafficInSeconds": 300,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:13:10+00:00",
"routePathRange": {
"legIndex": 0,
"range": [
0,
64
]
}
}
]
},
"bbox": [
-122.20697,
47.60868,
-122.20147,
47.61508
]
}
],
"alternativeRoutes": [
{
"type": "FeatureCollection",
"features": [
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.20147,
47.60868
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 0
},
"order": {
"inputIndex": 0
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
-122.2016,
47.61508
]
},
"properties": {
"routePathPoint": {
"legIndex": 0,
"pointIndex": 29
},
"order": {
"inputIndex": 1
},
"type": "Waypoint"
}
},
{
"type": "Feature",
"geometry": {
"type": "MultiLineString",
"coordinates": [
[
[
-122.20147,
47.60868
],
[
-122.20148,
47.60884
],
[
-122.20148,
47.60906
],
[
-122.20148,
47.60919
],
[
-122.20148,
47.60953
],
[
-122.20148,
47.60967
],
[
-122.20149,
47.60997
],
[
-122.2015,
47.61011
],
[
-122.2015,
47.61019
],
[
-122.20151,
47.61072
],
[
-122.20152,
47.61092
],
[
-122.20152,
47.61097
],
[
-122.20149,
47.611
],
[
-122.20147,
47.61104
],
[
-122.20145,
47.61117
],
[
-122.20145,
47.61122
],
[
-122.20145,
47.61126
],
[
-122.20146,
47.61149
],
[
-122.20147,
47.61166
],
[
-122.20148,
47.61197
],
[
-122.20148,
47.61203
],
[
-122.2015,
47.61268
],
[
-122.20151,
47.61289
],
[
-122.20152,
47.61297
],
[
-122.20153,
47.61338
],
[
-122.20155,
47.61386
],
[
-122.20158,
47.61464
],
[
-122.20159,
47.61475
],
[
-122.2016,
47.61503
],
[
-122.2016,
47.61508
]
]
]
},
"properties": {
"distanceInMeters": 713,
"durationInSeconds": 92,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:09:40+00:00",
"durationTrafficInSeconds": 90,
"trafficCongestion": "Medium",
"type": "RoutePath",
"legs": [
{
"distanceInMeters": 713,
"durationInSeconds": 92,
"durationTrafficInSeconds": 90,
"departureAt": "2025-06-17T09:08:10+00:00",
"arrivalAt": "2025-06-17T09:09:40+00:00",
"routePathRange": {
"legIndex": 0,
"range": [
0,
29
]
}
}
]
},
"bbox": [
-122.2016,
47.60868,
-122.20145,
47.61508
]
}
]
}
]
}
Definicje
| Nazwa | Opis |
|---|---|
| Address |
Okręg administracyjny i region kraju dla punktów trasy i punktów manewrowych na trasie. |
|
Admin |
Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie. |
|
Adr |
Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych. |
|
Avoid |
Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas wyznaczania trasy. Opcja Avoid obsługuje wiele wartości w żądaniu i jest obsługiwana tylko w przypadku trybu jazdy i jazdy ciężarówki. Przykład: "unikać": ["limitedAccessHighways", "tollRoads"] |
|
Country |
Reprezentuje kraj lub region zawierający powiązane szczegóły. |
|
Directions |
Ten obiekt jest treścią żądania. |
|
Driving |
Wskazuje lewą i prawą stronę jazdy w punkcie manewru. |
|
Feature |
|
|
Features |
Obiekt funkcji GeoJSON, który zawiera obiekt Geometry i dodatkowe właściwości trasy. |
|
Features |
Określa typ |
|
Feature |
Określa typ |
|
Geo |
Prawidłowy typ geometrii |
|
Input |
Określa wejściowy obiekt obiektu funkcji waypoint i viaWaypoint |
|
Input |
Określa właściwości punktu trasy, który jest określonym miejscem lub punktem na trasie lub podróży, który służy jako punkt odniesienia lub punktu zatrzymania. |
|
Input |
Typ punktu trasy na trasie. Może to być przystanek lub lokalizacja pośrednia, przez którą musi przebiegać trasa. |
| Instruction |
Opis manewru w zestawie kierunków. |
| Leg |
Informacje o odcinku trasy między dwoma punktami trasy. Więcej informacji o polach zawartych w odcinku trasy: |
|
Maneuver |
Określa instrukcje jazdy i dodatkowe właściwości dla każdego punktu manewru na odcinku trasy. |
|
Maneuver |
Rodzaj manewru opisany w tym szczegółowym zbiorze. Typ manewru dostarcza informacji o części manewru określonej przez odpowiednią instrukcję. Na przykład maneuverType instrukcji może określać TurnLeftThenTurnRight, podczas gdy skojarzone elementy szczegółów mogą zawierać szczegółowe informacje na temat manewrów TurnLeft i TurnRight |
|
Maps |
Szczegóły błędu. |
|
Maps |
Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. |
|
Maps |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
Multi |
Określa obiekt geometrii |
|
Optimized |
Zoptymalizowany obiekt punktu drogi. |
| Order |
Sekwencja odwiedzania punktów trasy. |
|
Point |
Punkt początkowy został przekazany jako prawidłowy obiekt geometrii
|
|
Route |
Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym. Przykład: "optimizeRoute":"najkrótszy" |
|
Route |
Ten obiekt jest zwracany z pomyślnego wywołania. |
|
Route |
Określa atrybuty pojazdu, takie jak rozmiar, masa, prędkość maksymalna, rodzaj ładunku itp., tylko dla tras dla ciężarówek. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu. IS: |
|
Route |
Dołącz żądane informacje o trasie z odpowiedzi. Domyślnie plan podróży jest uwzględniony w odpowiedzi. Obsługuje wiele wartości, takich jak "routeOutputOptions": ["routePath", "itinerary"] |
|
Route |
Odnosi się do indeksu punktu w obrębie określonego odcinka trasy. |
|
Route |
Określa właściwości opisujące ścieżkę trasy w odpowiedzi. |
|
Route |
Odnosi się do zakresu pokonywanego przez określony odcinek trasy lub ścieżki. |
|
Route |
Tryb podróży dla ścieżki trasy w odpowiedzi. |
|
Side |
Strona ulicy, po której znajduje się miejsce docelowe, na podstawie kierunku przyjazdu. To pole ma zastosowanie tylko do ostatniego manewruPoint. |
| Step |
Odcinek trasy zawiera szczegółowe instrukcje. Krok odnosi się do zakresu trasy między dwoma kolejnymi punktami manewru. |
|
Traffic |
Poziom natężenia ruchu na trasie.
|
|
Travel |
Tryb podróży dla żądanej trasy. Jeśli nie zostanie zdefiniowana, wartością domyślną jest "jazda", która zwraca trasę zoptymalizowaną pod kątem samochodów.
Przykład: "travelMode":"jazda" |
|
Vehicle |
Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu. |
|
Waypoint |
Określa właściwości punktu trasy, który jest określonym miejscem lub punktem na trasie lub podróży, który służy jako punkt odniesienia lub punktu zatrzymania. |
Address
Okręg administracyjny i region kraju dla punktów trasy i punktów manewrowych na trasie.
| Nazwa | Typ | Opis |
|---|---|---|
| adminDistricts |
Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie. |
|
| countryRegion |
Reprezentuje kraj lub region zawierający powiązane szczegóły. |
AdminDistrict
Nazwa poddziału w kraju lub regionie dla adresu. Ten element jest zwykle traktowany jako podsieć administracyjna pierwszego zamówienia, ale w niektórych przypadkach zawiera również drugą, trzecią lub czwartą podział kolejności w kraju, zależności lub regionie.
| Nazwa | Typ | Opis |
|---|---|---|
| shortName |
string |
Krótka nazwa odpowiedniego pola adminDistrict, For adminDistrict[0], może to być krótka nazwa stanu, taka jak WA. Ta funkcja jest dostępna tylko w Stanach Zjednoczonych, Kanadzie i Meksyku. |
AdrTunnelRestrictionCodeEnum
Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych.
| Wartość | Opis |
|---|---|
| B |
Pojazdy o kodzie B mają zakaz wjazdu na drogi z tunelami ADR kategorii B, C, D i E. |
| C |
Pojazdy o kodzie C nie mogą wjeżdżać na drogi z tunelami kategorii C, D i E ADR |
| D |
Pojazdy o kodzie D nie mogą wjeżdżać na drogi z tunelami ADR kategorii D i E. |
| E |
Pojazdy o kodzie E mają zakaz wjazdu na drogi z tunelem ADR kategorii E. |
AvoidEnum
Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas wyznaczania trasy. Opcja Avoid obsługuje wiele wartości w żądaniu i jest obsługiwana tylko w przypadku trybu jazdy i jazdy ciężarówki.
Przykład: "unikać": ["limitedAccessHighways", "tollRoads"]
| Wartość | Opis |
|---|---|
| limitedAccessHighways |
Unika korzystania z autostrad o ograniczonym dostępie na trasie. |
| tollRoads |
Unika korzystania z dróg płatnych na trasie. |
| ferries |
Unika korzystania z promów na trasie. |
| tunnels |
Unika korzystania z tuneli na trasie. |
| borderCrossings |
Unika przekraczania granic państwowych na trasie. |
| lowEmissionZones |
Omija strefy niskoemisyjne na trasie. |
| unpavedRoads |
Omija na trasie drogi nieutwardzone. |
CountryRegion
Reprezentuje kraj lub region zawierający powiązane szczegóły.
| Nazwa | Typ | Opis |
|---|---|---|
| ISO |
string |
ISO kraju/regionu reprezentuje kod regionu/kraju zgodny z normą ISO 3166-1 Alpha-2 |
| name |
string |
nazwa kraju/regionu |
DirectionsRequest
Ten obiekt jest treścią żądania.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| arriveAt |
string (date-time) |
Data i godzina przybycia do punktu docelowego sformatowana jako Nie można użyć parametru Przykład: "arriveAt": "2023-06-01T09:30:00.000-07:00" |
|
| avoid |
Określa ograniczenia, które powinny być uwzględniane przy obliczaniu trasy podczas wyznaczania trasy. Opcja Avoid obsługuje wiele wartości w żądaniu i jest obsługiwana tylko w przypadku trybu jazdy i jazdy ciężarówki. Przykład: "unikać": ["limitedAccessHighways", "tollRoads"] |
||
| departAt |
string (date-time) |
Data i godzina wyjazdu z punktu początkowego sformatowana jako Jeśli wartość nie Example: "departAt": "2023-06-01T09:30:00.000-07:00" |
|
| features |
Trasy dla kierowców, pieszych i ciężarówek są definiowane przez zestaw punktów trasy (przystanków) i viaWaypoints (lokalizacji pośrednich, przez które musi przebiegać trasa). Możesz mieć maksymalnie 150 punktów trasy i maksymalnie 10 punktów via Waypoints między każdym zestawem punktów trasy. Trasa musi mieć co najmniej 2 punkty trasy, a punkty początkowe i końcowe trasy nie mogą być punktami trasy. Zarówno lokalizacje punktów trasy, jak i viaWaypoint muszą być określone jako prawidłowy obiekt funkcji GeoJSON Point wraz z parametrem pointIndex, który określa kolejność lokalizacji. Aby uzyskać więcej informacji na temat formatu GeoJSON, zobacz RFC 7946. |
||
| heading |
integer (int64) minimum: 0maximum: 359 |
Początkowy kierunek pojazdu w stopniach, rozpoczynający się na północy rzeczywistej i kontynuujący w kierunku zgodnym z ruchem wskazówek zegara. Północ jest 0 stopni, wschód jest 90 stopni, południe jest 180 stopni, zachód jest 270 stopni. |
|
| maxRouteCount |
integer (int64) minimum: 1maximum: 6 |
Maksymalna liczba tras do zwrócenia. Dostępne dla trybów jazdy i jazdy samochodem ciężarowym. Domyślnie: "maxRouteCount":1 |
|
| optimizeRoute | fastestWithoutTraffic |
Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym. Przykład: "optimizeRoute":"najkrótszy" |
|
| optimizeWaypointOrder |
boolean |
False |
Zmień kolejność punktów trasy za pomocą szybkiego algorytmu heurystycznego, aby zmniejszyć koszt trasy określony za pomocą parametru optimize. Punkt początkowy i docelowy są wykluczone ze zoptymalizowanego punktu trasy, a ich pozycja jest uważana za stałą. Dopuszczalne wartości to prawda lub fałsz. |
| routeOutputOptions | [ "itinerary" ] |
Dołącz żądane informacje o trasie z odpowiedzi. Domyślnie plan podróży jest uwzględniony w odpowiedzi. Obsługuje wiele wartości, takich jak "routeOutputOptions": ["routePath", "itinerary"] |
|
| travelMode | driving |
Tryb podróży dla żądanej trasy. Jeśli nie zostanie zdefiniowana, wartością domyślną jest "jazda", która zwraca trasę zoptymalizowaną pod kątem samochodów.
Przykład: "travelMode":"jazda" |
|
| type |
Określa typ |
||
| vehicleSpec |
Określa atrybuty pojazdu, takie jak rozmiar, masa, prędkość maksymalna, rodzaj ładunku itp., tylko dla tras dla ciężarówek. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu.
|
DrivingSideEnum
Wskazuje lewą i prawą stronę jazdy w punkcie manewru.
| Wartość | Opis |
|---|---|
| Left |
Jazda po lewej stronie. |
| Right |
Jazda po prawej stronie. |
FeatureCollection
GeoJSON
FeatureCollection , który zawiera listę obiektów. Aby uzyskać więcej informacji, zobacz RFC 7946, sekcja 3.3.
| Nazwa | Typ | Opis |
|---|---|---|
| features |
|
|
| type |
Określa typ |
FeaturesItem
Obiekt funkcji GeoJSON, który zawiera obiekt Geometry i dodatkowe właściwości trasy.
| Nazwa | Typ | Opis |
|---|---|---|
| bbox |
number[] (double) |
Prostokątny obszar na ziemi zdefiniowany jako obiekt pola ograniczenia. Boki prostokątów są definiowane przez wartości szerokości i długości geograficznej. Aby uzyskać więcej informacji, zobacz RFC 7946, sekcja 5. Przykład: "bbox": [-10.0, -10.0, 10.0, 10.0] |
| geometry | RouteDirectionsGeometry: |
Prawidłowy |
| properties | FeatureProperties: |
Określa właściwości elementów trasy, takie jak trasa, odcinki i geometria trasy, podsumowanie podróży. |
| type |
Określa typ |
FeaturesItemTypeEnum
Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest Funkcja. Aby uzyskać więcej informacji, zobacz RFC 7946.
| Wartość | Opis |
|---|---|
| Feature |
Określa typ obiektu funkcji |
FeatureTypeEnum
Określa typ GeoJSON. Jedynym obsługiwanym typem obiektu jest FeatureCollection. Aby uzyskać więcej informacji, zobacz RFC 7946.
| Wartość | Opis |
|---|---|
| FeatureCollection |
Określa typ obiektu |
GeoJsonPoint
Prawidłowy typ geometrii GeoJSON Point. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Określa typ |
InputWaypointFeaturesItem
Określa wejściowy obiekt obiektu funkcji waypoint i viaWaypoint GeoJSON oraz dodatkowe właściwości. Aby uzyskać więcej informacji, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| geometry | GeoJsonPoint: |
Prawidłowy typ geometrii |
| properties |
Określa właściwości punktu trasy, który jest określonym miejscem lub punktem na trasie lub podróży, który służy jako punkt odniesienia lub punktu zatrzymania. |
|
| type |
Określa typ |
InputWaypointProperties
Określa właściwości punktu trasy, który jest określonym miejscem lub punktem na trasie lub podróży, który służy jako punkt odniesienia lub punktu zatrzymania.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| pointIndex |
integer (int64) |
Zidentyfikuj i uporządkuj sekwencję punktów trasy na trasie. Wartością |
|
| pointType | waypoint |
Typ punktu trasy na trasie. Może to być przystanek lub lokalizacja pośrednia, przez którą musi przebiegać trasa. |
InputWaypointTypeEnum
Typ punktu trasy na trasie. Może to być przystanek lub lokalizacja pośrednia, przez którą musi przebiegać trasa.
| Wartość | Opis |
|---|---|
| waypoint |
Punkt trasy to określone miejsce lub punkt na trasie lub podróży, który służy jako punkt odniesienia lub postoju. |
| viaWaypoint |
ViaWaypoint to konkretny punkt trasy, przez który należy przejść lub który należy odwiedzić na trasie lub podróży. |
Instruction
Opis manewru w zestawie kierunków.
| Nazwa | Typ | Opis |
|---|---|---|
| drivingSide |
Wskazuje lewą i prawą stronę jazdy w punkcie manewru. |
|
| formattedText |
string |
Sformatowany opis tekstowy instrukcji. |
| maneuverType |
Rodzaj manewru opisany w tym szczegółowym zbiorze. Typ manewru dostarcza informacji o części manewru określonej przez odpowiednią instrukcję. Na przykład maneuverType instrukcji może określać TurnLeftThenTurnRight, podczas gdy skojarzone elementy szczegółów mogą zawierać szczegółowe informacje na temat manewrów TurnLeft i TurnRight |
|
| text |
string |
Opis instrukcji w postaci zwykłego tekstu. |
Leg
Informacje o odcinku trasy między dwoma punktami trasy. Więcej informacji o polach zawartych w odcinku trasy:
| Nazwa | Typ | Opis |
|---|---|---|
| arrivalAt |
string (date-time) |
Szacowany czas przybycia na odcinek, który uwzględnia warunki ruchu, jest sformatowany jako wartość dateTime zdefiniowana w specyfikacji RFC 3339, sekcja 5.6. Będzie odwoływać się do przesunięcia strefy czasowej o jeden lub |
| departureAt |
string (date-time) |
Szacowany czas odjazdu odcinka, który uwzględnia warunki ruchu, jest sformatowany jako wartość dateTime zdefiniowana w dokumencie RFC 3339, sekcja 5.6. Będzie odwoływać się do przesunięcia strefy czasowej o jeden lub |
| distanceInMeters |
number |
Fizyczna odległość w metrach pokonana przez odcinek trasy. |
| durationInSeconds |
integer (int64) |
Szacowany czas podróży w sekundach, który nie obejmuje opóźnień na trasie spowodowanych warunkami drogowymi. |
| durationTrafficInSeconds |
integer (int64) |
Czas potrzebny na przebycie w sekundach odpowiada aktualnym |
| routePathRange |
Odnosi się do zakresu pokonywanego przez określony odcinek trasy lub ścieżki. |
ManeuverPointProperties
Określa instrukcje jazdy i dodatkowe właściwości dla każdego punktu manewru na odcinku trasy.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| address |
Okręg administracyjny i region kraju dla punktów trasy i punktów manewrowych na trasie. |
||
| distanceInMeters |
number |
Fizyczna odległość w metrach pokonana przez ten krok trasy. |
|
| durationInSeconds |
integer (int64) |
Czas potrzebny na przebycie odpowiedniego |
|
| exitIdentifier |
string |
Nazwa lub numer wyjścia skojarzonego z tym krokiem trasy. |
|
| instruction |
Opis manewru w zestawie kierunków. |
||
| order |
Sekwencja odwiedzania punktów trasy. |
||
| routePathPoint |
Odnosi się do indeksu punktu w obrębie określonego odcinka trasy. |
||
| sideOfStreet |
Strona ulicy, po której znajduje się miejsce docelowe, na podstawie kierunku przyjazdu. To pole ma zastosowanie tylko do ostatniego manewruPoint. |
||
| signs |
string[] |
Tekst oznakowania trasy. Może istnieć więcej niż jedna wartość znaku. |
|
| steps |
Step[] |
Kroki między dwoma kolejnymi punktami manewru. |
|
| towardsRoadName |
string |
Nazwa ulicy, do której prowadzi trasa w pierwszym |
|
| travelMode | driving |
Tryb podróży dla ścieżki trasy w odpowiedzi. |
|
| type |
string:
Maneuver |
Typ wyjścia. |
ManeuverTypeEnum
Rodzaj manewru opisany w tym szczegółowym zbiorze. Typ manewru dostarcza informacji o części manewru określonej przez odpowiednią instrukcję. Na przykład maneuverType instrukcji może określać TurnLeftThenTurnRight, podczas gdy skojarzone elementy szczegółów mogą zawierać szczegółowe informacje na temat manewrów TurnLeft i TurnRight
| Wartość | Opis |
|---|---|
| ArriveFinish |
Przyjazd do miejsca docelowego. |
| ArriveIntermediate |
Przyjedź do pośredniego punktu trasy. |
| BearLeft |
Niedźwiedź w lewo. |
| BearLeftThenBearLeft |
Niedźwiedź w lewo, a potem znowu w lewo. |
| BearLeftThenBearRight |
Skręć w lewo, a następnie w prawo. |
| BearLeftThenTurnLeft |
Skręć w lewo, a następnie skręć w lewo. |
| BearLeftThenTurnRight |
Skręć w lewo, a następnie w prawo. |
| BearRight |
Niedźwiedź w prawo. |
| BearRightThenBearLeft |
Skręć w prawo, a następnie w lewo. |
| BearRightThenBearRight |
Skręć w prawo, a potem znowu w prawo. |
| BearRightThenTurnLeft |
Skręć w prawo, a następnie skręć w lewo. |
| BearRightThenTurnRight |
Skręć w prawo, a następnie skręć w prawo. |
| BearThenKeep |
Niedźwiedź instrukcję, a następnie instrukcję keep |
| BearThenMerge |
Instrukcja Bear, a następnie instrukcja scalania. |
| Continue |
Kontynuuj bieżącą drogę. |
| DepartIntermediateStop |
Opuść pośredni punkt trasy w innym kierunku i na innej drodze niż ta, na którą przyjechałeś. |
| DepartIntermediateStopReturning |
Opuść pośredni punkt trasy w tym samym kierunku i na tej samej drodze, na której przyjechałeś. |
| DepartStart |
Opuść punkt początkowy. |
| EnterRoundabout |
Wjedź na rondo. |
| ExitRoundabout |
Zjedź z ronda. |
| EnterThenExitRoundabout |
Wjazd i wyjazd z ronda. |
| ExitRoundaboutRight |
Na rondzie wyjdź z prawej strony. |
| ExitRoundaboutLeft |
Na rondzie zajmij się wyjściem po lewej stronie. |
| Follow |
Follow. |
| GoAroundRoundabout |
Chodź po rondzie. |
| KeepLeft |
Trzymaj się lewej strony na inną drogę. |
| KeepOnRampLeft |
Trzymaj się lewej strony i kontynuuj na rampie. |
| KeepOnRampRight |
Trzymaj się prawej strony i jedź dalej na rampę. |
| KeepOnRampStraight |
Trzymaj się prosto i kontynuuj na rampie. |
| KeepRight |
Trzymaj się prawej strony na innej drodze. |
| KeepStraight |
Jedź prosto na inną drogę. |
| KeepToStayLeft |
Trzymaj się lewej strony, aby pozostać na tej samej drodze. |
| KeepToStayRight |
Trzymaj się prawej strony, aby pozostać na tej samej drodze. |
| KeepToStayStraight |
Trzymaj się prosto, aby pozostać na tej samej drodze. |
| MergeFreeway |
Wjedź na autostradę. |
| MergeHighway |
Wjedź na autostradę. |
| MergeMotorway |
Wjedź na autostradę. |
| MotorwayExitLeft |
Wyjdź z lewego wyjścia. |
| MotorwayExitRight |
Wyjdź z prawej strony. |
| None |
Brak instrukcji. |
| RampThenHighwayLeft |
Skręć w lewo w autostradę. Jest to część połączonej instrukcji. |
| RampThenHighwayRight |
Skręć w prawo w autostradę. Jest to część połączonej instrukcji. |
| RampThenHighwayStraight |
Trzymaj się prosto, aby skręcić w rampę na autostradę. Jest to część połączonej instrukcji. |
| RoadNameChange |
Zmiany nazw dróg. |
| SwitchToParallelRoad |
Przełącz się na równoległą drogę. |
| SwitchToMainRoad |
Przejdź do głównej drogi. |
| Take |
Idź drogą. Ta instrukcja jest używana podczas wchodzenia lub wychodzenia z promu. |
| TakeFerry |
Weź prom. |
| TakeExit |
Weź wyjście. |
| TakeRamp |
Zjedź na rampę. |
| TakeRampLeft |
Skręć w rampę w lewo. |
| TakeRampRight |
Skręć w rampę w prawo. |
| TakeRampStraight |
Trzymaj się prosto, aby wjechać na rampę. |
| TurnBack |
Zawróć ostro. |
| TurnLeft |
Skręć w lewo. |
| TurnLeftSharp |
Skręć ostro w lewo. |
| TurnLeftThenBearLeft |
Skręć w lewo, a następnie skręć w lewo. |
| TurnLeftThenBearRight |
Skręć w lewo, a następnie skręć w prawo. |
| TurnLeftThenTurnLeft |
Skręć w lewo, a następnie ponownie w lewo. |
| TurnLeftThenTurnRight |
Skręć w lewo, a następnie w prawo. |
| TurnRight |
Skręć w prawo. |
| TurnRightSharp |
Skręć ostro w prawo. |
| TurnRightThenBearLeft |
Skręć w prawo, a następnie skręć w lewo. |
| TurnRightThenBearRight |
Skręć w prawo, a następnie skręć w prawo. |
| TurnRightThenTurnLeft |
Skręć w prawo, a następnie w lewo. |
| TurnRightThenTurnRight |
Skręć w prawo, a następnie ponownie w prawo |
| TurnThenMerge |
Turn instrukcja, po której następuje instrukcja scalania. |
| TurnToStayLeft |
Skręć w lewo, aby pozostać na tej samej drodze. |
| TurnToStayRight |
Skręć w prawo, aby pozostać na tej samej drodze. |
| Unknown |
Instrukcja nie jest znana. |
| UTurn |
Zawróć, aby pojechać w przeciwnym kierunku. |
| Wait |
Wait |
| Walk |
Walk |
MapsErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
| details |
Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu. |
|
| innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
|
| message |
string |
Czytelna dla człowieka reprezentacja błędu. |
| target |
string |
Element docelowy błędu. |
MapsErrorResponse
Typowa odpowiedź na błędy interfejsów API usługi Azure Maps w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem.
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Szczegóły błędu. |
MapsInnerError
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
| Nazwa | Typ | Opis |
|---|---|---|
| code |
string |
Kod błędu. |
| innererror |
Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie. |
MultiLineStringGeometry
Określa obiekt geometrii GeoJSON MultiLineString. Aby uzyskać więcej informacji, zobacz RFC 7946.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
Współrzędne geometrii |
| type |
string:
Multi |
Określa typ geometrii obiektu |
OptimizedWaypoint
Zoptymalizowany obiekt punktu drogi.
| Nazwa | Typ | Opis |
|---|---|---|
| inputIndex |
integer (int64) |
Indeks punktu drogi udostępniany przez użytkownika. |
| optimizedIndex |
integer (int64) |
Zoptymalizowany indeks punktów z systemu. |
Order
Sekwencja odwiedzania punktów trasy.
| Nazwa | Typ | Opis |
|---|---|---|
| inputIndex |
integer (int64) |
Indeks dostarczony przez użytkownika dla punktu trasy |
| optimizedIndex |
integer (int64) |
Punkt trasy zoptymalizowany pod kątem systemu |
PointGeometry
Punkt początkowy został przekazany jako prawidłowy obiekt geometrii GeoJSON, z którego ma zostać obliczony wielokąt zakresu. Aby uzyskać szczegółowe informacje, zobacz RFC 7946.
Note: interfejs API przyciągnie żądany punkt początkowy do najbliższej sieci drogowej i użyje go do obliczenia zakresu. Zostanie on zwrócony jako punkt center w odpowiedzi.
| Nazwa | Typ | Opis |
|---|---|---|
| coordinates |
number[] (double) |
|
| type |
string:
Point |
Określa typ geometrii obiektu |
RouteDirectionOptimizeRouteEnum
Określa parametr, który ma być używany do optymalizacji trasy. Jeśli nie zostanie zdefiniowana, wartość domyślna to "fastestWithoutTraffic", która zwraca trasę w celu zminimalizowania czasu podróży bez korzystania z bieżących informacji o ruchu drogowym.
Przykład: "optimizeRoute":"najkrótszy"
| Wartość | Opis |
|---|---|
| short |
Trasa jest obliczana tak, aby zrównoważyć czas szybkiej podróży i krótki dystans, a nie tylko jedną. Jest zoptymalizowany zarówno pod kątem szybkości, jak i wydajności. Informacje o ruchu drogowym nie są używane. |
| shortest |
Trasa jest obliczana tak, aby zminimalizować odległość. Informacje o ruchu drogowym nie są używane. |
| fastestWithoutTraffic |
Znajduje najszybszą trasę bez uwzględniania informacji o ruchu drogowym. |
| fastestWithTraffic |
Trasa jest obliczana tak, aby zminimalizować czas na podstawie aktualnych informacji o ruchu drogowym.
|
RouteDirectionsResponse
Ten obiekt jest zwracany z pomyślnego wywołania.
| Nazwa | Typ | Opis |
|---|---|---|
| alternativeRoutes |
Alternatywna trasa. |
|
| features |
|
|
| type |
Określa typ |
RouteDirectionVehicleSpec
Określa atrybuty pojazdu, takie jak rozmiar, masa, prędkość maksymalna, rodzaj ładunku itp., tylko dla tras dla ciężarówek. Pomaga to uniknąć niskich prześwitów od mostów, ograniczeń drogowych, trudnych skrętów w prawo, aby zapewnić zoptymalizowaną trasę ciężarówki w oparciu o specyfikacje pojazdu.
IS:Note Obsługiwane tylko w przypadku trybu jazdy ciężarówki.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| adrTunnelRestrictionCode |
Kod ograniczenia tunelu ADR. ADR to europejska umowa dotycząca międzynarodowego przewozu drogowego towarów niebezpiecznych. Kod ograniczenia tunelu ADR służy do określenia, czy pojazd może przejechać przez tunel z ograniczeniami dotyczącymi przewozu towarów niebezpiecznych. |
||
| axleCount |
integer (int64) |
Liczba osi w pojeździe. |
|
| axleWeight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Waga na oś pojazdu w kg. Wartość 0 oznacza, że ograniczenia wagi na oś nie są brane pod uwagę. |
| height |
number (double) minimum: 0maximum: 1000000 |
0 |
Wysokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia wysokości nie są brane pod uwagę. |
| isVehicleCommercial |
boolean |
False |
Czy pojazd jest używany do celów komercyjnych. Pojazdy komercyjne mogą nie być dozwolone do jazdy na niektórych drogach. |
| length |
number (double) minimum: 0maximum: 1000000 |
0 |
Długość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia długości nie są brane pod uwagę. |
| loadType |
Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu. |
||
| maxSpeed |
integer (int64) minimum: 0maximum: 250 |
0 |
Maksymalna prędkość pojazdu w km/godzinę. Maksymalna prędkość w profilu pojazdu służy do sprawdzania, czy pojazd jest dozwolony na autostradach. Wartość 0 oznacza, że odpowiednia wartość dla pojazdu zostanie określona i zastosowana podczas planowania tras. Wartość niezerowa może zostać zastąpiona podczas planowania trasy. Na przykład bieżący przepływ ruchu wynosi 60 km/godzinę. Jeśli maksymalna prędkość pojazdu wynosi 50 km/godzinę, silnik rozsyłania rozważy 60 km/godzinę, ponieważ jest to bieżąca sytuacja. Jeśli maksymalna prędkość pojazdu wynosi 80 km/godzinę, ale bieżący przepływ ruchu wynosi 60 km/godzinę, silnik routingu ponownie użyje 60 km/godzinę. |
| weight |
integer (int64) minimum: 0maximum: 1000000 |
0 |
Waga pojazdu w kilogramach. Wartość 0 oznacza, że ograniczenia wagowe nie są brane pod uwagę. |
| width |
number (double) minimum: 0maximum: 1000000 |
0 |
Szerokość pojazdu w metrach. Wartość 0 oznacza, że ograniczenia szerokości nie są brane pod uwagę. |
RouteOutputOptionEnum
Dołącz żądane informacje o trasie z odpowiedzi. Domyślnie plan podróży jest uwzględniony w odpowiedzi.
Obsługuje wiele wartości, takich jak "routeOutputOptions": ["routePath", "itinerary"]
| Wartość | Opis |
|---|---|
| routeSummary |
Podaj tylko czas i odległość podróży dla trasy i nie podawaj innych informacji. |
| routePath |
Dołącz do odpowiedzi dokument GeoJSON MultiLineString RFC 7946, sekcja 3.1.5 , który opisuje ścieżkę trasy. |
| itinerary |
Dołącz szczegółowe wskazówki w odpowiedzi. Szczegółowe wskazówki są dostarczane jako "Punkty manewrowe" i zawierają szczegóły, takie jak instrukcje zakręt po zakręcie. |
RoutePathPoint
Odnosi się do indeksu punktu w obrębie określonego odcinka trasy.
| Nazwa | Typ | Opis |
|---|---|---|
| legIndex |
integer (int64) |
Indeks odcinka trasy to kolejny numer przypisany do każdego odcinka trasy, który pomaga zidentyfikować i rozróżnić różne odcinki trasy. |
| pointIndex |
integer (int64) |
Indeks punktu w obrębie określonej nogi. |
RoutePathProperties
Określa właściwości opisujące ścieżkę trasy w odpowiedzi.
| Nazwa | Typ | Opis |
|---|---|---|
| arrivalAt |
string (date-time) |
Szacowany czas przybycia odcinka, który uwzględnia warunki ruchu, jest sformatowany jako |
| departureAt |
string (date-time) |
Szacowany czas odjazdu odcinka, który uwzględnia warunki ruchu, jest sformatowany jako |
| distanceInMeters |
number |
Fizyczny dystans w metrach pokonany przez całą trasę. |
| durationInSeconds |
integer (int64) |
Szacowany czas podróży w sekundach, który nie obejmuje opóźnień na trasie spowodowanych warunkami drogowymi. |
| durationTrafficInSeconds |
integer (int64) |
Czas potrzebny na przebycie w sekundach odpowiada aktualnym |
| legs |
Leg[] |
Tablica odcinków trasy. Aby uzyskać więcej informacji, sprawdź opis obiektu trasy. |
| optimizedWaypoints |
Zoptymalizowana sekwencja punktów drogi. Pokazuje indeks z sekwencji punktów trasy podanej przez użytkownika dla oryginalnych i zoptymalizowanych list. |
|
| trafficCongestion |
Poziom natężenia ruchu na trasie.
|
|
| type |
string:
Route |
Typ wyjścia. |
RoutePathRange
Odnosi się do zakresu pokonywanego przez określony odcinek trasy lub ścieżki.
| Nazwa | Typ | Opis |
|---|---|---|
| legIndex |
integer (int64) |
Indeks odcinka trasy to kolejny numer przypisany do każdego odcinka trasy, który pomaga zidentyfikować i rozróżnić różne odcinki trasy. |
| range |
integer[] (int64) |
Odnosi się do zakresu pokonywanego przez określony odcinek trasy lub ścieżki. |
RoutePathTravelModeEnum
Tryb podróży dla ścieżki trasy w odpowiedzi.
| Wartość | Opis |
|---|---|
| driving |
Trasy zoptymalizowane pod kątem samochodów. |
| truck |
Trasy zoptymalizowane dla samochodów ciężarowych o dużych rozmiarach w oparciu o specyfikację pojazdu. |
| walking |
Trasy zoptymalizowane dla pieszych. |
| other |
RouteTravelMode jest zwracany jako "other" dla trucka travelMode, gdy trasa ciężarówki nie jest dostępna dla określonego odcinka trasy. |
SideOfStreetEnum
Strona ulicy, po której znajduje się miejsce docelowe, na podstawie kierunku przyjazdu. To pole ma zastosowanie tylko do ostatniego manewruPoint.
| Wartość | Opis |
|---|---|
| Left |
Left. |
| Right |
Right. |
| Unknown |
Unknown. |
Step
Odcinek trasy zawiera szczegółowe instrukcje. Krok odnosi się do zakresu trasy między dwoma kolejnymi punktami manewru.
| Nazwa | Typ | Opis |
|---|---|---|
| maneuverType |
Rodzaj manewru opisany w tym szczegółowym zbiorze. Typ manewru dostarcza informacji o części manewru określonej przez odpowiednią instrukcję. Na przykład maneuverType instrukcji może określać TurnLeftThenTurnRight, podczas gdy skojarzone elementy szczegółów mogą zawierać szczegółowe informacje na temat manewrów TurnLeft i TurnRight |
|
| names |
string[] |
Ulica, autostrada lub skrzyżowanie, na którym odbywa się manewr. Jeśli manewr jest złożony, w kolekcji szczegółów może znajdować się więcej niż jedno pole nazwy. Pole nazwy może również nie mieć żadnej wartości. Może się tak zdarzyć, jeśli nazwa nie jest znana lub jeśli ulica, autostrada lub skrzyżowanie nie ma nazwy. |
| routePathRange |
Odnosi się do zakresu pokonywanego przez określony odcinek trasy lub ścieżki. |
TrafficCongestionEnum
Poziom natężenia ruchu na trasie.
Note: Obsługiwane tylko w przypadku jazdy w trybie travelMode
| Wartość | Opis |
|---|---|
| Unknown |
Unknown. |
| None |
None. |
| Mild |
Mild. |
| Medium |
Medium. |
| Heavy |
Heavy. |
TravelModeEnum
Tryb podróży dla żądanej trasy. Jeśli nie zostanie zdefiniowana, wartością domyślną jest "jazda", która zwraca trasę zoptymalizowaną pod kątem samochodów.
Note: W przypadku trybu jazdy ciężarówki żądana trasa dla ciężarówki może nie być dostępna dla całej trasy. Jeśli trasa ciężarówki nie jest dostępna dla określonej sekcji, elementem travelMode odpowiedzi dla tej sekcji będzie "other".
Przykład: "travelMode":"jazda"
| Wartość | Opis |
|---|---|
| driving |
Zwrócone trasy są zoptymalizowane pod kątem samochodów. |
| truck |
Zwracane trasy są optymalizowane dla dużych ciężarówek w oparciu o specyfikację pojazdu. |
| walking |
Zwrócone trasy są zoptymalizowane pod kątem pieszych, w tym korzystania z chodników. |
VehicleLoadTypeEnum
Typy ładunków, które mogą być klasyfikowane jako materiały niebezpieczne i ograniczone z niektórych dróg. Dostępne wartości vehicleLoadType to amerykańskie klasy materiałów niebezpiecznych od 1 do 9 oraz klasyfikacje ogólne do użytku w innych krajach. Wartości rozpoczynające się od USHazmat dotyczą routingu w USA, podczas gdy otherHazmat powinny być używane dla wszystkich innych krajów. vehicleLoadType obsługuje wiele wartości w żądaniu.
| Wartość | Opis |
|---|---|
| USHazmatClass1 |
Explosives |
| USHazmatClass2 |
Gaz sprężony |
| USHazmatClass3 |
Ciecze łatwopalne |
| USHazmatClass4 |
Substancje stałe łatwopalne |
| USHazmatClass5 |
Oxidizers |
| USHazmatClass6 |
Poisons |
| USHazmatClass7 |
Radioactive |
| USHazmatClass8 |
Corrosives |
| USHazmatClass9 |
Miscellaneous |
| otherHazmatExplosive |
Explosives |
| otherHazmatGeneral |
Miscellaneous |
| otherHazmatHarmfulToWater |
Działa szkodliwie na wodę |
WaypointProperties
Określa właściwości punktu trasy, który jest określonym miejscem lub punktem na trasie lub podróży, który służy jako punkt odniesienia lub punktu zatrzymania.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| address |
Okręg administracyjny i region kraju dla punktów trasy i punktów manewrowych na trasie. |
||
| distanceInMeters |
number |
Fizyczna odległość w metrach pokonana przez ten krok trasy. |
|
| durationInSeconds |
integer (int64) |
Czas potrzebny na przebycie odpowiedniego |
|
| exitIdentifier |
string |
Nazwa lub numer wyjścia skojarzonego z tym krokiem trasy. |
|
| instruction |
Opis manewru w zestawie kierunków. |
||
| order |
Sekwencja odwiedzania punktów trasy. |
||
| routePathPoint |
Odnosi się do indeksu punktu w obrębie określonego odcinka trasy. |
||
| sideOfStreet |
Strona ulicy, po której znajduje się miejsce docelowe, na podstawie kierunku przyjazdu. To pole ma zastosowanie tylko do ostatniego manewruPoint. |
||
| signs |
string[] |
Tekst oznakowania trasy. Może istnieć więcej niż jedna wartość znaku. |
|
| steps |
Step[] |
Kroki między dwoma kolejnymi punktami manewru. |
|
| towardsRoadName |
string |
Nazwa ulicy, do której prowadzi trasa w pierwszym |
|
| travelMode | driving |
Tryb podróży dla ścieżki trasy w odpowiedzi. |
|
| type |
string:
Waypoint |
Typ wyjścia. |