本頁面由 Cloud Translation API 翻譯而成。

邀請或將使用者、Google 群組或 Google Chat 應用程式新增至聊天室

本指南說明如何在 Google Chat API 的 Membership 資源上使用 create() 方法，邀請或新增使用者、Google 網路論壇群組或 Chat 應用程式至聊天室，也就是建立會員資格。建立會員時，如果指定成員已停用自動接受政策，則他們會收到邀請，並必須先接受聊天室邀請才能加入。否則，建立會員資格會直接將成員新增至指定的聊天室。

如果您是 Google Workspace 管理員，可以將使用者、Google 網路論壇或 Chat 應用程式新增至 Google Workspace 機構中的任何聊天室。

Membership 資源代表使用者或 Google Chat 應用程式是否已受邀加入聊天室、是否已加入聊天室或未加入聊天室。

必要條件

Node.js

具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Node.js Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
  - 如要以 Chat 應用程式的形式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Python

具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 使用 Chat 應用程式的名稱、圖示和說明啟用並設定 Google Chat API。
- 安裝 Python Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
  - 如要以 Chat 應用程式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Java

具備 Google Chat 存取權的 Google Workspace 企業或進階版帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 安裝 Java Cloud 用戶端程式庫。
- 根據您要在 Google Chat API 要求中驗證的方式建立存取憑證：
  - 如要以 Chat 使用者的身分進行驗證，請建立 OAuth 用戶端 ID 憑證，並將憑證儲存為名為 client_secrets.json 的 JSON 檔案，並儲存在本機目錄中。
  - 如要以 Chat 應用程式進行驗證，請建立服務帳戶憑證，並將憑證儲存為名為 credentials.json 的 JSON 檔案。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

Apps Script

可存取 Google Chat 的 Business 或 Enterprise Google Workspace 帳戶。

設定環境：
- 建立 Google Cloud 專案。
- 設定 OAuth 同意畫面。
- 啟用並設定 Google Chat API，並為 Chat 應用程式提供名稱、圖示和說明。
- 建立獨立的 Apps Script 專案，並啟用進階 Chat 服務。
- 在本指南中，您必須使用使用者或應用程式驗證。如要以 Chat 應用程式驗證，請建立服務帳戶憑證。如需步驟，請參閱「以 Google Chat 應用程式身分驗證及授權」。
根據您想以使用者或 Chat 應用程式身分驗證，選擇授權範圍。

邀請或新增使用者加入聊天室

如要使用使用者驗證邀請或新增使用者至聊天室，請在要求中傳遞下列資訊：

指定 chat.memberships 授權範圍。
呼叫 CreateMembership() 方法。
將 parent 做為要在其中建立成員的聊天室資源名稱。
將 membership 做為 Membership 的例項傳遞，並將其 member 欄位設為下列設定：
- type 欄位設為 HUMAN。
- name 欄位設為 users/{user}，其中 {user} 是您要新增至聊天室的使用者。如要指定 Chat 使用者，請將 {user} 替換為下列任一項：
  - People API 中的人物 ID。舉例來說，如果 People API person resourceName 是 people/123456789，請使用 users/123456789 值。
  - Directory API 中的使用者 ID。
  - 使用者的電子郵件地址。例如 users/222larabrown@gmail.com 或 users/larabrown@cymbalgroup.com。如果使用者使用 Google 帳戶或屬於其他 Google Workspace 機構，您必須使用他們的電子郵件地址。

以下範例會將使用者加入空間，並進行使用者驗證：

Node.js

chat/client-libraries/cloud/create-membership-user-cred.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to create membership with user credential for a human user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      member: {
        // Replace USER_NAME here
        name: 'users/USER_NAME',
        // User type for the membership
        type: 'HUMAN'
      }
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred.py

前往 GitHub 查看

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.memberships"]

# This sample shows how to create membership with user credential for a human
# user
def create_membership_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "member": {
                # Replace USER_NAME here
                "name": "users/USER_NAME",
                # user type for the membership
                "type_": "HUMAN"
            }
        }
    )

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

    # Handle the response
    print(response)

create_membership_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCred.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.User;

// This sample shows how to create membership with user credential for a human
// user.
public class CreateMembershipUserCred {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setMember(User.newBuilder()
            // replace USER_NAME here
            .setName("users/USER_NAME")
            // user type for the membership
            .setType(User.Type.HUMAN)));
      Membership response = chatServiceClient.createMembership(request.build());

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

Apps Script

即時通訊/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to create membership with user credential for a human user
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    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.Members.create(membership, parent);

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

如要執行範例，請替換下列項目：

SPACE_NAME：聊天室 name 的 ID。您可以呼叫 ListSpaces() 方法，或從空間的網址取得 ID。
USER_NAME：使用者 ID。

Chat API 會傳回 Membership 的例項，詳細說明已建立的使用者會籍。

邀請或新增 Google 群組至聊天室

