設定有初始成員的聊天室

本指南說明如何在 Google Chat API 的 Space 資源上使用 setUp() 方法，設定 Google Chat 聊天室。設定聊天室會建立聊天室，並將指定使用者加入其中。

Space 資源代表使用者和 Chat 應用程式可用於傳送訊息、共用檔案及協作的空間。聊天室分為以下幾種類型：

  • 即時訊息 (DM) 是兩位使用者或使用者和 Chat 應用程式之間的對話。
  • 群組通訊是指三位以上使用者與 Chat 應用程式之間的對話。
  • 命名聊天室是持續存在的空間，可供使用者傳送訊息、分享檔案和協作。

設定聊天室時，請考量下列事項：

  • 呼叫端 (已驗證) 使用者會自動加入聊天室，因此您不需要在要求中指定使用者的會員資格。
  • 建立即時訊息 (DM) 時，如果兩位使用者之間存在 DM，系統會傳回該 DM。否則系統會建立 DM。
  • 建立群組通訊時，如果要求中提供的任何成員資格都無法成功加入群組通訊 (例如權限問題)，就可能會建立空白群組通訊 (僅包含發起通訊的使用者)。
  • 您無法設定含有討論串回覆的聊天室，也無法新增 Google Workspace 以外的使用者。
  • 在要求中提供的重複會員資格 (包括呼叫使用者) 會遭到篩除，而不會導致要求錯誤。

必要條件

Node.js

Python

Java

Apps Script

設定聊天室

如要設定空間，請在要求中傳遞以下內容：

  • 指定 chat.spaces.create 或 chat.spaces 授權範圍。
  • 呼叫 SetUpSpace() 方法。
  • 將 space 做為 Space 的執行個體傳遞，其中包含所有必要欄位，例如 displayName 或 spaceType。
  • 將 memberships 做為 Membership 例項的陣列傳遞。請針對每個執行個體執行下列操作：
    • 指定 users/{user} 即可將真人使用者新增為聊天室成員，其中 {user} 是 People API 中的 person 的 {person_id}，或是 Directory API 中的 user 的 ID。舉例來說，如果 People API 使用者 resourceName 是 people/123456789，您可以加入會員，並將 users/123456789 設為 member.name，將使用者加入聊天室。
    • 指定 groups/{group} 即可將群組新增為聊天室成員，其中 {group} 是您要建立成員資格的群組 ID。您可以使用 Cloud Identity API 擷取群組 ID。舉例來說，如果 Cloud Identity API 傳回名稱為 groups/123456789 的群組，請將 membership.groupMember.name 設為 groups/123456789。您無法將 Google 群組新增至群組通訊或即時訊息，只能新增至命名聊天室。

如要在呼叫使用者和其他使用者之間建立 DM，請在要求中指定使用者的會員資格。

如要在發出呼叫的使用者和呼叫應用程式之間建立即時訊息，請將 space.singleUserBotDm 設為 true，且不要指定任何成員資格。您只能使用這個方法，透過呼叫應用程式設定私訊。如要將呼叫應用程式新增為空間的成員，或將其新增為兩位使用者之間現有的私訊成員，請參閱「建立會員資格」。

以下範例會建立命名空間，並為兩位使用者 (已驗證使用者和另一位使用者) 建立一個空間會員資格。

Node.js

chat/client-libraries/cloud/set-up-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.spaces.create'];

// This sample shows how to set up a named space with one initial member
// with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    space: {
      spaceType: 'SPACE',
      // Replace DISPLAY_NAME here.
      displayName: 'DISPLAY_NAME'
    },
    memberships: [{
      member: {
        // Replace USER_NAME here.
        name: 'users/USER_NAME',
        type: 'HUMAN'
      }
    }]
  };

  // Make the request
  const response = await chatClient.setUpSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Python

chat/client-libraries/cloud/set_up_space_user_cred.py
from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.spaces.create"]

def set_up_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.SetUpSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        },
        memberships = [{
            "member": {
                # Replace USER_NAME here.
                "name": 'users/USER_NAME',
                "type_": 'HUMAN'
            }
        }]
    )

    # Make the request
    response = client.set_up_space(request)

    # Handle the response
    print(response)

set_up_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SetUpSpaceRequest;
import com.google.chat.v1.Space;
import com.google.chat.v1.User;

// This sample shows how to set up a named space with one initial member with
// user credential.
public class SetUpSpaceUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.spaces.create";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      SetUpSpaceRequest.Builder request = SetUpSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"))
        .addAllMemberships(ImmutableList.of(Membership.newBuilder()
          .setMember(User.newBuilder()
            // Replace USER_NAME here.
            .setName("users/USER_NAME")
            .setType(User.Type.HUMAN)).build()));
      Space response = chatServiceClient.setUpSpace(request.build());

      System.out.println(JsonFormat.printer().print(response));
    }
  }
}

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to set up a named space with one initial member with
 * user credential.
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.spaces.create'
 * referenced in the manifest file (appsscript.json).
 */
function setUpSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: 'SPACE',
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: 'DISPLAY_NAME'
  };
  const memberships = [{
    member: {
      // TODO(developer): Replace USER_NAME here
      name: 'users/USER_NAME',
      // User type for the membership
      type: 'HUMAN'
    }
  }];

  // Make the request
  const response = Chat.Spaces.setup({ space: space, memberships: memberships });

  // Handle the response
  console.log(response);
}

如要執行範例，請替換下列內容：

  • DISPLAY_NAME：新聊天室的顯示名稱。
  • USER_NAME：要加入會籍的其他使用者 ID。

如要前往聊天室，請使用聊天室的資源 ID 建構聊天室網址。您可以從 Google Chat 回應內文中的聊天室 name 取得資源 ID。舉例來說，如果聊天室的 name 為 spaces/1234567，您可以使用以下網址前往聊天室：https://mail.google.com/chat/u/0/#chat/space/1234567。