Zarządzaj grupami

Na tej stronie dowiesz się, jak zarządzać grupami Google za pomocą interfejsu Directory API:

  • Tworzenie grupy
  • Aktualizowanie grupy
  • Dodawanie aliasu grupy
  • Pobieranie grupy
  • Pobieranie wszystkich grup w domenie lub na koncie
  • Pobieranie wszystkich grup, do których należy użytkownik
  • Pobieranie wszystkich aliasów grupy
  • Usuwanie aliasu grupy
  • Usuwanie grupy

Tworzenie grupy

Aby utworzyć grupę, użyj tego żądania POST i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. Możesz utworzyć grupę dla dowolnej domeny powiązanej z kontem. Informacje o ciągach zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w groups.insertmetodzie. 

POST https://admin.googleapis.com/admin/directory/v1/groups

Poniższe żądanie JSON przedstawia przykładową treść żądania, która tworzy grupę. Adres e-mail grupy to sales_group@example.com: 

{
   "email": "sales_group@example.com",
   "name": "Sales Group",
   "description": "This is the Sales group."
}

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP 201 i właściwości nowej grupy.

Aktualizowanie grupy

Aby zaktualizować ustawienia grupy, użyj poniższego żądania PUT i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy, adres e-mail dowolnego aliasu grupy lub unikalny id grupy. Informacje o ciągach zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w metodzie groups.update.

PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Ogólnie zalecamy, aby nie używać adresu e-mail grupy jako klucza do danych trwałych, ponieważ adres e-mail może ulec zmianie.

Ogólnie zalecamy, aby nie używać adresu e-mail grupy jako klucza do danych trwałych, ponieważ adres e-mail może ulec zmianie.

W tym przykładzie unikalny znak groupKey to nnn, a nazwa grupy to APAC Sales Group: 

PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn

{
    "email": "sales_group@example.com",
    "name": "APAC Sales Group"
}

W przypadku prośby o aktualizację wystarczy przesłać zaktualizowane informacje. W prośbie nie musisz podawać wszystkich właściwości grupy.

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP 201 i właściwości nowej grupy: 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases": [
     {
        "alias": "liz@test.com"
     }
    ]
}

Dodawanie aliasu grupy

Aby dodać alias grupy, użyj poniższego żądania POST i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy, dowolny adres e-mail aliasu grupy lub unikalny id grupy. Informacje o ciągach zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w groupszasobie.

POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

Ogólnie Google zaleca, aby nie używać adresu e-mail grupy jako klucza do danych trwałych, ponieważ adres e-mail może ulec zmianie.

Poniższe żądanie JSON pokazuje przykładowe żądanie utworzenia aliasu grupy. groupKey to unikalny id grupy reprezentowany przez NNNN.

POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases

{
    "alias": "best_sales_group@example.com"
}

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP201 i właściwości nowego aliasu grupy.

Pobieranie grupy

Aby pobrać grupę, użyj tego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to adres e-mail grupy, dowolny adres e-mail aliasu grupy lub unikalny id grupy. Informacje o ciągach zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w metodzie groups.get. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Ogólnie Google zaleca, aby nie używać adresu e-mail grupy jako klucza do danych trwałych, ponieważ adres e-mail może ulec zmianie.

W tym przykładzie unikalny identyfikator groupKey to nnnn: 

GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP i ustawienia grupy:200 

{
    "kind": "directory#groups",
    "id": "group's unique ID",
    "etag": "group's unique ETag",
    "email": "sales_group@example.com",
    "name": "APAC Sales Group",
    "directMembersCount": "5",
    "description": "This is the APAC sales group.",
    "adminCreated": true,
    "aliases": [
     {
        "alias": "best_sales_group@example.com"
     }
    ],
    "nonEditableAliases": [
     {
        "alias": "liz@test.com"
     }
    ]
}

Pobieranie wszystkich grup w domenie lub na koncie

Aby pobrać wszystkie grupy w określonej domenie lub na koncie, użyj tego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Informacje o ciągach zapytania oraz właściwościach żądań i odpowiedzi znajdziesz w metodzie groups.list. Aby ułatwić czytanie, w tym przykładzie użyto znaków łamania wierszy: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name
&customer=my_customer or customerId&pageToken=pagination token
&maxResults=max results

Podczas pobierania wszystkich grup w domenie lub na koncie pamiętaj o tych kwestiach:

  • Wszystkie grupy w subdomenie: użyj argumentu domain z nazwą domeny.
  • Wszystkie grupy na koncie: użyj argumentu customer z wartością my_customer lub wartością customerId konta. Jako administrator konta użyj ciągu znaków my_customer, aby reprezentować customerId Twojego konta. Jeśli jesteś sprzedawcą, który ma dostęp do konta klienta sprzedawcy, użyj adresu e-mail konta sprzedawcy: customerId. W przypadku wartości customerId użyj nazwy domeny podstawowej konta w żądaniu operacji Pobierz wszystkich użytkowników w domenie. Odpowiedź zawiera wartość customerId.
  • Użycie argumentów domain i customer: interfejs Directory API zwraca wszystkie grupy dla domain.
  • Nie używasz argumentów domain i customer: interfejs Directory API zwraca wszystkie grupy na koncie powiązanym z my_customer. Jest to konto customerId administratora, który wysyła prośbę.
  • Użycie argumentów customer i userKey: interfejs Directory API zwraca błąd. Musisz wysłać 2 osobne żądania z tymi argumentami.

