Hangi bilgilerin döndürüleceğini seçme
Rota veya rota matrisini hesaplamak için bir yöntem çağırdığınızda ilgili alanları sizin için uygun olacak şekilde listeleyerek, geri dönelim. Döndürülen alanların varsayılan listesi yok. Bu listeyi atlarsanız yöntemler hata döndürür.
Yanıt alanı maskesi oluşturarak alan listesini belirtirsiniz. Ardından, yanıt alan maskesini $fields
veya fields
URL parametresini ya da HTTP veya gRPC başlığını X-Goog-FieldMask
kullanarak yöntemlerden birine iletirsiniz.
Alan maskesi kullanmak, bir alan adına sahip Bu da gereksiz işlem süresi ve faturalandırılan ücretlerin önlenmesine yardımcı olur.
URL parametreleri hakkında daha fazla bilgi için Sistem Parametreleri başlıklı makaleyi inceleyin.
Yanıt alanı maskesi tanımlama
Yanıt alanı maskesi, her yolun yanıt mesajında benzersiz bir alan belirttiği, virgülle ayrılmış bir yol listesidir. Yol, üst düzey yanıt mesajından başlar ve bir noktayla ayrılmış yolu gösterir.
Aşağıdaki gibi bir alan yolu oluşturup belirtin:
- Routes API'den ihtiyacınız olan bilgileri içeren alanları bulun. Ayrıntılar için Alan Referansları bölümüne bakın.
- İhtiyaç duyduğunuz alanların yollarını belirleyin ve bunlar için alan maskeleri oluşturun: Ayrıntılar için Kullanmak istediğiniz alan maskesini belirleme başlıklı makaleye bakın.
Alan maskelerini virgülle ayırarak gereken tüm alanlar için alan maskelerini birleştirin. Örneğin, rota adımı için
distanceMeters
'yi ve her rota adımı adımının süresini istemek üzere her ikisini de virgülle ayırarak ve boşluk bırakmadan girin:routes.legs.distanceMeters,routes.legs.steps.duration
API isteğinizle birlikte alan maskesini gönderin. Örneğin, bir cURL isteğinde alan maskesini
-H
veX-Goog-FieldMask
ile belirtirsiniz:-H X-Goog-FieldMask: routes.legs.distanceMeters,routes.legs.steps.duration
Alan Referansları
Alan maskeleri aracılığıyla bir yanıtta isteyebileceğiniz alanları görmek için aşağıdaki listede bağlantısı verilen Routes API referanslarına bakın. Alanları, referanstaki gibi büyük/küçük harf kullanmadan belirtin. Örneğin, routePreference
.
Bu referanslar, kullanılabilir alanları içerir. Ancak tam alan maskesi yolunu belirlemek için alanların hiyerarşisini referans olarak kullanmanız gerekir. Alanların hiyerarşisini almayla ilgili ayrıntılar için Kullanmak istediğiniz alan maskesini belirleme başlıklı makaleye bakın.
- Compute rota alanı maskesi
- Rota matrisi alan maskelerini hesaplama
- REST: Döndürülecek yanıt gövdesinin alanlarını belirtir.
- gRPC: RouteMatrixElement nesnesini tanımlayın.
Hangi alan maskelerinin kullanılacağını belirleme
Kullanmak istediğiniz alanları nasıl belirleyeceğinizi ve bunlar için alan maskelerini nasıl oluşturacağınızı aşağıda bulabilirsiniz:
*
alan maskesi kullanarak tüm alanları isteyin.- Alanların hiyerarşisine bakın istediğiniz alanları seçin.
Önceki adımda gösterilen alanların hiyerarşisini kullanarak aşağıdaki biçimi kullanarak alan maskelerinizi oluşturun:
topLevelField[.secondLevelField][.thirdLevelField][...]
Örneğin, bir rotadan alınan bu kısmi yanıt için:
"routes": [ { "legs": [ { "steps": [ {"distanceMeters": 119}, {"distanceMeters": 41} ] } ], "distanceMeters": 160 } ]
Rota adımı için yalnızca distanceMeters
alanını (yani önceki örnekteki son distanceMeters
alanını) döndürmek istiyorsanız alan maskeniz aşağıdaki gibidir:
routes.legs.distanceMeters
Bunun yerine, rota adımını her adımı için distanceMeters
alanını döndürmek istiyorsanız (yani önceki örnekte steps
altındaki distanceMeters
) alan maskeniz şöyle olur:
routes.legs.steps.distanceMeters
Her ikisini de geri almak istiyorsanız, yukarıdaki sonuçla birlikte alan maskeniz aşağıdaki gibi olur:
routes.legs.distanceMeters,routes.legs.steps.distanceMeters
Örnek alan maskesi yolları
Bu bölümde, REST ve gRPC çağrılarında yanıt alanı maskesinin bir parçası olarak alan yolunun nasıl belirtileceğine dair daha fazla örnek bulunmaktadır.
computeRoutes
adlı kişiye REST araması
İlk örnekte,
Hesaplama yöntemi computeRoutes
yol gösterir. Bu örnekte, yanıtta distanceMeters
ve duration
yol alanlarının döndürülmesi için üstbilgide alan maskeleri belirtirsiniz. Alan adına routes
ön ekini eklemeyi unutmayın.
X-Goog-FieldMask: routes.distanceMeters,routes.duration
computeRouteMatrix
için REST çağrısı
REST computeRouteMatrix
için
rota matrisini hesaplamak için kullanılan yöntem, başlıkta, değer
Her kaynak kombinasyonu için originIndex
, destinationIndex
ve duration
ve hedef:
X-Goog-FieldMask: originIndex,destinationIndex,duration
gRPC çağrısı
gRPC için yanıt alanı maskesini içeren bir değişken ayarlayın. Daha sonra bu değişkeni isteğe aktarabilirsiniz.
const ( fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline" )
Alan yoluyla ilgili dikkat edilmesi gerekenler
Yalnızca ihtiyacınız olan alanları döndürmek için yanıta yalnızca ihtiyacınız olan alanları ekleyin:
- İşleme sürelerini kısaltır. Böylece sonuçlarınız daha düşük gecikmeyle döndürülür.
- Kararlı gecikme performansı sağlar. Şu durumda: tüm alanları seçebilir veya en üst düzeydeki tüm alanları seçerseniz yeni alanlar eklendiğinde performansta düşüş yaşanır ve ardından yanıtınıza otomatik olarak eklenir.
- Daha küçük bir yanıt boyutuna neden olur. Bu da daha yüksek ağ işleme hızına dönüşür.
- Gereksiz veri istememenizi sağlar. Bu da gereksiz işlem süresini ve faturalandırılan ücretleri önlemeye yardımcı olur.
Alan maskesi oluşturma hakkında daha fazla bilgi için field_mask.proto dosyasını inceleyin.
Rota jetonu isteme
Routes API'nin oluşturulan rotalar için rota jetonları döndürmesini istemek amacıyla şu adımları uygulayın:
- Rota jetonu döndürmek için gereken aşağıdaki parametreleri ayarlayın:
travelMode
değeriniDRIVE
olarak ayarlayın.routingPreference
öğesiniTRAFFIC_AWARE
veyaTRAFFIC_AWARE_OPTIMAL
olarak ayarlayın.
- Rota ara noktalarınızdan hiçbirinin
via
ara nokta olmadığından emin olun. - Rota jetonu döndürmek için
routes.routeToken
alan maskesini belirtin:X-Goog-FieldMask: routes.routeToken
Gezinme SDK'sında planlanmış rotanız için rota jetonunu kullanabilirsiniz. Daha fazla bilgi için bkz. Rota planlama (Android) veya Rota planlayın (iOS).
Rota jetonu örneği
Tek bir kaynak ve tek bir hedefe sahip rota için örnek bir cURL istek gövdesi aşağıda verilmiştir. Bu örnekte, rota jetonu istemek için alan maskeleri, rota süresi, mesafe ve rota poli çizgisi kullanılmaktadır:
curl -X POST -d {"origin":{ "location": { "latLng":{ "latitude": -37.8167, "longitude": 144.9619 } } }, "destination":{ "location": { "latLng":{ "latitude":-37.8155, "longitude": 144.9663 } } }, "routingPreference":"TRAFFIC_AWARE", "travelMode":"DRIVE" } -H 'X-Goog-Api-Key: YOUR_API_KEY' \ -H X-Goog-FieldMask: routes.routeToken,routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline 'https://routes.googleapis.com/directions/v2:computeRoutes'
Daha fazla bilgi için Compute Routes API referansı.