Method: people.connections.list

Menyediakan daftar kontak pengguna yang diautentikasi.

Masa berlaku token sinkronisasi berakhir 7 hari setelah sinkronisasi penuh. Permintaan dengan token sinkronisasi yang sudah tidak berlaku akan menerima error dengan google.rpc.ErrorInfo dengan alasan "EXPIRED_SYNC_TOKEN". Jika terjadi error seperti itu, klien harus membuat permintaan sinkronisasi penuh tanpa syncToken.

Halaman pertama dari permintaan sinkronisasi penuh memiliki kuota tambahan. Jika kuota terlampaui, error 429 akan ditampilkan. Kuota ini bersifat tetap dan tidak dapat ditambah.

Saat syncToken ditentukan, resource yang dihapus sejak sinkronisasi terakhir akan ditampilkan sebagai pengguna dengan PersonMetadata.deleted disetel ke benar (true).

Saat pageToken atau syncToken ditentukan, semua parameter permintaan lainnya harus cocok dengan panggilan pertama.

Operasi tulis mungkin mengalami penundaan penerapan selama beberapa menit untuk permintaan sinkronisasi. Sinkronisasi inkremental tidak dimaksudkan untuk kasus penggunaan baca setelah tulis.

Lihat contoh penggunaan di Menampilkan daftar kontak pengguna yang telah berubah.

Permintaan HTTP

GET https://people.googleapis.com/v1/{resourceName=people/*}/connections

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
resourceName
(deprecated)

string

Wajib. Nama resource yang koneksinya akan ditampilkan. Hanya people/me yang valid.

Parameter kueri

Parameter
pageToken

string

Opsional. Token halaman, diterima dari respons sebelumnya nextPageToken. Berikan ini untuk mengambil halaman berikutnya.

Saat melakukan penomoran halaman, semua parameter lain yang disediakan ke people.connections.list harus cocok dengan panggilan pertama yang menyediakan token halaman.
pageSize

integer

Opsional. Jumlah koneksi yang akan disertakan dalam respons. Nilai yang valid adalah antara 1 dan 1000, inklusif. Jika tidak disetel atau disetel ke 0, defaultnya adalah 100.
sortOrder

enum (SortOrder)

Opsional. Urutan koneksi harus diurutkan. Default-nya adalah LAST_MODIFIED_ASCENDING.
requestSyncToken

boolean

Opsional. Apakah respons harus menampilkan nextSyncToken di halaman terakhir hasil. Class ini dapat digunakan untuk mendapatkan perubahan inkremental sejak permintaan terakhir dengan menyetelnya pada permintaan syncToken.

Detail selengkapnya tentang perilaku sinkronisasi di people.connections.list.
syncToken

string

Opsional. Token sinkronisasi, diterima dari respons sebelumnya nextSyncToken Berikan ini untuk mengambil resource yang diubah sejak permintaan terakhir.

Saat menyinkronkan, semua parameter lain yang disediakan ke people.connections.list harus cocok dengan panggilan pertama yang menyediakan token sinkronisasi.

Detail selengkapnya tentang perilaku sinkronisasi di people.connections.list.
requestMask
(deprecated)

object (RequestMask)

Opsional. TIDAK DIGUNAKAN LAGI (Sebagai gantinya, gunakan personFields)

Mask untuk membatasi hasil ke sebagian kolom orang.
personFields

string (FieldMask format)

Wajib. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Nilai yang valid adalah:

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • clientData
  • coverPhotos
  • emailAddresses
  • acara
  • externalIds
  • gender
  • imClients
  • minat
  • locales
  • lokasi
  • channel
  • metadata
  • miscKeywords
  • names
  • nama panggilan
  • pekerjaan
  • organizations
  • phoneNumbers
  • foto
  • relasi
  • sipAddresses
  • keterampilan
  • urls
  • userDefined
sources[]

enum (ReadSourceType)

Opsional. Mask untuk jenis sumber yang akan ditampilkan. Jika tidak ditetapkan, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT dan READ_SOURCE_TYPE_PROFILE.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons terhadap permintaan koneksi pengguna yang diautentikasi.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "connections": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalPeople": integer,
  "totalItems": integer
}
Kolom
connections[]

object (Person)

Daftar orang yang terhubung dengan pemohon.
nextPageToken

string

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

string

Token yang dapat dikirim sebagai syncToken untuk mengambil perubahan sejak permintaan terakhir. Permintaan harus menetapkan requestSyncToken untuk menampilkan token sinkronisasi. Jika respons diberi nomor halaman, hanya halaman terakhir yang akan berisi nextSyncToken.
totalPeople
(deprecated)

integer

TIDAK DIGUNAKAN LAGI (Gunakan totalItems) Jumlah total orang dalam daftar tanpa penomoran halaman.
totalItems

integer

Jumlah total item dalam daftar tanpa penomoran halaman.

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.

SortOrder

Urutan daftar koneksi yang harus diurutkan. Ini hanya digunakan jika sinkronisasi tidak diminta.

Enum
LAST_MODIFIED_ASCENDING Urutkan orang berdasarkan kapan mereka diubah; entri yang lebih lama terlebih dahulu.
LAST_MODIFIED_DESCENDING Urutkan orang berdasarkan waktu perubahan mereka; entri yang lebih baru terlebih dahulu.
FIRST_NAME_ASCENDING Urutkan orang menurut nama depan.
LAST_NAME_ASCENDING Urutkan orang berdasarkan nama belakang.