בקשה לסנכרון

התכונה 'בקשת סנכרון' מפעילה בקשה של SYNC למילוי ההזמנות לכל משתמש Google במכשירים שצוינו איש הקשר agentUserId משויך אליהם (שאליו אתם נשלח בבקשת הסנכרון המקורית). כך אפשר לעדכן מכשירים בלי לבטל את הקישור של החשבון ולקשר אותו מחדש. כל המשתמשים המקושרים לקמפיין הזה יקבל בקשת SYNC.

צריך להפעיל בקשת SYNC:

• אם המשתמש מוסיף מכשיר חדש.
• אם המשתמש מסיר מכשיר קיים.
• אם המשתמש משנה שם של מכשיר קיים.
• אם אתם מטמיעים סוג מכשיר חדש או תכונה חדשה, או מוסיפים תכונה חדשה במכשיר.

שנתחיל?

כדי ליישם את בקשת הסנכרון, יש לבצע את השלבים הבאים:

• הפעלת ה-Google HomeGraph API
• יצירת מפתח לחשבון שירות
• קריאה ל-API

הפעלת Google Home Graph API

1. ברכיב Google Cloud Console, עוברים לדף Home Graph API.

   לדף Home Graph API
2. צריך לבחור את הפרויקט שתואם למזהה הפרויקט ב-smart home.
3. לוחצים על הפעלה.

יצירת מפתח לחשבון שירות

כדי ליצור מפתח לחשבון שירות מ-Google Cloud Console, פועלים לפי ההוראות הבאות:

1. באפליקציית Google Cloud Console, עוברים לדף Create service account key.

   כניסה לדף Create Service Account Key
2. מהרשימה Service Account, בוחרים חשבון שירות חדש.
3. כותבים שם בשדה Service account name.
4. מזינים מזהה בשדה Service account ID.

5. ברשימה Role בוחרים באפשרות Service Accounts > יצירת אסימונים בחשבון שירות.

6. בשדה Key type, בוחרים באפשרות JSON.

7. לוחצים על יצירה. קובץ 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);
    

תגובות לשגיאות

כשנשלחת בקשה לסנכרון, יכול להיות שתתקבל אחת מתגובות השגיאה הבאות. התגובות האלה מגיעות בצורת קודי מצב של HTTP.

• 400 Bad Request – השרת לא הצליח לעבד הבקשה שנשלחה על ידי הלקוח בגלל תחביר לא חוקי. סיבות נפוצות כוללים JSON שגוי או משתמשים ב-null במקום ב-"" למחרוזת.
• 403 Forbidden - השרת לא הצליח לעבד את הבקשה עבור הנתון agentUserId עקב שגיאה בזמן רענון האסימון. מוודאים שנקודת הקצה (endpoint) של OAuth מגיבה כדי לרענן בקשות לאסימונים ולבדוק את קישור החשבונות של המשתמש בצורה נכונה הסטטוס.
• 404 Not Found – לא ניתן לבצע את המשאב המבוקש נמצא, אבל עשוי להיות זמין בעתיד. בדרך כלל המשמעות היא חשבון המשתמש אינו מקושר ל-Google או שקיבלנו חשבון agentUserId צריך לוודא שה-agentUserId תואם לערך שצוין ב- התגובה SYNC, וזה בסדר בטיפול בכוונות ניתוק.
• 429 Too Many Requests – המספר המקסימלי של סנכרון בו-זמנית יש יותר מדי בקשות עבור agentUserId הנתון. מתקשר/ת יכול לשלוח רק בקשת סנכרון אחת בו-זמנית, אלא אם async מוגדר כ-true.