ラストワンマイルのフリートソリューションは現在、一部のお客様のみご利用いただけます。詳しくは、営業担当者までお問い合わせください。

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

Driver SDK for Android のスタートガイド

注: LMFS 機能には、Driver SDK で使用する 2 つのセキュリティモデル（信頼できないモデルと信頼されるモデル）があります。untrusteduntrustedどちらのセキュリティモデルも、ドライバーアプリが車両データの更新を Fleet Engine に提供する方法を定義します。信頼できないセキュリティモデルでは、ドライバーアプリからのデータチェックのレイヤが追加されます。信頼できないモデルでは、ドライバーアプリが車両の位置情報の更新のみを Fleet Engine に直接送信できます。信頼できないドライバーアプリからのその他の車両データ更新はすべて、お客様のバックエンドに送信する必要があります。お客様のバックエンドはデータを Fleet Engine にリレーします。

信頼できるセキュリティモデルにより、ドライバアプリは、仲介サービスを必要とせずに、車両データの更新を Fleet Engine に直接送信できます。このデータには、車両、タスク、停車地の作成と更新の両方が含まれます。

信頼できないモデルは一般提供されていますが、信頼できるドライバモデルはプレビュー版です。信頼できるドライバモデルの詳細については、他のサービスアカウントのロールをご覧ください。

最小システム要件

モバイルデバイスに Android 6.0（API レベル 23）以降が搭載されている必要があります。

ビルドと依存関係の構成

Driver SDK バージョン 4.99 以降は、Google Maven リポジトリから入手できます。

Gradle

次のコードを build.gradle ファイルに追加します。

repositories {
    ...
    google()
}

Maven

次のコードを pom.xml ファイルに追加します。

<project>
  ...
  <repositories>
    <repository>
      <id>google-maven-repository</id>
      <url>https://maven.google.com</url>
    </repository>
  </repositories>
  ...
</project>

プロジェクト構成

Driver SDK を使用するには、アプリで minSdkVersion 23 以降をターゲットにする必要があります。詳細については、リリースノートをご覧ください。

Driver SDK でビルドしたアプリを実行するには、Android デバイスに Google Play 開発者サービスがインストールされている必要があります。

開発プロジェクトを設定する

Google Cloud コンソールで開発プロジェクトを設定し、そのプロジェクトの API キーを取得するには:

Driver SDK で使用する新しい Google Cloud Console プロジェクトを作成するか、既存のプロジェクトを選択します。新しいプロジェクトが Google Cloud コンソールに表示されるまで数分待ちます。
デモアプリを実行するには、プロジェクトが Maps SDK for Android にアクセスできる必要があります。Google Cloud コンソールで、[API とサービス] > [ライブラリ] を選択し、Maps SDK for Android を検索して有効にします。
プロジェクトの API キーを取得するには、[API とサービス] > [認証情報] > [認証情報を作成] > [API キー] を選択します。API キーの取得について詳しくは、API キーを取得するをご覧ください。

Driver SDK をアプリに追加する

Driver SDK は Google Maven リポジトリから入手できます。リポジトリには、SDK のプロジェクトオブジェクトモデル（.pom）ファイルと Javadocs が含まれています。Driver SDK をアプリに追加するには:

Gradle または Maven の構成に次の依存関係を追加します。VERSION_NUMBER プレースホルダは、選択した Driver SDK のバージョンに置き換えます。

Gradle

build.gradle に次の行を追加します。

dependencies {
  ...
  implementation 'com.google.android.libraries.mapsplatform.transportation:transportation-driver:VERSION_NUMBER'
}

Maven

pom.xml に次の行を追加します。

<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.mapsplatform.transportation</groupId>
    <artifactId>transportation-driver</artifactId>
    <version>VERSION_NUMBER</version>
  </dependency>
</dependencies>

