Permissions API

Home API を使用する前に、アプリはユーザーの家に設置されているデバイス（API では「ストラクチャ」と呼ばれます）にアクセスする権限を取得する必要があります。Permissions API を使用すると、ユーザーは Google アカウントを使用して、家にあるデバイスへのアクセスを Home APIs アプリに許可できます。

Permissions API を統合する

続行する前に、家を初期化するの手順を完了していることを確認してください。この手順の homeManager インスタンスは、ここで説明するすべての権限の例で使用されます。

まず、SDK に ActivityResultCaller を登録します。たとえば、サンプルアプリでは次のように処理します。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    homeManager.registerActivityResultCallerForPermissions(this)
  }

権限を確認する

権限をリクエストする前に、アプリのユーザーがすでに同意しているかどうかを確認することをおすすめします。そのためには、Home インスタンスの hasPermissions() メソッドを呼び出して、PermissionsState 値の Flow を取得します。

val permissionsReadyState =
  homeManager.hasPermissions().collect { state ->
    state == PermissionsState.GRANTED ||
      state == PermissionsState.PERMISSIONS_STATE_UNAVAILABLE ||
      state == PermissionsState.NOT_GRANTED
    when (permissionsReadyState) {
      PermissionsState.GRANTED -> println("Permissions granted, no need to request permissions")
      PermissionsState.PERMISSIONS_STATE_UNAVAILABLE ->
        println("Permissions state unavailable, request permissions")
      PermissionsState.NOT_GRANTED ->
        println("OAuth permission is enabled but not granted yet, request permissions")
      else ->
        throw IllegalStateException(
          "HomeClient.hasPermissions state should be PermissionsState.GRANTED or " +
            "PermissionsState.PERMISSIONS_STATE_UNAVAILABLE")
  }
}

チェックが NOT_GRANTED または PERMISSIONS_STATE_UNAVAILABLE の PermissionsState を返す場合は、権限をリクエストする必要があります。チェックで GRANTED の PermissionsState が返されたものの、その後の structures() 呼び出しで構造が返されなかった場合、ユーザーは Google Home app (GHA) 設定ページでアプリへのアクセス権を取り消したため、権限をリクエストする必要があります。それ以外の場合は、ユーザーはすでにアクセス権を持っている必要があります。

権限をリクエストする

特定のストラクチャ内のストラクチャとデバイスにアクセスするには、アプリに権限を付与する必要があります。

ユーザーが権限を付与していない場合は、Home インスタンスの requestPermissions() メソッドを使用して権限 UI を起動し、結果を処理します。

fun requestPermissions(scope: CoroutineScope, onShowSnackbar: (String) -> Unit) {
  scope.launch {
    val result =
      try {
        homeManager.requestPermissions()
      } catch (e: HomeException) {
        PermissionsResult(
          PermissionsResultStatus.ERROR,
          "Got HomeException with error: ${e.message}",
        )
      }
    when (result.status) {
      PermissionsResultStatus.SUCCESS -> {
        Log.i(TAG, "Permissions successfully granted.")
      }
      PermissionsResultStatus.CANCELLED -> {
        Log.i(TAG, "User cancelled Permissions flow.")
        onShowSnackbar("User cancelled Permissions flow")
      }
      else -> {
        Log.e(
          TAG,
          "Failed to grant permissions with error: ${result.status}, ${result.errorMessage}",
        )
        onShowSnackbar("Failed to grant permissions with error: ${result.errorMessage}")
      }
    }
  }
}

権限 UI を適切に起動するには、アプリの OAuth を設定しておく必要があります。

権限を付与する

これで、アプリを実行してユーザーに権限を付与できるようになります。権限を付与できるユーザーのタイプと、権限を付与できるデバイスのタイプは、アプリを Google Home Developer Console に登録したかどうかによって異なります。

Home API を使用してアプリを公開するには、Developer Console の登録が必要です。Home API をテストして使用する必要はありません。

アプリが Developer Console に登録されていない場合は、未確認の状態になります。これは、Home API の使用をテストする場合に推奨されます。

• アプリの権限を付与できるのは、OAuth コンソールでテストユーザーとして登録されたユーザーのみです。未確認のアプリのテストユーザーの上限は 100 人です。

• 未確認のアプリは、Home APIs の OAuth でサポートされているデバイスタイプ（Developer Console のデバイスタイプのリスト）のすべてのデバイスにアクセスできます。ストラクチャ内のすべてのデバイスにアクセス権が付与されます。

アプリが Developer Console に登録されており、1 つ以上のデバイスタイプへのアクセスが承認され、OAuth のブランド確認が完了している場合、そのアプリは確認済みステータスになります。 この状態は、アプリを本番環境にリリースするために必要です。

• テストユーザーの上限は適用されなくなりました。どのユーザーもアプリに権限を付与できます。
• ユーザーは、Developer Console で承認されたデバイスタイプにのみ権限を付与できます。

OAuth が設定されたので、アプリの requestPermissions() 呼び出しによって次のダイアログがトリガーされます。

1. ユーザーは、使用する Google アカウントを選択するよう求められます。
2. アプリにアクセス権を付与する構造を選択するよう求めるメッセージが表示されます。
   1. 未確認のアプリの場合、Home API でサポートされているすべてのデバイスタイプがアプリで使用できます。
   2. 確認済みのアプリの場合、ユーザーは Developer Console で承認されているデバイスタイプにのみ権限を付与できます。
   3. アプリが管理にアクセスできる機密性の高いデバイスタイプについては、ユーザーはデバイスごとにアクセスを制限できます。たとえば、ユーザーが 3 つのロックを持っている場合、アクセス権を付与できるのは 1 つのロックのみです。

権限が付与されると、アプリは Home API を使用してストラクチャ内のデバイスの状態を読み取り、デバイスを操作できるようになります。ユーザーが特定のデバイスタイプまたは機密性の高いデバイスに対してアプリに権限を付与しない場合、アプリは Home API を使用してデバイスにアクセス、制御、自動化を行うことはできません。

権限を変更

別の構造のデバイスにアクセスする権限を付与するには、アカウント選択ツールを起動して、ユーザーが切り替える Google アカウントと構造を選択できるようにします。このプロセスでは、以前に同意が得られていた場合でも、ユーザーに同意画面が再度表示されます。

これを行うには、forceLaunch フラグを true に設定して requestPermissions() を再度呼び出します。

homeManager.requestPermissions(forceLaunch=true)

権限を取り消す

ユーザーは、以前に付与したアクセス権を取り消すことができます。

1. Google マイアカウント ページ > [データとプライバシー] > [サードパーティ製のアプリとサービス] からアクセスします。これにより、最初の同意が付与されたときに発行された OAuth トークンが取り消され、ユーザーがすべてのサーフェス（スマートフォン）と構造で使用していたアプリのインスタンスへのアクセスが取り消されます。

2. [GHA] > [設定] > [リンクされたアプリ] ページからアクセスします。GHA の settings をクリックすると、[設定] ページが表示されます。そこから [リンク済みアプリ] タイルをクリックすると、同意画面に似たページが表示されます。このページから、アプリへのアクセス権を削除できます。また、この同じページを使用して、アプリがアクセスできるデバイスタイプや特定の機密性の高いデバイスを変更することもできます。

3. ウェブの [リンク済みアプリ] ページから直接。

OkGoogle の権限

okGoogle コマンドは構造レベルのコマンドであり、構造内の任意のデバイスを自動化するために使用できます。ただし、Home APIs アプリがすべてのデバイスにアクセスできるとは限りません。次の表に、このような場合に権限が適用される仕組みを示します。