REST Resource: contactGroups

Referensi: ContactGroup

Grup kontak.

Representasi JSON 
{
  "resourceName": string,
  "etag": string,
  "metadata": {
    object (ContactGroupMetadata)
  },
  "groupType": enum (GroupType),
  "name": string,
  "formattedName": string,
  "memberResourceNames": [
    string
  ],
  "memberCount": integer,
  "clientData": [
    {
      object (GroupClientData)
    }
  ]
}
Kolom
resourceName

string

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

string

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

object (ContactGroupMetadata)

Hanya output. Metadata tentang grup kontak.
groupType

enum (GroupType)

Hanya output. Jenis grup kontak.
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 harus unik untuk grup kontak pengguna. Mencoba membuat grup dengan nama duplikat akan menampilkan error HTTP 409.
formattedName

string

Hanya output. Nama 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.
memberResourceNames[]

string

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

integer

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

object (GroupClientData)

Data klien grup.

ContactGroupMetadata

Metadata tentang grup kontak.

Representasi JSON 
{
  "updateTime": string,
  "deleted": boolean
}
Kolom
updateTime

string (Timestamp format)

Hanya output. Waktu grup terakhir diperbarui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Hanya output. True jika resource grup kontak telah dihapus. Hanya diisi untuk permintaan contactGroups.list yang menyertakan token sinkronisasi.

GroupType

Jenis grup kontak.

Enum
GROUP_TYPE_UNSPECIFIED Tidak ditentukan.
USER_CONTACT_GROUP Grup kontak buatan pengguna.
SYSTEM_CONTACT_GROUP Grup kontak yang ditentukan sistem.

GroupClientData

Data klien arbitrer yang diisi oleh klien. Kunci dan nilai duplikat diizinkan.

Representasi JSON 
{
  "key": string,
  "value": string
}
Kolom
key

string

Kunci yang ditentukan klien dari data klien.
value

string

Klien menentukan nilai data klien.

Metode

batchGet

 Dapatkan daftar grup kontak yang dimiliki oleh pengguna yang diautentikasi dengan menentukan daftar nama resource grup kontak.

create

 Buat grup kontak baru yang dimiliki oleh pengguna yang diautentikasi.

delete

 Menghapus grup kontak yang ada yang dimiliki oleh pengguna yang diautentikasi dengan menentukan nama resource grup kontak.

get

 Dapatkan grup kontak tertentu yang dimiliki oleh pengguna yang diautentikasi dengan menentukan nama resource grup kontak.

list

 Menampilkan daftar semua grup kontak yang dimiliki oleh pengguna yang diautentikasi.

update

 Perbarui nama grup kontak yang ada yang dimiliki oleh pengguna yang diautentikasi.