Method: people.batchUpdateContacts

Perbarui batch kontak dan tampilkan peta nama resource ke PersonResponses untuk kontak yang diperbarui.

Permintaan yang berubah 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. Peta nama resource ke data orang yang akan diperbarui. Memungkinkan 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. Mask kolom untuk membatasi kolom pada orang yang akan diperbarui. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Semua kolom yang ditentukan akan diganti, atau dihapus jika dibiarkan kosong untuk setiap orang. Nilai yang valid adalah:

  • addresses
  • biografi
  • ulang tahun
  • calendarUrls
  • clientData
  • emailAddresses
  • acara
  • externalIds
  • gender
  • imClients
  • minat
  • locales
  • lokasi
  • channel
  • miscKeywords
  • names
  • nama panggilan
  • pekerjaan
  • organizations
  • phoneNumbers
  • relasi
  • sipAddresses
  • urls
  • userDefined
readMask

string (FieldMask format)

Wajib. Mask kolom untuk membatasi kolom mana pada setiap orang yang ditampilkan. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan 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
  • 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 ditetapkan, setelan defaultnya adalah READ_SOURCE_TYPE_CONTACT dan READ_SOURCE_TYPE_PROFILE.

Isi respons

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

Respons terhadap permintaan untuk memperbarui sekumpulan kontak.

Jika berhasil, isi respons memuat data dengan struktur berikut:

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 informasi selengkapnya, lihat Panduan otorisasi.