REST Resource: groups

Zasób: grupa

Grupy dyskusyjne Google umożliwiają użytkownikom wysyłanie wiadomości do grup osób przy użyciu adresu e-mail grupy. Więcej informacji o typowych zadaniach znajdziesz w Przewodniku dla programistów.

Informacje o innych typach grup znajdziesz w dokumentacji interfejsu Cloud Identity Groups API.

Uwaga: użytkownik wywołujący interfejs API (lub podszywa się pod niego przez konto usługi) musi mieć przypisaną rolę obejmującą uprawnienia grup w interfejsie Admin API, takie jak superadministrator lub administrator grup.

Zapis JSON 
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
Pola
id

string

Tylko do odczytu. Unikalny identyfikator grupy. Grupa id może być używana jako identyfikator URI żądania grupy groupKey.
email

string

Adres e-mail grupy. Jeśli Twoje konto ma wiele domen, wybierz odpowiednią domenę dla adresu e-mail. email musi być niepowtarzalny. Ta usługa jest wymagana podczas tworzenia grupy. Adresy e-mail grupy podlegają takim samym zasadom dotyczącym użycia znaków co nazwy użytkowników. Więcej informacji znajdziesz w Centrum pomocy.
name

string

Wyświetlana nazwa grupy.
description

string

Rozszerzony opis, który pomaga użytkownikom określić przeznaczenie grupy. Możesz na przykład dołączyć informacje o tym, kto powinien dołączyć do grupy, o typach wiadomości wysyłanych do grupy, linkach do najczęstszych pytań dotyczących grupy lub powiązanych grupach. Maksymalna długość to 4,096 znaków.
adminCreated

boolean

Tylko do odczytu. Wartość to true, jeśli grupa została utworzona przez administratora, a nie użytkownika.
directMembersCount

string (int64 format)

Liczba użytkowników, którzy są bezpośrednimi członkami grupy. Jeśli grupa jest członkiem (elementem podrzędnym) tej grupy (grupy nadrzędnej), członkowie grupy podrzędnej nie są zliczani we właściwości directMembersCount grupy nadrzędnej.
kind

string

Typ zasobu interfejsu API. W przypadku zasobów Grup dyskusyjnych wartość wynosi admin#directory#group.
etag

string

Tag ETag zasobu.
aliases[]

string

Tylko do odczytu. Lista aliasów e-mail grupy. Aby dodawać, aktualizować lub usuwać aliasy grupy, użyj metod groups.aliases. Jeśli edytowano w żądaniu POST lub PUT grupy, jest ona ignorowana.
nonEditableAliases[]

string

Tylko do odczytu. Lista nieedytowalnych aliasów e-mail grupy, które są poza domeną podstawową konta lub subdomenami. Są to działające adresy e-mail używane przez grupę. Jest to właściwość tylko do odczytu zwracana w odpowiedzi interfejsu API dotyczącej grupy. Jeśli edytowano w żądaniu POST lub PUT grupy, jest ona ignorowana.

Metody

delete

 Usuwa grupę.

get

 Pobiera właściwości grupy.

insert

 Tworzy grupę.

list

 Pobiera wszystkie grupy domeny lub użytkownika z danym userKey (z podziałem na strony).

patch

 Aktualizuje właściwości grupy.

update

 Aktualizuje właściwości grupy.