如要透過使用者驗證邀請或將 Google 群組加入聊天室 (應用程式驗證不支援邀請或將 Google 群組加入聊天室)，請在要求中傳遞以下資訊：

指定 chat.memberships 授權範圍。
呼叫 CreateMembership() 方法。
將 parent 做為要建立會籍的聊天室資源名稱傳遞。
將 membership 做為 Membership 的執行個體傳遞，並將 groupMember 的欄位 name 設為 groups/{group}，其中 {group} 是要建立成員資格的群組 ID。您可以使用 Cloud Identity API 擷取群組 ID。

您無法將 Google 網路論壇群組加入群組即時通訊或即時訊息，只能加入命名聊天室。

以下範例會將群組新增至具備使用者驗證功能的命名聊天室：

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-group.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to create membership with user credential for a group
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      groupMember: {
        // Replace GROUP_NAME here
        name: 'groups/GROUP_NAME'
      }
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred_for_group.py

前往 GitHub 查看

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.memberships"]

# This sample shows how to create membership with user credential for a group
def create_membership_with_user_cred_for_group():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "groupMember": {
                # Replace GROUP_NAME here
                "name": "groups/GROUP_NAME"
            }
        }
    )

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

    # Handle the response
    print(response)

create_membership_with_user_cred_for_group()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCredForGroup.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.Group;

// This sample shows how to create membership with user credential for a group.
public class CreateMembershipUserCredForGroup {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setGroupMember(Group.newBuilder()
            // replace GROUP_NAME here
            .setName("groups/GROUP_NAME")));
      Membership response = chatServiceClient.createMembership(request.build());

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

Apps Script

chat/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to create membership with user credential for a group
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCredForGroup() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    groupMember: {
      // TODO(developer): Replace GROUP_NAME here
      name: 'groups/GROUP_NAME'
    }
  };

  // Make the request
  const response = Chat.Spaces.Members.create(membership, parent);

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

如要執行範例，請替換下列項目：

SPACE_NAME：聊天室 name 的 ID。您可以呼叫 ListSpaces() 方法或聊天室網址來取得 ID。
GROUP_NAME：群組 ID。

Chat API 會傳回 Membership 的例項，其中詳細說明已建立的使用者會籍。

將 Chat 應用程式新增至聊天室

Chat 應用程式無法將其他應用程式新增為聊天室的成員。如要在聊天室或兩位使用者之間的即時訊息中新增 Chat 應用程式，請使用使用者驗證在要求中傳遞以下內容 (應用程式驗證不支援邀請或將 Chat 應用程式新增至聊天室)：

指定 chat.memberships.app 授權範圍。
呼叫 CreateMembership() 方法。
將 parent 做為要建立會籍的聊天室資源名稱傳遞。
將 membership 做為 Membership 的例項傳遞，並將其 member 欄位設為下列設定：
- type 欄位設為 BOT。
- name 欄位設為 users/app，這是代表呼叫 Chat API 的應用程式別名。

以下範例會將 Chat 應用程式新增至聊天室：

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-app.js

前往 GitHub 查看

import {createClientWithUserCredentials} from './authentication-utils.js';

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

// This sample shows how to create membership with app credential for an app
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here.
    parent: 'spaces/SPACE_NAME',
    membership: {
      member: {
        // Member name for app membership, do not change this
        name: 'users/app',
        // User type for the membership
        type: 'BOT'
      }
    }
  };

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

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

main().catch(console.error);

Python

chat/client-libraries/cloud/create_membership_user_cred_for_app.py

前往 GitHub 查看

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.memberships.app"]

# This sample shows how to create membership with app credential for an app
def create_membership_with_user_cred_for_app():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateMembershipRequest(
        # Replace SPACE_NAME here
        parent = "spaces/SPACE_NAME",
        membership = {
            "member": {
                # member name for app membership, do not change this.
                "name": "users/app",
                # user type for the membership
                "type_": "BOT"
            }
        }
    )

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

    # Handle the response
    print(response)

create_membership_with_user_cred_for_app()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateMembershipUserCredForApp.java

前往 GitHub 查看

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateMembershipRequest;
import com.google.chat.v1.Membership;
import com.google.chat.v1.SpaceName;
import com.google.chat.v1.User;

// This sample shows how to create membership with user credential for the
// calling app.
public class CreateMembershipUserCredForApp {

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

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      CreateMembershipRequest.Builder request = CreateMembershipRequest.newBuilder()
        // replace SPACE_NAME here
        .setParent("spaces/SPACE_NAME")
        .setMembership(Membership.newBuilder()
          .setMember(User.newBuilder()
            // member name for app membership, do not change this.
            .setName("users/app")
            // user type for the membership
            .setType(User.Type.BOT)));
      Membership response = chatServiceClient.createMembership(request.build());

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

Apps Script

chat/advanced-service/Main.gs

前往 GitHub 查看

/**
 * This sample shows how to create membership with app credential for an app
 * 
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.memberships.app'
 * referenced in the manifest file (appsscript.json).
 */
function createMembershipUserCredForApp() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here.
  const parent = 'spaces/SPACE_NAME';
  const membership = {
    member: {
      // Member name for app membership, do not change this
      name: 'users/app',
      // User type for the membership
      type: 'BOT'
    }
  };

