このドキュメントでは、配送車両を一覧表示する方法について説明します。
環境と制限事項
サーバーまたはブラウザ環境から配送車両を一覧表示できます。Driver SDK は、配送車両の一覧表示をサポートしていません。
配送車両の一覧表示は、配送車両への幅広いアクセスをリクエストするもので、信頼できるユーザーのみを対象としています。配送車両の一覧表示リクエストを行う場合は、配送フリート リーダー トークンまたは Fleet Engine 配送管理者 トークンを使用します。
リストされた配送車両では、レスポンス サイズへの影響を考慮して、次のフィールドが削除されています。
CurrentRouteSegmentRemainingVehicleJourneySegments
用途
属性フィルタとビューポート境界で車両を一覧表示できます。フィルタまたはビューポートを指定しない場合、レスポンスにはすべての配送車両が含まれます。
属性フィルタを使用したリスト
attributes プロパティを使用して、配送車両をフィルタで一覧表示できます。たとえば、キー my_key と値 my_value を持つ属性をクエリするには、attributes.my_key = my_value を使用します。複数の属性をクエリするには、attributes.key1 = value1 AND
attributes.key2 = value2 のように論理 AND 演算子と OR 演算子を使用してクエリを結合します。フィルタクエリ構文の詳細については、AIP-160 をご覧ください。フィルタをビューポート境界と組み合わせると、フィルタはビューポート境界に対して AND 演算子として機能します。詳細については、車両属性フィルタクエリをご覧ください。
ビューポートの境界を含むリスト
viewport リクエスト パラメータを使用すると、一覧表示された配送車両を場所でフィルタできます。viewport リクエスト パラメータは、2 つの境界座標(high(北東)と low(南西)の緯度と経度の座標ペア)を使用してビューポートを定義します。地理的に低緯度よりも低い高緯度が含まれている場合、リクエストは拒否されます。
回答を一覧表示する
配送車両のリストは、デフォルトで適切なページサイズを使用してページ分けされます。ページサイズを指定すると、リクエストは、上限で指定された数以下の車両のみを返します。リクエストされたページサイズが内部の最大値を超えている場合は、内部の最大値が使用されます。デフォルトのページサイズと最大ページサイズはどちらも 100 台の車両です。
配送車両リストには、結果の次のページを読み取るためのトークンを含めることができます。ページトークンは、取得可能な配送車両のページがさらにある場合にのみレスポンスに表示されます。タスクの次のページを取得するには、前のリクエストと同じリクエストでページトークンを使用します。
車両を一覧表示する例
Java gRPC ライブラリまたは REST を使用して、特定の属性を持つ特定のリージョンの配送車両を一覧表示できます。成功レスポンスが空の場合もあります。この場合、指定されたビューポートに、指定された属性を持つ車両が存在しないことを意味します。サポートされている言語の一覧については、スケジュールされたタスク サービスのクライアント ライブラリをご覧ください。
Java
static final String PROJECT_ID = "my-delivery-co-gcp-project";
DeliveryServiceBlockingStub deliveryService =
DeliveryServiceGrpc.newBlockingStub(channel);
// Tasks request
String parent = "providers/" + PROJECT_ID;
ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
ListDeliveryVehiclesRequest.newBuilder() // No need for the header
.setParent(parent)
.setViewport(
Viewport.newBuilder()
.setHigh(LatLng.newBuilder()
.setLatitude(37.45)
.setLongitude(-122.06)
.build())
.setLow(LatLng.newBuilder()
.setLatitude(37.41)
.setLongitude(-122.11)
.build())
.setFilter("attributes.my_key = my_value")
.build();
try {
ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND:
break;
case PERMISSION_DENIED:
break;
}
return;
}
REST
# HTTP request
html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles
# Request with a filter
# Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
curl -H "Authorization: Bearer ${JWT}" \
"https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"
ルックアップが成功すると、レスポンスの本文に次の構造のデータが含まれます。
// JSON representation
{
"deliveryVehicles": [
{
object (DeliveryVehicle)
}
],
"nextPageToken": string,
"totalSize": integer
}