Route - Post Route Directions Batch
Tek bir zaman uyumsuz istekte Yol Tarifleri Alma API'sine bir grup sorgu göndermek için kullanın.
Post Route Directions Batch
API, tek bir zaman uyumsuz istek kullanarak Yol Tarifleri Alma API'sine toplu sorgular gönderen bir HTTP POST
isteğidir. API'yi çağırarak Route Directions Batch
zaman uyumsuz (zaman uyumsuz) veya zaman uyumlu (eşitleme) çalıştırabilirsiniz. Zaman uyumsuz API, çağıranın en fazla 700 sorguyu toplu olarak toplamasına ve API'yi 100 sorguya kadar eşitlemesine olanak tanır. API'yi Post Route Directions Batch
zaman uyumlu bir istekte çağırmak için bkz. Yol Tarifleri Sonrası Batch Eşitleme.
Zaman Uyumsuz Toplu İş İsteği Gönderme
Zaman Uyumsuz API, görece karmaşık yol isteklerinin büyük hacimlerini işlemek için uygundur
- Sonuçların ayrı bir çağrıda alınmasına izin verir (birden çok indirme mümkündür).
- Zaman uyumsuz API güvenilirlik için iyileştirilmiştir ve zaman aşımıyla karşılaşılmaması beklenmez.
- Bu API için toplu iş öğelerinin sayısı 700 ile sınırlıdır.
Zaman uyumsuz istek kullanarak istek yaptığınızda, hizmet varsayılan olarak yanıt üst bilgisinin Konum alanında yeniden yönlendirme URL'si boyunca bir 202 yanıt kodu döndürür. Yanıt verileri veya hata bilgileri sağlanana kadar bu URL düzenli aralıklarla denetlenmelidir. Zaman uyumsuz yanıtlar 14 gün boyunca depolanır. Yeniden yönlendirme URL'si, son kullanma süresinden sonra kullanılırsa bir 404 yanıtı döndürür.
Zaman uyumsuz toplu iş isteğinin uzun süre çalışan bir işlem olduğunu lütfen unutmayın. Aşağıda tipik bir işlem dizisi verilmiştir:
- İstemci, Azure Haritalar'a bir Yol Tarifleri Batch
POST
isteği gönderir.
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0&subscription-key={subscription-key}
Sunucu aşağıdakilerden biriyle yanıt verir:
HTTP
202 Accepted
- Toplu iş isteği kabul edildi.HTTP
Error
- Batch isteğiniz işlenirken bir hata oluştu. Bu bir veya başkaError
bir400 Bad Request
durum kodu olabilir.Toplu iş isteği başarıyla kabul edildiyse, yanıttaki üst bilgi toplu
Location
iş isteğinin sonuçlarını indirme URL'sini içerir. Bu durum URI'si aşağıdaki gibi görünür:
GET https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
- İstemci, toplu iş sonuçlarını indirmek için 3. Adımda alınan indirme URL'sinde bir
GET
istek gönderir.
Toplu İstek için POST Gövdesi
Yol tarifleri sorgularını göndermek için istek gövdesinin diziyi batchItems
json
biçiminde içereceği ve Content-Type
üst bilginin olarak ayarlanacağı application/json
bir POST
istek kullanacaksınız. Aşağıda 3 yol tarifi sorgusu içeren örnek bir istek gövdesi verilmiştir :
{
"batchItems": [
{ "query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false" },
{ "query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest" },
{ "query": "?query=48.923159,-122.557362:32.621279,-116.840362" }
]
}
Toplu işte yol tarifleri sorgusu protokol, temel URL, yol, api sürümü ve abonelik anahtarı olmayan kısmi bir URL'dir. Desteklenen yol tarifleriURI parametrelerinden herhangi birini kabul edebilir. Yol tarifleri sorgusundaki dize değerleri düzgün bir şekilde çıkış yapmalıdır (örneğin , " karakteri \ ile kaçış karakteri olmalıdır) ve aynı zamanda düzgün URL ile kodlanmış olmalıdır.
Zaman uyumsuz API, çağıranın en fazla 700 sorguyu toplu olarak toplamasına ve API'yi en çok 100 sorguyu eşitlemesine olanak tanır ve toplu işlem en az 1 sorgu içermelidir.
Zaman Uyumsuz Toplu İş Sonuçlarını İndirme
Zaman uyumsuz toplu iş sonuçlarını indirmek için toplu indirme uç noktasına bir GET
istek gönderirsiniz. Bu indirme URL'si başarılı POST
bir toplu iş isteğinin Location
üst bilgisinden alınabilir ve aşağıdaki gibi görünür:
https://atlas.microsoft.com/route/directions/batch/{batch-id}?api-version=1.0&subscription-key={subscription-key}
Toplu iş sonuçlarını indirmeye yönelik tipik işlem dizisi aşağıda verilmiştir:
İstemci, indirme URL'sini kullanarak bir
GET
istek gönderir.Sunucu aşağıdakilerden biriyle yanıt verir:
HTTP
202 Accepted
- Toplu iş isteği kabul edildi ancak hala işleniyor. Lütfen bir süre sonra yeniden deneyin.HTTP
200 OK
- Toplu istek başarıyla işlendi. Yanıt gövdesi tüm toplu iş sonuçlarını içerir.
Toplu Yanıt Modeli
Döndürülen veri içeriği, zaman uyumsuz ve eşitleme istekleri için benzerdir. Zaman uyumsuz toplu iş isteğinin sonuçları indirilirken, toplu iş işleme tamamlandıysa yanıt gövdesi toplu iş yanıtını içerir. Bu toplu yanıt, özgün toplu iş isteğinin totalRequests
parçası olan öğesini ve successfulRequests
örneğin başarıyla yürütülen sorguları gösteren bir summary
bileşen içerir. Toplu yanıt, toplu iş isteğindeki her sorgu için bir yanıt içeren bir dizi de içerir batchItems
. , batchItems
sonuçları, özgün sorguların toplu iş isteğinde gönderildiği sırayla tam olarak aynı sırada içerir. içindeki batchItems
her öğe ve response
alanlarını içerirstatusCode
. içindeki batchItems
her response
biri aşağıdaki türlerden biridir:
RouteDirections
- Sorgu başarıyla tamamlandıysa.Error
- Sorgu başarısız olduysa. Yanıt, bu durumda bircode
vemessage
içerir.
Aşağıda 1 başarılı ve 1 başarısız sonucu içeren örnek bir Batch Yanıtı verilmişti :
{
"summary": {
"successfulRequests": 1,
"totalRequests": 2
},
"batchItems": [
{
"statusCode": 200,
"response": {
"routes": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1758,
"travelTimeInSeconds": 387,
"trafficDelayInSeconds": 0,
"departureTime": "2018-07-17T00:49:56+00:00",
"arrivalTime": "2018-07-17T00:56:22+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 40,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 400,
"response":
{
"error":
{
"code": "400 BadRequest",
"message": "Bad request: one or more parameters were incorrectly specified or are mutually exclusive."
}
}
}
]
}
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
format
|
path | True |
Yanıtın istenen biçimi. Yalnızca |
|
api-version
|
query | True |
string |
Azure Haritalar API'sinin sürüm numarası. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
x-ms-client-id |
string |
Microsoft Entra ID güvenlik modeliyle birlikte hangi hesabın kullanıma yönelik olduğunu belirtir. Azure Haritalar hesabı için benzersiz bir kimliği temsil eder ve Azure Haritalar yönetim düzlemi Hesap API'sinden alınabilir. Azure Haritalar'da Microsoft Entra ID güvenliğini kullanmak için rehberlik için aşağıdaki makalelere bakın. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
batchItems |
İşlenmek üzere sorguların listesi. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Toplu iş isteği başarıyla işlendi. Yanıt gövdesi tüm toplu iş sonuçlarını içerir. |
|
202 Accepted |
Yalnızca zaman uyumsuz istek için desteklenir. İstek Kabul Edildi: İstek işlenmek üzere kabul edildi. Sonuçları yeniden denemek veya sonuçlara erişmek için lütfen Konum Üst Bilgisindeki URL'yi kullanın. Üst Bilgiler Location: string |
|
Other Status Codes |
Beklenmeyen bir hata oluştu. |
Güvenlik
AADToken
Bunlar Microsoft Entra OAuth 2.0 Akışlarıdır. Azure rol tabanlı erişim denetimi ile eşleştirildiğinde, Azure Haritalar REST API'lerine erişimi denetlemek için kullanılabilir. Azure rol tabanlı erişim denetimleri, bir veya daha fazla Azure Haritalar kaynak hesabına veya alt kaynağına erişim belirtmek için kullanılır. Tüm kullanıcılara, gruplara veya hizmet sorumlularına yerleşik bir rol veya Azure Haritalar REST API'leri için bir veya daha fazla izinden oluşan özel bir rol aracılığıyla erişim verilebilir.
Senaryoları uygulamak için kimlik doğrulama kavramlarını görüntülemenizi öneririz. Özetle, bu güvenlik tanımı belirli API'ler ve kapsamlar üzerinde erişim denetimi yapabilen nesneler aracılığıyla uygulamaları modellemek için bir çözüm sağlar.
Notlar
- Bu güvenlik tanımı, uygulamanın erişim istediği Azure Haritalar kaynağını belirtmek için üst bilgi kullanımını
x-ms-client-id
gerektirir. Bu, Haritalar yönetim API'sinden alınabilir.
Authorization URL
, Azure genel bulut örneğine özgüdür. Bağımsız bulutların benzersiz Yetkilendirme URL'leri ve Microsoft Entra ID yapılandırmaları vardır.
* Azure rol tabanlı erişim denetimi Azure portalı, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure yönetim düzleminden yapılandırılır.
* Azure Haritalar Web SDK'sının kullanımı, bir uygulamanın birden çok kullanım örneği için yapılandırma tabanlı kurulumuna olanak tanır.
- Microsoft kimlik platformu hakkında daha fazla bilgi için bkz. Microsoft kimlik platformuna genel bakış.
Tür:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
https://atlas.microsoft.com/.default | https://atlas.microsoft.com/.default |
subscription-key
Bu, Azure portalında Azure Haritalar hesabı oluşturduğunuzda veya PowerShell, CLI, Azure SDK'ları veya REST API kullandığınızda sağlanan paylaşılan bir anahtardır.
Bu anahtarla, tüm uygulamalar tüm REST API'lere erişebilir. Başka bir deyişle, bu anahtar, verildikleri hesapta ana anahtar olarak kullanılabilir.
Herkese açık uygulamalar için, anahtarınızın güvenli bir şekilde depolanabilmesi için Gizli istemci uygulamaları yaklaşımını kullanarak Azure Haritalar REST API'lerine erişmenizi öneririz.
Tür:
apiKey
İçinde:
query
SAS Token
Bu paylaşılan erişim imzası belirteci, Azure portal, PowerShell, CLI, Azure SDK'ları veya REST API'leri aracılığıyla Azure Haritalar kaynağındaki Sas Listeleme işleminden oluşturulur.
Bu belirteçle, tüm uygulamalar Azure rol tabanlı erişim denetimleri ve belirli bir belirtecin kullanım süresi, oranı ve bölgelerine yönelik ayrıntılı denetim ile erişim yetkisine sahip olur. Başka bir deyişle SAS Belirteci, uygulamaların erişimi paylaşılan anahtardan daha güvenli bir şekilde denetlemesine izin vermek için kullanılabilir.
Herkese açık uygulamalar için önerimiz, uygunsuz işlemeyi sınırlamak ve SAS Belirtecini düzenli olarak yenilemek için Harita hesabı kaynağında izin verilen kaynakların belirli bir listesini yapılandırmanızdır.
Tür:
apiKey
İçinde:
header
Örnekler
Successfully submit a route direction batch request
Sample request
POST https://atlas.microsoft.com/route/directions/batch/json?api-version=1.0
{
"batchItems": [
{
"query": "?query=47.639987,-122.128384:47.621252,-122.184408:47.596437,-122.332000&routeType=fastest&travelMode=car&maxAlternatives=99"
},
{
"query": "?query=47.620659,-122.348934:47.610101,-122.342015&travelMode=bicycle&routeType=eco&traffic=false"
},
{
"query": "?query=40.759856,-73.985108:40.771136,-73.973506&travelMode=pedestrian&routeType=shortest"
}
]
}
Sample response
{
"batchItems": [
{
"statusCode": 400,
"response": {
"error": {
"code": "400 BadRequest",
"message": "maxAlternatives parameter value should be between 0 and 5 inclusive"
}
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1754,
"travelTimeInSeconds": 386,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:02:49+00:00"
},
"points": [
{
"latitude": 47.62094,
"longitude": -122.34892
},
{
"latitude": 47.62094,
"longitude": -122.3485
},
{
"latitude": 47.62095,
"longitude": -122.3476
},
{
"latitude": 47.60995,
"longitude": -122.34174
},
{
"latitude": 47.61011,
"longitude": -122.342
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 44,
"sectionType": "TRAVEL_MODE",
"travelMode": "bicycle"
}
]
}
]
}
},
{
"statusCode": 200,
"response": {
"formatVersion": "0.0.12",
"routes": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"legs": [
{
"summary": {
"lengthInMeters": 1772,
"travelTimeInSeconds": 1276,
"trafficDelayInSeconds": 0,
"departureTime": "2019-06-21T22:56:23+00:00",
"arrivalTime": "2019-06-21T23:17:38+00:00"
},
"points": [
{
"latitude": 40.75982,
"longitude": -73.98493
},
{
"latitude": 40.7601,
"longitude": -73.98483
},
{
"latitude": 40.75984,
"longitude": -73.98417
},
{
"latitude": 40.76047,
"longitude": -73.9837
},
{
"latitude": 40.77095,
"longitude": -73.9736
},
{
"latitude": 40.77114,
"longitude": -73.97356
}
]
}
],
"sections": [
{
"startPointIndex": 0,
"endPointIndex": 47,
"sectionType": "TRAVEL_MODE",
"travelMode": "pedestrian"
}
]
}
]
}
}
],
"summary": {
"successfulRequests": 2,
"totalRequests": 3
}
}
operation-Location: URL to download the results of the long-running batch request.
Tanımlar
Name | Description |
---|---|
Batch |
Bu tür, Batch hizmeti için istek gövdesini temsil eder. |
Batch |
Batch istek nesnesi |
Delay |
Olayın neden olduğu gecikmenin büyüklüğü. Bu değerler , Trafik Olayı Ayrıntısı Alma API'sinin yanıt alanı ty değerlerine karşılık gelir. |
Driving |
Manevra noktasında sol taraftakiyle sağ taraftakinin sürüşünün karşılaştırmasını gösterir. |
Effective |
Bu Yol API'si çağrılırken kullanılan etkili parametre veya veriler. |
Error |
Kaynak yönetimi hatası ek bilgileri. |
Error |
Hata ayrıntısı. |
Error |
Hata yanıtı |
Guidance |
Yönergenin türü, örneğin yol formunun değiştirilmesi veya değiştirilmesi. |
Guidance |
Manevrayı tanımlayan bir kod. |
Json |
Yanıtın istenen biçimi. Yalnızca |
Junction |
Manevranın gerçekleştiği kavşağın türü. Daha büyük kavşaklar için, kavşak girmek ve çıkmak için iki ayrı yönerge oluşturulur. |
Lat |
Enlem ve boylam olarak temsil edilen konum. |
Response |
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa RouteDirections, aksi takdirde ErrorResponse. |
Response |
Bildirilen yol yanıtının bölüm türleri |
Response |
Hesaplanan rota için seyahat modu. İstenen aktarım modu bu bölümde mümkün değilse değer olarak ayarlanır |
Route | |
Route |
Yol Tarifleri Batch hizmet çağrısından döndürülen bir öğe. |
Route |
Bu nesne başarılı bir Yol Tarifleri Batch hizmet çağrısından döndürülür. |
Route |
Kılavuzla ilgili öğeleri içerir. Bu alan yalnızca rehberlik istendiğinde bulunur ve kullanılabilir durumdadır. |
Route |
Bir manevrayı açıklayan bir öznitelik kümesi, örneğin 'Sağa dön', 'Sola tut', 'Feribota bin', 'Otoyola bin', 'Var'. |
Route |
Birbiriyle ilişkili yönerge öğelerinin bir dizisini gruplandırır. Sıra aralığı firstInstructionIndex ve lastInstructionIndex ile kısıtlanır. İnsan tarafından okunabilir metin iletileri için rehberlik istendiğinde (instructionType=text veya etiketli), varsa instructionGroup'ta bir özet ileti döndürülür. |
Route |
Bir nokta listesinden oluşan rotanın bir bölümünün açıklaması. İstekte sağlanan her ek yol noktası, döndürülen rotada ek bir bacakla sonuçlanır. |
Route |
Yol bölümü için özet nesnesi. |
Route |
İyileştirilmiş yol noktası nesnesi. |
Route |
Geçerli çağrıda kullanılan geçerli ayarları bildirir. |
Route |
Yol bölümleri, bir yolun bölümleri hakkında ek bilgiler içerir. Her bölüm en az , |
Route |
TPEG2-TEC standardında tanımları kullanarak trafik olayının ayrıntıları. effectCode içerebilir ve öğelere neden olabilir. |
Route |
Trafik olayının nedeni. mainCauseCode ve subCauseCode öğelerini içerebilir. Simgeografiyi ve açıklamaları tanımlamak için kullanılabilir. |
Route |
Özet nesnesi |
Simple |
Olayın türü. Şu anda JAM, ROAD_WORK, ROAD_CLOSURE veya OTHER olabilir. Ayrıntılı bilgi için "tec" bölümüne bakın. |
Summary |
Toplu istek sonuçlarının özeti |
BatchRequest
Bu tür, Batch hizmeti için istek gövdesini temsil eder.
Name | Tür | Description |
---|---|---|
batchItems |
İşlenmek üzere sorguların listesi. |
BatchRequestItem
Batch istek nesnesi
Name | Tür | Description |
---|---|---|
query |
string |
Bu parametre, yapılandırılmamış bir coğrafi kodlama işlemi gerçekleştirmek için kullanılan bir sorgu dizesi içerir. Sorgu dizesi, işlenmek üzere arama API'sine ayrıntılı olarak geçirilir. |
DelayMagnitude
Olayın neden olduğu gecikmenin büyüklüğü. Bu değerler , Trafik Olayı Ayrıntısı Alma API'sinin yanıt alanı ty değerlerine karşılık gelir.
Name | Tür | Description |
---|---|---|
0 |
string |
Bilinmiyor. |
1 |
string |
Küçük. |
2 |
string |
Orta. |
3 |
string |
Binbaşı. |
4 |
string |
Tanımsız, yol kapatma ve diğer belirsiz gecikmeler için kullanılır. |
DrivingSide
Manevra noktasında sol taraftakiyle sağ taraftakinin sürüşünün karşılaştırmasını gösterir.
Name | Tür | Description |
---|---|---|
LEFT |
string |
Sol taraf. |
RIGHT |
string |
Sağ tarafta. |
EffectiveSetting
Bu Yol API'si çağrılırken kullanılan etkili parametre veya veriler.
Name | Tür | Description |
---|---|---|
key |
string |
Kullanılan parametrenin adı. |
value |
string |
Kullanılan parametrenin değeri. |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
Name | Tür | Description |
---|---|---|
info |
object |
Ek bilgiler. |
type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
Name | Tür | Description |
---|---|---|
additionalInfo |
Hata ek bilgileri. |
|
code |
string |
Hata kodu. |
details |
Hata ayrıntıları. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
GuidanceInstructionType
Yönergenin türü, örneğin yol formunun değiştirilmesi veya değiştirilmesi.
Name | Tür | Description |
---|---|---|
DIRECTION_INFO |
string |
Yön bilgileri. |
LOCATION_ARRIVAL |
string |
Varış yeri. |
LOCATION_DEPARTURE |
string |
Kalkış yeri. |
LOCATION_WAYPOINT |
string |
Yol noktası konumu. |
ROAD_CHANGE |
string |
Yol Değişikliği. |
TURN |
string |
Dönmek. |
GuidanceManeuver
Manevrayı tanımlayan bir kod.
Name | Tür | Description |
---|---|---|
ARRIVE |
string |
Siz geldiniz. |
ARRIVE_LEFT |
string |
Siz geldiniz. Hedefiniz sol tarafta. |
ARRIVE_RIGHT |
string |
Siz geldiniz. Hedefiniz sağ tarafta. |
BEAR_LEFT |
string |
Ayı gitti. |
BEAR_RIGHT |
string |
Ayı sağ. |
DEPART |
string |
Ayrılmak. |
ENTER_FREEWAY |
string |
Otobana binin. |
ENTER_HIGHWAY |
string |
Otobana bin. |
ENTER_MOTORWAY |
string |
Otoyola çık. |
ENTRANCE_RAMP |
string |
Rampadan in. |
FOLLOW |
string |
Takip etmek. |
KEEP_LEFT |
string |
Sola doğru devam edin. |
KEEP_RIGHT |
string |
Sağa doğru devam edin. |
MAKE_UTURN |
string |
U dönüşü yapın. |
MOTORWAY_EXIT_LEFT |
string |
Sol çıkışa geçin. |
MOTORWAY_EXIT_RIGHT |
string |
Doğru çıkışa çık. |
ROUNDABOUT_BACK |
string |
Kavşakta dolaş. |
ROUNDABOUT_CROSS |
string |
Kavşakta geç. |
ROUNDABOUT_LEFT |
string |
Kavşakta soldaki çıkışı alın. |
ROUNDABOUT_RIGHT |
string |
Kavşakta sağ taraftaki çıkışı alın. |
SHARP_LEFT |
string |
Keskin sola dön. |
SHARP_RIGHT |
string |
Sağa doğru keskin dön. |
STRAIGHT |
string |
Dümdüz devam et. |
SWITCH_MAIN_ROAD |
string |
Ana yola geç. |
SWITCH_PARALLEL_ROAD |
string |
Paralel yola geçin. |
TAKE_EXIT |
string |
Çıkışa çık. |
TAKE_FERRY |
string |
Feribota bin. |
TRY_MAKE_UTURN |
string |
U dönüşü yapmayı deneyin. |
TURN_LEFT |
string |
Sola dönün. |
TURN_RIGHT |
string |
Sağa dönün. |
WAYPOINT_LEFT |
string |
Yol noktasına ulaştınız. Sol tarafta. |
WAYPOINT_REACHED |
string |
Yol noktasına ulaştınız. |
WAYPOINT_RIGHT |
string |
Yol noktasına ulaştınız. Sağ tarafta. |
JsonFormat
Yanıtın istenen biçimi. Yalnızca json
biçim desteklenir.
Name | Tür | Description |
---|---|---|
json |
string |
JunctionType
Manevranın gerçekleştiği kavşağın türü. Daha büyük kavşaklar için, kavşak girmek ve çıkmak için iki ayrı yönerge oluşturulur.
Name | Tür | Description |
---|---|---|
BIFURCATION |
string |
Çatallanma |
REGULAR |
string |
düzenli |
ROUNDABOUT |
string |
atlıkarınca |
LatLongPair
Enlem ve boylam olarak temsil edilen konum.
Name | Tür | Description |
---|---|---|
latitude |
number |
Latitude özelliği |
longitude |
number |
Longitude özelliği |
Response
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa RouteDirections, aksi takdirde ErrorResponse.
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |
|
formatVersion |
string |
Format Version özelliği |
optimizedWaypoints |
İyileştirilmiş yol noktası dizisi. Özgün ve iyileştirilmiş liste için kullanıcı tarafından sağlanan yol noktası dizisinin dizinini gösterir. Örneğin, bir yanıt:
, özgün dizinin [0, 1, 2] ve iyileştirilmiş sıranın [1, 2, 0] olduğu anlamına gelir. Dizin 0 ile başladığından, özgün "birinci, ikinci, üçüncü", iyileştirilmiş ise "ikinci, üçüncü, ilk" şeklindedir. |
|
report |
Geçerli çağrıda kullanılan geçerli ayarları bildirir. |
|
routes |
Route[] |
Rotalar dizisi |
ResponseSectionType
Bildirilen yol yanıtının bölüm türleri
Name | Tür | Description |
---|---|---|
CARPOOL |
string |
Yolun, araç havuzu (HOV/Yüksek Doluluk Aracı) şeritlerinin kullanılmasını gerektiren bölümleri. |
CAR_TRAIN |
string |
Rotanın arabalar veya trenler olan bölümleri. |
COUNTRY |
string |
Rotanın hangi ülkelerde/bölgelerde olduğunu gösteren bölümler. |
FERRY |
string |
Rotanın feribot olan bölümleri. |
MOTORWAY |
string |
Yolun otoyollar olan bölümleri. |
PEDESTRIAN |
string |
Rotanın yalnızca yayalar için uygun bölümleri. |
TOLL_ROAD |
string |
Rotanın ücretli ödeme gerektiren bölümleri. |
TOLL_VIGNETTE |
string |
Yolun ücretli bir vignette bulunmasını gerektiren bölümleri. |
TRAFFIC |
string |
Yolun trafik bilgilerini içeren bölümleri. |
TRAVEL_MODE |
string |
İstek parametresiyle |
TUNNEL |
string |
Yolun tünel olan bölümleri. |
URBAN |
string |
Yolun kentsel alanlar içinde yer alan bölümleri. |
ResponseTravelMode
Hesaplanan rota için seyahat modu. İstenen aktarım modu bu bölümde mümkün değilse değer olarak ayarlanır other
Name | Tür | Description |
---|---|---|
bicycle |
string |
Döndürülen rotalar, bisiklet kulvarlarının kullanımı da dahil olmak üzere bisikletler için iyileştirilmiştir. |
bus |
string |
Döndürülen rotalar, yalnızca otobüs hatlarının kullanımı dahil olmak üzere otobüsler için iyileştirilmiştir. BETA işlevi. |
car |
string |
Döndürülen rotalar arabalar için iyileştirilmiştir. |
motorcycle |
string |
Döndürülen rotalar motosikletler için iyileştirilmiştir. BETA işlevi. |
other |
string |
Verilen aktarım modu bu bölümde mümkün değildir |
pedestrian |
string |
Geri dönen yollar, kaldırım kullanımı dahil olmak üzere yayalar için iyileştirilmiştir. |
taxi |
string |
Döndürülen rotalar taksiler için iyileştirilmiştir. BETA işlevi. |
truck |
string |
Döndürülen rotalar, kamyonlar gibi ticari araçlar için optimize edilmiştir. |
van |
string |
Döndürülen yollar, minibüsler için iyileştirilmiştir. BETA işlevi. |
Route
Name | Tür | Description |
---|---|---|
guidance |
Kılavuzla ilgili öğeleri içerir. Bu alan yalnızca rehberlik istendiğinde bulunur ve kullanılabilir durumdadır. |
|
legs |
Route |
Bacaklar dizisi |
sections |
Bölümler dizisi |
|
summary |
Özet nesnesi |
RouteDirectionsBatchItem
Yol Tarifleri Batch hizmet çağrısından döndürülen bir öğe.
Name | Tür | Description |
---|---|---|
response |
Sorgunun sonucu. Sorgu başarıyla tamamlandıysa RouteDirections, aksi takdirde ErrorResponse. |
|
statusCode |
integer |
HTTP isteği durum kodu. |
RouteDirectionsBatchResult
Bu nesne başarılı bir Yol Tarifleri Batch hizmet çağrısından döndürülür.
Name | Tür | Description |
---|---|---|
batchItems |
Toplu iş sonuçlarını içeren dizi. |
|
summary |
Toplu istek sonuçlarının özeti |
RouteGuidance
Kılavuzla ilgili öğeleri içerir. Bu alan yalnızca rehberlik istendiğinde bulunur ve kullanılabilir durumdadır.
Name | Tür | Description |
---|---|---|
instructionGroups |
Birbiriyle ilişkili bir yönerge öğeleri dizisini gruplandırır. |
|
instructions |
Manevraları açıklayan yönergelerin listesi. |
RouteInstruction
Bir manevrayı açıklayan bir öznitelik kümesi, örneğin 'Sağa dön', 'Sola tut', 'Feribota bin', 'Otoyola bin', 'Var'.
Name | Tür | Description |
---|---|---|
combinedMessage |
string |
Manevra için insan tarafından okunabilen bir mesaj, sonraki yönergedeki mesajla birleştirildi. Bazen birbirini izleyen iki yönergeyi tek bir yönergede birleştirmek mümkündür ve bu da izlemeyi kolaylaştırır. Bu durumda, olasıCombineWithNext bayrağı true olur. Örnek:
10. yönergedeki possibleCombineWithNext bayrağı true. Bu, kodlanmış kılavuzun istemcilerine yönerge 11 ile birleştirilebileceğini gösterir. yönergeler, insanlar tarafından okunabilir rehberlik isteyen istemciler için otomatik olarak birleştirilir. combinedMessage alanı birleşik iletiyi içerir:
|
countryCode |
string |
3 karakterli ISO 3166-1 alfa-3 ülke kodu. Örneğin ABD. |
drivingSide |
Manevra noktasında sol ve sağ taraftaki sürüşü gösterir. |
|
exitNumber |
string |
Geçerli manevra tarafından alınan bir otoyol çıkışının sayısı... Bir çıkışın birden çok çıkış numarası varsa, bunlar "" ile ayrılır ve büyük olasılıkla "-" ile toplanır; örneğin, "10, 13-15". |
instructionType |
Yönergenin türü, örneğin yol formunun değiştirilmesi veya değiştirilmesi. |
|
junctionType |
Manevranın gerçekleştiği kavşağın türü. Daha büyük kavşaklar için, kavşak girmek ve kavşaktan çıkmak için iki ayrı yönerge oluşturulur. |
|
maneuver |
Manevrayı tanımlayan bir kod. |
|
message |
string |
Manevra için insan tarafından okunabilen bir mesaj. |
point |
Enlem ve boylam olarak temsil edilen konum. |
|
pointIndex |
integer |
Yönergenin noktasına karşılık gelen çok çizgili "noktalar" listesindeki noktanın dizini. |
possibleCombineWithNext |
boolean |
İsteğe bağlı olarak yönergeyi bir sonraki yönergeyle birleştirmek mümkündür. Bu, "Sola dön ve sonra sağa dön" gibi iletiler oluşturmak için kullanılabilir. |
roadNumbers |
string[] |
Manevradan sonraki bir sonraki önemli yol segmentlerinin veya izlenecek yolların yol sayıları... Örnek: ["E34", "N205"] |
roundaboutExitNumber |
integer |
Bu, dönel kavşakta hangi çıkışın alınacak olduğunu gösterir. |
routeOffsetInMeters |
integer |
Yolun başlangıcından yönergenin noktasına uzaklık. |
signpostText |
string |
Manevrayla veya takip edilmesi gereken yöne en uygun işaret direğindeki metin. |
stateCode |
string |
ISO 3166-2 kodunun ikinci bölümüyle temsil edilen ülkenin alt bölümü (örneğin, eyalet). Bu yalnızca ABD, Kanada ve Meksika gibi bazı ülkelerde/bölgelerde kullanılabilir. |
street |
string |
Manevradan sonraki sonraki önemli yol segmentinin veya izlenmesi gereken caddenin sokak adı. |
travelTimeInSeconds |
integer |
RouteOffsetInMeters'e karşılık gelen noktaya kadar tahmini seyahat süresi. |
turnAngleInDecimalDegrees |
integer |
Yönergenin yönünü gösterir. junctionType bir dönüş yönergesi gösteriyorsa:
JunctionType bir çarpım yönergesi gösteriyorsa:
|
RouteInstructionGroup
Birbiriyle ilişkili yönerge öğelerinin bir dizisini gruplandırır. Sıra aralığı firstInstructionIndex ve lastInstructionIndex ile kısıtlanır. İnsan tarafından okunabilir metin iletileri için rehberlik istendiğinde (instructionType=text veya etiketli), varsa instructionGroup'ta bir özet ileti döndürülür.
Name | Tür | Description |
---|---|---|
firstInstructionIndex |
integer |
Yönergelerdeki ve bu gruba ait ilk yönergenin dizini. |
groupLengthInMeters |
integer |
Grubun uzunluğu. |
groupMessage |
string |
İnsan tarafından okunabilir metin iletileri yönergeler istendiğinde (instructionType=text veya etiketli) özet ileti. |
lastInstructionIndex |
integer |
Yönergelerdeki ve bu gruba ait olan son yönergenin dizini. |
RouteLeg
Bir nokta listesinden oluşan rotanın bir bölümünün açıklaması. İstekte sağlanan her ek yol noktası, döndürülen rotada ek bir bacakla sonuçlanır.
Name | Tür | Description |
---|---|---|
points |
Nokta dizisi |
|
summary |
Yol bölümü için özet nesnesi. |
RouteLegSummary
Yol bölümü için özet nesnesi.
Name | Tür | Description |
---|---|---|
arrivalTime |
string |
Rota veya bacak için tahmini varış zamanı. Saat UTC olarakdır. |
batteryConsumptionInkWh |
number |
Elektrik Tüketimi Modeli kullanılarak kilowatt saat (kWh) cinsinden tahmini elektrik enerjisi tüketimi. vehicleEngineType elektrikli olarak ayarlanırsa ve constantSpeedConsumptionInkWhPerHundredkm belirtilirse dahil edilir. BatteryConsumptionInkWh değeri, iyileştirilmiş elektrik enerjisini içerir ve bu nedenle negatif olabilir (bu da enerji kazandığını gösterir). Hem maxChargeInkWh hem de currentChargeInkWh belirtilirse, pil şarj düzeyinin maxChargeInkWh değerini asla aşmadığından emin olmak için yenileme sınırlanır. Ne maxChargeInkWh ne de currentChargeInkWh belirtilmezse, tüketim hesaplamasında kısıtlanmamış geri alma varsayılır. |
departureTime |
string |
Rota veya bacak için tahmini kalkış saati. Saat UTC olarakdır. |
fuelConsumptionInLiters |
number |
Yanma Tüketimi Modeli kullanılarak litre cinsinden tahmini yakıt tüketimi. VehicleEngineType yanma olarak ayarlanırsa ve constantSpeedConsumptionInLitersPerHundredkm belirtilirse dahil edilir. Değer negatif olmayacaktır. |
historicTrafficTravelTimeInSeconds |
integer |
Zamana bağlı geçmiş trafik verileri kullanılarak hesaplanan tahmini seyahat süresi. Yalnızca computeTravelTimeFor = tümü sorguda kullanılıyorsa dahil edilir. |
lengthInMeters |
integer |
Metre cinsinden Uzunluk özelliği |
liveTrafficIncidentsTravelTimeInSeconds |
integer |
Gerçek zamanlı hız verileri kullanılarak hesaplanan tahmini seyahat süresi. Yalnızca computeTravelTimeFor = tümü sorguda kullanılıyorsa dahil edilir. |
noTrafficTravelTimeInSeconds |
integer |
Tahmini seyahat süresi, trafik koşullarından (ör. tıkanıklık) dolayı rotada gecikme yaşanmaz gibi hesaplanır. Yalnızca computeTravelTimeFor = tümü sorguda kullanılıyorsa dahil edilir. |
trafficDelayInSeconds |
integer |
Trafik bilgilerine göre gerçek zamanlı olayların neden olduğu saniye cinsinden tahmini gecikme. Gelecekte kalkış saatiyle planlanan rotalar için gecikmeler her zaman 0'dır. Farklı trafik bilgisi türlerini kullanarak ek seyahat süreleri döndürmek için computeTravelTimeFor=all parametresinin eklenmesi gerekir. |
travelTimeInSeconds |
integer |
Gerçek zamanlı trafik nedeniyle gecikmeyi içeren saniye cinsinden tahmini seyahat süresi özelliği. Traffic=false travelTimeInSeconds yine de trafik nedeniyle gecikmeyi içerdiğini unutmayın. DepartAt gelecekteyse seyahat süresi zamana bağlı geçmiş trafik verileri kullanılarak hesaplanır. |
RouteOptimizedWaypoint
İyileştirilmiş yol noktası nesnesi.
Name | Tür | Description |
---|---|---|
optimizedIndex |
integer |
Sistemden iyileştirilmiş yol noktası dizini. |
providedIndex |
integer |
Kullanıcı tarafından sağlanan yol noktası dizini. |
RouteReport
Geçerli çağrıda kullanılan geçerli ayarları bildirir.
Name | Tür | Description |
---|---|---|
effectiveSettings |
Bu Yol API'si çağrılırken kullanılan geçerli parametreler veya veriler. |
RouteSection
Yol bölümleri, bir yolun bölümleri hakkında ek bilgiler içerir. Her bölüm en az , endPointIndex
ve sectionType
öğelerini startPointIndex
içerir.
Name | Tür | Description |
---|---|---|
delayInSeconds |
integer |
Olayın neden olduğu saniyelerdeki gecikme. |
effectiveSpeedInKmh |
integer |
Olayın km/s cinsinden etkin hızı, tüm uzunluğunun ortalamasını alır. |
endPointIndex |
integer |
Bu bölümün uygulandığı yoldaki son noktanın (uzaklık 0) dizini. |
magnitudeOfDelay |
Olayın neden olduğu gecikmenin büyüklüğü. Bu değerler , Trafik Olayı Ayrıntısı Alma API'sinin yanıt alanı ty değerlerine karşılık gelir. |
|
sectionType |
Bildirilen yol yanıtının bölüm türleri |
|
simpleCategory |
Olayın türü. Şu anda JAM, ROAD_WORK, ROAD_CLOSURE veya OTHER olabilir. Ayrıntılı bilgi için "tec" bölümüne bakın. |
|
startPointIndex |
integer |
Bu bölümün uygulandığı yoldaki ilk noktanın (uzaklık 0) dizini. |
tec |
TPEG2-TEC standardında tanımları kullanarak trafik olayının ayrıntıları. effectCode içerebilir ve öğelere neden olabilir. |
|
travelMode |
Hesaplanan rota için seyahat modu. İstenen aktarım modu bu bölümde mümkün değilse değer olarak ayarlanır |
RouteSectionTec
TPEG2-TEC standardında tanımları kullanarak trafik olayının ayrıntıları. effectCode içerebilir ve öğelere neden olabilir.
Name | Tür | Description |
---|---|---|
causes |
Diziye neden olur |
|
effectCode |
integer |
Trafik akışı üzerindeki etkisi. TPEG2-TEC standardında tanımlandığı gibi tec001:EffectCode tablosunda bir değer içerir. Trafik olaylarını önem derecesine göre renklendirmek için kullanılabilir. |
RouteSectionTecCause
Trafik olayının nedeni. mainCauseCode ve subCauseCode öğelerini içerebilir. Simgeografiyi ve açıklamaları tanımlamak için kullanılabilir.
Name | Tür | Description |
---|---|---|
mainCauseCode |
integer |
Trafik olayının temel nedeni. TPEG2-TEC standardında tanımlandığı gibi tec002:CauseCode tablosunda bir değer içerir. |
subCauseCode |
integer |
Trafik olayının alt parçası. TPEG2-TEC standardında tanımlandığı gibi mainCauseCode tarafından tanımlanan alt neden tablosunda bir değer içerir. |
RouteSummary
Özet nesnesi
Name | Tür | Description |
---|---|---|
arrivalTime |
string |
Rota veya bacak için tahmini varış zamanı. Saat UTC olarakdır. |
departureTime |
string |
Rota veya bacak için tahmini kalkış saati. Saat UTC olarakdır. |
lengthInMeters |
integer |
Metre cinsinden Uzunluk özelliği |
trafficDelayInSeconds |
integer |
Trafik bilgilerine göre gerçek zamanlı olayların neden olduğu saniye cinsinden tahmini gecikme. Gelecekte kalkış saatiyle planlanan rotalar için gecikmeler her zaman 0'dır. Farklı trafik bilgisi türlerini kullanarak ek seyahat süreleri döndürmek için computeTravelTimeFor=all parametresinin eklenmesi gerekir. |
travelTimeInSeconds |
integer |
Gerçek zamanlı trafik nedeniyle gecikmeyi içeren saniye cinsinden tahmini seyahat süresi özelliği. Traffic=false travelTimeInSeconds yine de trafik nedeniyle gecikmeyi içerdiğini unutmayın. DepartAt gelecekteyse seyahat süresi zamana bağlı geçmiş trafik verileri kullanılarak hesaplanır. |
SimpleCategory
Olayın türü. Şu anda JAM, ROAD_WORK, ROAD_CLOSURE veya OTHER olabilir. Ayrıntılı bilgi için "tec" bölümüne bakın.
Name | Tür | Description |
---|---|---|
JAM |
string |
Trafik sıkışıklığı. |
OTHER |
string |
Diğer. |
ROAD_CLOSURE |
string |
Yol kapatma. |
ROAD_WORK |
string |
Yol çalışması. |
Summary
Toplu istek sonuçlarının özeti
Name | Tür | Description |
---|---|---|
successfulRequests |
integer |
Toplu işlemdeki başarılı istek sayısı |
totalRequests |
integer |
Toplu işlemdeki toplam istek sayısı |