REST Resource: groups

Kaynak: Grup

Google Grupları, kullanıcılarınızın grubun e-posta adresini kullanarak kullanıcı gruplarına ileti gönderebilmesini sağlar. Genel görevler hakkında daha fazla bilgi için Geliştirici Kılavuzu'na bakın.

Diğer grup türleri hakkında bilgi edinmek için Cloud Identity Groups API dokümanlarına bakın.

Not: API'yi çağıran (veya bir hizmet hesabı tarafından kimliğine bürünen) kullanıcıya, Yönetici API'si Grup izinlerini (ör. Süper Yönetici veya Grup Yöneticisi) içeren atanmış bir rol olmalıdır.

JSON gösterimi
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Alanlar
id

string

Salt okunur. Bir grubun benzersiz kimliği. id grubu, grup istek URI'sı groupKey olarak kullanılabilir.

email

string

Grubun e-posta adresi. Hesabınızda birden fazla alan varsa e-posta adresi için uygun alanı seçin. email benzersiz olmalıdır. Bu özellik grup oluştururken gereklidir. Grup e-posta adresleri, kullanıcı adlarıyla aynı karakter kullanım kurallarına tabidir. Ayrıntılar için yardım merkezine göz atın.

name

string

Grubun görünen adı.

description

string

Kullanıcıların bir grubun amacını belirlemesine yardımcı olan genişletilmiş açıklama. Örneğin, gruba kimlerin katılması gerektiği, gruba gönderilecek ileti türleri, grupla ilgili SSS bağlantılarını veya ilgili gruplar hakkındaki bilgileri ekleyebilirsiniz. Maksimum uzunluk 4,096 karakterdir.

adminCreated

boolean

Salt okunur. Bu grup, bir kullanıcı yerine bir yönetici tarafından oluşturulduysa değer true olur.

directMembersCount

string (int64 format)

Grubun doğrudan üyesi olan kullanıcıların sayısı. Bir grup, bu grubun (üst öğe) üyesi (alt öğe) ise alt grubun üyeleri, üst grubun directMembersCount özelliğinde sayılmaz.

kind

string

API kaynağının türü. Gruplar kaynakları için değer admin#directory#group şeklindedir.

etag

string

Kaynağın ETag.

aliases[]

string

Salt okunur. Grubun takma ad e-posta adreslerinin listesi. Bir grubun takma adlarını eklemek, güncellemek veya kaldırmak için groups.aliases yöntemlerini kullanın. Bir grubun POST veya PUT isteğinde düzenlenmişse düzenleme yoksayılır.

nonEditableAliases[]

string

Salt okunur. Grubun birincil alanı veya alt alanları dışındaki, düzenlenemeyen takma ad e-posta adreslerinin listesi. Bunlar grup tarafından kullanılan, işlevsel e-posta adresleridir. Bu, bir grup için API'nin yanıtında döndürülen salt okunur bir özelliktir. Bir grubun POST veya PUT isteğinde düzenlenmişse düzenleme yoksayılır.

Yöntemler

delete

Grubu siler.

get

Bir grubun özelliklerini alır.

insert

Grup oluşturur.

list

Bir kullanıcı anahtarı verilen (sayfalara ayrılmış) bir alanın veya kullanıcının tüm gruplarını alır.

patch

Grubun özelliklerini günceller.

update

Grubun özelliklerini günceller.