  // Make the request
  const response = Chat.Spaces.Members.create(membership, parent);

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

如要執行範例，請將 SPACE_NAME 替換為聊天室 name 中的 ID。您可以呼叫 ListSpaces() 方法或聊天室網址來取得 ID。

Chat API 會傳回 Membership 的例項，其中詳細說明已建立的使用者會籍。

以 Chat 應用程式的形式邀請或新增使用者至聊天室

應用程式驗證需要一次性管理員核准。

如要使用應用程式驗證邀請或新增使用者至聊天室，請在要求中傳遞下列資訊：

指定 chat.app.memberships 授權範圍。
在 membership 資源上呼叫 create 方法。
將 parent 設為要在其中建立成員資格的聊天室資源名稱。
將 member 設為 users/{user}，其中 {user} 是您要為其建立會員資格的使用者，且為下列任一項：
- People API 中的人物 ID。舉例來說，如果 People API person resourceName 是 people/123456789，請將 membership.member.name 設為 users/123456789。
- Directory API 中的 user ID。
- 使用者的電子郵件地址。例如 users/222larabrown@gmail.com 或 users/larabrown@cymbalgroup.com。如果使用者使用 Google 帳戶或屬於其他 Google Workspace 機構，您必須使用他們的電子郵件地址。

建立 API 金鑰

如要呼叫開發人員預覽版 API 方法，您必須使用 API 探索文件的非公開開發人員預覽版。如要驗證要求，您必須傳遞 API 金鑰。

如要建立 API 金鑰，請開啟應用程式的 Google Cloud 專案，然後執行下列操作：

在 Google Cloud 控制台中，依序前往「Menu」(選單) >「APIs & Services」(API 和服務) >「Credentials」(憑證)。
前往「憑證」
依序按一下「建立憑證」「API 金鑰」。
系統隨即會顯示您新的 API 金鑰。
- 按一下「複製」即可複製 API 金鑰，以便在應用程式程式碼中使用。您也可以在專案憑證的「API 金鑰」部分找到 API 金鑰。
- 按一下「限制金鑰」，即可更新進階設定並限制 API 金鑰的使用方式。詳情請參閱「套用 API 金鑰限制」。

編寫呼叫 Chat API 的指令碼

以下範例會使用應用程式驗證功能，將使用者新增至聊天室：

Python

在工作目錄中，建立名為 chat_membership_app_create.py 的檔案。

在 chat_membership_app_create.py 中加入以下程式碼：

from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then adds a user to a Chat space by creating a membership.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().create(

        # The space in which to create a membership.
        parent = 'spaces/SPACE',

        # Specify which user the membership is for.
        body = {
          'member': {
            'name':'users/USER',
            'type': 'HUMAN'
          }
        }

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

在程式碼中，請替換下列內容：
- API_KEY：您建立的 API 金鑰，用於建構 Chat API 的服務端點。
- SPACE：聊天室名稱，可透過 Chat API 中的 spaces.list 方法或聊天室網址取得。
- USER：使用者 ID。
在工作目錄中建構並執行範例：
```
python3 chat_membership_app_create.py
```

以 Google Workspace 管理員身分將使用者或 Google 群組新增至聊天室

如果您是 Google Workspace 管理員，可以呼叫 create() 方法，將使用者、Google 群組或 Chat 應用程式新增至 Google Workspace 機構中的任何聊天室。

如要以 Google Workspace 管理員的身分呼叫這個方法，請按照下列步驟操作：

使用使用者驗證來呼叫方法，並指定支援使用管理員權限呼叫方法的授權範圍。
在要求中，將查詢參數 useAdminAccess 指定為 true。

如需進一步瞭解相關資訊和範例，請參閱「以 Google Workspace 管理員身分管理 Google Chat 聊天室」。

限制和注意事項

透過應用程式驗證，Chat 應用程式可以邀請或新增使用者，但無法邀請或新增 Google 群組或 Chat 應用程式。如要新增自己，Chat 應用程式必須使用具有 chat.memberships 授權範圍的使用者驗證。

邀請或將使用者、Google 群組或 Google Chat 應用程式新增至聊天室

必要條件

Node.js

Python

Java

Apps Script

邀請或新增使用者加入聊天室

Node.js

Python

Java

Apps Script

邀請或新增 Google 群組至聊天室

Node.js

Python

Java

Apps Script

將 Chat 應用程式新增至聊天室

Node.js

Python

Java

Apps Script

以 Chat 應用程式的形式邀請或新增使用者至聊天室

建立 API 金鑰

編寫呼叫 Chat API 的指令碼

Python

以 Google Workspace 管理員身分將使用者或 Google 群組新增至聊天室

限制和注意事項

相關主題