Method: people.batchUpdateContacts

Perbarui sekelompok kontak dan tampilkan peta nama resource ke PersonResponses untuk kontak yang telah diupdate.

Permintaan mutasi untuk pengguna yang sama harus dikirim secara berurutan untuk menghindari peningkatan latensi dan kegagalan.

Permintaan HTTP

POST https://people.googleapis.com/v1/people:batchUpdateContacts

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "contacts": {
    string: {
      object (Person)
    },
    ...
  },
  "updateMask": string,
  "readMask": string,
  "sources": [
    enum (ReadSourceType)
  ]
}
Kolom
contacts

map (key: string, value: object (Person))

Wajib diisi. Peta nama resource untuk data orang yang akan diperbarui. Mengizinkan hingga 200 kontak dalam satu permintaan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

updateMask

string (FieldMask format)

Wajib diisi. Mask kolom untuk membatasi kolom mana pada orang tersebut yang diperbarui. Beberapa kolom dapat ditentukan dengan memisahkannya dengan koma. Semua kolom yang ditentukan akan diganti, atau dihapus jika dibiarkan kosong untuk setiap orang. Nilai yang valid adalah:

  • addresses
  • biografi
  • ulang tahun
  • calendarUrls
  • dataklien
  • alamatEmail
  • acara
  • ID eksternal
  • gender
  • imClients
  • minat
  • lokalitas
  • lokasi
  • channel
  • Kata Kunci Lain-Lain
  • nama
  • nama panggilan
  • pekerjaan
  • organisasi
  • nomor telepon
  • hubungan
  • sipAddress
  • Url
  • Buatan pengguna
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. Jika mask baca dibiarkan kosong, post-mutate-get akan dilewati dan tidak ada data yang akan ditampilkan dalam respons. 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 respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Jika tidak berhasil, akan menampilkan BatchUpdateContactsErrorDetails, daftar error yang sesuai dengan setiap kontak.

Respons terhadap permintaan untuk memperbarui batch kontak.

Representasi JSON
{
  "updateResult": {
    string: {
      object (PersonResponse)
    },
    ...
  }
}
Kolom
updateResult

map (key: string, value: object (PersonResponse))

Peta nama resource ke kontak yang diperbarui, kecuali jika permintaan readMask kosong.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Cakupan Otorisasi

Memerlukan cakupan OAuth berikut ini:

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

Untuk mendapatkan informasi lebih lanjut, lihat Panduan otorisasi.