このページは Cloud Translation API によって翻訳されました。

車両を検索

モビリティオンデマンドルートサービスの一環として、SearchVehicles メソッドを使用して近くの車両を検索できます。

SearchVehicles メソッドを使用すると、特定の乗車リクエストや配達リクエストに最適な、近くで利用可能な車両を消費者向けモバイルアプリで見つけることができます。SearchVehicles API は、リクエストされたルートの属性と一致する車両のランク付けされたリストを返します。順位は、指定した順序（到着予定時刻、距離、集荷場所からの直線距離）で並べ替えられます。

検索属性	車両属性
乗車場所と降車場所リクエストされた車両とルートの種類必要な容量その他の必須の照合属性	車両の直近の位置情報車両の状態、タイプ、容量その他のカスタム属性

`SearchVehicles` メソッドを使用する

SearchVehicles を使用する一般的な手順は次のとおりです。

割り当てるルートに基づいて SearchVehiclesRequest を作成します。
作成したリクエストを使用して SearchVehicles API（vehicleService.searchVehicles）を呼び出します。
API から返された SearchVehicleResponse を処理します。

SearchVehiclesRequest フィールド

SearchVehiclesRequest を作成するには、次の必須属性フィールドを使用します。

フィールド	説明
親	必須。providers/{provider} の形式にする必要があります。プロバイダは、この呼び出しを行うサービスアカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID にする必要があります。
vehicle_types	必須。リクエストされた車両の種類（AUTO、TWO_WHEELER、TAXI、TRUCK、BICYCLE、PEDESTRIAN）。
trip_types	必須。排他的（ドライバーごとに一度に 1 件のアクティブなルート）または共有（ドライバーごとに一度に 1 件以上のルート）のいずれかです。
minimum_capacity	必須。新しいルート（乗客または配達）で車両に残されている最低限の容量。
pickup_point	必須。乗車場所の緯度と経度の座標。
dropoff_point	省略可。ルートの降車地点の緯度と経度の座標。trip_types に TripType.SHARED が含まれている場合、このフィールドは必須です。
pickup_radius_meters	必須。集荷地点からの車両検索エリアの半径（メートル単位）。
order_by	必須。次のいずれかの方法で車両を注文します。 PICKUP_POINT_ETA: 集荷地点における車両の到着予定時刻。 PICKUP_POINT_DISTANCE: 車両と乗車地点間の距離。 DROPOFF_POINT_ETA: 乗車地でルートを完了する車両の予定時刻。 PICKUP_POINT_STRAIGHT_DISTANCE: 車両と乗車地点間の直線距離（ルート上ではない）。
count	必須。返される車両の最大数（1 ～ 50）。
フィルタ	（省略可）車両の検索時に適用するフィルタクエリ。

SearchVehicleRequest フィールドの完全なセットについては、リファレンスドキュメントをご覧ください。

SearchVehiclesRequest のシナリオ

このセクションでは、SearchVehiclesRequest の作成方法の例を示します。

たとえば、レストラン X で乗車を希望するお客様がいて、4 台の車両があるとします。

車両 1: レストラン X から 3,500 m 離れている。
車両 2: レストラン X から 100 m のところに位置し、A と B の場所での乗車と下車を含むアクティブなルートを運行中。
車両 3: レストラン X から 200 m 離れており、非常に遠く離れた場所に 1 件の配達が残っています。
車両 4: レストラン X から 1,000 m 離れた場所。

以下に、返される車両のさまざまなリクエストを示します。

車両 4 を返します

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA

車両 3 と 4 を返します

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA, is_back_to_back enabled

車両 2、3、4 を返します。

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA, current_trips_present = ALL

SearchVehiclesResponse フィールド

SearchVehiclesResponse は、SearchVehiclesRequest で指定された order_by 属性でランク付けされた VehicleMatch エンティティのリストで構成されます。各 VehicleMatch エンティティには次のフィールドがあります。

フィールド	説明
車両	`Vehicle` オブジェクト（vehicle_id 属性と `Vehicle` 属性を含む）。
vehicle_pickup_eta	新しい乗車の乗車地点における車両の到着予定時刻。これは運転による到着予定時刻です。
vehicle_pickup_distance_meter	車両と新しい乗車地点との間の距離（メートル単位）。
vehicle_pickup_straight_line_distance_meter	車両と新しい乗車の乗車地点との間の直線距離（メートル単位）。
vehicle_dropoff_eta	新しい乗車の集合場所での車両の到着予定時刻のタイムスタンプ。なお、この ETA は運転時の ETA です。
vehicle_trips_waypoints	現在車両に割り当てられているアクティブなルートの残りのウェイポイントのリスト（乗車地と降車地を含む）。
vehicle_match_type	車両のルートのタイプ（EXCLUSIVE、BACK_TO_BACK、CARPOOL、CARPOOL_BACK_TO_BACK）。

VehicleMatch フィールドの一覧については、以下をご覧ください。

VehicleMatch message（gRPC）
VehicleMatch resource（REST）

フィルタクエリを使用する

SearchVehicles と ListVehicles は、フィルタクエリを使用して車両属性のフィルタリングをサポートしています。

フィルタクエリは、車両のカスタム属性のフィルタリングのみをサポートし、他のフィールドには使用できません。minimum_capacity や vehicle_types などの他のフィールド条件を含む検索で使用する場合、フィルタクエリは AND 句として機能します。

たとえば、最低乗車人数が 6 人の車を検索し、ペット可などの attributes をフィルタすると、ペット可で 6 人以上の乗車が可能な車のみが条件に一致して返されます。

フィルタクエリの構文については、AIP-160 の例をご覧ください。車両属性の作成について詳しくは、車両フィールドを更新するガイドの車両属性フィールドをご覧ください。

SearchVehicles の例

次の例は、Java gRPC ライブラリを使用して SearchVehicles API を使用する方法を示しています。

static final String PROJECT_ID = "project-id";

VehicleServiceBlockingStub vehicleService =
    VehicleService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
SearchVehiclesRequest searchVehiclesRequest = SearchVehiclesRequest.newBuilder()
    .setParent(parent)
    .setPickupPoint( // Grand Indonesia East Mall
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setDropoffPoint( // Balai Sidang Jkt Convention Center
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.213796).setLongitude(106.807195)))
    .setPickupRadiusMeters(2000)
    .setCount(10)
    .setMinimumCapacity(2)
    .addTripTypes(TripType.EXCLUSIVE)
    .addVehicleTypes(VehicleType.newBuilder().setCategory(Category.AUTO).build())
    .setCurrentTripsPresent(CurrentTripsPresent.ANY)
    .setFilter("attributes.on_trip=\"false\"")
    .setOrderBy(VehicleMatchOrder.PICKUP_POINT_ETA)
    .build();

try {
  SearchVehiclesResponse searchVehiclesResponse =
      vehicleService.searchVehicles(searchVehiclesRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

List<VehicleMatch> vehicleMatches =
    searchVehicleResponse.getMatchesList();

// Each VehicleMatch contains a Vehicle entity and information about the
// distance and ETA to the pickup point and drop-off point.

次のステップ

オンデマンドルートを作成する