Method: contactGroups.list

Cantumkan semua grup kontak yang dimiliki oleh pengguna yang diautentikasi. Anggota grup kontak tidak diisi.

Permintaan HTTP

GET https://people.googleapis.com/v1/contactGroups

URL menggunakan sintaksis gRPC Transcoding.

Parameter kueri

Parameter
pageToken

string

Opsional. Nilai nextPageToken yang ditampilkan dari panggilan sebelumnya ke contactGroups.list. Meminta halaman resource berikutnya.
pageSize

integer

Opsional. Jumlah maksimum resource yang akan ditampilkan. Nilai yang valid adalah antara 1 dan 1000, inklusif. Jika tidak disetel atau disetel ke 0, setelan defaultnya adalah 30.
syncToken

string

Opsional. Token sinkronisasi, yang ditampilkan oleh panggilan sebelumnya ke contactgroups.list. Hanya resource yang diubah sejak token sinkronisasi dibuat yang akan ditampilkan.
groupFields

string (FieldMask format)

Opsional. Mask kolom untuk membatasi kolom mana pada grup yang ditampilkan. Default-nya adalah metadata, groupType, memberCount, dan name jika tidak disetel atau disetel ke kosong. Kolom yang valid adalah:

  • clientData
  • groupType
  • memberCount
  • metadata
  • nama

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons ke permintaan daftar grup kontak.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "contactGroups": [
    {
      object (ContactGroup)
    }
  ],
  "totalItems": integer,
  "nextPageToken": string,
  "nextSyncToken": string
}
Kolom
contactGroups[]

object (ContactGroup)

Daftar grup kontak. Anggota grup kontak tidak diisi.
totalItems

integer

Jumlah total item dalam daftar tanpa penomoran halaman.
nextPageToken

string

Token yang dapat digunakan untuk mengambil halaman hasil berikutnya.
nextSyncToken

string

Token yang dapat digunakan untuk mengambil perubahan sejak permintaan terakhir.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/contacts
  • https://www.googleapis.com/auth/contacts.readonly

Untuk informasi selengkapnya, lihat Panduan otorisasi.