Konfigurowanie pokoju z początkowymi użytkownikami

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

Zasób Space reprezentuje miejsce, w którym osoby i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Istnieje kilka typów pokoi:

  • Czaty to rozmowy między 2 użytkownikami lub użytkownikiem i aplikacją do obsługi czatu.
  • Czaty grupowe to rozmowy między co najmniej 3 użytkownikami i aplikacjami do obsługi czatu.
  • Pokoje z nazwą 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ć jego członkostwa w żądaniu.
  • Gdy tworzysz wiadomość na czacie, jeśli 2 użytkowników istnieje między nimi, czat jest zwracany. W przeciwnym razie tworzony jest czat.
  • Nie możesz konfigurować pokoi z odpowiedziami w wątkach ani dodawać osób spoza Google Workspace.

Wymagania wstępne

Python

  • Python 3.6 lub nowszy
  • Narzędzie do zarządzania pakietami pip

  • Najnowsze biblioteki klienta Google do języka Python. Aby je zainstalować lub zaktualizować, uruchom w interfejsie wiersza poleceń to polecenie:

    pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client

  • Opublikowana aplikacja Google Chat. Aby utworzyć i opublikować aplikację do obsługi czatu, przeczytaj artykuł Tworzenie aplikacji Google Chat.

  • Autoryzacja aplikacji Google Chat została skonfigurowana. Skonfigurowanie pokoju wymaga uwierzytelniania użytkowników z zakresem autoryzacji chat.spaces.create lub chat.spaces.

Konfigurowanie pokoju

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

  • Określ zakres autoryzacji chat.spaces.create lub chat.spaces.
  • Wywołaj metodę setup w zasobie Space.
  • Aby dodać użytkownika jako użytkownika pokoju, wpisz users/{user}, gdzie {user} to {person_id} elementu person z interfejsu People API lub identyfikator user w interfejsie Directory API. Jeśli na przykład osobą z interfejsu People API resourceName jest people/123456789, możesz dodać użytkownika do pokoju, podając członkostwo z users/123456789 w polu member.name.
  • Aby utworzyć czat między użytkownikiem wywołującym a innym użytkownikiem, określ w swojej prośbie o członkostwo użytkownika.
  • Aby utworzyć czat między użytkownikiem wywołującym a aplikacją do rozmów, ustaw Space.singleUserBotDm na true i nie określaj żadnych subskrypcji. Tej metody możesz użyć tylko do skonfigurowania czatu z aplikacją wywołującą. Aby dodać aplikację wywołującą jako członka pokoju lub istniejącego czatu między 2 użytkownikami, przeczytaj artykuł o tworzeniu subskrypcji.

Poniższy przykład pokazuje utworzenie pokoju nazwanego i członkostwo w nim dla 3 użytkowników – 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ść ten kod w pliku chat_space_setup.py:

    import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# 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 people and app 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'
              }
            }
        ]
      }

      ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

  3. W katalogu roboczym skompiluj i uruchom przykład:

    python3 chat_space_setup.py

Skonfigurowane jest nazwane pokój czatu z 3 użytkownikami, w tym użytkownikiem uwierzytelnionym.

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