Driver SDK は Navigation SDK に依存します。この依存関係は、Navigation SDK の特定のバージョンが必要な場合、以下のようにビルド構成ファイルで明示的に定義する必要があります。上記のコードブロックを省略すると、プロジェクトはメジャーリリースバージョン内の Navigation SDK の最新バージョンを常にダウンロードできます。Driver SDK と Navigation SDK の最新バージョンの動作は、リリース前に厳格なテストを受けています。

それに応じて、開発環境とリリース環境の依存関係構成を調整します。
Gradle
build.gradle に次の行を追加します。
```
dependencies {
  ...
  implementation 'com.google.android.libraries.navigation:navigation:5.0.0'
}
```
Maven
pom.xml に次の行を追加します。
```
<dependencies>
  ...
  <dependency>
    <groupId>com.google.android.libraries.navigation</groupId>
    <artifactId>navigation</artifactId>
    <version>5.0.0</version>
  </dependency>
</dependencies>
```

アプリのマニフェストを更新する

Driver SDK をアプリに追加したら、AndroidManifest.xml ファイルを編集してアプリのマニフェストを更新できます。

<application> 要素内に API キーを追加します。開発プロジェクトを設定したときに取得したプロジェクト API キーを使用する必要があります。

たとえば、次のアプリメタデータの PASTE_YOUR_API_KEY_HERE を実際の API キーに置き換えます。

<meta-data
    android:name="com.google.android.geo.API_KEY"
    android:value="PASTE_YOUR_API_KEY_HERE"/>

次の例は、サンプルアプリの完全なマニフェストを示しています。

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.driverapidemo" >
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:supportsRtl="true"
        android:theme="@style/_AppTheme" >

        <meta-data
            android:name="com.google.android.geo.API_KEY"
            android:value="PASTE_YOUR_API_KEY_HERE"/>

        <activity android:name=".MainActivity" >
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
    </application>
</manifest>

必要な帰属情報をアプリに含める

アプリで Driver SDK を使用する場合は、アプリの法的通知のセクションに、帰属情報テキストとオープンソースライセンスを含める必要があります。帰属情報は、独立したメニュー項目として、または [概要] メニュー項目の一部として含めることをおすすめします。

ライセンス情報は、アーカイブ解除された AAR ファイルの「third_party_licenses.txt」ファイルで確認できます。

オープンソースの通知を含める方法については、https://developers.google.com/android/guides/opensource をご覧ください。

依存関係

Driver SDK は gRPC を使用して Fleet Engine サーバーと通信します。gRPC をまだ取り込みていない場合は、次の依存関係の宣言が必要になることがあります。

dependencies {
    implementation 'io.grpc:grpc-android:1.12.0'
    implementation 'io.grpc:grpc-okhttp:1.12.0'
}

これらの依存関係がないと、Driver SDK が Fleet Engine サーバーとの通信中に実行時にエラーが発生します。

ProGuard を使用してビルドを最適化する場合は、ProGuard 構成ファイルに次の行を追加する必要があります。

-dontwarn com.google.**
-dontwarn io.grpc.**
-dontwarn okio.**

サポートされる最小 API レベルは 23 です。

SDK を初期化する

FleetEngine オブジェクトを初期化するには、プロバイダ ID（通常は Google Cloud プロジェクト ID）が必要です。Google Cloud プロジェクトの設定の詳細については、認証と認可をご覧ください。

Driver SDK を使用する前に、まず Navigation SDK を初期化する必要があります。SDK を初期化するには:

NavigationApi から Navigator オブジェクトを取得します。

NavigationApi.getNavigator(
      this, // Activity
      new NavigationApi.NavigatorListener() {
        @Override
        public void onNavigatorReady(Navigator navigator) {
          // Keep a reference to the Navigator (used to configure and start nav)
          this.navigator = navigator;
        }
      }
);

DriverContext オブジェクトを作成し、必須フィールドに値を入力します。

DriverContext driverContext = DriverContext.builder(application)
             .setProviderId(providerId)
             .setVehicleId(vehicleId)
             .setAuthTokenFactory(authTokenFactory)
             .setNavigator(navigator)
             .setRoadSnappedLocationProvider(
                 NavigationApi.getRoadSnappedLocationProvider(application))
             .build()

