จัดการข้อผิดพลาดและข้อยกเว้น

เมื่ออุปกรณ์หรือคำขอไม่ทำงานตามที่คาดไว้ คุณควรจัดการข้อผิดพลาดและสื่อสารกับผู้ใช้อย่างเหมาะสมเพื่อให้ผู้ใช้เข้าใจสิ่งที่เกิดขึ้นและวิธีแก้ไข (หากเป็นไปได้) อย่าลืมพิจารณาสถานการณ์ที่อาจเกิดขึ้นเมื่อเกิดข้อผิดพลาดและวิธีที่อุปกรณ์ควรตอบสนอง เช่น จะเกิดอะไรขึ้นหากผู้ใช้ขัดจังหวะงานที่อยู่ระหว่างดำเนินการ จะเกิดอะไรขึ้นหากผู้ใช้ส่งคำขอดำเนินการจากอุปกรณ์ขณะออฟไลน์ การวางแผนรับมือกับปัญหาเหล่านี้และช่วยให้ผู้ใช้แก้ไขได้จะช่วยป้องกันไม่ให้ผู้ใช้หงุดหงิดและสร้างประสบการณ์การใช้งานที่มีคุณภาพสูงขึ้นสำหรับอุปกรณ์

คู่มือนี้แสดงตัวอย่างคำตอบของ Intent ที่จัดการข้อผิดพลาด ดูข้อผิดพลาดและข้อยกเว้นเพื่อตรวจสอบค่า errorCode ที่ถูกต้องสำหรับข้อผิดพลาดและข้อยกเว้น

ตัวอย่างที่ 1: การตอบกลับข้อผิดพลาดสําหรับ Intent EXECUTE

ผู้ใช้ปลายทางติดตั้งหลอดไฟอัจฉริยะ 2 หลอดไว้ในห้องนั่งเล่น ผู้ใช้ออกคำสั่ง "เปิดไฟห้องนั่งเล่น" และ Google ส่งEXECUTE Intent ไปยัง URL การดำเนินการ คุณพบว่าอุปกรณ์ของผู้ใช้ออฟไลน์และไม่สามารถควบคุมได้ ดังนั้นการตอบสนองของคุณจึงแสดงผลลัพธ์ EXECUTE พร้อม status ERROR และ errorCode deviceOffline

ตัวอย่างนี้แสดงวิธีแสดงผลลัพธ์ EXECUTE ที่มี errorCode จากอุปกรณ์หลอดไฟตามที่อธิบายไว้ก่อนหน้านี้

{
  "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 จะแจ้งให้ผู้ใช้ทราบด้วยข้อความว่า "อุปกรณ์ไม่พร้อมใช้งานในขณะนี้" หลังจากได้รับการตอบกลับ โปรดทราบว่าคุณยังคงต้องส่งสถานะออฟไลน์ของอุปกรณ์ในสถานะรายงานหลังจากส่ง errorCode deviceOffline ในการตอบกลับ EXECUTE

ตัวอย่างที่ 2: ข้อยกเว้นแบบไม่บล็อกสําหรับ Intent EXECUTE

ผู้ใช้พยายามล็อกล็อกอัจฉริยะที่ประตูหน้าโดยใช้ Assistant คุณควบคุมล็อกได้สําเร็จ แต่พบว่าแบตเตอรี่ของอุปกรณ์เหลือน้อย การดำเนินการตามคำขอจึงแสดงEXECUTEการตอบกลับที่มี status SUCCESS และ exceptionCode lowBattery

ตัวอย่างนี้แสดงวิธีส่งการตอบกลับ EXECUTE ที่มี exceptionCode จากอุปกรณ์ล็อกตามที่อธิบายไว้ก่อนหน้านี้

{
  "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 จะแจ้งให้ผู้ใช้ทราบด้วยข้อความว่า "อุปกรณ์มีแบตเตอรี่เหลือน้อย" หลังจากได้รับการตอบกลับ

ตัวอย่างที่ 3: การแจ้งเตือนข้อผิดพลาดเชิงรุก

ในบางกรณี การแจ้งเตือนผู้ใช้เกี่ยวกับข้อผิดพลาดอาจเป็นประโยชน์ โดยเฉพาะอย่างยิ่งสำหรับฟังก์ชันที่ผู้ใช้คาดหวังว่าจะดำเนินการเสร็จสมบูรณ์โดยอัตโนมัติ สําหรับลักษณะที่รองรับการแจ้งเตือนเชิงรุก คุณสามารถแจ้งเตือนผู้ใช้ได้ในขณะที่เกิดข้อผิดพลาดหากคุณได้ติดตั้งใช้งานsmart home การแจ้งเตือนเชิงรุก

เครื่องอบผ้าอัจฉริยะทำงานอยู่และมีคนเปิดประตูก่อนที่รอบการทำงานจะเสร็จสิ้น คุณสามารถเรียกใช้เมธอด Google Home Graph API reportStateAndNotifications เพื่อส่งการแจ้งเตือนล่วงหน้าพร้อมerrorCode

ตัวอย่างนี้แสดงวิธีส่งการแจ้งเตือนเชิงรุกด้วย 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": {
        "dryer-device-id": {
          "RunCycle": {
            "priority": 0,
            "status": "FAILURE",
            "errorCode": "deviceDoorOpen"
          }
        }
      },
      "states": {
        "dryer-device-id": {
          "isRunning": false,
          "isPaused": true
        }
      }
    }
  }
}

Assistant จะแจ้งให้ผู้ใช้ทราบด้วยข้อความว่า "ประตูอุปกรณ์เปิดอยู่" หลังจากได้รับการแจ้งเตือน คุณสามารถส่งสถานะอุปกรณ์ที่เกี่ยวข้องพร้อมกับการแจ้งเตือนในเพย์โหลดเดียวกัน

ตัวอย่างที่ 4: การแจ้งเตือนติดตามผล

สําหรับคําสั่งลักษณะที่รองรับการแจ้งเตือนติดตามผล คุณสามารถส่งการแจ้งเตือนติดตามผลไปยังผู้ใช้ได้เมื่อเกิดข้อผิดพลาดหรือข้อยกเว้น หากได้ใช้smart home การแจ้งเตือนติดตามผล

ผู้ใช้ออกคำสั่งให้ปิดประตูโรงรถ แต่ประตูติดขัดขณะปิด คุณส่งการแจ้งเตือนติดตามผลพร้อม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
        }
      }
    }
  }
}

Assistant จะแจ้งให้ผู้ใช้ทราบด้วยข้อความว่า "อุปกรณ์ติดขัด" หลังจากได้รับการแจ้งเตือน คุณสามารถส่งสถานะอุปกรณ์ที่เกี่ยวข้องพร้อมกับการแจ้งเตือนในเพย์โหลดเดียวกัน

ดูข้อมูลเพิ่มเติมและerrorCodesโดยละเอียดได้ที่เอกสารอ้างอิงเกี่ยวกับข้อผิดพลาดและข้อยกเว้น