Konfigurowanie pokoju z początkowymi użytkownikami

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

Zasób Space wskazuje miejsce, w którym użytkownicy i aplikacje do obsługi czatu mogą wysyłać wiadomości, udostępniać pliki i współpracować. Jest kilka typó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 i aplikacjami Google Chat.
  • 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ć jego członkostwa w żądaniu.
  • Jeśli czat jest między 2 użytkownikami, podczas tworzenia czatu są one zwracane. W przeciwnym razie zostanie utworzony czat.
  • Jeśli podczas tworzenia czatu grupowego żadne ze wskazanych w prośbie informacji o członkostwie nie zostało dodane do czatu grupowego (np. z powodu problemu z uprawnieniami), może zostać utworzony pusty czat grupowy (w tym tylko użytkownik nawiązujący połączenie).
  • Nie możesz konfigurować pokoi z odpowiedziami w wątkach ani dodawać osób spoza Google Workspace.
  • Zduplikowane członkostwo (w tym użytkownik wywołujący) podane w żądaniu są odfiltrowywane, a nie powoduje to błędu żądania.

Wymagania wstępne

Python

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

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

    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 Google Chat.

  • Autoryzacja dla aplikacji Google Chat została skonfigurowana. Skonfigurowanie pokoju wymaga uwierzytelniania użytkowników 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 w interfejsie wiersza poleceń to polecenie:

    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 Google Chat.

  • Autoryzacja dla aplikacji Google Chat została skonfigurowana. Utworzenie pokoju wymaga uwierzytelniania użytkownika 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 członka pokoju, wpisz users/{user}, gdzie {user} to identyfikator {person_id} elementu person z interfejsu People API lub identyfikator user w interfejsie Directory API. Jeśli na przykład osobą w interfejsie People API resourceName jest people/123456789, możesz dodać użytkownika do pokoju, podając członkostwo z users/123456789 jako member.name.
  • Aby utworzyć czat między użytkownikiem dzwoniącym a innym użytkownikiem, określ w żądaniu członkostwo użytkownika.
  • Aby utworzyć czat między użytkownikiem dzwoniącym a aplikacją do rozmów, ustaw Space.singleUserBotDm na true i nie podawaj żadnych informacji o członkostwie. Tej metody możesz użyć tylko do skonfigurowania czatu z aplikacją wywołującą. Jeśli chcesz dodać aplikację wywołującą jako członka pokoju lub rozmowy na czacie między 2 użytkownikami, przeczytaj sekcję o tworzeniu subskrypcji.

Poniższy przykład pokazuje utworzenie nazwanego pokoju i dodanie do niego członkostwa 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 elemencie chat_space_setup.py:

    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 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 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ść ten kod w elemencie setup-space.js:

    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'}},
      ]
    }
  });
}

setupSpace().then(console.log);

  3. W katalogu roboczym uruchom przykład:

    node setup-space.js

Skonfigurowany jest nazwany pokój czatu z 3 użytkownikami (w tym użytkownikiem uwierzytelnionym).

Aby przejść do pokoju, utwórz jego adres URL, korzystając z jego identyfikatora zasobu. Identyfikator zasobu znajdziesz 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ść pod tym adresem URL: https://mail.google.com/chat/u/0/#chat/space/1234567.