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 odgrywany przez konto usługi) musi mieć przypisaną rolę obejmującą uprawnienia do grup dyskusyjnych w interfejsie Admin API, na przykład 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. Element email musi być niepowtarzalny. Ta właściwość jest wymagana podczas tworzenia grupy. Adresy e-mail grup podlegają tym samym regułom 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 ułatwiający użytkownikom określenie przeznaczenia grupy. Na przykład możesz dołączyć informacje o tym, kto powinien dołączyć do grupy, jakiego rodzaju wiadomości należy do niej wysyłać, linki do odpowiedzi na najczęstsze pytania dotyczące grupy czy informacje o 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 tej grupy (podrzędnej), członkowie grupy podrzędnej nie są uwzględniani we właściwości directMembersCount grupy nadrzędnej.
kind

string

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

string

ETag zasobu.
aliases[]

string

Tylko do odczytu. Lista aliasów e-mail grupy. Aby dodać, zaktualizować lub usunąć aliasy grupy, użyj metod groups.aliases. W przypadku zmiany w żądaniu POST lub PUT grupy zmiana zostanie zignorowana.
nonEditableAliases[]

string

Tylko do odczytu. Lista aliasów e-mail grupy, których nie można edytować, spoza domeny podstawowej lub subdomen konta. To są działające adresy e-mail używane przez grupę. Jest to właściwość tylko do odczytu zwrócona w odpowiedzi interfejsu API dla grupy. W przypadku zmiany w żądaniu POST lub PUT grupy zmiana zostanie zignorowana.

Metody

delete

 Usuwa grupę.

get

 Pobiera właściwości grupy.

insert

 Tworzy grupę.

list

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

patch

 Aktualizuje właściwości grupy.

update

 Aktualizuje właściwości grupy.