Konfigurowanie pokoju z początkowymi użytkownikami

Z tego przewodnika dowiesz się, jak użyć metody setUp() w zasobach Space interfejsu Google Chat API, aby skonfigurować pokój Google Chat. Skonfigurowanie pokoju powoduje utworzenie pokoju i dodanie do niego określonych 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ć. Jest kilka rodzajów pokoi:

  • Czaty to rozmowy między dwoma użytkownikami lub użytkownikiem a aplikacją czatu.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami komunikatory;
  • Pokoje nazwane to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracę.

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.
  • Jeśli podczas tworzenia czatu istnieje 2 użytkowników, po wysłaniu wiadomości pojawi się czat. W przeciwnym razie zostanie utworzony czat.
  • podczas tworzenia czatu grupowego, jeśli nie wybrano żadnego członkostwa wymienionego w prośbie. zostaną dodani do czatu grupowego (np. problem z uprawnieniami), a potem może zostać utworzony pusty czat grupowy (z którym tylko użytkownik dzwoni).
  • Nie możesz konfigurować pokoi z odpowiedziami w wątku ani dodawać osób spoza Google Workspace.
  • Zduplikowane subskrypcje (w tym użytkownik dzwoniący) podane w prośbie. są odfiltrowywane, a nie powodują błędu żądania.

Wymagania wstępne

Node.js

Python

Java

Google Apps Script

Konfigurowanie pokoju

Aby skonfigurować pokój, w swojej prośbie podaj te informacje:

  • Określ zakres autoryzacji chat.spaces.create lub chat.spaces.
  • Wywołaj funkcję SetUpSpace() .
  • Przekaż space jako instancję Space z wszystkimi niezbędnymi polami, np. displayName lub spaceType.
  • Przekaż parametr memberships jako tablicę instancji Membership. W przypadku każdego wystąpienia:
    • Określ users/{user}, aby dodać użytkownika jako użytkownika 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 korzystająca z interfejsu People API resourceName to people/123456789. Możesz dodać użytkownika do pokoju, wykonując: w tym członkostwo z 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ą Cloud Identity API Na przykład, jeśli plik Cloud Identity API zwraca grupę o nazwie groups/123456789, a następnie ustawiono membership.groupMember.name do groups/123456789. Grupy dyskusyjne Google nie mogą została dodana do czatu grupowego lub czatu, ale tylko do nazwanego pokoju.

Aby utworzyć czat między użytkownikiem łączącym się a innym użytkownikiem, podaj na liście użytkowników, których dotyczy prośba.

Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw space.singleUserBotDm do true i nie określaj żadnych członkostwa. Dostępne opcje tej metody należy użyć tylko do skonfigurowania czatu z aplikacją do rozmów. Aby dodać połączenie jako członka pokoju lub istniejącego czatu między 2 użytkownikami, patrz utworzyć subskrypcję.

W poniższym przykładzie tworzymy pokój nazwany i jedną subskrypcję dla 2 użytkowników (uwierzytelnionego użytkownika i jednego innego użytkownika).

Node.js

chat/client-libraries/cloud/set-up-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 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);

Python

chat/client-libraries/cloud/set_up_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 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()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/SetUpSpaceUserCred.java
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));
    }
  }
}

Google Apps Script

chat/advanced-service/Main.gs
/**
 * 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:

  • DISPLAY_NAME: wyświetlana nazwa nowego pokoju.
  • USER_NAME: identyfikator innego użytkownika, do którego chcesz dodać parametr dla domeny.

Aby otworzyć pokój, utwórz jego adres URL na podstawie identyfikatora jego zasobu. Identyfikator zasobu możesz znaleźć w name w treści odpowiedzi w Google Chat. Jeśli na przykład name w Twoim pokoju to spaces/1234567, możesz do pokoju pod tym adresem URL: https://mail.google.com/chat/u/0/#chat/space/1234567