Создайте пространство с первыми участниками

В этом руководстве объясняется, как использовать метод setUp() ресурса Space API Google Chat для настройки пространства Google Chat. При настройке пространства создается пространство и добавляются в него указанные пользователи.

Ресурс Space представляет собой место, где люди и приложения чата могут отправлять сообщения, обмениваться файлами и сотрудничать. Есть несколько типов помещений:

• Прямые сообщения (DM) — это разговоры между двумя пользователями или пользователем и приложением чата.
• Групповые чаты — это разговоры между тремя или более пользователями и приложениями чата.
• Именованные пространства — это постоянные места, где люди отправляют сообщения, обмениваются файлами и сотрудничают.

При обустройстве помещения учитывайте следующее:

• Вызывающий (аутентифицированный) пользователь автоматически добавляется в спейс, поэтому указывать членство пользователя в запросе не нужно.
• При создании прямого сообщения (DM), если между двумя пользователями существует DM, то DM возвращается. В противном случае создается DM.
• Если при создании группового чата ни одно из участников, указанных в запросе, не было успешно добавлено в групповой чат (например, проблема с разрешениями), может быть создан пустой групповой чат (включающий только вызывающего пользователя).
• Вы не можете создавать группы с цепочками ответов или добавлять людей за пределами вашего Google Workspace.
• Повторяющиеся членства (включая вызывающего пользователя), указанные в запросе, отфильтровываются, а не приводят к ошибке запроса.

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

Настроить пространство

Чтобы настроить пространство, передайте в запросе следующее:

• Укажите область авторизации chat.spaces.create или chat.spaces .
• Вызовите метод SetUpSpace() .
• Передайте space как экземпляр Space со всеми необходимыми полями, такими как displayName или spaceType .
• Передавайте memberships как массив экземпляров Membership . Для каждого экземпляра:
  • Укажите users/{user} чтобы добавить пользователя-человека в качестве члена пространства, где {user} — это либо {person_id} для person из API People, либо идентификатор user в API каталога. Например, если resourceName person API People — people/123456789 , вы можете добавить пользователя в пространство, включив членство с помощью users/123456789 в member.name .
  • Укажите groups/{group} чтобы добавить группу в качестве участника пространства, где {group} — это идентификатор группы, для которой вы хотите создать членство. Идентификатор группы можно получить с помощью API Cloud Identity . Например, если Cloud Identity API возвращает группу с именем groups/123456789 , задайте membership.groupMember.name значение groups/123456789 . Группы Google нельзя добавить в групповой чат или DM, а только в именованное пространство.

Чтобы создать DM между вызывающим пользователем и другим пользователем-человеком, укажите членство пользователя-человека в своем запросе.

Чтобы создать DM между вызывающим пользователем и вызывающим приложением, установите для space.singleUserBotDm значение true и не указывайте членство. Вы можете использовать этот метод только для настройки DM с вызывающим приложением. Чтобы добавить вызывающее приложение в качестве участника пространства или существующего DM между двумя пользователями-людьми, см. создание членства .

В следующем примере создается именованное пространство и одно членство в нем для двух пользователей-людей (прошедшего проверку подлинности пользователя и еще одного пользователя).

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

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

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));
    }
  }
}

/**
 * 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 : идентификатор другого пользователя, для которого требуется включить членство.

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

Связанные темы

• Создайте пространство .
• Получите подробную информацию о помещении .
• Перечислите пространства .
• Обновите пространство .
• Удалить пробел .
• Найдите место для прямых сообщений .
• Сделайте пространство доступным для просмотра определенным пользователям .