Method: otherContacts.list

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

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 lain 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 nextPageToken sebelumnya. Berikan ini untuk mengambil halaman berikutnya.

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

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 otherContacts.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 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 dengan koma. Nilai yang valid bergantung pada nilai ReadSourceType yang digunakan.

Jika READ_SOURCE_TYPE_CONTACT digunakan, nilai yang valid adalah:

  • alamatEmail
  • metadata
  • nama
  • nomor telepon
  • foto

Jika READ_SOURCE_TYPE_PROFILE digunakan, 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.

Nilai yang mungkin untuk kolom ini adalah:

Penentuan READ_SOURCE_TYPE_PROFILE tanpa menentukan READ_SOURCE_TYPE_CONTACT tidak diperbolehkan.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons terhadap permintaan "Kontak lainnya" milik pengguna yang diautentikasi.

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

object (Person)

Daftar "Kontak lainnya" ditampilkan sebagai fasilitas Orang. "Kontak lainnya" mendukung subkumpulan kolom yang terbatas. Lihat ListOtherContactsRequest.request_mask untuk informasi selengkapnya.

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 ini:

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

Untuk mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.