DriverContext オブジェクトを使用して *DriverApi を初期化します。

DeliveryDriverApi driverApi = DeliveryDriverApi.createInstance(driverContext);

API オブジェクトから DeliveryVehicleReporter を取得します。（DeliveryVehicleReporter は NavigationVehicleReporter を拡張します）。
```
DeliveryVehicleReporter vehicleReporter = driverApi.getDeliveryVehicleReporter();
```

`AuthTokenFactory` による認証

Driver SDK は、位置情報の更新データを生成するときに、その更新情報を Google Fleet Engine サーバーに送信する必要があります。これらのリクエストを認証するために、Driver SDK は呼び出し元が提供する AuthTokenFactory のインスタンスを呼び出します。ファクトリは、位置情報の更新時に認証トークンを生成します。

トークンが正確に生成される方法は、各デベロッパーの状況によって異なります。ただし、多くの場合、実装には以下が必要になります。

HTTPS サーバーから認証トークン（JSON 形式など）を取得します。
トークンを解析してキャッシュに保存します。
期限切れになったらトークンを更新します。

Fleet Engine サーバーが必要とするトークンの詳細については、認可用の JSON Web Token（JWT）の作成をご覧ください。

AuthTokenFactory のスケルトン実装は次のとおりです。

class JsonAuthTokenFactory implements AuthTokenFactory {
  String vehicleServiceToken;  // initially null
  long expiryTimeMs = 0;

  // This method is called on a thread whose only responsibility is to send
  // location updates. Blocking is OK, but just know that no location updates
  // can occur until this method returns.
  @Override public String getToken(AuthTokenContext authTokenContext) {
    if (System.currentTimeMillis() > expiryTimeMs) {
      // The token has expired, go get a new one.
      fetchNewToken(vehicleId);
    }
    if (ServiceType.VEHICLE.equals(authTokenContext.getServiceType)) {
      return vehicleServiceToken;
    } else {
      throw new RuntimeException("Unsupported ServiceType: " + authTokenContext.getServiceType());
    }
  }

  private void fetchNewToken(String vehicleId) {
    String url = "https://yourauthserver.example/token/" + vehicleId;

    try (Reader r = new URL(url).openStream()) {
      com.google.gson.JsonObject obj
          = new com.google.gson.JsonParser().parse(r);
      vehicleServiceToken = obj.get("VehicleServiceToken").getAsString();
      expiryTimeMs = obj.getAsLong("TokenExpiryMs");

      // The expiry time could be an hour from now, but just to try and avoid
      // passing expired tokens, we subtract 10 minutes from that time.
      expiryTimeMs -= 10 * 60 * 1000;
    } catch (IOException e) {
      // It's OK to throw exceptions here, the StatusListener you passed to
      // create the FleetEngine class will be notified and pass along the failed
      // update warning.
      throw new RuntimeException("Could not get auth token", e);
    }
  }
}

この実装では、組み込みの Java HTTP クライアントを使用して、デベロッパーの認証サーバーから JSON 形式のトークンを取得します。トークンは再利用のために保存されます。古いトークンの有効期限から 10 分以内の場合、トークンは再取得されます。

実装によっては、バックグラウンドスレッドを使用してトークンを更新するなど、異なる処理が行われる場合があります。

AuthTokenFactory の例外は、繰り返し発生しない限り、一時的なものとして扱われます。何度か試行すると、Driver SDK はエラーが永続的なものと見なし、アップデートの送信を停止します。

`StatusListener` を使用した Status と Error Reporting

Driver SDK はバックグラウンドでアクションを実行するため、StatusListener を使用して、エラー、警告、デバッグメッセージなどの特定のイベントが発生したときに通知をトリガーします。エラーは本質的に一時的なもの（BACKEND_CONNECTIVITY_ERROR など）もあれば、位置情報の更新が恒久的に停止する原因となる場合もあります（設定エラーを示す VEHICLE_NOT_FOUND など）。

次のように、オプションの StatusListener 実装を指定します。

