درخواست همگام سازی

درخواست همگام‌سازی برای هر کاربر Google با دستگاه‌هایی که agentUserId مشخص شده مرتبط با آن‌ها (که شما در درخواست SYNC اصلی ارسال کرده‌اید) یک درخواست SYNC را برای انجام شما آغاز می‌کند. این به شما امکان می‌دهد دستگاه‌های کاربران را بدون لغو پیوند و پیوند مجدد حساب آن‌ها به‌روزرسانی کنید. همه کاربرانی که به این شناسه پیوند داده شده اند یک درخواست SYNC دریافت خواهند کرد.

شما باید یک درخواست SYNC را راه اندازی کنید:

• اگر کاربر دستگاه جدیدی اضافه کند.
• اگر کاربر دستگاه موجود را حذف کند.
• اگر کاربر یک دستگاه موجود را تغییر نام دهد.
• اگر نوع، ویژگی یا ویژگی دستگاه جدیدی را اضافه کنید.

شروع کنید

برای اجرای Request Sync، مراحل زیر را دنبال کنید:

• Google HomeGraph API را فعال کنید
• یک کلید حساب سرویس ایجاد کنید
• با API تماس بگیرید

Google HomeGraph API را فعال کنید

1. در Google Cloud Console ، به صفحه HomeGraph API بروید.

   به صفحه HomeGraph API بروید
2. پروژه ای را انتخاب کنید که با شناسه پروژه smart home شما مطابقت دارد.
3. روی ENABLE کلیک کنید.

یک کلید حساب سرویس ایجاد کنید

برای ایجاد یک کلید حساب سرویس از Google Cloud Console این دستورالعمل ها را دنبال کنید:

1. در Google Cloud Console ، به صفحه کلید ایجاد حساب سرویس بروید.

   به صفحه Create Service Account Key بروید
2. از لیست حساب سرویس ، حساب سرویس جدید را انتخاب کنید.
3. در قسمت نام حساب سرویس ، یک نام وارد کنید.
4. در قسمت شناسه حساب سرویس ، یک شناسه وارد کنید.

5. از فهرست نقش ، حساب‌های خدمات > ایجاد کننده رمز حساب حساب را انتخاب کنید.

6. برای نوع کلید ، گزینه 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 داده شده را به دلیل بروز خطا در هنگام بازخوانی رمز پردازش کند. مطمئن شوید که نقطه پایانی OAuth شما به درستی به درخواست‌های رمز به‌روزرسانی پاسخ می‌دهد و وضعیت پیوند دادن حساب کاربر را بررسی کنید.
• 404 Not Found - منبع درخواستی یافت نشد اما ممکن است در آینده در دسترس باشد. به طور معمول، این بدان معنی است که حساب کاربری با Google مرتبط نیست یا یک agentUserId نامعتبر دریافت کرده ایم. مطمئن شوید که agentUserId با مقدار ارائه شده در پاسخ SYNC شما مطابقت دارد و به درستی مقاصد DISCONNECT را مدیریت می کنید.
• 429 Too Many Requests - از حداکثر تعداد درخواست های همگام سازی همزمان برای agentUserId داده شده بیشتر شده است. تماس‌گیرنده می‌تواند فقط یک درخواست همگام‌سازی همزمان صادر کند، مگر اینکه پرچم async روی درست تنظیم شود.