エラーと例外

このドキュメントでは、スマートホーム デバイスの正式にサポートされているエラーと例外について説明します。インテント エラーや実装済みの場合は、通知でこれらのエラーコードと例外コードを使用してください。これにより、Google コマンドが特定のコマンドやデバイスの状態に関連する問題をエンドユーザーに警告します。レスポンスに不適切な形式や errorCode が含まれていると、Google アシスタントは一般的なエラー メッセージ（例: 「現在、デバイスはご利用いただけません」など）を表示します。

エラー

問題で実行リクエストまたはクエリ リクエストが失敗した場合は、エラーコードが返されます。たとえば、ドアのロックが故障してロックまたはロック解除ができない場合、この状態に関するエラーがユーザーに返されます。

エラーコードは、デバイスレベルまたはグローバル レベルでアタッチできます。たとえば、ユーザーが 1 つのプロバイダから多くのライトを持っていて、ハブによって制御されている場合、ユーザーがすべてのライトをオフにするよう要求すると、プロバイダは、1 つのライトがオフラインの場合はデバイスレベルのエラーを返し、ハブ全体がオフラインでライトを制御できない場合はグローバル レベルのエラーを返します。すべてのデバイスがオフラインの場合、グローバル レベルとデバイスレベルのエラーの間に違いはありません。デバイスがオフラインの場合は、deviceOffline エラーコードを返しても、reportState で {"online": false} の状態を報告する必要があります。

概要は次のとおりです。

• グローバル レベルのエラー: レスポンス内のすべてのデバイスに同じエラーがあります
• ローカルレベルのエラー: 混合レスポンスとエラーおよび成功例

グローバル レベルのエラー

次の JSON スニペットは、QUERY または EXECUTE レスポンスでグローバル レベルのエラーを返す方法を示しています。

ハブによるグローバル レベルのエラー deviceOffline の例はオフラインです。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "deviceOffline",
    "status" : "ERROR"
  }
}

ハブによる inSoftwareUpdate のグローバル レベルのエラーの例を次に示します。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "errorCode": "inSoftwareUpdate",
    "status" : "ERROR"
  }
}

デバイスレベルのエラー

QUERY レスポンス

次の JSON スニペットは、QUERY レスポンスでデバイスレベルのエラーを返す方法を示しています。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      },
      "device-id-2": {
        "errorCode": "deviceOffline",
        "status" : "ERROR"
      }
    }
  }
}

EXECUTE レスポンス

次の JSON スニペットは、EXECUTE レスポンスでデバイスレベルのエラーを返す方法を示しています。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [
      {
        "ids": [
          "device-id-1"
        ],
        "status": "ERROR",
        "errorCode": "deviceOffline"
      },
      {
        "ids": [
          "device-id-2"
        ],
        "status": "SUCCESS",
        "states": {
          "on": true,
          "online": true
        }
      }
    ]
  }
}

エラーがある通知

パーソナル通知

次の JSON スニペットは、事前通知でデバイスレベルのエラーを報告する方法を示しています。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "RunCycle": {
            "priority": 0,
            "status": "FAILURE",
            "errorCode": "deviceDoorOpen"
          }
        }
      }
    }
  }
}

フォローアップの回答

次の JSON スニペットは、フォローアップ レスポンス内のデバイスレベルのエラーを報告する方法を示しています。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "agentUserId": "agent-user-id-1",
  "eventId": "unique-event-id-1",
  "payload": {
    "devices": {
      "notifications": {
        "device-id-1": {
          "LockUnlock": {
            "priority": 0,
            "followUpResponse": {
              "status": "FAILURE",
              "errorCode": "deviceJammingDetected",
              "followUpToken": "PLACEHOLDER"
            }
          }
        }
      }
    }
  }
}

エラーリスト

以下のエラーは、関連する TTS をデバイスに生成します。

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isLocked": true,
        "isJammed": false,
        "exceptionCode": "lowBattery"
      }
    }]
  }
}

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "commands": [{
      "ids": ["device-id-1"],
      "status": "SUCCESS",
      "states": {
        "on": true,
        "online": true,
        "isArmed": true,
        "currentArmLevel": "L2",
        "currentStatusReport": [{
          "blocking": false,
          "deviceTarget": "sensor_id1",
          "priority": 0,
          "statusCode": "deviceOpen"
        }]
      }
    }]
  }
}

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "devices": {
      "device-id-1": {
        "on": true,
        "online": true,
        "status": "EXCEPTIONS",
        "currentStatusReport": [{
            "blocking": true,
            "deviceTarget": "device-id-1",
            "priority": 0,
            "statusCode": "lowBattery"
          },
          {
            "blocking": true,
            "deviceTarget": "front_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          },
          {
            "blocking": true,
            "deviceTarget": "back_window_id",
            "priority": 1,
            "statusCode": "deviceOpen"
          }
        ]
      }
    }
  }
}