Status Laporan

Report State adalah fitur penting yang memungkinkan Tindakan Home secara proaktif melaporkan status terbaru perangkat pengguna kembali ke Google Home Graph, bukan menunggu intent QUERY.

Report State melaporkan status perangkat pengguna dengan agentUserId yang ditentukan yang terkait dengannya (dikirim dalam permintaan SYNC asli). Saat Google Assistant ingin melakukan tindakan yang memerlukan pemahaman status perangkat saat ini, aplikasi cukup mencari informasi status di Home Graph, bukan mengeluarkan intent QUERY ke berbagai cloud pihak ketiga sebelum mengeluarkan intent EXECUTE.

Tanpa Report State, dengan mempertimbangkan lampu dari beberapa penyedia di ruang keluarga, perintah Ok Google, cerahkan ruang tamu memerlukan penyelesaian beberapa intent QUERY yang dikirim ke beberapa cloud, bukan hanya mencari nilai kecerahan saat ini berdasarkan pada apa yang telah dilaporkan sebelumnya. Untuk pengalaman pengguna terbaik, Assistant harus memiliki status perangkat saat ini, tanpa memerlukan perjalanan pulang pergi ke perangkat.

Setelah SYNC awal untuk perangkat, platform akan mengirimkan intent QUERY yang mengumpulkan status perangkat untuk mengisi Home Graph. Setelah itu, Home Graph hanya menyimpan status yang dikirim dengan Report State.

Saat memanggil Report State, pastikan Anda memberikan data status lengkap untuk trait tertentu. Home Graph memperbarui status per fitur dan menimpa semua data untuk fitur tersebut saat panggilan Report State dilakukan. Misalnya, jika Anda melaporkan status untuk karakteristik StartStop, payload harus menyertakan nilai untuk isRunning dan isPaused.

Mulai

Untuk menerapkan Report State, 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:

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

Pilih opsi dari tab di bawah:

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

const res = await homegraphClient.devices.reportStateAndNotification({
  requestBody: {
    agentUserId: 'PLACEHOLDER-USER-ID',
    requestId: 'PLACEHOLDER-REQUEST-ID',
    payload: {
      devices: {
        states: {
          "PLACEHOLDER-DEVICE-ID": {
            on: true
          }
        }
      }
    }
  }
});
    

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

  // Build device state payload.
  Map<?, ?> states = Map.of("on", true);

  // Report device state.
  ReportStateAndNotificationRequest request =
      new ReportStateAndNotificationRequest()
          .setRequestId("PLACEHOLDER-REQUEST-ID")
          .setAgentUserId("PLACEHOLDER-USER-ID")
          .setPayload(
              new StateAndNotificationPayload()
                  .setDevices(
                      new ReportStateAndNotificationDevice()
                          .setStates(Map.of("PLACEHOLDER-DEVICE-ID", states))));
  homegraphService.devices().reportStateAndNotification(request);
}
    

Status Laporan Pengujian

Agar tindakan Anda siap untuk disertifikasi, Anda harus menguji Report State.

Untuk melakukannya, sebaiknya gunakan alat Pelihat Home Graph, yang merupakan aplikasi web mandiri yang tidak memerlukan download atau deployment.

Dasbor Report State masih tersedia, tetapi tidak digunakan lagi dan tidak didukung lagi.

Dasbor Status Laporan

Prasyarat

Agar dapat menguji tindakan, Anda memerlukan Kunci Akun Layanan dan agentUserId. Jika Anda sudah memiliki Kunci Akun Layanan dan agentUserId, lihat Men-deploy Dasbor Report State.

Men-deploy dasbor Status Laporan

Setelah memiliki Kunci Akun Layanan dan ID Pengguna Agen untuk project Anda, download dan deploy versi terbaru dari Dasbor Report State. Setelah mendownload versi terbaru, ikuti petunjuk dari file README.MD yang disertakan.

Setelah Anda men-deploy dasbor Report State, akses dasbor dari URL berikut (ganti your_project_id dengan project ID Anda):

http://<your-project-id>.appspot.com

Di dasbor, lakukan tindakan berikut:

• Pilih File Kunci Akun Anda
• Tambahkan agenUserId Anda

Lalu klik List.

Semua perangkat Anda tercantum. Setelah daftar terisi, Anda dapat menggunakan tombol Refresh untuk memperbarui status perangkat. Jika ada perubahan status perangkat, baris tersebut akan disorot dengan warna hijau.

Respons Error

Anda mungkin menerima salah satu respons error berikut saat memanggil Report State. 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.
• 404 Not Found - Resource yang diminta tidak dapat ditemukan, tetapi mungkin tersedia di masa mendatang. Biasanya, ini berarti kita tidak dapat menemukan perangkat yang diminta. Ini juga dapat berarti bahwa akun pengguna tidak tertaut 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.