索引
DevicesPlatformService（インターフェース）CreateDeviceModelRequest（メッセージ）CreateDeviceRequest（メッセージ）DeleteDeviceModelRequest（メッセージ）DeleteDeviceRequest（メッセージ）Device（メッセージ）Device.ClientType（列挙型）DeviceModel（メッセージ）DeviceModel.ExecutionMode（列挙型）GetDeviceModelRequest（メッセージ）GetDeviceRequest（メッセージ）ListDeviceModelsRequest（メッセージ）ListDeviceModelsResponse（メッセージ）ListDevicesRequest（メッセージ）ListDevicesResponse（メッセージ）Manifest（メッセージ）UpdateDeviceModelRequest（メッセージ）
DevicesPlatformService
このサービスは Google 製以外のデバイスを管理します。現時点では、デバイスモデル登録用の API とデバイス インスタンス登録用の API がデベロッパーに提供されています。
デバイスモデル登録 API は、デバイスモデルを作成および管理します。デバイスモデルには、そのモデルに属するすべてのデバイスで共有されるハードウェア能力と構成が含まれます。
デバイス インスタンスの登録は、モデルで定義されている機能と構成に基づいてデバイス インスタンスをインスタンス化します。また、デベロッパーはデバイスによって異なる属性を定義できます。登録後の実行時には、各 gRPC リクエストで device_model_id と device_id の両方が必要であり、Google Assistant API では両方の ID が登録済みである必要があります。そうでない場合、エラーが返されます。
| CreateDevice | |
|---|---|
|
1 つのデバイスを登録します。登録が成功した場合はそのデバイスを返し、デバイスがすでに存在する場合、または登録が失敗した場合はエラーを返します。
|
|
| CreateDeviceModel | |
|---|---|
|
サードパーティ製デバイスのデバイスモデルを作成します。
|
|
| DeleteDevice | |
|---|---|
|
ユーザーが所有する特定のデバイスを削除します。成功した場合は Empty を返し、それ以外の場合はデバイスが見つからない、または削除に失敗したというエラーを返します。
|
|
| DeleteDeviceModel | |
|---|---|
|
サードパーティ製デバイスのデバイスモデルを削除します。
|
|
| GetDevice | |
|---|---|
|
ユーザーが所有している特定のデバイスの設定情報を取得します。成功した場合はそのデバイスを返し、失敗した場合はエラーを返します。
|
|
| GetDeviceModel | |
|---|---|
|
指定したデバイスモデル ID のデバイスモデルを返します。
|
|
| ListDeviceModels | |
|---|---|
|
この REST API 呼び出しに関連付けられたプロジェクト ID のデバイスモデルを一覧表示します。
|
|
| ListDevices | |
|---|---|
|
ユーザーが所有する、OAuth トークン内の特定のプロジェクト ID に属するデバイスのリストを取得します。URL で指定されたプロジェクト ID とトークンに含まれるプロジェクト ID が同じであることを確認する必要があります。
|
|
| UpdateDeviceModel | |
|---|---|
|
デバイスモデルを更新し、モデルの新しいバージョンを返します。注: これは全体的な更新です。つまり、更新するデバイスモデル全体を送信する必要があります。
|
|
CreateDeviceModelRequest
DevicesPlatformService.CreateDeviceModel に対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
デバイスモデルを作成するプロジェクトのリソース名（ |
device_model |
作成する device_model。 |
CreateDeviceRequest
DevicesPlatformService.CreateDevice に対するリクエスト メッセージ。
| フィールド | |
|---|---|
device |
ユーザーから提供された未加工のデバイス情報。device_id はプロジェクト内で一意であり、プロジェクト オーナーが割り当てます。 |
parent |
デバイスが属するプロジェクトの名前（形式は |
DeleteDeviceModelRequest
DevicesPlatformService.DeleteDeviceModel に対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
デバイスモデルを削除するプロジェクトのリソース名。形式は |
DeleteDeviceRequest
DevicesPlatformService.DeleteDevice に対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
デバイスを削除するプロジェクトのリソース名（形式は |
デバイス
| フィールド | |
|---|---|
name |
デバイスのリソース名。形式は |
id |
必須。プロジェクト スコープ内の一意のデバイス ID。形式はデベロッパーによって定義されます（例:"06ba29e5-5f1c-1a89-303c-22de2580f2e2". Converse RPC を送信するときは DeviceConfig.device_id と一致する必要があります。この ID は FDR のためにリセットできます。 |
nickname |
によって指定される、このデバイスのニックネーム。ユーザーがデバイスに話しかけるときに、音声認識とデバイス ターゲティングに使用されます。たとえば、ユーザーが「スマート ロボット」という名前のデバイスを持っている場合、「スマート ロボットを左に移動して」と言うことができます。 |
model_id |
必須。エージェント ID のすべてのデバイスの中で、デバイスの「クラス」（モデル）を一意に識別します（例:「manufacturer-2017-v2」となります。1 つのプロジェクトに複数のデバイスモデルを含めることもできます。 |
client_type |
必須。Assistant SDK には、アシスタントをデバイスに統合するためのオプションが 2 通り用意されています。このフィールドは、クライアントが Assistant SDK ライブラリに基づくのか、SDK サービス API を呼び出すのかを識別するためのものです。 |
ClientType
クライアント タイプを識別します。
| 列挙型 | |
|---|---|
CLIENT_TYPE_UNSPECIFIED |
クライアントのタイプが不明です。これがデフォルト値です。 |
SDK_SERVICE |
SDK gRPC Service API 用。アシスタントのリクエストとレスポンスの音声バイトを直接操作する低レベル API を公開します。Service |
SDK_LIBRARY |
クライアント タイプが Google アシスタント クライアント ライブラリです。これは高レベルのイベントベース API を備えたターンキー ソリューションです。 |
DeviceModel
デバイス ファミリーのメタデータを定義します。デバイスモデルは、デバイス ファミリーに共通のハードウェア能力も定義します。
| フィールド | |
|---|---|
name |
デバイスモデルのリソース名。形式は |
device_model_id |
必須。デベロッパーが指定するグローバルで一意の ID（「comcast-voice-assistant-2017-v1」など）。デバイスモデル ID がすでに存在する場合は、エラーが返されます。 |
project_id |
必須。デバイスモデルに関連付けられた Cloud プロジェクト ID。各プロジェクトでは、複数のデバイスモデルを作成できます。 |
device_type |
必須。有効なデバイスタイプの例: "action.devices.types.LIGHT" "action.devices.types.OUTLET" "action.devices.types.SWITCH" "action.devices.types.AC_HEATING" |
traits[] |
（省略可）デバイスがサポートできる組み込みトレイトのリスト。例: 「action.devices.lets.OnOff」 |
manifest |
必須。デバイスモデルとメーカーを表すメタデータ。これは、SDK Console、指標ダッシュボード、その他の関連するビジュアル インターフェースに表示されます。 |
execution_modes[] |
デバイス アクションの実行モード（省略可）。DIRECT_RESPONSE を設定すると、デバイスはデバイス コントロールに対して有効になります。 |
ExecutionMode
デバイス アクションの実行モード。現時点では直接応答のみがサポートされています。
| 列挙型 | |
|---|---|
MODE_UNSPECIFIED |
指定なし。 |
DIRECT_RESPONSE |
デバイスは直接実行をサポートします。デバイスからのクエリに対して、アシスタントはコマンドとパラメータを含む DeviceControlRequest を返します。 |
GetDeviceModelRequest
DevicesPlatformService.GetDeviceModel に対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
デバイスモデルを取得するプロジェクトのリソース名。形式は |
GetDeviceRequest
DevicesPlatformService.GetDevice に対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
デバイスを取得するリソース名（ |
ListDeviceModelsRequest
DevicesPlatformService.ListDeviceModel に対するリクエスト メッセージ。
| フィールド | |
|---|---|
parent |
リクエストされているデバイスモデルのリソース名（形式は |
ListDeviceModelsResponse
DevicesPlatformService.CreateDeviceModel に対するレスポンス メッセージ。
| フィールド | |
|---|---|
device_models[] |
|
ListDevicesRequest
DevicesPlatformService.ListDevices に対するリクエスト メッセージです。
| フィールド | |
|---|---|
parent |
一覧表示するデバイスのプロジェクトの名前（projects/{project_id} の形式）。 |
ListDevicesResponse
DevicesPlatformService.ListDevices に対するレスポンス メッセージ。
| フィールド | |
|---|---|
devices[] |
ユーザーが特定のプロジェクト内で所有しているすべてのデバイス。 |
マニフェスト
デバイスモデルとメーカーを表すメタデータ。これは SDK コンソール、指標ダッシュボード、その他の関連するビジュアル インターフェースに表示されます。
| フィールド | |
|---|---|
manufacturer |
必須。このデバイスのメーカー（「Google」など）。 |
product_name |
必須。このデバイスモデルの消費者向け商品名（「Google アシスタント プロトタイプ デバイス」など）。 |
device_description |
このデバイスモデルについての説明（省略可）。例: 「Google アシスタント搭載、Google のスマート スピーカー」 |
UpdateDeviceModelRequest
DevicesPlatformService.UpdateDeviceModel に対するリクエスト メッセージ。
| フィールド | |
|---|---|
name |
デバイスモデルを更新するプロジェクトのリソース名。形式は |
device_model |
デベロッパーが更新先にする新しいデバイスモデル。 |