Method: otherContacts.list

Menampilkan daftar semua "Kontak lainnya", yaitu kontak yang tidak ada dalam grup kontak. "Kontak lainnya" biasanya merupakan kontak yang dibuat secara otomatis dari interaksi.

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 lainnya milik pengguna yang telah berubah.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

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 otherContacts.list harus cocok dengan panggilan pertama yang menyediakan token halaman.

pageSize

integer

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

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 otherContacts.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 otherContacts.list harus cocok dengan panggilan pertama yang menyediakan token sinkronisasi.

Detail selengkapnya tentang perilaku sinkronisasi di otherContacts.list.

readMask

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 bergantung pada ReadSourceType yang digunakan.

Jika READ_SOURCE_TYPE_CONTACT digunakan, nilai yang valid adalah:

  • emailAddresses
  • metadata
  • names
  • phoneNumbers
  • foto

Jika READ_SOURCE_TYPE_PROFILE digunakan, 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 disetel, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT.

Nilai yang memungkinkan untuk kolom ini adalah:

Penentuan READ_SOURCE_TYPE_PROFILE tanpa menentukan READ_SOURCE_TYPE_CONTACT tidak diizinkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons terhadap permintaan untuk "Kontak lainnya" milik pengguna terautentikasi.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON
{
  "otherContacts": [
    {
      object (Person)
    }
  ],
  "nextPageToken": string,
  "nextSyncToken": string,
  "totalSize": integer
}
Kolom
otherContacts[]

object (Person)

Daftar "Kontak lainnya" ditampilkan sebagai resource Person. "Kontak lainnya" mendukung subkumpulan kolom yang terbatas. Lihat ListOtherContactsRequest.request_mask untuk informasi lebih detail.

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.

totalSize

integer

Jumlah total kontak lain dalam daftar tanpa penomoran halaman.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.