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 peristiwa pada 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 akan dikirim (harus diawali dengan https://). dapat ditulis
collection string Koleksi yang akan dijadikan langganan. Nilai yang diizinkan adalah:
  • timeline - Perubahan pada linimasa termasuk penyisipan, penghapusan, dan pembaruan.
  • locations - Update lokasi.
  • settings - Update setelan.
 dapat ditulis
id string ID langganan.
kind string Jenis resource. Ini selalu mirror#subscription.
notification nested object Objek container untuk notifikasi. Ini tidak diisi di resource Subscription.
notification.collection string Kumpulan yang menghasilkan notifikasi.
notification.itemId string ID item yang menghasilkan notifikasi.
notification.operation string Jenis operasi yang menghasilkan notifikasi.

Nilai yang dapat diterima:
  • "DELETE"
  • "INSERT"
  • "MENU_ACTION"
  • "UPDATE"
notification.userActions[] list Daftar tindakan yang dilakukan 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. Nilainya 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 menyematkan item.
  • UNPIN - pengguna melepas pin pada item.
  • LAUNCH - pengguna memulai perintah suara.
Di masa mendatang, jenis lain mungkin akan ditambahkan. UserActions dengan jenis yang tidak dikenal harus diabaikan.
notification.userToken string Token pengguna yang diberikan oleh layanan saat berlangganan notifikasi.
notification.verifyToken string Token verifikasi rahasia yang disediakan oleh layanan saat berlangganan notifikasi.
operation[] list Daftar operasi yang harus diikuti. Daftar kosong menunjukkan bahwa semua operasi pada koleksi harus menjadi langganan. Nilai yang diizinkan adalah:
  • UPDATE - Item telah diperbarui.
  • INSERT - Item baru telah disisipkan.
  • DELETE - Item telah dihapus.
 dapat ditulis
updated datetime Waktu langganan ini terakhir diubah, diformat sesuai dengan RFC 3339.
userToken string Token buram yang dikirimkan ke pelanggan dalam notifikasi agar dapat menentukan ID pengguna. dapat ditulis
verifyToken string Token rahasia yang dikirim kepada pelanggan dalam notifikasi agar dapat memverifikasi bahwa notifikasi tersebut dibuat oleh Google. dapat ditulis

Metode

hapus
Menghapus langganan.
sisipkan
Membuat langganan baru.
list
Mengambil daftar langganan untuk pengguna dan layanan yang diautentikasi.
info terbaru
Memperbarui langganan yang sudah ada.