class MyStatusListener implements StatusListener {
  /** Called when background status is updated, during actions such as location reporting. */
  @Override
  public void updateStatus(
    StatusLevel statusLevel,
    StatusCode statusCode,
    String statusMsg) {
    // Status handling stuff goes here.
    // StatusLevel may be DEBUG, INFO, WARNING, or ERROR.
    // StatusCode may be DEFAULT, UNKNOWN_ERROR, VEHICLE_NOT_FOUND,
    // BACKEND_CONNECTIVITY_ERROR, or PERMISSION_DENIED.
  }
}

SSL/TLS に関する注意事項

Driver SDK の実装では、内部的に SSL/TLS を使用して Fleet Engine サーバーと安全に通信します。以前のバージョンの Android（API バージョン 23 以前）では、サーバーと通信するために SecurityProvider パッチが必要になる場合があります。Android で SSL を使用する方法については、セキュリティプロバイダをアップデートして SSL エクスプロイトから保護するをご覧ください。この記事には、セキュリティプロバイダにパッチを適用するためのコードサンプルも掲載されています。

位置情報の更新を有効にする

*VehicleReporter インスタンスを取得したら、位置情報の更新を簡単に有効にします。

DeliveryVehicleReporter reporter = ...;

reporter.enableLocationTracking();

位置情報の更新データは定期的に送信されます（可能な場合）。また、位置情報が更新されるたびに、車両がオンラインであることも示されます。

デフォルトでは、レポート間隔は 10 秒ですが、FleetEngine.setLocationReportingInterval(long, TimeUnit) でレポート間隔を変更できます。サポートされる最小更新間隔は 5 秒です。頻繁に更新すると、リクエストが遅くなり、エラーが発生する可能性があります。

位置情報の更新を無効にする

ドライバーのシフトが終了したら、DeliveryVehicleReporter.disableLocationTracking を呼び出して位置情報の更新を停止できます。

信頼できるモデルのユースケース

このセクションでは、信頼できるモデルを使用する際に Driver SDK を使用して一般的なユースケースを実装する方法について説明します。

車両を作成する

Driver SDK から車両を作成できます。

車両を作成する前に、必ず Delivery Driver API を初期化してください。車両 ID は、Driver SDK の初期化中に使用された車両 ID とプロバイダ ID で作成する必要があります。次に、次の例のように車両を作成します。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleManager vehicleManager = api.getDeliveryVehicleManager();
try {
  DeliveryVehicle vehicle = vehicleManager.createVehicle().get();
  // Handle CreateVehicleRequest DeliveryVehicle response.
} catch (Exception e) {
  // Handle CreateVehicleRequest error.
}

配送集荷タスクを作成する

Driver SDK から配送集荷タスクを作成できます。

タスクを作成する前に、必ず Delivery Driver API を初期化してください。タスクは、Driver SDK の初期化時に指定されたプロバイダ ID を使用して作成する必要があります。次に、次の例に示すように配送受け取りタスクを作成します。タスク ID の詳細については、タスク ID の例をご覧ください。

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
   .setTaskDurationSeconds(2 * 60)
   .setParentId("my-tracking-id")
   .setTaskType(TaskType.DELIVERY_PICKUP)
   .build();

try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

配送タスクを作成する

Driver SDK から配送タスクを作成できます。

タスクを作成する前に、必ず Delivery Driver API を初期化してください。次に、次の例に示すように配送タスクを作成します。タスク ID については、タスク ID の例をご覧ください。

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
   .setTaskDurationSeconds(2 * 60)
   .setParentId("my-tracking-id")
   .setTaskType(TaskType.DELIVERY_DELIVERY)
   .build();
try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

スケジュール設定された利用停止

Driver SDK から使用不能であることを示すタスク（ドライバーのブレークや車両への給油など）を作成できます。スケジュール設定された利用不能なタスクには、トラッキング ID を含めることはできません。必要に応じて場所を指定できます。

