Создайте именованное пространство в Google Chat

В этом руководстве объясняется, как создать именованное пространство с помощью метода create() ресурса Space в Google Chat API.

Именованное пространство (где spaceType — SPACE ) — это место, где люди отправляют сообщения, обмениваются файлами и сотрудничают. Именованные пространства могут включать в себя приложения для чата. У именованных пространств есть администраторы, которые могут применять административные настройки, описания, а также добавлять или удалять пользователей и приложения.

Для создания различных типов чатов (включая личные сообщения или групповые сообщения) используйте метод setUp() ресурса Space , чтобы создать пространство и одновременно добавить участников. Подробности см. в разделе «Настройка пространства» .

После создания именованного пространства его единственным участником является авторизованный пользователь. Чтобы добавить участников в пространство, вызовите метод create() ресурса Membership для каждого человека или приложения, которое вы хотите добавить. Или вы можете использовать метод setUp() для создания именованного пространства и одновременного добавления в него участников.

Предварительные требования

Node.js

Python

Java

Apps Script

Создайте именованное пространство от имени пользователя.

Для создания именованного пространства с аутентификацией пользователя передайте в запросе следующее:

  • Укажите область авторизации chat.spaces.create или chat.spaces .
  • Вызовите метод CreateSpace() , space в качестве параметра экземпляр класса Space со следующими полями:
    • spaceType установлено на SPACE .
    • displayName устанавливается равным видимому пользователю имени пространства.
    • При желании можно задать и другие атрибуты, например, следующие:
      • spaceDetails — видимое пользователю описание и набор рекомендаций по использованию помещения.
      • predefinedPermissionSettings — предопределенные права доступа для пространства. Например, вы можете настроить их так, чтобы все участники или только администраторы пространства могли публиковать сообщения.

Вот как создать именованное пространство:

Node.js

chat/client-libraries/cloud/create-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 create a named space 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',
    },
  };

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

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

await main();

Python

chat/client-libraries/cloud/create_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 create_space_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.CreateSpaceRequest(
        space = {
            "space_type": 'SPACE',
            # Replace DISPLAY_NAME here.
            "display_name": 'DISPLAY_NAME'
        }
    )

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

    # Handle the response
    print(response)

create_space_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/CreateSpaceUserCred.java
import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.CreateSpaceRequest;
import com.google.chat.v1.Space;

// This sample shows how to create space with user credential.
public class CreateSpaceUserCred {

  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))) {
      CreateSpaceRequest.Builder request = CreateSpaceRequest.newBuilder()
        .setSpace(Space.newBuilder()
          .setSpaceType(Space.SpaceType.SPACE)
          // Replace DISPLAY_NAME here.
          .setDisplayName("DISPLAY_NAME"));
      Space response = chatServiceClient.createSpace(request.build());

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

Apps Script

chat/advanced-service/Main.gs
/**
 * This sample shows how to create space 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 createSpaceUserCred() {
  // Initialize request argument(s)
  const space = {
    spaceType: "SPACE",
    // TODO(developer): Replace DISPLAY_NAME here
    displayName: "DISPLAY_NAME",
  };

  // Make the request
  const response = Chat.Spaces.create(space);

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

Создайте именованное пространство в качестве приложения для чата.

Для аутентификации приложения требуется однократное подтверждение администратора .

Чтобы пригласить или добавить пользователя в пространство с аутентификацией через приложение , передайте в запросе следующее:

  • Укажите область авторизации chat.app.spaces.create или chat.app.spaces .
  • Вызовите метод create для ресурса Space .
  • Установите spaceType в SPACE .
  • Установите displayName равным видимому пользователю имени пространства. В следующем примере displayName установлено на API-made .
  • Укажите идентификатор клиента домена Google Workspace, используя поле customer .
  • При желании можно задать и другие атрибуты помещения, например, spaceDetails (описание и набор рекомендаций для помещения, отображаемые для пользователя).

Напишите скрипт, который вызывает API чата.

Вот как создать именованное пространство:

Python

  1. В рабочей директории создайте файл с именем chat_space_create_named_app.py .

  2. Включите следующий код в chat_space_create_named_app.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.spaces.create"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then creates a Chat space.
    '''

    # 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)

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

      # Details about the space to create.
      body = {

        # To create a named space, set spaceType to SPACE.
        'spaceType': 'SPACE',

        # The user-visible name of the space.
        'displayName': 'API-made',

        # The customer ID of the Workspace domain.
        'customer': 'CUSTOMER'
      }

      ).execute()

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

if __name__ == '__main__':
    main()

  3. В коде замените следующее:

    • CUSTOMER : идентификатор клиента домена пространства в формате customer/{customer} , где {customer} — это ID из ресурса клиента в Admin SDK . Чтобы создать пространство в той же организации Google Workspace, что и приложение Chat, используйте customers/my_customer .

  4. В рабочей директории соберите и запустите пример:

    python3 chat_space_create_named_app.py

Откройте это пространство в Google Чате.

Чтобы перейти в пространство, используйте идентификатор ресурса пространства для формирования URL-адреса пространства. Идентификатор ресурса можно найти в name пространства в теле ответа Google Chat. Например, если name вашего пространства — spaces/1234567 , вы можете перейти в него, используя следующий URL-адрес: https://mail.google.com/chat/u/0/#chat/space/1234567 .

Ограничения и соображения

  • При создании пространства с использованием аутентификации приложения , аутентифицирующее приложение «Чат» добавляется в качестве участника пространства, но, в отличие от аутентификации пользователя, не в качестве менеджера пространства. По умолчанию все участники пространства могут удалить приложение «Чат». Чтобы разрешить удаление приложения «Чат» только менеджерам пространства, установите permissionSettings.manageApps в значение managersAllowed .