ユーザー、Google グループ、Google Chat アプリをスペースに招待または追加する

このガイドでは、Google Chat API の Membership リソースで create() メソッドを使用して、ユーザー、Google グループ、Chat 用アプリをスペースに招待または追加する方法について説明します。これは、メンバーシップの作成とも呼ばれます。メンバーシップを作成するときに、指定されたメンバーの自動承認ポリシーがオフになっている場合は、そのメンバーは招待され、参加する前にスペースの招待を承認する必要があります。それ以外の場合、メンバーシップを作成すると、指定されたスペースにメンバーが直接追加されます。

Google Workspace 管理者は、Google Workspace 組織内の任意のスペースにユーザー、Google グループ、Chat 用アプリを追加できます。

Membership リソースは、ユーザーまたは Google Chat アプリがスペースに招待されているか、スペースに参加しているか、スペースに参加していないかを表します。

前提条件

Node.js

Python

Java

Apps Script

ユーザーをスペースにユーザーとして招待または追加する

ユーザー認証を使用してユーザーをスペースに招待または追加するには、リクエストで次の情報を渡します。

  • chat.memberships 認可スコープを指定します。
  • CreateMembership() メソッドを呼び出します。
  • メンバーシップを作成するスペースのリソース名として parent を渡します。
  • membership を Membership のインスタンスとして渡し、そのフィールド member を次のように設定します。
    • HUMAN に設定されている type フィールド。
    • name フィールドが users/{user} に設定されている。ここで、{user} はスペースに追加するユーザーです。Chat ユーザーを指定するには、{user} を次のいずれかに置き換えます。
      • People API の person の 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
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
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
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

chat/advanced-service/Main.gs
/**
 * 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。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
  • USER_NAME: ユーザー ID。

Chat API は、作成されたユーザー メンバーシップの詳細を示す Membership のインスタンスを返します。

スペースに Google グループを招待または追加する

ユーザー認証（アプリ認証では、Google グループをスペースに招待または追加することはできません）を使用して Google グループをスペースに招待または追加するには、リクエストで次の情報を渡します。

  • chat.memberships 認可スコープを指定します。
  • CreateMembership() メソッドを呼び出します。
  • メンバーシップを作成するスペースのリソース名として parent を渡します。
  • membership は、groupMember のフィールド name が groups/{group} に設定された Membership のインスタンスとして渡します。ここで、{group} はメンバーシップを作成するグループ ID です。グループの ID は、Cloud Identity API を使用して取得できます。

Google グループは、グループ チャットやダイレクト メッセージに追加することはできません。名前付きスペースにのみ追加できます。

次の例では、ユーザー認証を使用して、名前付きスペースにグループを追加します。

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-group.js
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
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
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
/**
 * 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。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。
  • GROUP_NAME: グループ ID。

Chat API は、作成されたユーザー メンバーシップの詳細を示す Membership のインスタンスを返します。

スペースに Chat 用アプリを追加する

Chat 用アプリは、別のアプリをスペースのメンバーとして追加できません。Chat アプリをスペースまたは 2 人のユーザー間のダイレクト メッセージに追加するには、ユーザー認証を使用してリクエストで次の情報を渡します（アプリ認証では、Chat アプリをスペースに招待したり追加したりすることはできません）。

  • chat.memberships.app 認可スコープを指定します。
  • CreateMembership() メソッドを呼び出します。
  • メンバーシップを作成するスペースのリソース名として parent を渡します。
  • membership を Membership のインスタンスとして渡し、そのフィールド member を次のように設定します。
    • BOT に設定されている type フィールド。
    • name フィールドが users/app に設定されています。Chat API を呼び出すアプリを表すエイリアス。

次の例では、Chat 用アプリをスペースに追加します。

Node.js

chat/client-libraries/cloud/create-membership-user-cred-for-app.js
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
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
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
/**
 * 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 に置き換えます。ID は、ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。

Chat API は、作成されたユーザー メンバーシップの詳細を示す Membership のインスタンスを返します。

Chat 用アプリとしてユーザーをスペースに招待または追加する

アプリの認証には、1 回限りの管理者による承認が必要です。

アプリ認証を使用してユーザーをスペースに招待または追加するには、リクエストで次の情報を渡します。

  • chat.app.memberships 認可スコープを指定します。
  • membership リソースで create メソッドを呼び出します。
  • parent は、メンバーシップを作成するスペースのリソース名に設定します。
  • member を users/{user} に設定します。ここで、{user} はメンバーシップを作成するユーザーであり、次のいずれかになります。
    • People API の person の ID。たとえば、People API の person resourceName が people/123456789 の場合は、membership.member.name を users/123456789 に設定します。
    • Directory API のユーザーの ID。
    • ユーザーのメールアドレス。たとえば、users/222larabrown@gmail.com や users/larabrown@cymbalgroup.com です。ユーザーが Google アカウントを使用している場合や、別の Google Workspace 組織に属している場合は、そのユーザーのメールアドレスを使用する必要があります。

API キーを作成する

デベロッパー プレビュー API メソッドを呼び出すには、API 検出ドキュメントの非公開のデベロッパー プレビュー バージョンを使用する必要があります。リクエストを認証するには、API キーを渡す必要があります。

API キーを作成するには、アプリの Google Cloud プロジェクトを開いて次の操作を行います。

  1. Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。

    [認証情報] に移動

  2. [認証情報を作成] > [API キー] をクリックします。
  3. 新しい API キーが表示されます。
    • [コピー] をクリックして、アプリのコードで使用する API キーをコピーします。API キーは、プロジェクトの認証情報の [API キー] セクションでも確認できます。
    • [キーを制限] をクリックして、詳細設定を更新し、API キーの使用を制限します。詳しくは、API キーの制限を適用するをご覧ください。

Chat API を呼び出すスクリプトを作成する

次の例では、アプリ認証を使用してユーザーをスペースに追加します。

Python

  1. 作業ディレクトリに chat_membership_app_create.py という名前のファイルを作成します。

  2. 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()

  3. コードで、次のように置き換えます。

    • API_KEY: Chat API のサービス エンドポイントを構築するために作成した API キー。

    • SPACE: スペース名。Chat API の spaces.list メソッドまたはスペースの URL から取得できます。

    • USER: ユーザー ID。

  4. 作業ディレクトリで、サンプルをビルドして実行します。

    python3 chat_membership_app_create.py

Google Workspace 管理者としてスペースにユーザーまたは Google グループを追加する

Google Workspace 管理者は、create() メソッドを呼び出して、Google Workspace 組織内の任意のスペースにユーザー、Google グループ、Chat 用アプリを追加できます。

Google Workspace 管理者としてこのメソッドを呼び出すには、次の操作を行います。

  • ユーザー認証を使用してメソッドを呼び出し、管理者権限を使用してメソッドを呼び出すことをサポートする認可スコープを指定します。
  • リクエストで、クエリ パラメータ useAdminAccess を true に指定します。

詳細と例については、Google Workspace 管理者として Google Chat スペースを管理するをご覧ください。

制限事項と考慮事項

  • アプリ認証では、Chat 用アプリはユーザーを招待または追加できますが、Google グループや Chat 用アプリは招待または追加できません。Chat 用アプリが自身を追加するには、chat.memberships 認証スコープでユーザー認証を使用する必要があります。