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

Z tego przewodnika dowiesz się, jak używać metody setUp() w zasobie Space interfejsu Google Chat API do tworzenia pokoju w Google Chat i dodawania do niego użytkowników.

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

• Wiadomości na czacie to rozmowy między 2 użytkownikami lub między użytkownikiem a aplikacją do obsługi czatu.
• Czaty grupowe to rozmowy między co najmniej 3 użytkownikami i aplikacjami do czatowania.
• Pokoje z nazwami to trwałe miejsca, w których użytkownicy mogą wysyłać wiadomości, udostępniać pliki i współpracować.

Za pomocą metody setUp() możesz wykonać dowolną z tych czynności:

• Utwórz nazwany pokój z początkowymi członkami.
• Utwórz czat między dwiema osobami.
• Utwórz czat grupowy z wieloma osobami.

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 czat między dwoma użytkownikami, zostanie on zwrócony. W przeciwnym razie zostanie utworzona wiadomość DM.
• Podczas tworzenia czatu grupowego, jeśli żadne z członkostw podanych w żądaniu nie zostanie dodane do czatu grupowego (np. z powodu problemu z uprawnieniami), może zostać utworzony pusty czat grupowy (zawierający tylko użytkownika wywołującego).
• Nie możesz konfigurować pokoi z odpowiedziami w wątkach ani dodawać osób spoza organizacji Google Workspace.
• Zduplikowane członkostwa (w tym użytkownika wywołującego) podane w żądaniu są odfiltrowywane zamiast powodować błąd żądania.
• Gdy administrator Google Workspace zainstaluje aplikację do Google Chat dla całej organizacji Google Workspace, Google Chat utworzy wiadomość na czacie między zainstalowaną aplikacją a każdym użytkownikiem w organizacji, więc nie trzeba programowo konfigurować wiadomości na czacie. Zamiast tego wyświetl pokoje, aby zwrócić wszystkie czaty, lub znajdź czat, aby uzyskać szczegółowe informacje o konkretnym czacie.

Wymagania wstępne

Konfigurowanie pokoju

Aby skonfigurować przestrzeń, w żądaniu przekaż 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 lub spaceType.
• Przekaż memberships jako tablicę instancji Membership. W przypadku każdej instancji:
  • Określ users/{user}, aby dodać użytkownika jako uczestnika pokoju, gdzie {user} to {person_id} dla person z interfejsu People API lub identyfikator user w interfejsie Directory API. Jeśli na przykład osoba w People API resourceName ma wartość people/123456789, możesz dodać użytkownika do pokoju, uwzględniając członkostwo z wartością users/123456789 w polu member.name.
  • Określ groups/{group}, aby dodać grupę jako członka pokoju, gdzie {group} to identyfikator grupy, dla której chcesz utworzyć członkostwo. Identyfikator grupy można pobrać za pomocą interfejsu Cloud Identity API. Jeśli na przykład Cloud Identity API zwróci grupę o nazwie groups/123456789, ustaw membership.groupMember.name na groups/123456789. Grup dyskusyjnych Google nie można dodawać do czatu grupowego ani czatu, a tylko do pokoju z nazwą.

Aby utworzyć wiadomość bezpośrednią między użytkownikiem dzwoniącym a innym użytkownikiem, w prośbie określ członkostwo tego użytkownika.

Aby utworzyć wiadomość bezpośrednią między użytkownikiem dzwoniącym a aplikacją dzwoniącą, ustaw parametr space.singleUserBotDm na true i nie określaj żadnych członkostw. Tej metody możesz użyć tylko do skonfigurowania wiadomości bezpośredniej z aplikacją do dzwonienia. Aby dodać aplikację do dzwonienia jako członka pokoju lub istniejącej wiadomości bezpośredniej między 2 użytkownikami, zapoznaj się z artykułem tworzenie członkostwa.

W tym przykładzie tworzymy nazwaną przestrzeń i 1 członkostwo w przestrzeni dla 2 użytkowników (uwierzytelnionego użytkownika i innego użytkownika).

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

await main();

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 elementy:

• DISPLAY_NAME: wyświetlana nazwa nowej przestrzeni.
• USER_NAME: identyfikator innego użytkownika, dla którego ma zostać uwzględnione członkostwo.

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

Powiązane artykuły

• Utwórz pokój.
• Sprawdzanie szczegółów pokoju
• Wyświetlanie pokoi
• Aktualizowanie pokoju
• Usuń pokój.
• Znajdź pokój na czacie.
• Udostępnianie pokoju określonym użytkownikom