Minta Sinkronisasi

smart home

Sinkronisasi Permintaan memicu permintaan SYNC ke fulfillment Anda untuk setiap pengguna Google dengan perangkat yang memiliki agentUserId tertentu yang terkait dengannya (yang Anda kirim dalam permintaan SYNC asli). Tindakan ini memungkinkan Anda mengupdate perangkat pengguna tanpa membatalkan tautan dan menautkan ulang akun mereka. Semua pengguna yang ditautkan ke ID ini akan menerima permintaan SYNC.

Anda harus memicu permintaan SYNC:

• Jika pengguna menambahkan perangkat baru.
• Jika pengguna menghapus perangkat yang ada.
• Jika pengguna mengganti nama perangkat yang sudah ada.
• Jika Anda menerapkan jenis perangkat, karakteristik, atau penambahan fitur perangkat baru.

Mulai

Untuk menerapkan Request Sync, ikuti langkah-langkah berikut:

• Mengaktifkan Google HomeGraph API
• Membuat Kunci Akun Layanan
• Memanggil API

Mengaktifkan Google HomeGraph API

1. Di Google Cloud Console, buka halaman HomeGraph API.

   Buka halaman HomeGraph API
2. Pilih project yang cocok dengan project ID smart home Anda.
3. Klik ENABLE.

Membuat Kunci Akun Layanan

Ikuti petunjuk ini untuk membuat kunci akun layanan dari Google Cloud Console:

Catatan: Pastikan Anda menggunakan project GCP yang benar saat melakukan langkah-langkah ini. Project ini cocok dengan project ID smart home Anda.

1. Di Google Cloud Console, buka halaman Create service account key.

   Buka halaman Create Service Account Key
2. Dari daftar Service account, pilih New service account.
3. Di kolom Nama akun layanan, masukkan nama.
4. Di kolom ID akun layanan, masukkan ID.

5. Dari daftar Role, pilih Service Accounts > Service Account Token Creator.

6. Untuk Jenis kunci, pilih opsi JSON.

7. Klik Create. File JSON yang berisi kunci yang didownload ke komputer Anda.

Memanggil API

HTTP

Home Graph API menyediakan endpoint HTTP

1. Gunakan file JSON akun layanan yang didownload untuk membuat Token Web JSON (JWT). Untuk mengetahui informasi selengkapnya, lihat Mengautentikasi Menggunakan Akun Layanan.
2. Dapatkan token akses OAuth 2.0 dengan cakupan https://www.googleapis.com/auth/homegraph menggunakan oauth2l:

oauth2l fetch --credentials service-account.json \
  --scope https://www.googleapis.com/auth/homegraph

3. Buat permintaan JSON dengan agentUserId. Berikut adalah contoh permintaan JSON untuk Request Sync:

{
  "agentUserId": "user-123"
}

4. Gabungkan Request Sync JSON dan token dalam permintaan HTTP POST ke endpoint Google Home Graph. Berikut adalah contoh cara membuat permintaan dalam command line menggunakan curl, sebagai pengujian:

curl -X POST -H "Authorization: Bearer ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d @request-body.json \
  "https://homegraph.googleapis.com/v1/devices:requestSync"

gRPC

Home Graph API menyediakan endpoint gRPC

1. Dapatkan definisi layanan buffering protokol untuk Home Graph API.
2. Ikuti dokumentasi developer gRPC untuk membuat stub klien untuk salah satu bahasa yang didukung.
3. Panggil metode RequestSync.

Node.js

Klien Node.js Google API menyediakan binding untuk Home Graph API.

1. Lakukan inisialisasi layanan google.homegraph menggunakan Kredensial Default Aplikasi.
2. Panggil metode requestSync dengan RequestSyncDevicesRequest. Metode ini menampilkan Promise dengan RequestSyncDevicesResponse kosong.

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
  }
});
    

Java

Library Klien HomeGraph API untuk Java menyediakan binding untuk Home Graph API.

1. Lakukan inisialisasi HomeGraphApiService menggunakan Kredensial Default Aplikasi.
2. Panggil metode requestSync dengan RequestSyncDevicesRequest. Metode ini menampilkan ReportStateAndNotificationResponse kosong.

// 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);
    

Catatan: Anda harus berhenti memanggil Request Sync setelah menerima intent DISCONNECT, yang menunjukkan bahwa pengguna telah membatalkan tautan akunnya.

Respons error

Anda mungkin menerima salah satu respons error berikut saat memanggil Request Sync. Respons ini berbentuk kode status HTTP.

• 400 Bad Request - Server tidak dapat memproses permintaan yang dikirim oleh klien karena sintaksis tidak valid. Penyebab umum mencakup format JSON yang salah atau penggunaan null, bukan "" untuk nilai string.
• 403 Forbidden - Server tidak dapat memproses permintaan untuk agentUserId tertentu karena terjadi error saat memuat ulang token. Pastikan endpoint OAuth Anda merespons dengan benar untuk memperbarui permintaan token dan memeriksa status penautan akun pengguna.
• 404 Not Found - Resource yang diminta tidak dapat ditemukan, tetapi mungkin tersedia di masa mendatang. Biasanya, ini berarti bahwa akun pengguna tidak ditautkan dengan Google atau kami menerima agentUserId yang tidak valid. Pastikan agentUserId cocok dengan nilai yang diberikan dalam respons SYNC, dan Anda menangani intent DISCONNECT dengan benar.
• 429 Too Many Requests - Jumlah maksimum permintaan sinkronisasi serentak telah terlampaui untuk agentUserId yang ditentukan. Pemanggil hanya dapat mengeluarkan satu permintaan sinkronisasi serentak kecuali jika flag async disetel ke benar (true).