Notifikasi push

Dokumen ini menjelaskan cara menggunakan notifikasi push yang memberi tahu aplikasi Anda saat resource berubah.

Ringkasan

Google Calendar API menyediakan notifikasi push yang memungkinkan Anda memantau perubahan pada resource. Anda dapat menggunakan fitur ini untuk meningkatkan performa aplikasi Anda. Dengan demikian, Anda dapat menghilangkan biaya jaringan dan komputasi tambahan yang terkait dengan polling resource untuk menentukan apakah resource tersebut telah berubah. Setiap kali resource yang dipantau berubah, Google Calendar API akan memberi tahu aplikasi Anda.

Untuk menggunakan notifikasi push, Anda harus melakukan dua hal:

  • Siapkan URL penerima atau penerima callback "webhook".

    Server HTTPS ini menangani pesan notifikasi API yang dipicu saat resource berubah.

  • Siapkan (saluran notifikasi) untuk setiap endpoint resource yang ingin Anda pantau.

    Saluran menentukan informasi perutean untuk pesan notifikasi. Sebagai bagian dari penyiapan channel, Anda harus mengidentifikasi URL tertentu tempat Anda ingin menerima notifikasi. Setiap kali resource channel berubah, Google Calendar API akan mengirimkan pesan notifikasi sebagai permintaan POST ke URL tersebut.

Saat ini, Google Calendar API mendukung notifikasi untuk perubahan pada resource Acl, CalendarList, Events, dan Settings.

Membuat saluran notifikasi

Untuk meminta notifikasi push, Anda harus menyiapkan saluran notifikasi untuk setiap resource yang ingin dipantau. Setelah saluran notifikasi Anda disiapkan, Google Calendar API akan memberi tahu aplikasi Anda saat ada perubahan pada resource yang dipantau.

Membuat permintaan jam

Setiap resource Google Calendar API yang dapat dipantau memiliki metode watch terkait di URI dengan format berikut:

https://www.googleapis.com/API_NAME/API_VERSION/RESOURCE_PATH/watch

Untuk menyiapkan saluran notifikasi untuk pesan tentang perubahan pada resource tertentu, kirim permintaan POST ke metode watch untuk resource tersebut.

Setiap saluran notifikasi dikaitkan dengan pengguna tertentu dan resource tertentu (atau sekumpulan resource). Permintaan watch tidak akan berhasil kecuali jika pengguna saat ini memiliki atau memiliki izin untuk mengakses resource ini.

Contoh

Mulai memantau perubahan pada kumpulan acara di kalender tertentu:

POST https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events/watch
Authorization: Bearer auth_token_for_current_user
Content-Type: application/json

