Method: otherContacts.list

Cantumkan semua "Kontak lainnya", yaitu kontak yang tidak ada di grup kontak. "Kontak lainnya" biasanya merupakan kontak yang dibuat otomatis dari interaksi.

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

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

Jika 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 Mencantumkan kontak pengguna lainnya 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 atribut ini untuk mengambil halaman selanjutnya.

Saat memberi nomor halaman, semua parameter lain yang diberikan ke otherContacts.list harus cocok dengan panggilan pertama yang menyediakan token halaman.
pageSize

integer

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

boolean

Opsional. Apakah respons harus menampilkan nextSyncToken di halaman terakhir hasil. Opsi 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 token ini untuk hanya mengambil resource yang diubah sejak permintaan terakhir.

Saat menyinkronkan, semua parameter lain yang diberikan untuk otherContacts.list harus cocok dengan panggilan pertama yang menyediakan token sinkronisasi.

Detail selengkapnya tentang perilaku sinkronisasi di otherContacts.list.
readMask

string (FieldMask format)

Wajib diisi. 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
  • nama
  • phoneNumbers
  • foto

Jika READ_SOURCE_TYPE_PROFILE digunakan, nilai yang valid adalah:

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

enum (ReadSourceType)

Opsional. Masker jenis sumber yang akan ditampilkan. Jika tidak disetel, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT.

Kemungkinan nilai untuk kolom ini adalah:

Menentukan READ_SOURCE_TYPE_PROFILE tanpa menentukan READ_SOURCE_TYPE_CONTACT tidak diizinkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Respons ke permintaan untuk "Kontak lainnya" dari pengguna yang diautentikasi.

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" yang ditampilkan sebagai resource Person. "Kontak lainnya" mendukung subset kolom terbatas. Lihat ListOtherContactsRequest.request_mask untuk informasi lebih mendetail.
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.
totalSize

integer

Jumlah total kontak lainnya dalam daftar tanpa penomoran halaman.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.