Konfigurowanie pokoju z początkowymi użytkownikami

Z tego przewodnika dowiesz się, jak używać metody setup w zasobie Space interfejsu Google Chat API do konfigurowania pokoju Google Chat. Skonfigurowanie pokoju powoduje utworzenie pokoju i dodanie do niego określonych użytkowników.

Zasób Space to miejsce, w którym użytkownicy i aplikacje Google Chat mogą wysyłać wiadomości, udostępniać pliki i współpracować. Jest kilka rodzajów pokoi:

  • Czaty to rozmowy między 2 użytkownikami lub użytkownikiem i aplikacją Google Chat.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami a aplikacjami do obsługi czatu.
  • Pokoje nazwane to trwałe miejsca, w których użytkownicy wysyłają wiadomości, udostępniają pliki i współpracują.

Podczas konfigurowania pokoju weź pod uwagę te kwestie:

  • Użytkownik wywołujący (uwierzytelniony) jest automatycznie dodawany do pokoju, więc nie musisz określać w żądaniu jego członkostwa.
  • Jeśli podczas tworzenia czatu istnieje między 2 użytkownikami czat, zostanie on zwrócony. W przeciwnym razie zostanie utworzony czat.
  • Jeśli podczas tworzenia czatu grupowego nie zostaną do niego dodane żadne osoby wymienione w prośbie (np. problem z uprawnieniami), może zostać utworzony pusty czat grupowy (w tym tylko użytkownik dzwoniący).
  • Nie możesz konfigurować pokoi z odpowiedziami w wątkach ani dodawać osób spoza Google Workspace.
  • Zduplikowane informacje o członkostwie w żądaniu (w tym użytkownik dzwoniący) podane w żądaniu zostaną odfiltrowane, a nie spowoduje to błędu.

Wymagania wstępne

Python

  • Python w wersji 3.6 lub nowszej
  • Narzędzie do zarządzania pakietami pip
  • Najnowsze biblioteki klienta Google dla języka Python. Aby je zainstalować lub zaktualizować, uruchom to polecenie w interfejsie wiersza poleceń:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
    
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji w Google Chat.
  • Autoryzacja skonfigurowana dla aplikacji Google Chat. Konfigurowanie pokoju wymaga uwierzytelniania użytkownika z zakresem autoryzacji chat.spaces.create lub chat.spaces.

Node.js

  • Node.js i npm
  • Najnowsze biblioteki klienta Google dla środowiska Node.js. Aby je zainstalować, uruchom to polecenie w interfejsie wiersza poleceń:

    npm install @google-cloud/local-auth @googleapis/chat
    
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji w Google Chat.
  • Autoryzacja skonfigurowana dla aplikacji Google Chat. Tworzenie pokoju wymaga uwierzytelniania użytkownika z zakresem autoryzacji chat.spaces.create lub chat.spaces.

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 metodę setup w zasobie Space.
  • Aby dodać użytkownika jako członka pokoju, wpisz users/{user}, gdzie {user} to {person_id} dla person z interfejsu People API lub identyfikator user w interfejsie Directory API. Jeśli na przykład osobą resourceName w interfejsie People API jest people/123456789, możesz dodać użytkownika do pokoju, dodając członkostwo z users/123456789 jako member.name.
  • Aby dodać grupę jako członka pokoju, wpisz groups/{group}, gdzie {group} to identyfikator grupy, do której chcesz utworzyć członkostwo. Identyfikator grupy można pobrać za pomocą interfejsu Cloud Identity API. Jeśli na przykład interfejs Cloud Identity API zwraca grupę o nazwie groups/123456789, ustaw membership.groupMember.name na groups/123456789. Grup dyskusyjnych Google nie można dodawać do czatu grupowego, a jedynie do nazwanego pokoju.
  • Aby utworzyć czat między użytkownikiem łączącym się a innym człowiekiem, określ w żądaniu członkostwo tego użytkownika.
  • Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw Space.singleUserBotDm na true i nie określaj żadnych członkostwa. Tej metody możesz użyć tylko do skonfigurowania czatu w aplikacji do połączeń. Aby dodać aplikację do rozmów jako członka pokoju lub istniejącego czatu między 2 użytkownikami, przeczytaj artykuł na temat tworzenia subskrypcji.

Poniższy przykład powoduje utworzenie nazwanego pokoju i dodanie do niego członkostwa dla 1 grupy i 3 użytkowników (w tym uwierzytelnionego użytkownika i 2 innych określonych użytkowników).

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_setup.py.
  2. Umieść w pliku chat_space_setup.py ten kod:

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient.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.spaces.create"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then sets up a Chat space by creating a space and adding members.
        '''
    
        # Authenticate with Google Workspace
        # and get user authorization.
        flow = InstalledAppFlow.from_client_secrets_file(
                          'client_secrets.json', SCOPES)
        creds = flow.run_local_server()
    
        # Build a service endpoint for Chat API.
        chat = build('chat', 'v1', credentials=creds)
    
        # Use the service endpoint to call Chat API.
        result = chat.spaces().setup(
    
          # Details about the space to set up.
          body = {
    
            # Attributes of the space to set up, like space type and display name.
            'space': {
    
                # To set up a named space, set spaceType to SPACE.
                'spaceType': 'SPACE',
    
                # The user-visible name of the space
                'displayName': 'API-setup'
            },
    
            # The users and groups to add to the space.
            #
            # The authenticated user is automatically added to the space,
            # and doesn't need to be specified in the memberships array.
            'memberships': [
                {
                  'member': {
                    'name':'users/123456789',
                    'type': 'HUMAN'
                  }
                },
                {
                  'member': {
                    'name':'users/987654321',
                    'type': 'HUMAN'
                  }
                },
                {
                  'groupMember': {
                    'name': 'groups/11223344'
                  }
                }
            ]
          }
    
          ).execute()
    
        # Prints details about the created space.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_setup.py
    

Node.js

  1. W katalogu roboczym utwórz plik o nazwie setup-space.js.
  2. Umieść w pliku setup-space.js ten kod:

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Sets up a new Chat space with users.
    * @return {!Promise<!Object>}
    */
    async function setupSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.create',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.setup({
        requestBody: {
          space: {
            spaceType: 'SPACE',
            displayName: 'API-made',
          },
          memberships: [
            {member: {name: 'users/123456789', type: 'HUMAN'}},
            {member: {name: 'users/987654321', type: 'HUMAN'}},
            {groupMember: {name: 'groups/11223344'}},
          ]
        }
      });
    }
    
    setupSpace().then(console.log);
    
  3. W katalogu roboczym uruchom przykładowy kod:

    node setup-space.js
    

Skonfigurowany jest nazwany pokój czatu z 1 grupą i 3 użytkownikami, w tym z uwierzytelnionym użytkownikiem.

Aby otworzyć pokój, utwórz jego adres URL na podstawie identyfikatora jego zasobu. Identyfikator zasobu możesz uzyskać z pokoju name w treści odpowiedzi Google Chat. Jeśli na przykład name pokoju to spaces/1234567, możesz otworzyć ten pokój, korzystając z tego adresu URL: https://mail.google.com/chat/u/0/#chat/space/1234567.