REST Resource: groups

Kaynak: Grup

Google Grupları, kullanıcılarınıza, grubun e-posta adresini kullanarak kullanıcı gruplarına ileti gönderme olanağı sağlar. Sık yapılan görevler hakkında daha fazla bilgi edinmek için Geliştirici Kılavuzu'nu inceleyin.

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ünülen) kullanıcının, Süper Yönetici veya Gruplar Yöneticisi gibi Admin API Gruplar izinlerini içeren atanmış bir rolüne sahip olması gerekir.

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 isteği 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. Grup oluştururken bu özellik 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ı olacak genişletilmiş açıklama. Örneğin, gruba kimlerin katılması gerektiğine ilişkin bilgileri, gruba gönderilecek ileti türlerini, grupla ilgili SSS bağlantılarını veya ilgili grupları ekleyebilirsiniz. Maksimum uzunluk 4,096 karakterdir.

adminCreated

boolean

Salt okunur. Bu grup bir kullanıcı tarafından değil, 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) üyesiyse (üst grup) 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'i.

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üzenlenirse düzenleme yoksayılır.

nonEditableAliases[]

string

Salt okunur. Grubun, hesabın birincil alan adının veya alt alan adlarının dışında olup düzenlenemeyen takma ad e-posta adreslerinin listesi. Bunlar, grup tarafından kullanılan işlevsel e-posta adresleridir. Bu, API'nin bir gruba verdiği yanıtta döndürülen salt okunur bir özelliktir. Bir grubun POST veya PUT isteğinde düzenlenirse 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

Bir grubun özelliklerini günceller.

update

Bir grubun özelliklerini günceller.