Subscriptions

Mirror API memungkinkan Anda berlangganan notifikasi yang dikirim saat pengguna mengambil tindakan tertentu pada item linimasa atau saat lokasi pengguna telah diperbarui.

Untuk daftar metode untuk resource ini, lihat bagian akhir halaman ini.

Representasi resource

Langganan ke peristiwa di koleksi.

{
  "kind": "mirror#subscription",
  "id": string,
  "updated": datetime,
  "collection": string,
  "operation": [
    string
  ],
  "callbackUrl": string,
  "verifyToken": string,
  "userToken": string,
  "notification": {
    "collection": string,
    "itemId": string,
    "operation": string,
    "userActions": [
      {
        "type": string,
        "payload": string
      }
    ],
    "verifyToken": string,
    "userToken": string
  }
}
Nama properti Nilai Deskripsi Catatan
callbackUrl string URL tempat notifikasi harus dikirim (harus diawali dengan https://). dapat ditulis
collection string Koleksi yang akan disubscribe. Nilai yang diizinkan adalah:
  • timeline - Perubahan di linimasa termasuk penyisipan, penghapusan, dan update.
  • locations - Pembaruan lokasi.
  • settings - Pembaruan setelan.
 dapat ditulis
id string ID langganan.
kind string Jenis resource. Nilai ini selalu mirror#subscription.
notification nested object Objek container untuk notifikasi. Ini tidak diisi di resource Subscription.
notification.collection string Koleksi yang menghasilkan notifikasi.
notification.itemId string ID item yang menghasilkan notifikasi.
notification.operation string Jenis operasi yang menghasilkan notifikasi.

Nilai yang dapat diterima adalah:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Daftar tindakan yang diambil oleh pengguna yang memicu notifikasi.
notification.userActions[].payload string Payload opsional untuk tindakan.

Untuk tindakan jenis CUSTOM, ini adalah ID item menu kustom yang dipilih.
notification.userActions[].type string Jenis tindakan. Nilai ini dapat berupa:
  • SHARE - pengguna membagikan item.
  • REPLY - pengguna membalas item.
  • REPLY_ALL - pengguna membalas semua penerima item.
  • CUSTOM - pengguna memilih item menu kustom di item linimasa.
  • DELETE - pengguna menghapus item.
  • PIN - pengguna telah menyematkan item.
  • UNPIN - pengguna telah melepas item.
  • LAUNCH - pengguna memulai perintah suara.
Di masa mendatang, jenis tambahan mungkin akan ditambahkan. UserActions dengan jenis yang tidak dikenal harus diabaikan.
notification.userToken string Token pengguna yang disediakan oleh layanan ketika berlangganan notifikasi.
notification.verifyToken string Token verifikasi rahasia yang diberikan oleh layanan saat berlangganan notifikasi.
operation[] list Daftar operasi yang harus di-subscribe. Daftar kosong menunjukkan bahwa semua operasi pada koleksi harus diikuti. Nilai yang diizinkan adalah:
  • UPDATE - Item telah diperbarui.
  • INSERT - Item baru disisipkan.
  • DELETE - Item telah dihapus.
 dapat ditulis
updated datetime Waktu saat langganan ini terakhir diubah, yang diformat sesuai dengan RFC 3339.
userToken string Token buram yang dikirimkan kepada pelanggan dalam notifikasi agar dapat menentukan ID pengguna. dapat ditulis
verifyToken string Token rahasia dikirim ke pelanggan dalam notifikasi agar dapat memverifikasi bahwa notifikasi dibuat oleh Google. dapat ditulis

Metode

hapus
Menghapus langganan.
masukkan
Membuat langganan baru.
list
Mengambil daftar langganan untuk pengguna dan layanan yang diautentikasi.
perbarui
Memperbarui langganan yang ada.