docs: Update doc for SetUpSpace in service ChatService to support group members

Google APIs · copybara-github · commit ac0973e85be4 · 2024-06-26T08:15:49.000-07:00
docs: Update doc for `CreateMembership` in service `ChatService` to support group members
docs: Update doc for field `group_member` in message `google.chat.v1.Membership`

PiperOrigin-RevId: 646951938
diff --git a/google/chat/v1/chat_service.proto b/google/chat/v1/chat_service.proto
@@ -311,6 +311,17 @@ service ChatService {
   // you can add the user to the space by setting the `membership.member.name`
   // to `users/user@example.com` or `users/123456789`.
   //
+  // To specify the Google groups to add, add memberships with the
+  // appropriate `membership.group_member.name`. To add or invite a Google
+  // group, use `groups/{group}`, where `{group}` is the `id` for the group from
+  // the Cloud Identity Groups API. For example, you can use [Cloud Identity
+  // Groups lookup
+  // API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
+  // to retrieve the ID `123456789` for group email `group@example.com`, then
+  // you can add the group to the space by setting the
+  // `membership.group_member.name` to `groups/123456789`. Group email is not
+  // supported, and Google groups can only be added as members in named spaces.
+  //
   // For a named space or group chat, if the caller blocks, or is blocked
   // by some members, or doesn't have permission to add some members, then
   // those members aren't added to the created space.
@@ -427,7 +438,8 @@ service ChatService {
   // authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
   //
   // To specify the member to add, set the `membership.member.name` for the
-  // human or app member.
+  // human or app member, or set the `membership.group_member.name` for the
+  // group member.
   //
   // - To add the calling app to a space or a direct message between two human
   //   users, use `users/app`. Unable to add other
@@ -440,6 +452,15 @@ service ChatService {
   // profile ID for `user@example.com` is `123456789`, you can add the user to
   // the space by setting the `membership.member.name` to
   // `users/user@example.com` or `users/123456789`.
+  //
+  // - To add or invite a Google group in a named space, use
+  // `groups/{group}`, where `{group}` is the `id` for the group from the Cloud
+  // Identity Groups API. For example, you can use [Cloud Identity Groups lookup
+  // API](https://cloud.google.com/identity/docs/reference/rest/v1/groups/lookup)
+  // to retrieve the ID `123456789` for group email `group@example.com`, then
+  // you can add or invite the group to a named space by setting the
+  // `membership.group_member.name` to `groups/123456789`. Group email is not
+  // supported, and Google groups can only be added as members in named spaces.
   rpc CreateMembership(CreateMembershipRequest) returns (Membership) {
     option (google.api.http) = {
       post: "/v1/{parent=spaces/*}/members"
diff --git a/google/chat/v1/membership.proto b/google/chat/v1/membership.proto
@@ -106,8 +106,6 @@ message Membership {
     User member = 3;
 
     // The Google Group the membership corresponds to.
-    // Only supports read operations. Other operations, like
-    // creating or updating a membership, aren't currently supported.
     Group group_member = 5;
   }
 
diff --git a/google/chat/v1/space_setup.proto b/google/chat/v1/space_setup.proto
@@ -64,8 +64,8 @@ message SetUpSpaceRequest {
   // authenticated user returns an error.
   string request_id = 2 [(google.api.field_behavior) = OPTIONAL];
 
-  // Optional. The Google Chat users to invite to join the space. Omit the
-  // calling user, as they are added automatically.
+  // Optional. The Google Chat users or groups to invite to join the space. Omit
+  // the calling user, as they are added automatically.
   //
   // The set currently allows up to 20 memberships (in addition to the caller).
   //
@@ -78,6 +78,10 @@ message SetUpSpaceRequest {
   // To invite Gmail users or users from external Google Workspace domains,
   // user's email must be used for `{user}`.
   //
+  // For Google group membership, the `Membership.group_member` field must
+  // contain a `group` with `name` populated (format `groups/{group}`). You
+  // can only add Google groups when setting `Space.spaceType` to `SPACE`.
+  //
   // Optional when setting `Space.spaceType` to `SPACE`.
   //
   // Required when setting `Space.spaceType` to `GROUP_CHAT`, along with at

Original file line number	Diff line number	Diff line change
`@@ -106,8 +106,6 @@ message Membership {`
`106`	`106`	`User member = 3;`
`107`	`107`
`108`	`108`	`// The Google Group the membership corresponds to.`
`109`		`- // Only supports read operations. Other operations, like`
`110`		`- // creating or updating a membership, aren't currently supported.`
`111`	`109`	`Group group_member = 5;`
`112`	`110`	`}`
`113`	`111`