Referensi: Langganan
Langganan untuk menerima acara tentang resource Google Workspace. Untuk mempelajari langganan lebih lanjut, lihat Ringkasan Google Workspace Events API.
Representasi JSON |
---|
{ "name": string, "uid": string, "targetResource": string, "eventTypes": [ string ], "payloadOptions": { object ( |
Kolom | |
---|---|
name |
Opsional. Tidak dapat diubah. Pengenal. Nama resource langganan. Format: |
uid |
Hanya output. ID unik yang ditetapkan sistem untuk langganan. |
targetResource |
Wajib. Tidak dapat diubah. Resource Google Workspace yang dipantau untuk acara, yang diformat sebagai nama referensi lengkap. Untuk mempelajari resource target dan peristiwa yang didukungnya, lihat Peristiwa Google Workspace yang didukung. Pengguna hanya dapat mengizinkan aplikasi Anda membuat satu langganan untuk resource target tertentu. Jika aplikasi Anda mencoba membuat langganan lain dengan kredensial pengguna yang sama, permintaan akan menampilkan error |
eventTypes[] |
Wajib. Tidak dapat diubah. Daftar yang tidak diurutkan. Input untuk membuat langganan. Jika tidak, hanya output. Satu atau beberapa jenis peristiwa yang akan diterima tentang resource target. Diformat menurut spesifikasi CloudEvents. Jenis peristiwa yang didukung bergantung pada resource target langganan Anda. Untuk mengetahui detailnya, lihat Peristiwa Google Workspace yang didukung. Secara default, Anda juga menerima peristiwa tentang siklus proses langganan Anda. Anda tidak perlu menentukan peristiwa siklus proses untuk kolom ini. Jika Anda menentukan jenis peristiwa yang tidak ada untuk resource target, permintaan akan menampilkan kode status |
payloadOptions |
Opsional. Opsi tentang data apa saja yang akan disertakan dalam payload peristiwa. Hanya didukung untuk acara Google Chat. |
notificationEndpoint |
Wajib. Tidak dapat diubah. Endpoint tempat langganan mengirimkan peristiwa, seperti topik Pub/Sub. |
state |
Hanya output. Status langganan. Menentukan apakah langganan dapat menerima peristiwa dan mengirimkannya ke endpoint notifikasi. |
suspensionReason |
Hanya output. Error yang menangguhkan langganan. Untuk mengaktifkan kembali langganan, atasi error dan panggil metode |
authority |
Hanya output. Pengguna yang memberikan otorisasi pembuatan langganan. Format: Untuk pengguna Google Workspace, nilai |
createTime |
Hanya output. Waktu pembuatan langganan. |
updateTime |
Hanya output. Terakhir kali langganan diperbarui. |
reconciling |
Hanya output. Jika |
etag |
Opsional. Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan mungkin dikirim pada permintaan update untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan. |
Kolom union Waktu habis masa berlaku maksimum bergantung pada apakah langganan Anda menyertakan data resource dalam payload peristiwa (ditentukan dalam kolom
Setelah masa berlaku langganan berakhir, langganan tersebut akan otomatis dihapus. Anda menerima peristiwa siklus proses ke Untuk mencegah masa berlaku langganan berakhir, Anda dapat menggunakan metode |
|
expireTime |
Default yang tidak kosong. Stempel waktu dalam UTC saat masa berlaku langganan berakhir. Selalu ditampilkan di output, apa pun yang digunakan pada input. |
ttl |
Hanya input. Time to live (TTL) atau durasi langganan. Jika tidak ditentukan atau disetel ke |
PayloadOptions
Opsi tentang data apa saja yang akan disertakan dalam payload peristiwa. Hanya didukung untuk acara Google Chat.
Representasi JSON |
---|
{ "includeResource": boolean, "fieldMask": string } |
Kolom | |
---|---|
includeResource |
Opsional. Apakah payload peristiwa menyertakan data tentang resource yang berubah. Misalnya, untuk peristiwa tempat pesan Google Chat dibuat, apakah payload berisi data tentang resource |
fieldMask |
Opsional. Jika Jika Anda menetapkan kolom yang tidak ada untuk resource, sistem akan mengabaikan kolom tersebut. |
NotificationEndpoint
Endpoint tempat langganan mengirimkan peristiwa.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union
|
|
pubsubTopic |
Tidak dapat diubah. Topik Cloud Pub/Sub yang menerima peristiwa untuk langganan. Format: Anda harus membuat topik di project Google Cloud yang sama tempat Anda membuat langganan ini. Saat topik menerima peristiwa, peristiwa tersebut akan dienkode sebagai pesan Cloud Pub/Sub. Untuk mengetahui detailnya, lihat Binding Protokol Google Cloud Pub/Sub untuk CloudEvents. |
Negara Bagian
Kemungkinan status untuk langganan.
Enum | |
---|---|
STATE_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
ACTIVE |
Langganan aktif dan dapat menerima serta mengirimkan peristiwa ke endpoint notifikasinya. |
SUSPENDED |
Langganan tidak dapat menerima acara karena terjadi error. Untuk mengidentifikasi error, lihat kolom . |
DELETED |
Langganan dihapus. |
ErrorType
Kemungkinan error pada langganan.
Enum | |
---|---|
ERROR_TYPE_UNSPECIFIED |
Nilai default. Nilai ini tidak digunakan. |
USER_SCOPE_REVOKED |
Pengguna yang memberi otorisasi telah mencabut pemberian satu atau beberapa cakupan OAuth. Guna mempelajari otorisasi Google Workspace lebih lanjut, lihat Mengonfigurasi layar izin OAuth. |
RESOURCE_DELETED |
Resource target untuk langganan tidak ada lagi. |
USER_AUTHORIZATION_FAILURE |
Pengguna yang mengizinkan pembuatan langganan tidak lagi memiliki akses ke resource target langganan. |
ENDPOINT_PERMISSION_DENIED |
Aplikasi Google Workspace tidak memiliki akses untuk mengirimkan peristiwa ke endpoint notifikasi langganan Anda. |
ENDPOINT_NOT_FOUND |
Endpoint notifikasi langganan tidak ada, atau endpoint tidak dapat ditemukan di project Google Cloud tempat Anda membuat langganan. |
ENDPOINT_RESOURCE_EXHAUSTED |
Endpoint notifikasi langganan gagal menerima peristiwa karena kuota tidak mencukupi atau mencapai pembatasan kapasitas. |
OTHER |
Terjadi error yang tidak teridentifikasi. |
Metode |
|
---|---|
|
Membuat langganan Google Workspace. |
|
Menghapus langganan Google Workspace. |
|
Mendapatkan detail tentang langganan Google Workspace. |
|
Mencantumkan langganan Google Workspace. |
|
Memperbarui atau memperpanjang langganan Google Workspace. |
|
Mengaktifkan kembali langganan Google Workspace yang ditangguhkan. |