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

このドキュメントでは、複数の目的地があるルートを作成し、正しいフィールドを設定して、車両に割り当てて完了する方法について説明します。Fleet Engine を設定し、車両を作成し、ドライバー アプリが動作し、必要に応じてユーザーアプリが動作していることを前提としています。また、オンデマンド ルートで利用できるさまざまなルート シナリオについても理解している必要があります。関連するガイドは次のとおりです。

旅程作成の基本

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

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

ルート フィールド

Fleet Engine でルートを作成するには、次のフィールドを使用します。ルートの種類（単一または複数の目的地、連続、相乗り）に応じて、異なるフィールドを使用できます。省略可能なフィールドは、ルートの作成時に指定することも、ルートの更新時に後で設定することもできます。

ルート フィールド
名前 必須かどうか 説明
parent はい プロジェクト ID を含む文字列。この ID は、Fleet Engine の統合全体で同じサービス アカウントのロールを使用して使用する必要があります。
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 を使用してルートを構成する必要があります。ルートの更新について詳しくは、 ルートを更新して状態を管理するをご覧ください。

ルートの作成時に降車地点または中間地点を指定しなかった場合は、いつでも指定できます。

ルート更新の例

次の例は、ルートを更新して中間地点のリストを追加し、車両 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

中間地点があるルートの例

次の例は、乗車場所を通過し、現在最初の中間地点に向かっている複数の目的地があるルートを作成する方法を示しています。

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;
}

次のステップ