Method: contactGroups.update

Perbarui nama grup kontak yang ada milik pengguna yang diautentikasi.

Nama grup kontak yang diperbarui harus unik bagi grup kontak pengguna. Mencoba membuat grup dengan nama duplikat akan menampilkan pesan {i>error<i} HTTP 409.

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

Permintaan HTTP

PUT https://people.googleapis.com/v1/{contactGroup.resourceName=contactGroups/*}

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
contactGroup.resourceName

string

Nama resource untuk grup kontak, yang ditetapkan oleh server. String ASCII, dalam bentuk contactGroups/{contactGroupId}.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "contactGroup": {
    "resourceName": string,
    "etag": string,
    "metadata": {
      "updateTime": string,
      "deleted": boolean
    },
    "groupType": enum (GroupType),
    "name": string,
    "formattedName": string,
    "memberResourceNames": [
      string
    ],
    "memberCount": integer,
    "clientData": [
      {
        "key": string,
        "value": string
      }
    ]
  },
  "updateGroupFields": string,
  "readGroupFields": string
}
Kolom
contactGroup.etag

string

Tag entity HTTP resource. Digunakan untuk validasi cache web.
contactGroup.metadata

object (ContactGroupMetadata)

Hanya output. Metadata tentang grup kontak.
contactGroup.groupType

enum (GroupType)

Hanya output. Jenis grup kontak.
contactGroup.name

string

Nama grup kontak yang ditetapkan oleh pemilik grup atau nama yang diberikan sistem untuk grup sistem.

Untuk contactGroups.create atau contactGroups.update, nama tersebut harus unik bagi grup kontak pengguna. Mencoba membuat grup dengan nama duplikat akan menampilkan pesan {i>error<i} HTTP 409.
contactGroup.formattedName

string

Hanya output. Nama yang diterjemahkan dan diformat dalam lokalitas akun pelihat atau lokalitas header HTTP Accept-Language untuk nama grup sistem. Nama grup yang ditetapkan oleh pemilik sama dengan nama.
contactGroup.memberResourceNames[]

string

Hanya output. Daftar nama resource narahubung yang merupakan anggota grup kontak. Kolom ini hanya diisi untuk permintaan GET dan hanya akan menampilkan anggota sebanyak maxMembers dalam permintaan get.
contactGroup.memberCount

integer

Hanya output. Jumlah total kontak dalam grup terlepas dari jumlah maksimum anggota yang ditentukan dalam permintaan.
contactGroup.clientData[]

object (GroupClientData)

Data klien grup.
updateGroupFields

string (FieldMask format)

Opsional. Mask kolom untuk membatasi kolom mana di grup yang diperbarui. Beberapa kolom dapat ditentukan dengan memisahkannya menggunakan koma. Jika tidak disetel atau disetel ke kosong, setelan defaultnya adalah name. Kolom yang diperbarui diganti. Nilai yang valid adalah:

  • clientData
  • nama
readGroupFields

string (FieldMask format)

Opsional. Mask kolom untuk membatasi kolom mana pada grup yang ditampilkan. Default-nya adalah metadata, groupType, dan name jika tidak disetel atau disetel ke kosong. Kolom yang valid adalah:

  • clientData
  • groupType
  • memberCount
  • metadata
  • nama

Isi respons

Jika berhasil, isi respons memuat instance ContactGroup.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk informasi selengkapnya, lihat Panduan otorisasi.