Tworzenie pokoju w Google Chat i dodawanie użytkowników

Z tego przewodnika dowiesz się, jak użyć metody setUp() na zasobie Space interfejsu Google Chat API, aby utworzyć pokój w Google Chat i dodać do niego użytkowników.

SpaceZasób to miejsce, w którym użytkownicy i aplikacje czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka typów pokoi:

• Czaty to rozmowy między dwoma użytkownikami lub użytkownikiem a aplikacją czatu.
• Czaty grupowe to rozmowy między 3 lub większą liczbą użytkowników i aplikacji Google Chat.
• Nazwane pokoje to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Metody setUp() możesz używać do wykonywania tych czynności:

• Utwórz pokój z nazwą i pierwszymi użytkownikami.
• Utwórz czat między 2 osobami.
• Utwórz wiadomość grupową dla wielu osób.

Podczas konfigurowania pokoju weź pod uwagę te kwestie:

• Dzwoniący (uwierzytelniony) użytkownik jest automatycznie dodawany do pokoju, więc nie musisz określać jego członkostwa w żądaniu.
• Podczas tworzenia wiadomości na czacie, jeśli istnieje już taka wiadomość między dwoma użytkownikami, to właśnie ona zostanie zwrócona. W przeciwnym razie zostanie utworzona wiadomość DM.
• Jeśli podczas tworzenia czatu grupowego żaden z członków podanych w żądaniu nie zostanie dodany do czatu grupowego (np. z powodu problemu z uprawnieniami), może zostać utworzony pusty czat grupowy (z udziałem tylko dzwoniącego użytkownika).
• Nie możesz konfigurować pokoi z odpowiedziami w wątku ani dodawać osób spoza Google Workspace.
• W przypadku duplikatów członkostw (w tym użytkownika wywołującego) podanych w żądaniu są one odfiltrowywane, a nie powodują błędu żądania.

Wymagania wstępne

Konfigurowanie pokoju

Aby skonfigurować przestrzeń, w żądaniu podaj te informacje:

• Określ zakres autoryzacji chat.spaces.create lub chat.spaces.
• Wywołaj metodę SetUpSpace().
• Przekaż space jako instancję Space ze wszystkimi niezbędnymi polami, takimi jak displayName czy spaceType.
• Przekaż parametr memberships jako tablicę instancji Membership. W przypadku każdego wystąpienia:
  • Określ users/{user}, aby dodać użytkownika jako uczestnika pokoju, gdzie {user} jest albo {person_id} dla person z interfejsu People API, albo identyfikatorem user w interfejsie Directory API. Jeśli na przykład osoba z interfejsu People API o identyfikatorze resourceName to people/123456789, możesz dodać ją do pokoju, podając identyfikator users/123456789 jako member.name.
  • Określ groups/{group}, aby dodać grupę jako użytkownika pokoju. {group} to identyfikator grupy, dla której chcesz utworzyć członkostwo. Identyfikator grupy można pobrać za pomocą interfejsu Cloud Identity API. Jeśli np. interfejs Cloud Identity API zwróci grupę o nazwie groups/123456789, ustaw wartość parametru membership.groupMember.name na groups/123456789. Grup dyskusyjnych Google nie można dodawać do czatu grupowego ani czatu bezpośredniego, a tylko do pokoju o nazwie.

Aby utworzyć wiadomość DM między użytkownikiem wywołującym a innym użytkownikiem, określ w prośbie przynależność tego drugiego użytkownika do grupy.

Aby utworzyć wiadomość DM między użytkownikiem a aplikacją, ustaw space.singleUserBotDm na true i nie określaj żadnych grup. Tej metody możesz używać tylko do konfigurowania DM-ów z aplikacją do połączeń. Aby dodać aplikację do połączeń jako członka pokoju lub istniejącego DM-a między dwoma użytkownikami, zapoznaj się z artykułem Tworzenie członkostwa.

W tym przykładzie tworzymy przestrzeń o nazwie i członkostwo w niej dla 2 użytkowników (zalogowanego użytkownika i jednego innego).

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

Aby uruchomić przykład, zastąp te wartości:

• DISPLAY_NAME: wyświetlana nazwa nowego pokoju.
• USER_NAME: identyfikator innego użytkownika, dla którego chcesz uwzględnić członkostwo.

Aby przejść do pokoju, użyj identyfikatora zasobu pokoju do utworzenia jego adresu URL. Identyfikator zasobu możesz znaleźć w name w treści odpowiedzi w Google Chat. Jeśli na przykład name Twojej przestrzeni to spaces/1234567, możesz przejść do niej, korzystając z tego adresu URL: https://mail.google.com/chat/u/0/#chat/space/1234567.

Powiązane artykuły

• Utwórz pokój.
• Znajdowanie informacji o pokoju
• Lista pokoi.
• Zaktualizuj pokój.
• Usuwanie pokoju.
• Znajdź pokój na czacie.
• Ustawianie pokoju jako możliwego do znalezienia dla określonych użytkowników.