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 grubu türü.
name

string

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

contactGroups.create veya contactGroups.update için ad, kullanıcıların kişi gruplarına özgü olmalıdır. Yinelenen adla bir grup oluşturulmaya çalışıldığında HTTP 409 hatası döndürülür.
formattedName

string

Yalnızca çıkış. Görüntüleyenin hesap yerel ayarında veya sistem grubu adları için Accept-Language HTTP üst bilgisi yerel ayarında çevrilmiş ve biçimlendirilmiş ad. Grup sahibi tarafından belirlenen grup adları ad ile aynıdır.
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ğinde maxMembers kadar üye döndürü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

Bir 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.

Nanosaniye çözünürlük ve en fazla dokuz kesir basamağı olan, RFC3339 UTC "Zulu" biçiminde bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
deleted

boolean

Yalnızca çıkış. Kişi grubu kaynağı silinmişse True (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 tanımlı kişi grubu.

GroupClientData

Müşteriler tarafından doldurulan rastgele müşteri verileri. Yinelenen anahtarlara ve değerlere izin verilir.

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

string

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

string

İstemci tarafından belirtilen müşteri verileri değeri.

Yöntemler

batchGet

 Kişi grubu kaynak adlarının bir listesini belirterek kimliği doğrulanmış kullanıcının sahip olduğu 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

 Kimliği doğrulanmış kullanıcının sahip olduğu mevcut bir kişi grubunu, kişi grubu kaynak adı belirterek silin.

get

 Bir kişi grubu kaynak adı belirterek kimliği doğrulanmış kullanıcının sahip olduğu belirli bir kişi grubunu alabilirsiniz.

list

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

update

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