{
  "id": "01234567-89ab-cdef-0123456789ab",
  "type": "web_hook",
  "address": "https://mydomain.com/notifications",
  ...
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

Dalam isi permintaan, berikan id channel Anda, type sebagai web_hook, dan URL penerima Anda di address. Anda juga dapat memberikan secara opsional:

  • token yang akan digunakan sebagai token channel Anda.
  • Waktu expiration dalam milidetik untuk waktu habis masa berlaku channel yang Anda minta.

Properti wajib

Dengan setiap permintaan watch, Anda harus memberikan kolom berikut:

  • String properti id yang secara unik mengidentifikasi saluran notifikasi baru ini dalam project Anda. Sebaiknya gunakan ID unik universal (UUID) atau string unik serupa. Panjang maksimum: 64 karakter.

    Nilai ID yang Anda tetapkan akan dikembalikan di header HTTP X-Goog-Channel-Id dari setiap pesan notifikasi yang Anda terima untuk saluran ini.

  • String properti type yang ditetapkan ke nilai web_hook.

  • String properti address yang ditetapkan ke URL yang memproses dan merespons notifikasi untuk saluran notifikasi ini. Ini adalah URL callback webhook Anda, dan harus menggunakan HTTPS.

    Perhatikan bahwa Google Calendar API hanya dapat mengirim notifikasi ke alamat HTTPS ini jika ada sertifikat SSL yang valid yang diinstal di server web Anda. Sertifikat yang tidak valid mencakup:

    • Sertifikat yang ditandatangani sendiri.
    • Sertifikat yang ditandatangani oleh sumber tidak tepercaya.
    • Sertifikat yang telah dicabut.
    • Sertifikat yang memiliki subjek yang tidak cocok dengan nama host target.

Properti opsional

Anda juga dapat menentukan kolom opsional ini dengan permintaan watch:

  • Properti token yang menentukan nilai string arbitrer untuk digunakan sebagai token channel. Anda dapat menggunakan token channel notifikasi untuk berbagai tujuan. Misalnya, Anda dapat menggunakan token untuk memverifikasi bahwa setiap pesan masuk ditujukan untuk channel yang dibuat oleh aplikasi Anda—untuk memastikan bahwa notifikasi tidak dipalsukan—atau untuk merutekan pesan ke tujuan yang tepat dalam aplikasi Anda berdasarkan tujuan channel ini. Panjang maksimum: 256 karakter.

    Token disertakan dalam header HTTP X-Goog-Channel-Token di setiap pesan notifikasi yang diterima aplikasi Anda untuk saluran ini.

    Jika Anda menggunakan token saluran notifikasi, sebaiknya:

    • Gunakan format encoding yang dapat di-extend, seperti parameter kueri URL. Contoh: forwardTo=hr&createdBy=mobile

    • Jangan sertakan data sensitif seperti token OAuth.

  • String properti expiration yang ditetapkan ke stempel waktu Unix (dalam milidetik) tanggal dan waktu saat Anda ingin Google Calendar API berhenti mengirim pesan untuk saluran notifikasi ini.

    Jika channel memiliki waktu habis masa berlaku, waktu tersebut disertakan sebagai nilai header HTTP X-Goog-Channel-Expiration (dalam format yang mudah dibaca) di setiap pesan notifikasi yang diterima aplikasi Anda untuk channel ini.

Untuk mengetahui detail selengkapnya tentang permintaan, lihat metode watch untuk resource Acl, CalendarList, Events, dan Settings di Referensi API.

Tonton respons

Jika permintaan watch berhasil membuat saluran notifikasi, permintaan tersebut akan menampilkan kode status HTTP 200 OK.

Isi pesan respons smartwatch memberikan informasi tentang saluran notifikasi yang baru saja Anda buat, seperti yang ditunjukkan dalam contoh di bawah.

{
  "kind": "api#channel",
  "id": "01234567-89ab-cdef-0123456789ab",
  "resourceId": "o3hgv1538sdjfh",
  "resourceUri": "https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events",
  "token": "target=myApp-myCalendarChannelDest",
  "expiration": 1426325213000
}

Isi respons memberikan detail channel seperti:

  • kind: Mengidentifikasi ini sebagai resource saluran API.
  • id: ID yang Anda tentukan untuk saluran ini.
  • resourceId: ID resource yang dipantau.
  • resourceUri: ID spesifik per versi dari resource yang dipantau.
  • token: Token yang diberikan dalam isi permintaan.
  • expiration: Waktu berakhirnya masa berlaku saluran sebagai stempel waktu Unix dalam milidetik.

Selain properti yang Anda kirim sebagai bagian dari permintaan, informasi yang ditampilkan juga mencakup resourceId dan resourceUri untuk mengidentifikasi resource yang dipantau di saluran notifikasi ini.

Anda dapat meneruskan informasi yang ditampilkan ke operasi saluran notifikasi lain, seperti saat Anda ingin berhenti menerima notifikasi.

Untuk mengetahui detail selengkapnya tentang respons, lihat metode watch untuk resource Acl, CalendarList, Events, dan Settings di Referensi API.

Pesan sinkronisasi

Setelah membuat saluran notifikasi untuk memantau resource, Google Calendar API akan mengirim pesan sync untuk menunjukkan bahwa notifikasi sedang dimulai. Nilai header HTTP X-Goog-Resource-State untuk pesan ini adalah sync. Karena masalah pengaturan waktu jaringan, Anda mungkin menerima pesan sync bahkan sebelum menerima respons metode watch.

Anda dapat mengabaikan notifikasi sync dengan aman, tetapi Anda juga dapat menggunakannya. Misalnya, jika Anda memutuskan tidak ingin mempertahankan saluran, Anda dapat menggunakan nilai X-Goog-Channel-ID dan X-Goog-Resource-ID dalam panggilan ke berhenti menerima notifikasi. Anda juga dapat menggunakan notifikasi sync untuk melakukan beberapa inisialisasi sebagai persiapan untuk peristiwa berikutnya.

Format pesan sync yang dikirim Google Calendar API ke URL penerima Anda ditampilkan di bawah.

POST https://mydomain.com/notifications // Your receiving URL.
X-Goog-Channel-ID: channel-ID-value
X-Goog-Channel-Token: channel-token-value
X-Goog-Channel-Expiration: expiration-date-and-time // In human-readable format. Present only if the channel expires.
X-Goog-Resource-ID: identifier-for-the-watched-resource
X-Goog-Resource-URI: version-specific-URI-of-the-watched-resource
X-Goog-Resource-State: sync
X-Goog-Message-Number: 1

Pesan sinkronisasi selalu memiliki nilai header HTTP X-Goog-Message-Number sebesar 1. Setiap notifikasi berikutnya untuk saluran ini memiliki nomor pesan yang lebih besar dari sebelumnya, meskipun nomor pesan tidak akan berurutan.

Memperbarui saluran notifikasi

Channel notifikasi dapat memiliki waktu habis masa berlaku, dengan nilai yang ditentukan oleh permintaan Anda atau oleh batas internal atau default Google Calendar API (nilai yang lebih ketat yang digunakan). Waktu habis masa berlaku channel, jika ada, disertakan sebagai stempel waktu Unix (dalam milidetik) dalam informasi yang ditampilkan oleh metode watch. Selain itu, tanggal dan waktu habis masa berlaku disertakan (dalam format yang dapat dibaca manusia) di setiap pesan notifikasi yang diterima aplikasi Anda untuk saluran ini di header HTTP X-Goog-Channel-Expiration.

Saat ini, tidak ada cara otomatis untuk memperpanjang saluran notifikasi. Saat channel hampir berakhir, Anda harus menggantinya dengan channel baru dengan memanggil metode watch. Seperti biasa, Anda harus menggunakan nilai unik untuk properti id saluran baru. Perhatikan bahwa kemungkinan ada periode waktu "tumpang-tindih" saat dua saluran notifikasi untuk resource yang sama aktif.

Terima notifikasi

Setiap kali resource yang ditonton berubah, aplikasi Anda akan menerima pesan notifikasi yang menjelaskan perubahan tersebut. Google Calendar API mengirim pesan ini sebagai permintaan HTTPS POST ke URL yang Anda tentukan sebagai properti address untuk saluran notifikasi ini.

Menafsirkan format pesan notifikasi

Semua pesan notifikasi menyertakan serangkaian header HTTP yang memiliki awalan X-Goog-. Beberapa jenis notifikasi juga dapat menyertakan isi pesan.

Header

Pesan notifikasi yang diposting oleh Google Calendar API ke URL penerima Anda mencakup header HTTP berikut:

Header Deskripsi
Selalu ada
X-Goog-Channel-ID UUID atau string unik lainnya yang Anda berikan untuk mengidentifikasi saluran notifikasi ini.
X-Goog-Message-Number Bilangan bulat yang mengidentifikasi pesan ini untuk saluran notifikasi ini. Nilainya selalu 1 untuk pesan sync. Message numbers meningkat untuk setiap pesan berikutnya di saluran, tetapi tidak berurutan.
X-Goog-Resource-ID Nilai buram yang mengidentifikasi resource yang dipantau. ID ini stabil di seluruh versi API.
X-Goog-Resource-State Status resource baru yang memicu notifikasi. Nilai yang mungkin: sync, exists, atau not_exists.
X-Goog-Resource-URI ID khusus versi API untuk resource yang dipantau.
Kadang-kadang hadir
X-Goog-Channel-Expiration Tanggal dan waktu berakhirnya channel notifikasi, dinyatakan dalam format yang dapat dibaca manusia. Hanya ada jika ditentukan.
X-Goog-Channel-Token Token saluran notifikasi yang ditetapkan oleh aplikasi Anda, dan yang dapat Anda gunakan untuk memverifikasi sumber notifikasi. Hanya ada jika ditentukan.

Pesan notifikasi yang diposting oleh Google Calendar API ke URL penerima Anda tidak menyertakan isi pesan. Pesan ini tidak berisi informasi spesifik tentang resource yang diperbarui, Anda harus melakukan panggilan API lain untuk melihat detail perubahan lengkap.

Contoh

Pesan notifikasi perubahan untuk kumpulan peristiwa yang diubah:

POST https://mydomain.com/notifications // Your receiving URL.
Content-Type: application/json; utf-8
Content-Length: 0
X-Goog-Channel-ID: 4ba78bf0-6a47-11e2-bcfd-0800200c9a66
X-Goog-Channel-Token: 398348u3tu83ut8uu38
X-Goog-Channel-Expiration: Tue, 19 Nov 2013 01:13:52 GMT
X-Goog-Resource-ID:  ret08u3rv24htgh289g
X-Goog-Resource-URI: https://www.googleapis.com/calendar/v3/calendars/my_calendar@gmail.com/events
X-Goog-Resource-State:  exists
X-Goog-Message-Number: 10

Menanggapi pemberitahuan

Untuk menunjukkan keberhasilan, Anda dapat menampilkan salah satu kode status berikut: 200, 201, 202, 204, atau 102.

Jika layanan Anda menggunakan library klien API Google dan menampilkan 500,502, 503, atau 504, Google Calendar API akan mencoba lagi dengan penundaan eksponensial. Kode status pengembalian lainnya dianggap sebagai kegagalan pesan.

Memahami peristiwa notifikasi Google Calendar API

Bagian ini memberikan detail tentang pesan notifikasi yang dapat Anda terima saat menggunakan notifikasi push dengan Google Calendar API.

X-Goog-Resource-State Berlaku untuk Dikirimkan saat
sync ACL, Daftar kalender, Acara, Setelan. Channel baru berhasil dibuat. Anda akan mulai menerima notifikasi untuknya.
exists ACL, Daftar kalender, Acara, Setelan. Ada perubahan pada resource. Kemungkinan perubahan mencakup pembuatan resource baru, atau modifikasi atau penghapusan resource yang ada.

Hentikan notifikasi

Properti expiration mengontrol kapan notifikasi berhenti secara otomatis. Anda dapat memilih untuk berhenti menerima notifikasi untuk saluran tertentu sebelum berakhir dengan memanggil metode stop di URI berikut:

https://www.googleapis.com/calendar/v3/channels/stop

Metode ini mengharuskan Anda memberikan setidaknya properti id dan resourceId channel, seperti yang ditunjukkan dalam contoh di bawah. Perhatikan bahwa jika Google Calendar API memiliki beberapa jenis resource yang memiliki metode watch, hanya ada satu metode stop.

Hanya pengguna dengan izin yang tepat yang dapat menghentikan channel. Khususnya:

  • Jika channel dibuat oleh akun pengguna biasa, hanya pengguna yang sama dari klien yang sama (seperti yang diidentifikasi oleh ID klien OAuth 2.0 dari token autentikasi) yang membuat channel yang dapat menghentikan channel.
  • Jika channel dibuat oleh akun layanan, pengguna mana pun dari klien yang sama dapat menghentikan channel tersebut.

Contoh kode berikut menunjukkan cara berhenti menerima notifikasi:

POST https://www.googleapis.com/calendar/v3/channels/stop
  
Authorization: Bearer CURRENT_USER_AUTH_TOKEN
Content-Type: application/json

{
  "id": "4ba78bf0-6a47-11e2-bcfd-0800200c9a66",
  "resourceId": "ret08u3rv24htgh289g"
}