W poniższym przykładzie administrator konta używa my_customer, aby poprosić o listę wszystkich grup na koncie:

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2

W poniższym przykładzie żądanie administratora sprzedawcy zwraca wszystkie grupy na koncie odsprzedanym z symbolem customerId C03az79cb. Maksymalna liczba wyników zwracanych na stronie odpowiedzi to 2. W odpowiedzi znajduje się nextPageToken dla listy użytkowników, którzy zostali dodani do listy obserwujących: 

GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2

Pomyślna odpowiedź zwraca kod stanu 200HTTP i grupy w kolejności alfabetycznej adresów e-mail grup: 

{
"kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support@sales.com",
      "name": "Sales support",
      "directMembersCount": "6",
      "description": "The sales support group",
      "adminCreated": true
     },
     {
      "kind": "directory#groups",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "travel@sales.com",
      "name": "Sales travel",
      "directMembersCount": "2",
      "description": "The travel group supporting sales",
      "adminCreated": false,
      "aliases": [
       {
         "alias": "best_sales_group@example.com"
       }
      ],
      "nonEditableAliases": [
       {
         "alias": "liz@test.com"
       }
      ]
     },
  "nextPageToken": "NNNN"
  }

Pobieranie wszystkich grup, do których należy użytkownik

Aby pobrać wszystkie grupy, w których użytkownik ma subskrypcję, użyj tego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Aby ułatwić czytanie, w tym przykładzie użyto znaków łamania wierszy: 

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
&pageToken=pagination token
&maxResults=maximum results per response page
  • Członkiem może być użytkownik lub grupa.
  • Wartość userKey może być podstawowym adresem e-mail użytkownika, aliasem adresu e-mail użytkownika, podstawowym adresem e-mail grupy, aliasem adresu e-mail grupy lub unikalnym identyfikatorem użytkownika id, który można znaleźć za pomocą operacji pobierania użytkownika.
  • Użytkownik lub grupa określona w polu userKey musi należeć do Twojej domeny.
  • Użyj ciągu zapytania pageToken w przypadku odpowiedzi z dużą liczbą grup. W przypadku paginacji odpowiedź zwraca właściwość nextPageToken, która zawiera token następnej strony wyników odpowiedzi. W kolejnym żądaniu użyjesz tego tokena jako wartości ciągu zapytania pageToken.
  • Użycie argumentów customer i userKey: interfejs Directory API zwraca błąd. Musisz wysłać 2 osobne żądania z tymi argumentami.

Informacje o właściwościach żądań i odpowiedzi znajdziesz w groups.listmetodzie.

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i listę informacji o członkach:

  • Zwracane są wszystkie grupy, w których użytkownik ma subskrypcję, w tym grupy spoza domeny użytkownika.
  • Grupy są zwracane w kolejności alfabetycznej adresów e-mail poszczególnych grup.
  • W treści odpowiedzi id to unikalny identyfikator grupy.
  • W odpowiedzi lista grup spoza domeny użytkownika nie zawiera aliasów grupy zewnętrznej. 
{
    "kind": "directory#groups",
    "groups": [
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "sales_group@example.com",
      "name": "sale group",
      "directMembersCount": "5",
      "description": "Sales group"
     },
     {
      "kind": "directory#group",
      "id": "group's unique ID",
      "etag": "group's unique ETag",
      "email": "support_group.com",
      "name": "support group",
      "directMembersCount": "5",
      "description": "Support group"
     }
  ],
   "nextPageToken": "NNNNN"
}

Pobieranie wszystkich aliasów grupy

Aby pobrać wszystkie aliasy grupy, użyj poniższego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey może być głównym adresem e-mail grupy, unikalnym id grupy lub dowolnym adresem e-mail aliasu grupy. Właściwości żądań i odpowiedzi znajdziesz w groupszasobie. 

GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases
 grupy.

Odpowiedź zakończona powodzeniem zwraca kod stanu 201 HTTP i listę aliasów grupy.

Usuwanie aliasu grupy

Aby usunąć alias grupy, użyj tego żądania DELETE i dołącz autoryzację opisaną w artykule Autoryzowanie żądań. groupKey może być głównym adresem e-mail grupy, unikalnym id grupy lub dowolnym adresem e-mail aliasu grupy. aliasId to alias, który jest usuwany. Informacje o właściwościach żądań i odpowiedzi znajdziesz w groupszasobie: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP201.

Usuwanie grupy

Aby usunąć grupę, użyj poniższego żądania DELETE i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. groupKey to unikalny id grupy: 

DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey

Na przykład to żądanie DELETE usuwa grupę, która ma nnnn grupę id:

DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn

Odpowiedź zakończona powodzeniem zwraca kod stanu HTTP200.

Po usunięciu grupy:

  • Wszyscy członkowie grupy zostaną usunięci. Konta użytkowników członka nie zostaną usunięte.
  • Archiwum grupy zostanie usunięte.
  • Wiadomości wysłane na adres usuniętej grupy nie będą dostarczane. Zamiast tego nadawca otrzymuje wiadomość o problemie z dostarczeniem.