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 użytkownik, którego w ramach podszywania się używa konto usługi) musi mieć przypisaną rolę, która obejmuje uprawnienia administratora grup interfejsu API, np. superadministratora lub administratora 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. Grupy id można używać jako identyfikatorów URI żądań grupowych groupKey.
email

string

Adres e-mail grupy. Jeśli Twoje konto ma wiele domen, wybierz odpowiednią domenę dla adresu e-mail. Wartość email musi być niepowtarzalna. Ta właściwość jest wymagana podczas tworzenia grupy. Adresy e-mail grup podlegają tym samym regułom dotyczącym znaków co nazwy użytkowników. Więcej informacji znajdziesz w Centrum pomocy.
name

string

Wyświetlana nazwa grupy.
description

string

Rozwinięty opis, który pomaga użytkownikom określić cel grupy. Możesz na przykład dodać informacje opisujące jej członków, typy wiadomości wysyłanych w ramach tej grupy i linki do najczęstszych pytań na jej temat, pokrewnych grup itp. 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 (podrzędnym) tej grupy (nadrzędnej), członkowie grupy podrzędnej nie są wliczani do właściwości directMembersCount grupy nadrzędnej.
kind

string

Typ zasobu interfejsu API. W przypadku zasobów Groups wartość to admin#directory#group.
etag

string

ETag zasobu.
aliases[]

string

Tylko do odczytu. Lista aliasów adresów e-mail grupy. Aby dodać, zaktualizować lub usunąć aliasy grupy, użyj metod groups.aliases. Jeśli zmiany zostaną wprowadzone w żądaniu POST lub PUT grupy, zostaną zignorowane.
nonEditableAliases[]

string

Tylko do odczytu. Lista nieedytowalnych aliasów adresów e-mail grupy, które znajdują się poza domeną podstawową lub subdomenami konta. To działające adresy e-mail używane przez grupę. To właściwość tylko do odczytu zwracana w odpowiedzi interfejsu API dla grupy. Jeśli zmiany zostaną wprowadzone w żądaniu POST lub PUT grupy, zostaną zignorowane.

Metody

delete

 usuwa grupę.

get

 Pobiera właściwości grupy.

insert

 Tworzy grupę.

list

 Pobiera wszystkie grupy domeny lub użytkownika na podstawie klucza użytkownika (po stronie).

patch

 Aktualizuje właściwości grupy.

update

 Aktualizuje właściwości grupy.