Home APIs Android サンプルアプリ

このサンプルアプリは、Google Home API の基本的な機能を示しています。

前提条件

アプリのビルド、インストール、テストを行うには、いくつかの前提条件を満たす必要があります。

  • Android Studio、バージョン 2024.2.1（「Ladybug」）以降。以前のバージョンでは、Home APIs SDK が正しく動作しないことがあります。

    Android Studio のダウンロード

  • Android デバッガ（adb）。

    adb をインストールします。

    これは SDK マネージャーで行うことができます。

Home API をテストするには、次のものが必要です。

  • Android 10 以降を搭載した Android デバイス。開発に使用する Google アカウントでセットアップされていること。最新バージョンの Android Studio がインストールされ、この開発用アカウントでログインしていることを確認します。
  • Wi-Fi ネットワーク。
  • Home API をサポートする Google ハブ。

  • 家の中にサポートされているデバイスが 1 台以上あること。このデバイス（またはテストする他のデバイス）が Thread を使用する場合は、ハブも Thread ボーダー ルーターである必要があります。Android サンプルアプリでは、次のデバイスタイプとトレイトがサポートされています。

    • 色温度ライト（オン / オフ、明るさ）
    • 接触センサー（ブール値の状態）
    • 調光ライト（オン / オフ、明るさ）
    • 拡張色ライト（オン / オフ、明るさ）
    • 汎用スイッチ
    • 在室確認センサー（在宅検出）
    • ライトのオン/オフ（オン、オフ、明るさ）
    • オン/オフ ライトスイッチ
    • オン/オフ プラグイン ユニット（オンとオフ）
    • オン/オフセンサー

  1. Google Cloud コンソールでプロジェクト セレクタ ダッシュボードに移動し、OAuth 認証情報を作成するプロジェクトを選択します。
  2. [API とサービス] ページに移動し、ナビゲーション メニューで [認証情報] をクリックします。

  3. この Google Cloud プロジェクトの同意画面をまだ構成していない場合は、[同意画面を構成] ボタンが表示されます。その場合は、次の手順で同意画面を構成します。問題が解決しない場合は、次のセクションに進みます。

    1. [同意画面を構成] をクリックします。OAuth 同意画面が表示されます。
    2. ユースケースに応じて [内部] または [外部] を選択し、[作成] をクリックします。[OAuth 同意画面] ペインが表示されます。
    3. 画面上の手順に沿って [アプリ情報ページ] に情報を入力し、[保存して次へ] をクリックします。[スコープ] ペインが表示されます。
    4. スコープを追加する必要はありません。[保存して次へ] をクリックします。[Test users] ペインが表示されます。
    5. アプリへのアクセスをテストするユーザーを追加する場合は、[ユーザーを追加] をクリックします。[ユーザーを追加] ペインが表示されます。テストユーザーには、アプリで権限を付与する権限があります。
    6. 空のフィールドに 1 つ以上の Google アカウントのメールアドレスを追加し、[追加] をクリックします。
    7. [保存して次へ] をクリックします。[Summary] ペインが表示されます。
    8. OAuth 同意画面の情報を確認して、[ダッシュボードに戻る] をクリックします。

詳細については、Google Cloud コンソール ヘルプサイトの OAuth 同意画面の設定をご覧ください。

ソースコードをダウンロードする

サンプルアプリのソースコードは GitHub で入手できます。

プロジェクトを保存する場所に移動し、クローンを作成します。

git clone https://github.com/google-home/google-home-api-sample-app-android.git

SDK を設定する

このオープンベータ版の Home API は、Google が開発用に提供する標準ライブラリの一部ではありません。Home API を使用してアプリケーションを開発するには、ライブラリをローカルにダウンロードしてホストする必要があります。

Home APIs Android SDK をダウンロードするには、まず Google Home Developers にログインする必要があります。

今すぐログイン

ビルドと実行

  1. Android Studio を開き、ローカルマシンにクローンを作成した google-home-api-sample-app-android プロジェクト フォルダを開きます。
  2. 最初のセットアップでは、Android Studio がすべてのプロジェクト依存関係をダウンロードして Gradle ビルドを完了するまでに 10 分ほどかかることがあります。
    • この手順で Gradle Sync Failed などのエラーが発生した場合は、[再試行] をクリックして同期を再開します。
  3. サンプルアプリのパッケージ名を、組織の名前に基づくものなど、これまでに登録されていない新しい名前に変更します。
    1. プロジェクトを開きます。
    2. ソース階層を開きます。
    3. 変更するパッケージの部分（com.example）を選択します。
    4. パッケージを右クリックし、[Refactor] > [Rename...] を選択します。
    5. [すべてのディレクトリ] をクリックします。
    6. 新しい名前を入力して [Refactor] をクリックします。
    7. build.gradle.kts ファイルを編集し、android namespace と applicationId を新しいパッケージ名に変更します。
    8. AndroidManifest.xml ファイルを編集し、ファイル内のパッケージ名を新しいパッケージ名に変更します。

  4. Android Studio でアプリを実行して OAuth キーを生成します。Android Studio でアプリを実行またはデバッグすると、Android Studio は開発とデバッグ用の OAuth キーを自動的に生成します。詳細については、Android Studio: デバッグビルドに署名するをご覧ください。

    モバイル デバイスをローカルマシンに接続します。Android Studio には、接続されているデバイスがモデル番号で表示されます。リストからデバイスを選択し、[プロジェクトを実行] をクリックします。これにより、サンプルアプリがビルドされ、モバイル デバイスにインストールされます。

    詳細な手順については、Android デベロッパー サイトの ハードウェア デバイス上でのアプリの実行をご覧ください。

    実行中のアプリを停止します。

  5. Google Cloud コンソール ヘルプサイトの OAuth 2.0 / ネイティブ アプリケーション / Android の設定に記載されている手順に沿って、OAuth 証明書の SHA-1 フィンガープリントを取得します。

  6. OAuth 2.0 の設定の手順に沿って、OAuth 2.0 のサンプルアプリを登録し、OAuth 認証情報を作成します。

    1. アプリケーションの種類（ネイティブ/Android アプリ）を指定します。
    2. Google Cloud コンソール ヘルプサイトの OAuth 2.0 / ネイティブ アプリケーション / Android の設定の手順に沿って、SHA-1 フィンガープリントを OAuth クライアントに追加します。開発プロセス全体で、デフォルトの Android Studio 鍵から SHA-1 鍵を生成する必要があります。
    3. テストユーザーを追加します。テストユーザーには、サンプルアプリで権限を付与する権限があります。

  7. モバイル デバイスをローカルマシンに接続し、[プロジェクトを実行] をもう一度クリックして、モバイル デバイスでサンプルアプリを実行します。

インストールが完了すると、モバイル デバイスで Home API サンプルアプリとして使用できるようになります。