Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Google Home API Android サンプルアプリ

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

前提条件

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

Android Studio、バージョン 2024.2.1（「Ladybug」）以降。これより前のバージョンでは、Home APIs SDK が正常に動作しない可能性があります。

Android Studio のダウンロード
Android デバッガ（adb）。

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

これは SDK Manager で行えます。

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

開発に使用する Google アカウントでセットアップされた Android 10 以降を搭載した Android デバイス。Android Studio の最新バージョンがインストールされ、このデベロッパーアカウントでログインしていることを確認します。
Wi-Fi ネットワーク。
Matter デバイスにアクセスして操作するには、Home API をサポートする Google ハブも必要です。詳しくは、Android の接続をご覧ください。
家の中にサポートされているデバイスが 1 台以上ある。このデバイス（またはテストする他のデバイス）が Thread を使用している場合、ハブも Thread Border Router (TBR) である必要があります。Android サンプルアプリでは、次のデバイスタイプとトレイトがサポートされています。
- 色温度ライト（オン、オフ、明るさ）
- 接触センサー（ブール値の状態）
- 調光ライト（オン、オフ、明るさ）
- ドアロック
- 拡張カラーライト（オン、オフ、明るさ）
- 汎用スイッチ
- Google ボーダールーター
- Google カメラ
- Google Doorbell
- 在室確認センサー（在室確認）
- オン/オフライト（オンとオフ、明るさ）
- オン/オフライトスイッチ
- オン/オフプラグインユニット（オン、オフ）
- オン/オフセンサー

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

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

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

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

SDK を設定する

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

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

今すぐログイン

アプリをビルドする

Android Studio を開き、ローカルマシンにクローンされた google-home-api-sample-app-android プロジェクトフォルダを開きます。
最初のセットアップ時に、Android Studio がすべてのプロジェクトの依存関係をダウンロードして Gradle ビルドを完了するまでに、最大 10 分かかることがあります。

ヒント: この手順で Gradle Sync Failed などのエラーが発生した場合は、[再試行] をクリックして同期を再開します。
USB ケーブルでパソコンを物理 Android スマートフォンに接続し、開発者向けオプションで ADB を有効にします。Android Studio が ADB 経由で Android スマートフォンに接続できることを確認します。

注: Home API は実際のスマートフォンで実行されている Google Play 開発者サービスに依存しているため、Android Emulator ではなく、実際の Android スマートフォンでサンプルアプリを実行することをおすすめします。
サンプルアプリのパッケージ名を、組織の名前に基づく名前など、これまでに登録されていない新しい名前に変更します。
1. プロジェクトを開きます。
2. ソース階層を開きます。
3. 変更するパッケージの部分（com.example）を選択します。
4. パッケージを右クリックし、[Refactor] > [Rename...] を選択します。
5. 新しい名前を入力し、[Refactor] をクリックします。
6. build.gradle.kts ファイルを編集し、android namespace と applicationId を新しいパッケージ名に変更します。
HomeModule.kt で OAuth スコープを構成します。デフォルトでは、サンプルアプリのソースコードは https://www.googleapis.com/auth/home.platform.v2 スコープを使用します。サンプルアプリの多くの機能は home.platform.v2 スコープによって制限されており、アクセスするにはパートナーの承認が必要です。標準の https://www.googleapis.com/auth/home.platform.selected.devices スコープでサンプルアプリを実行するには、HomeModule.kt を開き、HomeConfig の homePlatformScope を HOME_PLATFORM_SCOPE_VERSION_1 に変更します。
```
val homeConfig = HomeConfig(
  coroutineContext = Dispatchers.IO,
  factoryRegistryProvider = {
    FactoryConstants.factoryRegistryAllTraitsAllTypes
  },
  homePlatformScope =
    HomeConfig.HomePlatformScope.HOME_PLATFORM_SCOPE_VERSION_1
)
```

HomeClientProvider.kt の switchAccount() で homePlatformScope を HOME_PLATFORM_SCOPE_VERSION_1 に更新します。それ以外の場合、プロフィールアイコンを選択してアカウントを切り替えると、アプリは HOME_PLATFORM_SCOPE_VERSION_2 に戻ります。

必要なライブラリがすべてダウンロードされ、Gradle の同期が完了したら、[Run] ボタンをクリックしてアプリをビルドして実行します。アプリがスマートフォンで正常に実行されると、サンプルアプリのメインページが表示されます。

署名証明書を作成する

Android Studio でアプリを実行またはデバッグすると、開発とデバッグを目的としたデバッグ用証明書が自動的に生成されます。詳細については、Android Studio: デバッグビルドに署名するをご覧ください。

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

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

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

実行中のアプリを停止します。
Google Cloud コンソールのヘルプサイトの OAuth クライアントの管理 / アプリケーションタイプ / ネイティブアプリケーション / Android の手順に沿って、デバッグ用証明書の SHA-1 フィンガープリントを取得します。
ヒント: Android Studio 2024.2.1（「Ladybug」）以降でプロジェクトのキーストアの場所を確認するには:
1. [Settings] > [Experimental] で、[Configure all Gradle tasks during Gradle Sync] が選択されていることを確認します。
2. Gradle ツールウィンドウを開きます。
3. プロジェクトを選択します。
4. app（app > tasks > android）から始まる Gradle 設定ツリーを展開します。
5. [android] で [signingReport] を選択します。
6. 下のパネルに署名レポートが表示されます。Store で始まる行を探します。これにより、debug.keystore ファイルの場所がわかります。

OAuth 同意を設定する

Google Cloud コンソールで、プロジェクトセレクタダッシュボードに移動し、OAuth 認証情報の作成に使用するプロジェクトを選択します。
[API とサービス] ページに移動し、ナビゲーションメニューで [認証情報] をクリックします。
この Google Cloud プロジェクトの同意画面をまだ構成していない場合は、[同意画面を構成] ボタンが表示されます。その場合は、次の手順で同意画面を構成します。それ以外の場合は、次のセクションに進みます。
1. [同意画面を構成] をクリックします。[OAuth 同意画面] ページが表示されます。
2. ユースケースに応じて [内部] または [外部] を選択し、[作成] をクリックします。[OAuth 同意画面] ペインが表示されます。
3. 画面上の手順に沿って [アプリ情報ページ] に情報を入力し、[保存して続行] をクリックします。[スコープ] ペインが表示されます。
4. スコープを追加する必要はないため、[保存して次へ] をクリックします。[テストユーザー] ペインが表示されます。
5. [対象ユーザー] をクリックし、[+ ユーザーを追加] ボタンをクリックします。
6. テストユーザーのメールアドレスを入力し、[保存] ボタンをクリックします。
7. [保存して次へ] をクリックします。[概要] ペインが表示されます。
8. OAuth 同意画面の情報を確認し、[ダッシュボードに戻る] をクリックします。

詳細については、Google Cloud コンソールのヘルプサイトの OAuth 同意画面の設定をご覧ください。続行する前に、少なくとも 1 人のテストユーザーを追加してください。

OAuth 認証情報を設定する

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

アプリを実行する

モバイルデバイスをローカルマシンに接続した状態で、[Run project] を再度クリックして、モバイルデバイスでサンプルアプリを実行します。

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