タスクを作成する前に、必ず Delivery Driver API を初期化してください。次に、次の例に示すように利用不可タスクを作成します。タスク ID については、タスク ID の例をご覧ください。

static final String TASK_ID = "task-8241890"; // Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setTaskDurationSeconds(2 * 60) // Duration or location (or both) must be provided for a BREAK task.
   .setTaskType(TaskType.UNAVAILABLE)
   .build();
try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

スケジュール設定された停車地

Driver SDK からスケジュール設定された停止タスクを作成できます。スケジュール設定された停止タスクにトラッキング ID を含めることはできません。

タスクを作成する前に、必ず Delivery Driver API を初期化してください。次に、次の例のようにスケジュール設定された停止タスクを作成します。タスク ID については、タスク ID の例をご覧ください。

static final String TASK_ID = "task-8241890"; //  Avoid auto-incrementing IDs.

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();
CreateDeliveryTaskRequest request = CreateDeliveryTaskRequest.builder(TASK_ID)
   .setPlannedWaypoint(Waypoint.builder().setLatLng(-6.195139, 106.820826).build())
   .setTaskDurationSeconds(2 * 60)
   .setTaskType(TaskType.DELIVERY_SCHEDULED_STOP)
   .build();
try {
   DeliveryTask task = taskManager.createTask(request).get();
   // Handle CreateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle CreateTaskRequest error.
}

タスクの順序を更新

Driver SDK から車両に割り当てられたタスクの実行順序を更新できます。

タスクの順序を更新すると、以前に車両に割り当てられていなかったタスクも車両に割り当てられます。また、以前に車両に割り当てられ、更新された順序から除外されたタスクを閉じます。以前に別の車両に割り当てられていたタスクを別の車両に割り当てると、エラーが発生します。新しい車両にタスクを割り当てる前に、既存のタスクを閉じて、新しいタスクを作成します。

タスクの順序はいつでも変更できます。

車両のタスクの注文を更新する前に、車両とタスクがすでに Fleet Engine に作成されていることを確認してください。次に、次の例のように車両のタスクの順序を更新します。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
try {
   List<VehicleStop> stops = reporter.setVehicleStops(
     ImmutableList.of(
         VehicleStop.builder()
             .setVehicleStopState(VehicleStopState.ARRIVED)
             .setWaypoint(Waypoint.builder().setLatLng(37.1749, 122.412).build())
             .setTasks(ImmutableList.of(task1)) // Previously created DeliveryTask in Fleet Engine.
             .build(),
         VehicleStop.builder()
             .setVehicleStopState(VehicleStopState.NEW) // The current vehicle stop.
             .setWaypoint(Waypoint.builder().setLatLng(37.7749, 122.4194).build())
             .setTasks(ImmutableList.of(task2)) // Previously created DeliveryTask in Fleet Engine.
             .build(),
         VehicleStop.builder()
             .setVehicleStopState(VehicleStopState.NEW)
             .setWaypoint(Waypoint.builder().setLatLng(37.3382, 121.8863).build())
             .setTasks(ImmutableList.of(task3, task4)) // Previously created DeliveryTasks in Fleet Engine.
             .build())).get();
   // Successfully updated vehicle stops in Fleet Engine. Returns the successfully set VehicleStops.
} catch (Exception e)  {
   // Failed to update vehicle stops in Fleet Engine. Setting VehicleStops must be attempted again after resolving
   // errors.
}

Driver SDK の内部状態の更新を妨げる可能性のある例外が発生する可能性があります。この場合、問題を解決し、呼び出しが成功するまで setVehicleStops を再度呼び出します。

考えられる問題には次のようなものがあります。

指定された VehicleStops が有効なパターンに従っていない。最初の VehicleStop は VehicleStopStates の NEW、ENROUTE、ARRRIVED のいずれかに設定できます。現在の停車地より後の VehicleStops は、新しい VehicleStopState でなければなりません。
タスクが存在しないか、別の車両のタスクです。
車両が存在しない。

車両は次の駅に向かっています

車両が停車地から出発したときとナビゲーションを開始したときに、Fleet Engine に通知する必要があります。Driver SDK から Fleet Engine に通知できます。

