デバイスモデルとデバイス インスタンスのスキーマ

デバイスモデル

デバイスモデルは、このセクションに示すフィールドによって定義されます。

デバイスモデルのフィールドに使用できる文字は、英字、数字、ピリオド（.）、ハイフン（-）、アンダースコア（_）、スペース（ ）、プラス（+）のみです。フィールドの先頭の文字は英字または数字にしてください。

例
{
  "project_id": "my-devices-project",
  "device_model_id": "my-devices-project-prototype-light-v1",
  "manifest": {
    "manufacturer": "Assistant SDK developer",
    "product_name": "Assistant SDK light",
    "device_description": "Assistant SDK light device"
  },
  "device_type": "action.devices.types.LIGHT",
  "traits": ["action.devices.traits.OnOff"]
}
スキーマ
{
  "project_id": string,
  "device_model_id": string,
  "manifest": {
    "manufacturer": string,
    "product_name": string,
    "device_description": string
  },
  "device_type": string,
  "traits": [ string ]
}
  • project_id:（文字列）必須。このデバイスモデルに関連付ける Actions Console プロジェクトの Google Cloud Platform プロジェクト ID。1 つのプロジェクトに複数のデバイスモデルを含めることができます。
  • device_model_id:（文字列）必須。このデバイスモデルのグローバルに一意な ID。すべてのプロジェクト間で競合が発生しないように、接頭辞として project_id を使用します。指標とデバイス登録で使用されます。
  • manifest: （オブジェクト（マニフェスト））必須。デバイスのモデルとメーカーを記述するメタデータ。これは、（今後の）SDK コンソール、指標ダッシュボード、その他の関連するビジュアル インターフェースに表示される場合があります。
    • manifest.manufacturer:（文字列）必須。デバイス メーカーの名前。
    • manifest.product_name:（文字列）必須。このデバイスモデルの消費者向け製品名。
    • manifest.device_description:（文字列）省略可。このデバイスモデルの説明。
  • device_type:（文字列）必須。デバイス ハードウェアのタイプ。次の中から選択してください。
    • action.devices.types.CAMERA
    • action.devices.types.DISHWASHER
    • action.devices.types.DRYER
    • action.devices.types.LIGHT
    • action.devices.types.OUTLET
    • action.devices.types.PHONE
    • action.devices.types.REFRIGERATOR
    • action.devices.types.SCENE
    • action.devices.types.SOUNDBAR
    • action.devices.types.SPEAKER
    • action.devices.types.SWITCH
    • action.devices.types.THERMOSTAT
    • action.devices.types.TV
    • action.devices.types.VACUUM
    • action.devices.types.WASHER
  • traits:（Array<String>）省略可。デバイスがサポートするトレイトのリスト。トレイトには、デバイスのコマンド、属性、状態が含まれます。 組み込みトレイト。

デバイス インスタンス

デバイス インスタンスは、このセクションに示すフィールドによって定義されます。

デバイス インスタンスのフィールドの先頭は英字または数字にしてください。デバイス ID には、英字、数字、ピリオド（.）、ハイフン（-）、アンダースコア（_）、プラス（+）のみを使用できます。デバイスのニックネームに使用できるのは、数字、英字、スペース（ ）記号のみです。

例
  {
    "id": "my_led_1",
    "model_id": "my-devices-project-prototype-light-v1",
    "nickname": "My Assistant Light",
    "client_type": "SDK_LIBRARY"
  }
スキーマ
  {
    "id": string,
    "model_id": string,
    "nickname": string,
    "client_type": string
  }
  • id:（文字列）必須。テストデバイスの識別子。同じ Google Developer プロジェクトに登録されているすべてのデバイス内で一意である必要があります。
  • model_id:（文字列）必須。デバイスモデルの識別子。このテストデバイスに関連付けられている device_model_id と同じである必要があります。デバイスモデルは事前に登録されている必要があります。
  • nickname:（文字列）省略可。デバイスのニックネーム。この名前は、アシスタントの設定などのビジュアル インターフェースでデバイスを参照する際に使用されます。
  • client_type:（文字列）必須。クライアント デバイスのタイプ。SDK_SERVICE または SDK_LIBRARY のいずれかにする必要があります。