Home APIs 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 ボーダー ルーターである必要があります。Android サンプルアプリでは、次のデバイスタイプとトレイトがサポートされています。

    • 色温度ライト(オン、オフ、明るさ)
    • コンタクト センサー(ブール値の状態)
    • 調光可能な照明(オン、オフ、明るさ)
    • 拡張カラー照明(オン、オフ、明るさ)
    • 汎用スイッチ
    • 在宅確認センサー(在宅検出)
    • 照明のオン/オフ(オン、オフ、明るさ)
    • オン/オフ ライトスイッチ
    • オン/オフ プラグイン ユニット(オン、オフ)
    • オン/オフ センサー

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

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

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

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

SDK を設定する

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

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

今すぐログイン

アプリをビルドする

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

  3. USB ケーブルでパソコンを実機 Android スマートフォンに接続し、開発者向けオプションで ADB を有効にします。Android Studio が ADB 経由で Android スマートフォンに接続できることを確認します。

  4. サンプルアプリのパッケージ名を、組織名に基づくなど、以前に登録されていない新しいパッケージ名に変更します。

    1. プロジェクトを開きます。
    2. ソース階層を展開します。
    3. 変更するパッケージの部分(com.example)を選択します。
    4. パッケージを右クリックして、[Refactor] > [Rename...] を選択します。 [Refactor] > [Rename] メニュー
    5. 新しい名前を入力し、[Refactor] をクリックします。
    6. build.gradle.kts ファイルを編集し、android namespaceapplicationId を新しいパッケージ名に変更します。
  5. 必要なライブラリがすべてダウンロードされ、Gradle の同期が完了したら、[実行] ボタンをクリックしてアプリをビルドして実行します。アプリがスマートフォンで正常に実行されると、サンプルアプリのメインページが表示されます。

署名証明書を作成する

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

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

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

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

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

  2. Google Cloud コンソール ヘルプサイトの OAuth クライアント / アプリケーション タイプ / ネイティブ アプリケーション / Android の管理に記載されている手順に沿って、デバッグ証明書の SHA-1 フィンガープリントを取得します。

  1. Google Cloud コンソールで、プロジェクト セレクタ ダッシュボードに移動し、OAuth 認証情報の作成に使用するプロジェクトを選択します。
  2. [API とサービス] ページに移動し、ナビゲーション メニューで [認証情報] をクリックします。
  3. この Google Cloud プロジェクトの同意画面をまだ構成していない場合は、[同意画面を構成] ボタンが表示されます。その場合は、次の手順で同意画面を構成します。それ以外の場合は、次のセクションに進みます。

    1. [同意画面を構成] をクリックします。[OAuth 同意画面] ページが表示されます。
    2. ユースケースに応じて、[内部] または [外部] を選択し、[作成] をクリックします。[OAuth 同意画面] ペインが表示されます。
    3. 画面上の手順に沿って [アプリ情報] ページに情報を入力し、[保存して次へ] をクリックします。[スコープ] ペインが表示されます。
    4. スコープを追加する必要はないため、[保存して次へ] をクリックします。[テストユーザー] ペインが表示されます。
    5. [Audience] をクリックし、[+ ユーザーを追加] ボタンをクリックします。
    6. テストユーザーのメールアドレスを入力し、[保存] ボタンをクリックします。
    7. [保存して次へ] をクリックします。[概要] ペインが表示されます。
    8. OAuth 同意画面の情報を確認し、[ダッシュボードに戻る] をクリックします。

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

OAuth 認証情報を設定する

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

アプリを実行する

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

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