複数の目的地があるルートを作成する

このドキュメントでは、複数の目的地を含むルートを作成し、正しいフィールドを設定して、車両に割り当てて実行する方法について説明します。このガイドでは、Fleet Engine をセットアップし、車両を作成して、動作するドライバー アプリと、必要に応じてコンシューマ アプリを作成していることを前提としています。また、オンデマンド ルートで利用できるさまざまなルート シナリオにも精通している必要があります。詳しくは、次の関連ガイドをご覧ください。

• Fleet Engine を設定する
• 車両を作成する
• オンデマンド ルートの概要のルート シナリオ

旅程作成の基本

このセクションでは、Fleet Engine でルートを作成するために必要なリクエストの詳細について説明します。作成リクエストは、gRPC または REST を使用して発行します。

• CreateTrip() メソッド: gRPC または REST
• CreateTripRequest メッセージ: gRPC のみ

注: CreateTrip() を使用するには、Fleet Engine: サービス アカウントのロールで説明されている特権アカウントの認証情報が必要です。

ルート フィールド

Fleet Engine でルートを作成するには、次のフィールドを使用します。単一または複数の目的地、連続したルート、共有プール ルートなど、さまざまな種類のルートに異なるフィールドを使用できます。省略可能なフィールドは、ルートの作成時に指定することも、後でルートを更新するときに設定することもできます。

ルートのフィールド

名前	必須	説明
parent	はい	プロジェクト ID を含む文字列。この ID は、Fleet Engine の統合全体で使用される ID と同じで、同じサービス アカウントのロールを持ちます。
trip_id	はい	このルートを一意に識別する文字列。参照に記載されているように、ルート ID には特定の制限があります。
trip_type	はい	作成するルートタイプに応じて、TripType を次の値に設定します。 単一の宛先: SHARED または EXCLUSIVE に設定します。 マルチデスティネーション: EXCLUSIVE に設定します。 連続: EXCLUSIVE に設定します。 共有プーリング: SHARED に設定します。
pickup_point	はい	ルートの出発地。
中間デスティネーション	はい	複数の目的地があるルートのみ: ドライバーが乗車と降車の間に訪れる中間目的地のリスト。dropoff_point と同様に、このフィールドは UpdateTrip を呼び出して後で設定することもできますが、複数の目的地があるルートには、定義上中間目的地が含まれます。
vehicle_waypoints	はい	共有プーリングのルートのみ: このフィールドは、複数のルートのウェイポイントをインターリーブできます。 割り当てられた車両の残りのウェイポイントと、このルートの乗車と降車のウェイポイントがすべて含まれています。このフィールドを設定するには、CreateTrip または UpdateTrip を呼び出します。UpdateVehicle を呼び出して waypoints フィールドで車両のルートポイントを更新することもできます。プライバシー上の理由から、このサービスは GetTrip 呼び出しでこの情報を返しません。
number_of_passengers	いいえ	乗車する乗客の数。
dropoff_point	いいえ	ルートの目的地。
vehicle_id	いいえ	ルートに割り当てられた車両の ID。

例: 複数の目的地を含むルートを作成する

以下は、乗車地、降車地、1 つの中間地点がある限定的な複数の目的地のルートを作成する方法を示しています。

static final String PROJECT_ID = "my-rideshare-co-gcp-project";
static final String TRIP_ID = "multi-destination-trip-A";

TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);

// Trip initial settings.
String parent = "providers/" + PROJECT_ID;

Trip trip = Trip.newBuilder()
    .setTripType(TripType.EXCLUSIVE)
    .setPickupPoint(
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder()
                .setLatitude(-6.195139).setLongitude(106.820826)))
    .setNumberOfPassengers(1)
    .setDropoffPoint(
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder()
                .setLatitude(-6.1275).setLongitude(106.6537)))
    // Add the list of intermediate destinations.
    .addAllIntermediateDestinations(
        ImmutableList.of(
            TerminalLocation.newBuilder().setPoint(
                LatLng.newBuilder()
                    .setLatitude(-6.195139).setLongitude(106.820826)).build()))
    .build();

// Create the Trip request.
CreateTripRequest createTripRequest = CreateTripRequest.newBuilder()
    .setParent(parent)
    .setTripId(TRIP_ID)  // Trip ID assigned by the Provider server.
    .setTrip(trip)       // Initial state is NEW.
    .build();

