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

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

旅程作成の基本

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

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

Trip Fields

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

Trip フィールド
名前 必須 説明
parent ○ プロジェクト ID を含む文字列。この ID は、フリート エンジン統合全体で同じサービス アカウント ロールで使用される ID と同じである必要があります。
trip_id ○ この乗車を一意に識別するために作成する文字列。参照に記載されているように、乗車 ID には特定の制限があります。
trip_type ○ 作成する乗車タイプに応じて、TripType を次のいずれかの値に設定します。
  • 単一の宛先: SHARED または EXCLUSIVE に設定します。
  • Multi-destination: EXCLUSIVE に設定します。
  • Back-to-back: 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;
}

次のステップ