ขอการซิงค์

คำขอซิงค์จะทริกเกอร์SYNCคำขอไปยังการจัดการคำสั่งซื้อสำหรับผู้ใช้ Google ที่มีอุปกรณ์ซึ่งมีagentUserIdที่ระบุเชื่อมโยงอยู่ (ซึ่งคุณ ส่งในคำขอ SYNC เดิม) ซึ่งจะช่วยให้คุณอัปเดตอุปกรณ์ของผู้ใช้ได้ โดยไม่ต้องยกเลิกการลิงก์และลิงก์บัญชีของผู้ใช้อีกครั้ง ผู้ใช้ทั้งหมดที่ลิงก์กับตัวระบุนี้จะได้รับSYNCคำขอ

คุณต้องทริกเกอร์คำขอ SYNC ดังนี้

• หากผู้ใช้เพิ่มอุปกรณ์ใหม่
• หากผู้ใช้นำอุปกรณ์ที่มีอยู่ออก
• หากผู้ใช้เปลี่ยนชื่ออุปกรณ์ที่มีอยู่
• หากคุณใช้ประเภทอุปกรณ์ ลักษณะ หรือเพิ่มฟีเจอร์ใหม่ของอุปกรณ์

เริ่มต้นใช้งาน

หากต้องการใช้การซิงค์คำขอ ให้ทำตามขั้นตอนต่อไปนี้

• เปิดใช้ Google HomeGraph API
• สร้างคีย์บัญชีบริการ
• เรียก API

เปิดใช้ Google HomeGraph API

1. ใน Google Cloud Console ให้ไปที่หน้า HomeGraph API

   ไปที่หน้า HomeGraph API
2. เลือกโปรเจ็กต์ที่ตรงกับsmart homeรหัสโปรเจ็กต์
3. คลิกเปิดใช้

สร้างคีย์บัญชีบริการ

ทำตามวิธีการต่อไปนี้เพื่อสร้างคีย์บัญชีบริการจาก Google Cloud Console

1. ใน Google Cloud Console ให้ไปที่หน้าบัญชีบริการ

   ไปที่หน้าบัญชีบริการ

   คุณอาจต้องเลือกโปรเจ็กต์ก่อนระบบจึงจะนำคุณไปยังหน้าบัญชีบริการ

2. คลิกaddสร้างบัญชีบริการ

3. ป้อนชื่อในช่องชื่อบัญชีบริการ

4. ป้อนรหัสในช่องรหัสบัญชีบริการ

5. ป้อนคำอธิบายในช่องคำอธิบายบัญชีบริการ

6. คลิกสร้างและต่อไป

7. จากเมนูแบบเลื่อนลงบทบาท ให้เลือกบัญชีบริการ > ผู้สร้างโทเค็นข้อมูลประจำตัว OpenID Connect ของบัญชีบริการ

8. คลิกต่อไป

9. คลิกเสร็จสิ้น

10. เลือกบัญชีบริการที่คุณเพิ่งสร้างจากรายการบัญชีบริการ แล้วเลือกจัดการคีย์จากเมนูmore_vert การดำเนินการ

11. เลือกเพิ่มคีย์ > สร้างคีย์ใหม่

12. สำหรับประเภทคีย์ ให้เลือกตัวเลือก JSON

13. คลิกสร้าง ระบบจะดาวน์โหลดไฟล์ JSON ที่มีคีย์ ลงในคอมพิวเตอร์

เรียก API

const homegraphClient = homegraph({
  version: 'v1',
  auth: new GoogleAuth({
    scopes: 'https://www.googleapis.com/auth/homegraph'
  })
});

const res = await homegraphClient.devices.requestSync({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    async: false
  }
});
    

// Get Application Default credentials.
GoogleCredentials credentials =
    GoogleCredentials.getApplicationDefault()
        .createScoped(List.of("https://www.googleapis.com/auth/homegraph"));

// Create Home Graph service client.
HomeGraphService homegraphService =
    new HomeGraphService.Builder(
            GoogleNetHttpTransport.newTrustedTransport(),
            GsonFactory.getDefaultInstance(),
            new HttpCredentialsAdapter(credentials))
        .setApplicationName("HomeGraphExample/1.0")
        .build();

// Request sync.
RequestSyncDevicesRequest request =
    new RequestSyncDevicesRequest().setAgentUserId("PLACEHOLDER-USER-ID").setAsync(false);
homegraphService.devices().requestSync(request);
    

การตอบกลับข้อผิดพลาด

คุณอาจได้รับการตอบกลับเป็นข้อผิดพลาดอย่างใดอย่างหนึ่งต่อไปนี้เมื่อเรียกใช้ Request Sync การตอบกลับเหล่านี้จะอยู่ในรูปแบบรหัสสถานะ HTTP

• 400 Bad Request - เซิร์ฟเวอร์ไม่สามารถประมวลผลคำขอที่ไคลเอ็นต์ส่งมาเนื่องจากไวยากรณ์ไม่ถูกต้อง สาเหตุที่พบบ่อย ได้แก่ JSON ที่มีรูปแบบไม่ถูกต้อง หรือการใช้ null แทน "" สำหรับค่าสตริง
• 403 Forbidden - เซิร์ฟเวอร์ประมวลผลคำขอสำหรับ agentUserId ที่ระบุไม่ได้เนื่องจากเกิดข้อผิดพลาดขณะรีเฟรชโทเค็น ตรวจสอบว่าปลายทาง OAuth ตอบสนองต่อคำขอโทเค็นการรีเฟรชอย่างถูกต้อง และตรวจสอบสถานะการลิงก์บัญชีของผู้ใช้
• 404 Not Found - ไม่พบทรัพยากรที่ขอ แต่อาจพร้อมใช้งานในอนาคต โดยปกติแล้ว ข้อความนี้หมายความว่า บัญชีผู้ใช้ไม่ได้ลิงก์กับ Google หรือเราได้รับ agentUserIdที่ไม่ถูกต้อง ตรวจสอบว่า agentUserId ตรงกับค่าที่ระบุในการตอบกลับ SYNC และคุณจัดการเจตนา DISCONNECT อย่างถูกต้อง
• 429 Too Many Requests - คำขอซิงค์พร้อมกันเกินจำนวนสูงสุดสำหรับ agentUserId ที่ระบุ ผู้โทร จะส่งคำขอซิงค์พร้อมกันได้เพียง 1 รายการ เว้นแต่จะตั้งค่าแฟล็ก async เป็น "จริง"