車両が停車地から出発したことを Fleet Engine に通知する前に、車両の停車場所が作成され、設定されていることを確認してください。次の例に示すように、Fleet Engine に車両の出発を通知します。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
reporter.enableLocationTracking(); // Location tracking must be enabled.

// Create Vehicle, VehicleStops, and DeliveryTasks.
// Set VehicleStops on Vehicle.

navigator.setDestination(vehicleStop.getWaypoint());
try {
   List<VehicleStop> updatedStops = reporter.enrouteToNextStop().get();
   // Successfully updated vehicle stops in Fleet Engine. Returns the set VehicleStops, with the first
   // VehicleStop updated to ENROUTE state.
} catch (Exception e)  {
   // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
   // after resolving errors.
}

Driver SDK の内部状態の更新を妨げる可能性のある例外が発生する可能性があります。この場合、問題を解決し、成功するまで enrouteToNextStop を再度呼び出します。

考えられる問題には次のようなものがあります。

Driver SDK で残りの VehicleStops は設定されません。

車両が停車地に到着する

車両が停車地に到着したときに Fleet Engine に通知する必要があります。Fleet Engine は Driver SDK から通知できます。

車両が停車地に到着したことを Fleet Engine に通知する前に、車両の停車地が設定されていることを確認します。次の例に示すように、停車地への車両の到着を Fleet Engine に通知します。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
reporter.enableLocationTracking(); // Location tracking must be enabled.

// Create Vehicle, VehicleStops, and DeliveryTasks.
// Set VehicleStops on Vehicle.
// Mark ENROUTE to VehicleStop and start guidance using Navigator.

try {
   List<VehicleStop> updatedStopsArrived = reporter.arrivedAtStop().get();
   // Successfully updated vehicle stops in Fleet Engine. Returns the set VehicleStops, with the first
   // VehicleStop updated to ARRIVED state.
   navigator.clearDestinations();
} catch (Exception e)  {
   // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
   // after resolving errors.
}

Driver SDK の内部状態の更新を妨げる可能性のある例外が発生する可能性があります。この場合、問題を解決し、成功するまで arrivedAtStop を再度呼び出します。

次のような問題が考えられます。

Driver SDK で残りの VehicleStops は設定されません。

車両が停車を完了

車両が停止を完了したときに Fleet Engine に通知する必要があります。これにより、停止に関連付けられているすべてのタスクが CLOSED 状態に設定されます。Driver SDK から Fleet Engine に通知できます。

次の例に示すように、車両が VehicleStop を完了したことを Fleet Engine に通知します。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleReporter reporter = api.getDeliveryVehicleReporter();
reporter.enableLocationTracking(); // Location tracking must be enabled.

// After completing the tasks at the VehicleStop, remove it from the
// the current list of VehicleStops.

try {
   List<VehicleStop> updatedStopsCompleted = reporter.completedStop().get();
   // Successfully updated vehicle stops in Fleet Engine. All tasks on the completed stop are set to CLOSED.
   // Returns the set VehicleStops, with the completed VehicleStop removed from the remaining list.
} catch (Exception e)  {
   // Failed to update vehicle stops in Fleet Engine. Updating VehicleStops must be attempted again
   // after resolving errors.
}

Driver SDK の内部状態の更新を妨げる可能性のある例外が発生する可能性があります。この場合、問題を解決し、成功するまで completedStop を再度呼び出します。

考えられる問題には次のようなものがあります。

Driver SDK で残りの VehicleStops は設定されません。

タスクを閉じる

車両に割り当てられているタスクを閉じるには、タスクが行われる場所の停車地を車両が完了したことを Fleet Engine に通知するか、車両の停車地のリストから削除します。これを行うには、車両のタスクの順序を更新する場合と同様に、残りの車両停車地のリストを設定します。

タスクにまだ車両が割り当てられておらず、終了する必要がある場合は、タスクを CLOSED 状態に更新します。ただし、CLOSED タスクを再度開くことはできません。

