On-demand Rides and Deliveries Solution is currently available only to select partners.

Android Driver SDK 3.0 Migration Guide

The Driver SDK for Android 3.0 release requires that you update your code for certain operations. This guide outlines the changes and what you'll need to do to migrate your code.

Package name change

The package name has changed from com.google.android.libraries.ridesharing.driver to com.google.android.libraries.mapsplatform.transportation.driver. Please update references in your code.

Initializing the SDK

In earlier versions, you would initialize the Navigation SDK and then obtain a reference to the FleetEngine class. In Driver SDK v3, initialize the SDK as follows:

Obtain a Navigator object from the NavigationApi.

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

Create a DriverContext object, populating the required fields.

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

Use the DriverContext object to initialize the *DriverApi.

RidesharingDriverApi ridesharingDriverApi = RidesharingDriverApi.createInstance(driverContext);

Obtain the NavigationVehicleReporter from the API object. *VehicleReporter extends NavigationVehicleReporter.
```
RidesharingVehicleReporter vehicleReporter = ridesharingDriverApi.getRidesharingVehicleReporter();
```

Enabling and disabling location updates

In earlier versions, you would enable location updates after obtaining a FleetEngine reference. In Driver SDK v3, enable location updates as follows:

RidesharingVehicleReporter reporter = ...;

reporter.enableLocationTracking();

To update the reporting interval, use RidesharingVehicleReporter.setLocationReportingInterval(long, TimeUnit) or DeliveryVehicleReporter.setLocationReportingInterval(long, TimeUnit).

When the driver's shift is finished, disable location updates and mark the vehicle as offline by calling NavigationVehicleReporter.disableLocationTracking().

Setting the vehicle state on the server

In earlier versions, you would use the FleetEngine object to set the vehicle state. In Driver SDK v3, use the RidesharingVehicleReporter object to set the vehicle state:

  RidesharingVehicleReporter reporter = ...;

  reporter.enableLocationTracking();
  reporter.setVehicleState(VehicleState.ONLINE);

To set the vehicle state to OFFLINE, call RidesharingVehicleReporter.disableLocationTracking(). Errors updating the vehicle state are propagated using the optionally provided StatusListener set in the DriverContext.

Error Reporting with StatusListener

ErrorListener has been removed and combined with StatusListener, which may be defined like the following:

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

Authenticating with `AuthTokenFactory`

AuthTokenFactory now has only one method, getToken(), which takes in an AuthTokenContext as the parameter. Ridesharing clients must authenticate for the VEHICLE service type, which enables location reporting and vehicle state (online/offline) reporting.

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