単一目的地のルートをナビゲートする

このガイドでは、Navigation SDK for Android を使用してアプリ内でルートを作成する方法について説明します。このガイドでは、プロジェクトを設定するで説明されているように、Navigation SDK がすでにアプリに統合されていることを前提としています。

概要

  1. UI 要素をナビゲーション フラグメントまたはナビゲーション ビューとしてアプリに追加します。この UI 要素を使用すると、インタラクティブな地図とターンバイターン ナビゲーションの UI をアクティビティに追加できます。
  2. 位置情報の利用許可をリクエストします。デバイスの位置を特定するには、アプリで位置情報の利用許可をリクエストする必要があります。
  3. NavigationApi クラスを使用して SDK を初期化します。

  4. Navigator クラスを使用して、目的地を設定し、ターンバイターン ナビゲーションを制御します。この処理は 3 つの手順で行います。

    • setDestination() を使用して宛先を設定します。
    • startGuidance() でナビを開始します。
    • getSimulator() を使用して、アプリのテスト、デバッグ、デモのために、ルート上の車両の進行状況をシミュレートします。

  5. アプリをビルドして実行します。

コードの確認

アプリに UI 要素を追加する

このセクションでは、ターンバイターン方式のナビゲーションを表示するためのインタラクティブな地図と UI を追加する 2 つの方法について説明します。ほとんどの場合、NavigationView を直接操作するのではなく、NavigationView のラッパーである SupportNavigationFragment を使用することをおすすめします。詳しくは、ナビゲーション マップの操作に関するベスト プラクティス をご覧ください。

SupportNavigationFragment は、インタラクティブな地図やターンバイターンの経路案内など、ナビゲーションの視覚的な出力を表示する UI コンポーネントです。次のように、XML レイアウト ファイル内でフラグメントを宣言できます。

<?xml version="1.0" encoding="utf-8"?>
<fragment xmlns:android="http://schemas.android.com/apk/res/android"
    android:name="com.google.android.libraries.navigation.SupportNavigationFragment"
    android:id="@+id/navigation_fragment"
    android:layout_width="match_parent"
    android:layout_height="match_parent"/>

また、Android のドキュメントで説明されているように、FragmentActivity.getSupportFragmentManager() を使用して、フラグメントをプログラムで作成することもできます。

フラグメントの代わりに、ナビゲーション用の地図を表示する UI コンポーネントを NavigationView としても利用できます。

位置情報の利用許可をリクエストする

このセクションでは、精度の高い位置情報の利用許可をリクエストする方法について説明します。詳しくは、Android の権限に関するガイドをご覧ください。

  1. 権限を <manifest> 要素の子要素として Android マニフェストに追加します。

    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.navsdksingledestination">
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
</manifest>

  2. アプリで実行時の権限をリクエストして、ユーザーが位置情報の利用許可を許可または拒否できるようにします。次のコードは、ユーザーが高精度位置情報の利用許可を付与しているかどうかを確認します。許可していない場合は、パーミッションをリクエストします。

    if (ContextCompat.checkSelfPermission(this.getApplicationContext(),
        android.Manifest.permission.ACCESS_FINE_LOCATION)
            == PackageManager.PERMISSION_GRANTED) {
    mLocationPermissionGranted = true;
} else {
    ActivityCompat.requestPermissions(this,
            new String[] { android.Manifest.permission.ACCESS_FINE_LOCATION },
            PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION);
}

if (!mLocationPermissionGranted) {
    displayMessage("Error loading Navigation SDK: "
            + "The user has not granted location permission.");
    return;
}

  3. 権限リクエストの結果を処理するよう onRequestPermissionsResult() コールバックをオーバーライドします。

    @Override