タスクを閉じても、成功または失敗を意味するわけではありません。これは、タスクが進行中と見なされなくなったことを示します。配送追跡では、配送結果を表示できるように、タスクの実際の結果を示すことが重要です。

Driver SDK を使用してタスクを閉じるには、タスクを車両に割り当てる必要があります。車両に割り当てられているタスクを閉じるには、タスクが行われる場所の停車を車両が完了したことを Fleet Engine に通知します。

または、タスクが割り当てられている車両のタスクの順序を更新してから、停車地のリストから目的のタスクを削除します。

タスクの結果と結果のロケーションを設定する

タスクを閉じても、成功か失敗かはわかりません。これは、タスクが進行中と見なされなくなったことを示します。配送追跡では、配送結果を表示し、サービスに対して適切な課金が行われるように、タスクの実際の結果を示すことが重要です。一度設定したタスクの結果は変更できません。ただし、タスクの結果時間とタスクの結果の場所は、設定後に変更できます。

終了状態のタスクの結果は、SUCCEEDED または FAILED のいずれかに設定されます。Fleet Engine は、ステータスが「SUCCEEDED」の配信タスクにのみ課金します。

タスクの結果をマークするときに、Fleet Engine は最後に認識された車両の位置情報をタスクの結果の場所に自動的に入力します。この動作は、Fleet Engine を呼び出すことでオーバーライドできます。Driver SDK を使用してタスクの結果の場所を設定することはできません。

次のコード例は、Driver SDK を使用してタスクの結果とタイムスタンプを設定する方法を示しています。

static final String TASK_ID = "task-8241890";

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryTaskManager taskManager = api.getDeliveryTaskManager();

// Updating an existing DeliveryTask which is already CLOSED. Manually
// setting TaskOutcomeLocation with Driver SDK is not supported at this time.
UpdateDeliveryTaskRequest req = UpdateDeliveryTaskRequest.builder(TASK_ID)
    .setTaskOutcome(TaskOutcome.SUCCEEDED)
    .setTaskOutcomeTimestamp(now()) // Timestamp in milliseconds.
    .build();

try {
   DeliveryTask updatedTask = taskManager.updateTask(req);
   // Handle UpdateTaskRequest DeliveryTask response.
} catch (Exception e)  {
   // Handle UpdateTaskRequest error.
}

車両を検索する

Driver SDK から車両を検索できます。車両を調べる前に、Delivery Driver API を初期化してください。次の例のように、車両を検索できます。

DeliveryDriverApi api = DeliveryDriverApi.getInstance();
DeliveryVehicleManager vehicleManager = api.getDeliveryVehicleManager();
try {
   DeliveryVehicle vehicle = vehicleManager.getVehicle().get();
   // Handle GetVehicleRequest DeliveryVehicle response.
} catch (Exception e)  {
   // Handle GetVehicleRequest error.
}

DeliveryVehicleManager は、Delivery Driver API の初期化時に指定された車両 ID についてのみ DeliveryVehicle を検索できます。

Driver SDK for Android のスタートガイド

最小システム要件

ビルドと依存関係の構成

Gradle

Maven

プロジェクト構成

開発プロジェクトを設定する

Driver SDK をアプリに追加する

Gradle

Maven

Gradle

Maven

アプリのマニフェストを更新する

必要な帰属情報をアプリに含める

依存関係

SDK を初期化する

AuthTokenFactory による認証

StatusListener を使用した Status と Error Reporting

SSL/TLS に関する注意事項

位置情報の更新を有効にする

位置情報の更新を無効にする

信頼できるモデルのユースケース

車両を作成する

配送集荷タスクを作成する

配送タスクを作成する

スケジュール設定された利用停止

スケジュール設定された停車地

タスクの順序を更新

車両は次の駅に向かっています

車両が停車地に到着する

車両が停車を完了

タスクを閉じる

タスクの結果と結果のロケーションを設定する

車両を検索する

`AuthTokenFactory` による認証

`StatusListener` を使用した Status と Error Reporting