Menangani error dan pengecualian

Jika perangkat atau permintaan tidak berfungsi seperti yang diharapkan, penting untuk memberikan penanganan dan komunikasi error yang baik kepada pengguna agar mereka memahami apa yang terjadi, dan jika memungkinkan, cara memperbaikinya. Pastikan Anda memikirkan kemungkinan skenario kegagalan dan cara perangkat Anda merespons: Bagaimana jika pengguna mengganggu tugas yang sedang berlangsung? Bagaimana jika pengguna meminta tindakan dari perangkat saat perangkat sedang offline? Merencanakan masalah ini dan membantu pengguna pulih dari masalah tersebut dapat menghindari frustrasi pengguna dan menciptakan pengalaman berkualitas lebih tinggi untuk perangkat Anda.

Panduan ini memberikan beberapa contoh respons intent yang menangani error. Lihat Error dan pengecualian untuk meninjau nilai errorCode yang valid untuk error dan pengecualian.

Contoh 1: Respons error untuk intent EXECUTE

Pengguna akhir memiliki dua lampu smart yang terpasang di ruang keluarga. Pengguna mengeluarkan perintah "nyalakan lampu ruang keluarga" dan Google mengirim intent EXECUTE ke URL fulfillment Anda. Anda menemukan bahwa perangkat pengguna sedang offline dan tidak dapat dikontrol, sehingga fulfillment Anda menampilkan respons EXECUTE dengan status ERROR dan errorCode deviceOffline.

Contoh ini menunjukkan cara menampilkan respons EXECUTE dengan errorCode dari perangkat lampu seperti yang dijelaskan sebelumnya:

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

Google Assistant meminta pengguna dengan "the device are not available right now" setelah menerima respons. Perlu diingat bahwa Anda tetap harus mengirim status offline untuk perangkat dalam status laporan setelah mengirim errorCode deviceOffline dalam respons EXECUTE.

Contoh 2: Pengecualian non-pemblokiran untuk intent EXECUTE

Pengguna mencoba mengunci smart lock di pintu depan menggunakan Assistant. Anda dapat berhasil mengontrol kunci, tetapi menemukan bahwa baterai perangkat lemah, sehingga fulfillment Anda menampilkan respons EXECUTE dengan status SUCCESS dan exceptionCode lowBattery.

Contoh ini menunjukkan cara mengirim respons EXECUTE dengan exceptionCode dari perangkat kunci seperti yang dijelaskan sebelumnya:

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

Assistant meminta pengguna dengan "the device has low battery" setelah menerima respons.

Contoh 3: Notifikasi error proaktif

Dalam beberapa kasus, sebaiknya beri tahu pengguna tentang error, terutama untuk fungsi yang diharapkan pengguna dapat diselesaikan secara otomatis. Untuk trait yang mendukung notifikasi proaktif, Anda dapat memberi tahu pengguna secara proaktif saat terjadi error jika telah menerapkan smart home notifikasi proaktif.

Pengering smart sedang berjalan, dan seseorang membuka pintu sebelum siklus selesai. Anda dapat memanggil metode Google Home Graph API reportStateAndNotifications untuk mengirim notifikasi proaktif dengan errorCode:

Contoh ini menunjukkan cara mengirim notifikasi proaktif dengan errorCode dari perangkat pengering seperti yang dijelaskan sebelumnya:

POST https://homegraph.googleapis.com/v1/devices:reportStateAndNotification

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

The Assistant meminta pengguna dengan "the device door is opened" setelah menerima notifikasi. Anda dapat mengirim status perangkat yang sesuai bersama notifikasi dalam payload yang sama.

Contoh 4: Notifikasi lanjutan

Untuk perintah trait yang mendukung notifikasi lanjutan, Anda dapat mengirim notifikasi lanjutan kepada pengguna saat terjadi error atau pengecualian, jika telah menerapkan smart home notifikasi lanjutan.

Pengguna mengeluarkan perintah untuk menutup pintu garasi, tetapi pintu macet saat menutup. Anda dapat mengirim notifikasi lanjutan dengan errorCode:

POST https://homegraph.googleapis.com/v1/devices:reportStateAndNotification

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

The Assistant meminta pengguna dengan "the device is jammed" setelah menerima notifikasi. Anda dapat mengirim status perangkat yang sesuai dengan notifikasi dalam payload yang sama.

Untuk mengetahui informasi selengkapnya dan errorCodes mendetail, lihat dokumentasi referensi Error dan pengecualian.