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 habis masa berlakunya akan menampilkan error dengan google.rpc.ErrorInfo dengan alasan "EXPIRED_SYNC_TOKEN". Dalam kasus error tersebut, 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 ditingkatkan.

Jika syncToken ditentukan, resource yang dihapus sejak sinkronisasi terakhir akan ditampilkan sebagai orang dengan PersonMetadata.deleted ditetapkan ke true (benar).

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

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

Lihat contoh penggunaan di Mencantumkan 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 diisi. Nama resource yang akan ditampilkan koneksinya. Hanya people/me yang valid.

Parameter kueri

Parameter
pageToken

string

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

Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk 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 ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah 100.

sortOrder

enum (SortOrder)

Opsional. Urutan pengurutan koneksi. Default-nya adalah LAST_MODIFIED_ASCENDING.

requestSyncToken

boolean

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

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

syncToken

string

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

Saat menyinkronkan, semua parameter lain yang disediakan untuk 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 subset kolom orang.

personFields

string (FieldMask format)

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

  • addresses
  • ageRanges
  • biografi
  • ulang tahun
  • calendarUrls
  • dataklien
  • coverFoto
  • alamatEmail
  • acara
  • ID eksternal
  • gender
  • imClients
  • minat
  • lokalitas
  • lokasi
  • channel
  • metadata
  • Kata Kunci Lain-Lain
  • nama
  • nama panggilan
  • pekerjaan
  • organisasi
  • nomor telepon
  • foto
  • hubungan
  • sipAddress
  • keterampilan
  • Url
  • Buatan pengguna
sources[]

enum (ReadSourceType)

Opsional. Masker dari 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

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap permintaan untuk koneksi pengguna yang diautentikasi.

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 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. Saat respons diberi nomor halaman, hanya halaman terakhir yang akan berisi nextSyncToken.

totalPeople
(deprecated)

integer

TIDAK DIGUNAKAN LAGI (Harap 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 mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.

SortOrder

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

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