サンプルアプリは、Android 用 Google Home API の基本機能を紹介します。
前提条件
アプリをビルド、インストール、テストするには、次の前提条件を満たす必要があります。
Android Studio バージョン 2024.2.1(Ladybug)以降。 これより前のバージョンでは、Home APIs SDK が正しく動作しない可能性があります。
Android デバッガ(
adb)。adbをインストールします。これは SDK Manager で行うことができます。
Home APIs をテストするには、次のものが必要です。
- Android 10 以降を搭載した Android デバイス。開発に使用する Google アカウントでセットアップされていること。最新バージョンの Android Studioがインストールされ、この 開発アカウントでログインしていることを確認してください。
- Wi-Fi ネットワーク。
- Matter デバイスにアクセスして操作するには、 Home APIs をサポートする Google ハブも必要です。 詳細については、Android での接続 をご覧ください。
家にサポートされているデバイスが少なくとも 1 台あること。このデバイス(またはテストする他のデバイス)が Thread を使用している場合、ハブも Thread ボーダー ルーターである必要があります。Android サンプルアプリでは、次のデバイスタイプとトレイトがサポートされています。
- 色温度ライト(オン / オフ、明るさ)
- コンタクト センサー(ブール値の状態)
- 調光可能なライト(オン / オフ、明るさ)
- 拡張色ライト(オン / オフ、明るさ)
- 汎用スイッチ
- Google カメラ
- 在宅確認センサー(在宅確認)
- オン / オフ ライト(オン / オフ、明るさ)
- オン/オフ ライト スイッチ
- オン / オフ プラグイン ユニット(オン / オフ)
- オン/オフ センサー
ソースコードをダウンロードする
サンプルアプリのソース コードは GitHub で入手できます。
プロジェクトを保存する場所に移動し、クローンを作成します。
git clone https://github.com/google-home/google-home-api-sample-app-android.gitSDK を設定する
このオープンベータ版の Android 用 Home APIs は、Google が開発用に提供する標準ライブラリにはまだ含まれていません。Home APIs を使用して Android アプリケーションを開発するには、ライブラリをダウンロードしてローカルでホストする必要があります。
Home APIs Android SDK をダウンロードするには、まず Google Home デベロッパーにログインする必要があります。
アプリをビルドする
- Android Studio を開き、ローカルマシンにクローンした
google-home-api-sample-app-androidプロジェクト フォルダを開きます。 最初のセットアップ時に、Android Studio がすべてのプロジェクトの依存関係をダウンロードして Gradle ビルドを完了するまでに、最大 10 分かかることがあります。
USB ケーブルでパソコンを物理的な Android スマートフォンに接続し、 デベロッパー オプションで ADB を有効にします。 Android Studio が Android スマートフォン が ADB 経由で接続できることを確認します。
サンプルアプリのパッケージ名を、以前に登録されていない新しいパッケージ名(組織名に基づくものなど)に変更します。
- プロジェクトを開きます。
- ソース階層を開きます。
- 変更するパッケージの部分(
com.example)を選択します。 - パッケージを右クリックして、[Refactor] > [Rename...]
を選択します。 - 新しい名前を入力し、[Refactor] をクリックします。
build.gradle.ktsファイルを編集し、android namespaceとapplicationIdを新しいパッケージ名に変更します。
必要なライブラリがすべてダウンロードされ、Gradle の同期が完了したら、[Run] ボタンをクリックしてアプリをビルドして実行します。アプリがスマートフォンで正常に実行されると、サンプルアプリのメインページが表示されます。
署名証明書を作成する
Android Studio でアプリを実行またはデバッグすると、開発とデバッグを目的としたデバッグ用証明書が自動的に 生成されます。詳細については、 Android Studio: デバッグビルドに署名する をご覧ください。
Android Studio でアプリを実行して、デバッグアプリ署名証明書を生成します。 Android Studioアプリを実行またはデバッグすると、 Android Studioが開発とデバッグを目的としたアプリ署名証明書を自動的に生成します。Android Studio詳細については、 Android Studio: デバッグビルドに署名する をご覧ください。
モバイル デバイスをローカルマシンに接続します。 Android Studio に、接続されているデバイスがモデル 番号で一覧表示されます。リストからデバイスを選択し、[Run project] をクリックします。これにより、サンプルアプリがビルドされ、モバイル デバイスにインストールされます。
詳細な手順については、ハードウェア デバイス 上でのアプリの実行をご覧ください。
実行中のアプリを停止します。
OAuth 同意画面を設定する
- Google Cloud コンソールで、 プロジェクト セレクタ ダッシュボード に移動し、OAuth 認証情報の作成に使用するプロジェクトを選択します。
- [API とサービス] ページに移動し、ナビゲーション メニューで [認証情報] をクリックします。
この Google Cloud プロジェクトの同意画面をまだ構成していない場合は、[Configure consent screen] ボタンが表示されます。その場合は、次の手順で同意画面を構成します。それ以外の場合は、次のセクションに進みます。
- [同意画面を設定] をクリックします。[OAuth 同意画面] ページが表示されます。
- ユースケースに応じて [Internal] または [External] を選択し、 [Create] をクリックします。[OAuth 同意画面] ペインが表示されます。
- [App information page] ページで、画面上の手順に沿って情報を入力し、[Save and continue] をクリックします。[Scopes] ペインが表示されます。
- スコープを追加する必要はないため、[Save and continue] をクリックします。[Test users] ペインが表示されます。
- [Audience] をクリックし、[+ ADD USERS] ボタンをクリックします。
- テストユーザーのメールアドレスを入力し、[SAVE] ボタンをクリックします。
- [Save and continue] をクリックします。[Summary] ペインが表示されます。
- OAuth 同意画面の情報を確認し、[Back to dashboard] をクリックします。
詳細については、Google Cloud コンソール ヘルプサイトの OAuth 同意 画面 の設定をご覧ください。続行する前に、少なくとも 1 人のテストユーザーを追加してください。
OAuth 認証情報を設定する
- OAuth 2.0 の設定の手順に沿って、サンプルアプリを OAuth 2.0 に登録し、OAuth 認証情報を作成します。
- アプリケーション タイプを指定します。これはネイティブ/Android アプリ です。
- Google Cloud コンソール ヘルプサイトの OAuth 2.0 の設定 / ネイティブ アプリケーション / Android の手順に沿って、SHA-1 フィンガープリントを OAuth クライアントに追加します。開発プロセス全体を通して、デフォルトの Android Studio キーから SHA-1 キーを生成する必要があります。
アプリを実行する
- モバイル デバイスをローカルマシンに接続した状態で、[Run project] をもう一度クリックして、モバイル デバイスでサンプルアプリを実行します。
インストールすると、アプリはモバイル デバイスで [Home API Sample App] として使用できるようになります。