Method: subscriptions.list

Mencantumkan langganan Google Workspace. Untuk mempelajari cara menggunakan metode ini, lihat Mencantumkan langganan Google Workspace.

Permintaan HTTP

GET https://workspaceevents.googleapis.com/v1/subscriptions

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
pageSize

integer

Opsional. Jumlah maksimum langganan yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan atau ditetapkan ke 0, hingga 50 langganan akan ditampilkan.

Nilai maksimumnya adalah 100. Jika Anda menentukan nilai lebih dari 100, sistem hanya akan menampilkan 100 langganan.
pageToken

string

Opsional. Token halaman, diterima dari panggilan list subscriptions sebelumnya. Berikan parameter ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, nilai filter harus sesuai dengan panggilan yang menyediakan token halaman. Meneruskan nilai yang berbeda dapat menyebabkan hasil yang tidak terduga.
filter

string

Wajib. Filter kueri.

Anda dapat memfilter langganan menurut jenis peristiwa (event_types) dan resource target (target_resource).

Anda harus menentukan setidaknya satu jenis peristiwa dalam kueri. Untuk memfilter beberapa jenis peristiwa, gunakan operator OR.

Untuk memfilter menurut jenis peristiwa dan resource target, gunakan operator AND dan tentukan nama resource lengkap, seperti //chat.googleapis.com/spaces/{space}.

Misalnya, kueri berikut valid:

event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/{space}"

Server menolak kueri yang tidak valid dengan error INVALID_ARGUMENT.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Pesan respons untuk SubscriptionsService.ListSubscriptions.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
Kolom
subscriptions[]

object (Subscription)

Daftar langganan.
nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/meetings.space.created
  • https://www.googleapis.com/auth/meetings.space.readonly

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.