Acara

Peristiwa bersifat asinkron dan dikelola oleh Google Cloud Pub/Sub, dalam satu topik per Project. Peristiwa memberikan pembaruan untuk semua perangkat, struktur, dan penerimaan peristiwa dijamin selama token akses tidak dicabut oleh pengguna dan pesan peristiwa belum habis masa berlakunya.

Aktifkan acara

Peristiwa adalah fitur opsional SDM API. Lihat Mengaktifkan peristiwa guna mempelajari cara mengaktifkannya untuk ProjectAnda.

Google Cloud Pub/Sub

Lihat dokumentasi Google Cloud Pub/Sub untuk mempelajari cara kerja Pub/Sub lebih lanjut. Pada khususnya:

Langganan acara

Saat peristiwa diaktifkan untuk Project, Anda akan diberi topik khusus untuk ID Project tersebut, dalam bentuk:

projects/sdm-prod/topics/enterprise-project-id

Untuk menerima peristiwa, buat langganan pull atau push ke topik tersebut, bergantung pada kasus penggunaan Anda. Beberapa langganan ke topik SDM didukung. Lihat Mengelola langganan untuk mengetahui informasi selengkapnya.

Memulai peristiwa

Untuk memulai peristiwa untuk pertama kalinya setelah langganan Pub/Sub dibuat, lakukan panggilan API devices.list sebagai pemicu satu kali. Peristiwa untuk semua struktur dan perangkat akan dipublikasikan setelah panggilan ini.

Misalnya, lihat halaman Otorisasi di Panduan Memulai Cepat.

Urutan acara

Pub/Sub tidak menjamin pengiriman peristiwa yang berurutan, dan urutan tanda terima peristiwa mungkin tidak sesuai dengan urutan peristiwa benar-benar terjadi. Gunakan kolom timestamp untuk membantu rekonsiliasi urutan peristiwa. Peristiwa juga dapat diterima secara terpisah atau digabungkan menjadi satu pesan peristiwa.

Untuk mengetahui informasi selengkapnya, lihat Mengurutkan pesan.

ID pengguna

Jika implementasi Anda didasarkan pada pengguna (bukan struktur atau perangkat), gunakan kolom userID dari payload peristiwa untuk menghubungkan resource dan peristiwa. Kolom ini adalah ID yang di-obfuscate yang mewakili pengguna tertentu.

userID juga tersedia di header respons HTTP setiap panggilan API.

Peristiwa relasi

Peristiwa relasi mewakili update relasional untuk suatu resource. Contohnya, saat perangkat ditambahkan ke struktur, atau saat perangkat dihapus dari struktur.

Ada tiga jenis peristiwa relasi:

  • DIBUAT
  • DELETED (DIHAPUS)
  • DIPERBARUI

Payload untuk peristiwa relasi adalah sebagai berikut:

Payload

