Zarządzaj grupami

Tworzenie grupy

Aby utworzyć grupę, użyj poniższego żądania POST i dołącz autoryzację opisaną w sekcji Autoryzowanie żądań. Grupę możesz utworzyć dla dowolnej domeny powiązanej z kontem. Właściwości ciągów zapytań, żądań i odpowiedzi znajdziesz w opisie metody groups.insert.

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

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

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

Pomyślna odpowiedź 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, dowolny z jej aliasów lub unikalny identyfikator id grupy. Właściwości ciągów zapytań, żądań i odpowiedzi znajdziesz w opisie metody groups.update.

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

Ogólnie odradzamy używanie adresu e-mail grupy jako klucza przechowywania trwałych danych, ponieważ adres ten może ulec zmianie.

W poniższym przykładzie unikalna wartość 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"
}

Jeśli chcesz poprosić o aktualizację, musisz przesłać tylko zaktualizowane informacje. W żądaniu nie musisz wpisywać wszystkich właściwości grupy.

Pomyślna odpowiedź 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 artykule Autoryzowanie żądań. groupKey to adres e-mail grupy, dowolny z jej aliasów lub unikalny identyfikator id grupy. Ciągi zapytań, właściwości żądania i odpowiedzi znajdziesz w artykule o zasobie groups.

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

Ogólnie odradzamy używanie adresu e-mail grupy jako klucza przechowywania trwałych danych, ponieważ adres ten może ulec zmianie.

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

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

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

Pomyślna odpowiedź zwraca kod stanu HTTP 201 i właściwości nowego aliasu grupy.

Pobieranie grupy

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

Ogólnie odradzamy używanie adresu e-mail grupy jako klucza przechowywania trwałych danych, ponieważ adres ten może ulec zmianie.

W tym przykładzie unikalny identyfikator groupKey to nnnn:

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i ustawienia 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"
     }
    ]
}

Pobieranie wszystkich grup dla domeny lub konta

Aby pobrać wszystkie grupy z określonej domeny lub konta, użyj poniższego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzacja żądań. Ciągi zapytań, właściwości żądania i odpowiedzi znajdziesz w opisie metody groups.list. Aby zwiększyć czytelność, w tym przykładzie użyto funkcji zwracania wiersza:

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 dla domeny lub konta weź pod uwagę te kwestie:

• Wszystkie grupy w subdomenie: użyj argumentu domain z nazwą domeny.
• Wszystkie grupy powiązane z kontem: użyj argumentu customer z wartością my_customer lub customerId konta. Jako administrator konta użyj ciągu my_customer, aby oznaczyć wartość customerId swojego konta. Jeśli jesteś sprzedawcą z dostępem do konta klienta sprzedawcy, użyj identyfikatora customerId konta sprzedawcy. Jako wartość customerId użyj nazwy domeny podstawowej konta w żądaniu operacji Pobierz wszystkich użytkowników w domenie. Otrzymana odpowiedź ma wartość customerId.
• Użycie zarówno argumentów domain, jak i customer: interfejs Directory API zwraca wszystkie grupy związane z domain.
• Bez argumentów domain i customer: interfejs Directory API zwraca wszystkie grupy na koncie powiązanym z my_customer. To jest konto customerId administratora, który przesłał prośbę.
• Używanie zarówno argumentów customer, jak i userKey: interfejs Directory API zwraca błąd. Musisz przesłać 2 osobne żądania z tymi argumentami.

W poniższym przykładzie administrator konta za pomocą funkcji my_customer poprosi o wyświetlenie listy 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 sprzedanym koncie z funkcją customerId C03az79cb. Maksymalna liczba wyników zwracanych na stronę odpowiedzi wynosi 2. Istnieje nextPageToken dla listy użytkowników, do których należy przejść tę odpowiedź:

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

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

{
"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"
  }

Pobierz wszystkie grupy użytkownika

Aby pobrać wszystkie grupy, których użytkownik ma subskrypcję, użyj poniższego żądania GET i dołącz autoryzację opisaną w sekcji Autoryzacja żądań. Aby zwiększyć czytelność, w tym przykładzie zastosowano zwracanie wierszy:

GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key
?pageToken=pagination token
&maxResults=maximum results per response page

• Użytkownikem może być użytkownik lub grupa.
• userKey może być podstawowym adresem e-mail użytkownika, aliasem adresu e-mail użytkownika, podstawowym adresem e-mail grupy, aliasem e-mail grupy lub unikalnym identyfikatorem id użytkownika. Aby go znaleźć, użyj opcji Pobierz operację użytkownika.
• Użytkownik lub grupa wskazana w userKey musi należeć do Twojej domeny.
• W przypadku odpowiedzi obejmujących dużą liczbę grup używaj ciągu zapytania pageToken. W przypadku podziału na strony odpowiedź zwraca właściwość nextPageToken, która stanowi token dla następnej strony wyników odpowiedzi. W kolejnym żądaniu użyj tego tokena jako wartości ciągu zapytania pageToken.
• Używanie zarówno argumentów customer, jak i userKey: interfejs Directory API zwraca błąd. Musisz przesłać 2 osobne żądania z tymi argumentami.

Właściwości żądania i odpowiedzi znajdziesz w opisie metody groups.list.

Pomyślna odpowiedź zwraca kod stanu HTTP 200 i listę informacji o użytkowniku:

• Zwrócone zostaną wszystkie grupy, których użytkownik ma subskrypcję, w tym grupy spoza domeny użytkownika.
• Grupy zostaną wyświetlone w kolejności alfabetycznej według ich adresów e-mail.
• id to unikalny identyfikator grupy w treści odpowiedzi.
• W odpowiedzi lista grupy 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"
     }
  ],
   "nextPakeToken": "NNNNN"
}

Pobierz wszystkie aliasy grup

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

Pomyślna odpowiedź zwraca kod stanu HTTP 201 i listę aliasów grupy.

Usuwanie aliasu grupy

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

Pomyślna odpowiedź zwraca kod stanu HTTP 201.

Usuwanie grupy

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

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

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

Pomyślna odpowiedź zwraca kod stanu HTTP 200.

Po usunięciu grupy:

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