public void onRequestPermissionsResult(int requestCode, @NonNull String permissions[],
                                       @NonNull int[] grantResults) {
    mLocationPermissionGranted = false;
    switch (requestCode) {
        case PERMISSIONS_REQUEST_ACCESS_FINE_LOCATION: {
            // If request is canceled, the result arrays are empty.
            if (grantResults.length > 0
                    && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                mLocationPermissionGranted = true;
            }
        }
    }
}

Navigation SDK を初期化する

NavigationApi クラスは、アプリが Google ナビゲーションを使用できるようにする初期化ロジックを提供します。このセクションでは、ナビゲータを初期化する方法と、アプリで有効にできるその他の構成について説明します。

  1. Navigation SDK を初期化し、onNavigatorReady() コールバックをオーバーライドして、ナビゲータの準備が整ったらナビを開始します。

  2. 省略可。ユーザーがデバイスからアプリを閉じると、ガイダンス通知とバックグラウンド サービスがシャットダウンされるようにアプリを構成します。この選択は、ビジネスモデルによって異なります。アプリが閉じられても、曲がり角の案内と位置情報の更新を継続的に表示するデフォルトのナビゲーター動作を使用することをおすすめします。エンドユーザーがアプリを閉じたときにナビゲーションと位置情報の更新を停止する場合は、この構成を使用します。

  3. 省略可。サポートされている国で道路規制を有効にします。ナンバープレートの末尾の数字を設定します。この呼び出しは 1 回だけ行う必要があります。後続のルート リクエストでは引き続きこの呼び出しが使用されます。この呼び出しは、サポートされているリージョンでのみ機能します。Navigation SDK のサポートされている国をご覧ください。

    NavigationApi.getNavigator(this, new NavigationApi.NavigatorListener() {
            /**
             * Sets up the navigation UI when the navigator is ready for use.
             */
            @Override
            public void onNavigatorReady(Navigator navigator) {
                displayMessage("Navigator ready.");
                mNavigator = navigator;
                mNavFragment = (NavigationFragment) getFragmentManager()
                        .findFragmentById(R.id.navigation_fragment);

                // Optional. Disable the guidance notifications and shut down the app
                // and background service when the user closes the app.
                // mNavigator.setTaskRemovedBehavior(Navigator.TaskRemovedBehavior.QUIT_SERVICE)

                // Optional. Set the last digit of the car's license plate to get
                // route restrictions for supported countries.
                // mNavigator.setLicensePlateRestrictionInfo(getLastDigit(), "BZ");

                // Set the camera to follow the device location with 'TILTED' driving view.
                mNavFragment.getCamera().followMyLocation(Camera.Perspective.TILTED);

                // Set the travel mode (DRIVING, WALKING, CYCLING, TWO_WHEELER, or TAXI).
                mRoutingOptions = new RoutingOptions();
                mRoutingOptions.travelMode(RoutingOptions.TravelMode.DRIVING);

                // Navigate to a place, specified by Place ID.
                navigateToPlace(SYDNEY_OPERA_HOUSE, mRoutingOptions);
            }

            /**
             * Handles errors from the Navigation SDK.
             * @param errorCode The error code returned by the navigator.
             */
            @Override
            public void onError(@NavigationApi.ErrorCode int errorCode) {
                switch (errorCode) {
                    case NavigationApi.ErrorCode.NOT_AUTHORIZED:
                        displayMessage("Error loading Navigation SDK: Your API key is "
                                + "invalid or not authorized to use the Navigation SDK.");
                        break;
                    case NavigationApi.ErrorCode.TERMS_NOT_ACCEPTED:
                        displayMessage("Error loading Navigation SDK: User did not accept "
                                + "the Navigation Terms of Use.");
                        break;
                    case NavigationApi.ErrorCode.NETWORK_ERROR:
                        displayMessage("Error loading Navigation SDK: Network error.");
                        break;
                    case NavigationApi.ErrorCode.LOCATION_PERMISSION_MISSING:
                        displayMessage("Error loading Navigation SDK: Location permission "
                                + "is missing.");
                        break;
                    default:
                        displayMessage("Error loading Navigation SDK: " + errorCode);
                }
            }
        });