{
  "eventId" : "167a296a-d339-4626-a360-7a43475625e9",
  "timestamp" : "2019-01-01T00:00:01Z",
  "relationUpdate" : {
    "type" : "CREATED",
    "subject" : "enterprises/project-id/structures/structure-id",
    "object" : "enterprises/project-id/devices/device-id"
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
}

Dalam peristiwa relasi, object adalah resource yang memicu peristiwa, dan subject adalah resource yang sekarang memiliki relasi dengan object. Pada contoh di atas, user telah memberikan akses ke perangkat khusus ini ke developer, dan perangkat yang diberi otorisasi userkini terkait dengan struktur resminya, yang memicu peristiwa.

subject hanya dapat berupa ruangan atau struktur. Jika a developer tidak memiliki izin untuk melihat struktur user, subject akan selalu kosong.

Kolom

Kolom Deskripsi Jenis Data
eventId ID unik untuk peristiwa. string
Contoh: "effe1a42-5d9a-4b5b-a424-cc6bd145a977"
timestamp Waktu terjadinya peristiwa. string
Contoh: "2019-01-01T00:00:01Z"
relationUpdate Objek yang memerinci informasi tentang pembaruan relasi. object
userId ID unik yang di-obfuscate yang mewakili pengguna. string
Contoh: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"

Lihat Peristiwa untuk informasi selengkapnya tentang berbagai jenis peristiwa dan cara kerjanya.

Contoh

Payload peristiwa berbeda untuk setiap jenis peristiwa relasi:

DIBUAT

Struktur dibuat

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Perangkat dibuat

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Perangkat dibuat

"relationUpdate" : {
  "type" : "CREATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

DIPERBARUI

Perangkat dipindahkan

"relationUpdate" : {
  "type" : "UPDATED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

DELETED (DIHAPUS)

Struktur dihapus

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "",
  "object" : "enterprises/project-id/structures/structure-id"
}

Perangkat dihapus

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Perangkat dihapus

"relationUpdate" : {
  "type" : "DELETED",
  "subject" : "enterprises/project-id/structures/structure-id/rooms/room-id",
  "object" : "enterprises/project-id/devices/device-id"
}

Peristiwa relasi tidak dikirim saat:

  • Ruang dihapus

Peristiwa resource

Peristiwa resource mewakili update khusus untuk resource. Hal ini dapat berupa respons terhadap perubahan nilai kolom ciri, seperti perubahan mode termostat. juga dapat merepresentasikan tindakan perangkat yang tidak mengubah kolom karakteristik seperti menekan tombol perangkat.

Peristiwa yang dihasilkan sebagai respons terhadap perubahan nilai kolom trait berisi objek traits, mirip dengan panggilan GET perangkat:

Payload

{
  "eventId" : "b3f6755c-17e1-4b33-b5cc-32251142e7d6",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "traits" : {
      "sdm.devices.traits.ThermostatMode" : {
        "mode" : "COOL"
      }
    }
  },
  "userId": "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Gunakan dokumentasi ciri individual untuk memahami format payload setiap peristiwa resource perubahan kolom ciri.

Peristiwa yang dihasilkan sebagai respons terhadap tindakan perangkat yang tidak mengubah kolom ciri juga memiliki payload dengan objek resourceUpdate, tetapi dengan objek events, bukan objek traits:

Payload

{
  "eventId" : "f67af755-e432-4b9a-9045-69e986896b3f",
  "timestamp" : "2019-01-01T00:00:01Z",
  "resourceUpdate" : {
    "name" : "enterprises/project-id/devices/device-id",
    "events" : {
      "sdm.devices.events.CameraMotion.Motion" : {
        "eventSessionId" : "CjY5Y3VKaTZwR3o4Y19YbTVfMF...",
        "eventId" : "UNRMB1-mV7fXP4ncSo9E4B5Pbd...",
      }
    }
  }
  "userId" : "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi",
  "eventThreadId" : "d67cd3f7-86a7-425e-8bb3-462f92ec9f59",
  "eventThreadState" : "STARTED",
  "resourceGroup" : [
    "enterprises/project-id/devices/device-id"
  ]
}

Jenis peristiwa resource ini didefinisikan dalam ciri tertentu. Misalnya, peristiwa Motion ditentukan dalam karakteristik CameraMotion . Lihat dokumentasi setiap trait untuk memahami format payload jenis peristiwa resource ini.

Kolom

Kolom Deskripsi Jenis Data
eventId ID unik untuk peristiwa. string
Contoh: "f67af755-e432-4b9a-9045-69e986896b3f"
timestamp Waktu terjadinya peristiwa. string
Contoh: "2019-01-01T00:00:01Z"
resourceUpdate Objek yang memerinci informasi tentang update resource. object
userId ID unik yang di-obfuscate yang mewakili pengguna. string
Contoh: "AVPHwEuBfnPOnTqzVFT4IONX2Qqhu9EJ4ubO-bNnQ-yi"
eventThreadId ID unik untuk rangkaian pesan peristiwa. string
Contoh: "d67cd3f7-86a7-425e-8bb3-462f92ec9f59"
eventThreadState Status thread peristiwa. string
Nilai: "STARTED", "DIPERBARUI", "ENDED"
resourceGroup Objek yang menunjukkan resource yang mungkin memiliki pembaruan serupa dengan peristiwa ini. Resource peristiwa itu sendiri (dari objek resourceUpdate) akan selalu ada dalam objek ini. object

Lihat Peristiwa untuk informasi selengkapnya tentang berbagai jenis peristiwa dan cara kerjanya.

Notifikasi yang dapat diperbarui

Notifikasi berdasarkan peristiwa resource dapat diterapkan di aplikasi, seperti untuk Android atau iOS. Untuk mengurangi jumlah notifikasi yang dikirim, fitur yang disebut notifikasi yang dapat diupdate dapat diterapkan, dengan notifikasi yang ada diupdate dengan informasi baru berdasarkan peristiwa berikutnya dalam thread peristiwa yang sama.

Beberapa fitur peristiwa yang mendukung notifikasi yang dapat diperbarui dan diberi tag sebagai Dapat diperbarui  dalam dokumentasi. Peristiwa ini memiliki kolom tambahan yang disebut eventThreadId dalam payloadnya. Gunakan kolom ini untuk menautkan setiap peristiwa secara bersamaan dengan tujuan memperbarui notifikasi yang ada dan telah ditampilkan untuk pengguna.

Rangkaian peristiwa tidak sama dengan sesi peristiwa. Thread peristiwa mengidentifikasi status yang diperbarui untuk peristiwa sebelumnya dalam thread yang sama. Sesi peristiwa mengidentifikasi peristiwa terpisah yang berhubungan satu sama lain, dan bisa ada beberapa thread peristiwa untuk sesi peristiwa tertentu.

Untuk tujuan notifikasi, berbagai jenis peristiwa dikelompokkan ke dalam thread yang berbeda.

Logika pengaturan waktu dan pengelompokan thread ini ditangani oleh Google dan dapat berubah kapan saja. developer harus memperbarui notifikasi berdasarkan thread peristiwa dan sesi yang disediakan oleh SDM API.

Status thread

Peristiwa yang mendukung notifikasi yang dapat diupdate juga memiliki kolom eventThreadState yang menunjukkan status thread peristiwa pada waktu tersebut. Kolom ini memiliki nilai berikut:

  • DIMULAI — Peristiwa pertama dalam rangkaian pesan peristiwa.
  • DIPERBARUI — Peristiwa di rangkaian pesan peristiwa yang sedang berlangsung. Mungkin ada nol peristiwa atau lebih dengan status ini dalam satu thread.
  • ENDED — Peristiwa terakhir dalam thread peristiwa, yang mungkin merupakan duplikat dari peristiwa yang terakhir DIPERBARUI, bergantung pada jenis thread.

Kolom ini dapat digunakan untuk melacak progres thread peristiwa dan kapan telah berakhir.

Pemfilteran peristiwa

Dalam beberapa kasus, peristiwa yang terdeteksi oleh perangkat mungkin difilter agar tidak dipublikasikan ke topik SDM Pub/Sub. Perilaku ini disebut pemfilteran peristiwa. Tujuan pemfilteran peristiwa adalah untuk menghindari publikasi terlalu banyak pesan peristiwa serupa dalam waktu singkat.

Misalnya, pesan mungkin dipublikasikan ke topik SDM untuk peristiwa Motion awal. Pesan lain untuk Motion setelah itu akan difilter agar tidak dipublikasikan hingga jangka waktu tertentu berlalu. Setelah periode waktu tersebut berlalu, pesan peristiwa untuk jenis peristiwa tersebut dapat dipublikasikan lagi.

Di Aplikasi Google Home (GHA), peristiwa yang difilter akan tetap ditampilkan di histori peristiwa user. Namun, peristiwa tersebut tidak menghasilkan notifikasi aplikasi (meskipun jenis notifikasi tersebut diaktifkan).

Setiap jenis peristiwa memiliki logika pemfilteran peristiwa sendiri, yang ditentukan oleh Google dan dapat berubah kapan saja. Logika pemfilteran peristiwa ini tidak bergantung pada thread peristiwa dan logika sesi.

Akun layanan

Akun layanan direkomendasikan untuk mengelola langganan SDM API dan pesan peristiwa. Akun layanan digunakan oleh aplikasi atau mesin virtual, bukan orang, dan memiliki kunci akun uniknya sendiri.

Otorisasi akun layanan untuk Pub/Sub API menggunakan Two-legged OAuth (2LO).

Dalam alur otorisasi 2LO:

  • developer meminta token akses menggunakan kunci layanan.
  • developer menggunakan token akses dengan panggilan ke API.

Untuk mempelajari Google 2LO lebih lanjut dan cara menyiapkannya, lihat Menggunakan OAuth 2.0 untuk Aplikasi Server ke Server.

Otorisasi

Akun layanan harus diizinkan untuk digunakan dengan Pub/Sub API:

  1. Aktifkan Cloud Pub/Sub API di Google Cloud.
  2. Buat akun layanan dan kunci akun layanan seperti yang dijelaskan dalam Membuat akun layanan. Sebaiknya hanya berikan peran Pub/Sub Subscriber. Pastikan untuk mendownload kunci akun layanan ke komputer yang akan menggunakan Pub/Sub API.
  3. Berikan kredensial autentikasi (kunci akun layanan) ke kode aplikasi Anda dengan mengikuti petunjuk di halaman pada langkah sebelumnya, atau dapatkan token akses secara manual menggunakan oauth2l, jika Anda ingin menguji akses API secara cepat.
  4. Gunakan kredensial akun layanan atau token akses dengan Pub/Sub project.subscriptions API untuk mengambil dan mengonfirmasi pesan.

Oauth2l

oauth2l Google adalah alat command line untuk OAuth yang ditulis dalam Go. Instal untuk Mac atau Linux menggunakan Go.

  1. Jika Anda tidak memiliki Go di sistem, download dan instal terlebih dahulu.
  2. Setelah Go diinstal, instal oauth2l dan tambahkan lokasinya ke variabel lingkungan PATH Anda: 
    go install github.com/google/oauth2l@latest
export PATH=$PATH:~/go/bin
  3. Gunakan oauth2l untuk mendapatkan token akses untuk API, dengan menggunakan cakupan OAuth yang sesuai: 
    oauth2l fetch --credentials path-to-service-key.json --scope https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
    Misalnya, jika kunci layanan Anda berada di ~/myServiceKey-eb0a5f900ee3.json: 
    oauth2l fetch --credentials ~/myServiceKey-eb0a5f900ee3.json --scope https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform
ya29.c.Elo4BmHXK5...

Lihat README oauth2l untuk informasi penggunaan selengkapnya.

Library Klien Google API

Ada beberapa library klien yang tersedia untuk Google API yang menggunakan OAuth 2.0. Lihat Library Klien Google API untuk informasi selengkapnya tentang bahasa pilihan Anda.

Saat menggunakan library ini dengan Pub/Sub API, gunakan string cakupan berikut:

https://www.googleapis.com/auth/pubsub
https://www.googleapis.com/auth/cloud-platform

Error

Kode error berikut mungkin ditampilkan sehubungan dengan panduan ini:

Pesan Error RPC Pemecahan masalah
Gambar kamera tidak lagi tersedia untuk didownload. DEADLINE_EXCEEDED Masa berlaku gambar peristiwa akan habis 30 detik setelah peristiwa dipublikasikan. Pastikan untuk mendownload gambar sebelum masa berlakunya habis.
ID peristiwa bukan bagian dari kamera. FAILED_PRECONDITION Gunakan eventID yang benar yang ditampilkan oleh peristiwa terekam kamera.

Lihat Referensi Kode Error API untuk mengetahui daftar lengkap kode error API.