Method: contactGroups.list

Cantumkan semua grup kontak yang dimiliki oleh pengguna terautentikasi. Anggota grup kontak tidak terisi.

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 ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah 30.

syncToken

string

Opsional. Token sinkronisasi, 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 di grup yang ditampilkan. Jika tidak ditetapkan, nilai default metadata, groupType, memberCount, dan name akan kosong. Kolom yang valid adalah:

  • dataklien
  • grupJenis
  • jumlah anggota
  • metadata
  • name

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap permintaan daftar grup kontak.

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

object (ContactGroup)

Daftar grup kontak. Anggota grup kontak tidak terisi.

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 mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.