エラーと例外

このドキュメントでは、スマートホーム デバイスの公式にサポートされているエラーと例外を示します。このようなエラーや例外コードは、インテント レスポンス内、または実装済みの場合は通知内を使用することで、特定のコマンドやデバイスの状態に関連する問題をエンドユーザーに通知できます。レスポンスに不適切な形式や 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 response

次の 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"
          }
        ]
      }
    }
  }
}