// Error handling.
try {
  Trip createdTrip =
      tripService.createTrip(createTripRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case ALREADY_EXISTS:  // Trip already exists.
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

複数の目的地を含むルートを更新する

Fleet Engine がルート上の車両を追跡できるように、車両 ID を使用してルートを構成する必要があります。ルートの更新について詳しくは、ルートを更新して状態を管理するをご覧ください。

ルートの作成時に乗車地や途中の目的地を指定していない場合は、この時点でいつでも指定できます。

注: ルートで intermediate_destinations を設定または更新すると、作成されたルート エンティティに intermediate_destinations_version が入力されます。このフィールドをシステムにキャッシュに保存し、後で intermediate_destination_index を更新するときに UpdateTripRequest を渡す必要があります。これにより、ドライバー クライアントと Fleet Engine の間で中間目的地が同期されます。

ルート更新の例

次の例は、ルートを更新して中間目的地のリストを追加し、車両 ID を設定する方法を示しています。

static final String PROJECT_ID = "my-rideshare-co-gcp-project";
static final String TRIP_ID = "multi-destination-trip-A";

String tripName = "providers/" + PROJECT_ID + "/trips/" + TRIP_ID;

TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);

// The trip settings to be updated.
Trip trip = Trip.newBuilder()
    // Add the list of intermediate destinations.
    .addAllIntermediateDestinations(
        ImmutableList.of(
            TerminalLocation.newBuilder().setPoint(
                LatLng.newBuilder()
                    .setLatitude(-6.195139).setLongitude(106.820826)).build()))
    .setVehicleId("8241890")
    .build();

// The trip update request.
UpdateTripRequest updateTripRequest = UpdateTripRequest.newBuilder()
    .setName(tripName)
    .setTrip(trip)
    .setUpdateMask(
        FieldMask.newBuilder()
            .addPaths("intermediate_destinations")
            .addPaths("vehicle_id")
            .build())
    .build();

// Error handling.
try {
  Trip updatedTrip =
      tripService.updateTrip(updateTripRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:            // The trip doesn't exist.
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

複数の目的地を訪れるルートのルート状態を管理する

ルートの状態は、TripStatus 列挙値のいずれかを使用して指定します。ルートの状態が ENROUTE_TO_PICKUP から ARRIVED_AT_PICKUP に変更された場合は、Fleet Engine でルートの状態を更新する必要があります。ルートのステータスは常に NEW の値で始まり、COMPLETE または CANCELED の値で終わります。

複数の目的地があるルートの場合は、単一の目的地があるルートの場合と同様にルート状態を更新するだけでなく、車両が中間目的地に到達するたびに次の項目も更新する必要があります。

• intermediateDestinationIndex
• intermediateDestinationsVersion

これを行うには、TripStatus 列挙型の次の値を使用します。

• ENROUTE_TO_PICKUP
• ARRIVED_AT_PICKUP
• ENROUTE_TO_INTERMEDIATE_DESTINATION
• ARRIVED_AT_INTERMEDIATE_DESTINATION
• ENROUTE_TO_DROPOFF
• COMPLETE

注: ルートでは、中間目的地ごとに ENROUTE_TO_INTERMEDIATE_DESTINATION と ARRIVED_AT_INTERMEDIATE_DESTINATION の両方を 1 回ずつ通過する必要があります。

途中下車のあるルートの例

以下は、乗車地点を過ぎて最初の中間地点に向かっている複数の目的地のルートを作成する方法を示しています。

static final String PROJECT_ID = "my-rideshare-co-gcp-project";
static final String TRIP_ID = "multi-destination-trip-A";

String tripName = "providers/" + PROJECT_ID + "/trips/" + TRIP_ID;

// Get the trip object from either the Fleet Engine or storage.
Trip trip = …;

TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);

// The trip settings to be updated.
Trip trip = Trip.newBuilder()
    // Trip status cannot return to a previous state once it has passed.
    .setTripStatus(TripStatus.ENROUTE_TO_INTERMEDIATE_DESTINATION)

    // Enroute to the first intermediate destination.
    .setIntermediateDestinationIndex(0)

    // You must provide an intermediate_destinations_version to ensure that you
    // have the same intermediate destinations list as the Fleet Engine.
    .setIntermediateDestinationsVersion(
         trip.getIntermediateDestinationsVersion())
    .build();

// The trip update request.
UpdateTripRequest updateTripRequest = UpdateTripRequest.newBuilder()
    .setName(tripName)
    .setTrip(trip)
    .setUpdateMask(
        FieldMask.newBuilder()
            .addPaths("trip_status")
            .addPaths("intermediate_destination_index")
            // intermediate_destinations_version must not be in the update mask.
            .build())
    .build();

// Error handling.
try {
  Trip updatedTrip =
      tripService.updateTrip(updateTripRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:            // The trip doesn't exist.
      break;
    case FAILED_PRECONDITION:  // Either the trip status is invalid, or the
                               // intermediate_destinations_version doesn't
                               // match Fleet Engine's.
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

次のステップ

• 連続する旅行を作成
• Driver SDK を設定する