REST Resource: contactGroups

Kaynak: ContactGroup

Kişi grubu.

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

string

Kişi grubu için sunucu tarafından atanan kaynak adı. contactGroups/{contactGroupId} biçiminde bir ASCII dizesi.
etag

string

Kaynağın HTTP varlık etiketi. Web önbelleği doğrulaması için kullanılır.
metadata

object (ContactGroupMetadata)

Yalnızca çıkış. Kişi grubuyla ilgili meta veriler.
groupType

enum (GroupType)

Yalnızca çıkış. Kişi grubunun türü.
name

string

Grup sahibi tarafından belirlenen kişi grubu adı veya sistem grupları için sistem tarafından sağlanan bir ad.

contactGroups.create veya contactGroups.update için ad, kullanıcının kişi gruplarına özgü olmalıdır. Yinelenen ada sahip bir grup oluşturma girişiminde HTTP 409 hatası döndürülür.
formattedName

string

Yalnızca çıkış. Görüntüleyen kullanıcının hesap yerel ayarında veya sistem grubu adları için Accept-Language HTTP üstbilgisi yerel ayarında çevrilen ve biçimlendirilen ad. Grup sahibi tarafından belirlenen grup adları, adla aynı.
memberResourceNames[]

string

Yalnızca çıkış. Kişi grubunun üyesi olan ilgili kişi kaynak adlarının listesi. Bu alan yalnızca GET istekleri için doldurulur ve yalnızca get isteğindeki maxMembers üye sayısına kadar döndürülür.
memberCount

integer

Yalnızca çıkış. İstekte belirtilen maksimum üye sayısından bağımsız olarak gruptaki toplam kişi sayısı.
clientData[]

object (GroupClientData)

Grubun istemci verileri.

ContactGroupMetadata

Kişi grubuyla ilgili meta veriler.

JSON gösterimi 
{
  "updateTime": string,
  "deleted": boolean
}
Alanlar
updateTime

string (Timestamp format)

Yalnızca çıkış. Grubun son güncellendiği zaman.

RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Yalnızca çıkış. Kişi grubu kaynağı silindiyse doğru değerini alır. Yalnızca senkronizasyon jetonu içeren contactGroups.list istekleri için doldurulur.

GroupType

Kişi grubu türü.

Sıralamalar
GROUP_TYPE_UNSPECIFIED Belirtilmedi.
USER_CONTACT_GROUP Kullanıcı tanımlı kişi grubu.
SYSTEM_CONTACT_GROUP Sistem tarafından tanımlanmış kişi grubu.

GroupClientData

İstemciler tarafından doldurulan rastgele istemci verileri. Yinelenen anahtarlara ve değerlere izin verilir.

JSON gösterimi 
{
  "key": string,
  "value": string
}
Alanlar
key

string

İstemci tarafından belirtilen istemci verilerinin anahtarı.
value

string

İstemci, müşteri verilerinin değerini belirtti.

Yöntemler

batchGet

 Kişi grubu kaynak adlarının bir listesini belirterek kimliği doğrulanmış kullanıcıya ait kişi gruplarının listesini alın.

create

 Kimliği doğrulanmış kullanıcıya ait yeni bir kişi grubu oluşturun.

delete

 Bir kişi grubu kaynak adı belirterek kimliği doğrulanmış kullanıcıya ait mevcut bir kişi grubunu silin.

get

 Bir kişi grubu kaynak adı belirterek kimliği doğrulanmış kullanıcıya ait belirli bir kişi grubunu alın.

list

 Kimliği doğrulanmış kullanıcının sahip olduğu tüm kişi gruplarını listeler.

update

 Kimliği doğrulanmış kullanıcıya ait mevcut bir kişi grubunun adını güncelleyin.