宛先を設定する

Navigator クラスは、ナビゲーション ジャーニーの構成、開始、停止を制御します。

前のセクションで取得した Navigator を使用して、このルートのデスティネーション Waypoint を設定します。ルートを計算すると、SupportNavigationFragment により、ルートを表すポリラインが地図上に表示され、目的地にマーカーが表示されます。

    private void navigateToPlace(String placeId, RoutingOptions travelMode) {
        Waypoint destination;
        try {
            destination = Waypoint.builder().setPlaceIdString(placeId).build();
        } catch (Waypoint.UnsupportedPlaceIdException e) {
            displayMessage("Error starting navigation: Place ID is not supported.");
            return;
        }

        // Create a future to await the result of the asynchronous navigator task.
        ListenableResultFuture<Navigator.RouteStatus> pendingRoute =
                mNavigator.setDestination(destination, travelMode);

        // Define the action to perform when the SDK has determined the route.
        pendingRoute.setOnResultListener(
                new ListenableResultFuture.OnResultListener<Navigator.RouteStatus>() {
                    @Override
                    public void onResult(Navigator.RouteStatus code) {
                        switch (code) {
                            case OK:
                                // Hide the toolbar to maximize the navigation UI.
                                if (getActionBar() != null) {
                                    getActionBar().hide();
                                }

                                // Enable voice audio guidance (through the device speaker).
                                mNavigator.setAudioGuidance(
                                        Navigator.AudioGuidance.VOICE_ALERTS_AND_GUIDANCE);

                                // Simulate vehicle progress along the route for demo/debug builds.
                                if (BuildConfig.DEBUG) {
                                    mNavigator.getSimulator().simulateLocationsAlongExistingRoute(
                                            new SimulationOptions().speedMultiplier(5));
                                }

                                // Start turn-by-turn guidance along the current route.
                                mNavigator.startGuidance();
                                break;
                            // Handle error conditions returned by the navigator.
                            case NO_ROUTE_FOUND:
                                displayMessage("Error starting navigation: No route found.");
                                break;
                            case NETWORK_ERROR:
                                displayMessage("Error starting navigation: Network error.");
                                break;
                            case ROUTE_CANCELED:
                                displayMessage("Error starting navigation: Route canceled.");
                                break;
                            default:
                                displayMessage("Error starting navigation: "
                                        + String.valueOf(code));
                        }
                    }
                });
    }

アプリをビルドして実行する

  1. Android デバイスをコンピュータに接続します。Android Studio の手順に沿って、ハードウェア デバイス上でアプリを実行する方法を行います。または、Android Virtual Device（AVD）Manager を使用して仮想デバイスを設定することもできます。エミュレータを指定する際は、Google API を含むイメージを選択する必要があります。
  2. Android Studio で [Run] メニュー オプションまたは再生ボタン アイコンをクリックします。表示される指示に沿ってデバイスを選択します。

ユーザー エクスペリエンスを向上させるヒント

  • ナビゲーションを利用できるようになるには、ユーザーが Google ナビゲーションの利用規約に同意する必要があります。この承認は 1 回のみ必要です。デフォルトでは、ナビゲータが初めて呼び出されたときに、SDK は承諾を求めるプロンプトを表示します。必要に応じて、TermsAndConditionsCheckOption を使用して、アプリの UX フローの早い段階（登録時やログイン時など）でナビゲーション利用規約ダイアログをトリガーできます。
  • ナビゲーションの品質と到着予定時刻の精度を大幅に改善するには、緯度/経度座標ではなく、プレイス ID を使用してウェイポイントを初期化します。
  • このサンプルでは、シドニー オペラハウスの特定の場所 ID から目的地のウェイポイントを導出します。プレイス ID 検索ツールを使用して、他の特定の場所のプレイス ID を取得できます。