Znajdowanie pokoju czatu

Z tego przewodnika dowiesz się, jak używać metody findDirectMessage dla zasobu Space interfejsu Google Chat API do uzyskiwania szczegółowych informacji o pokoju czatu.

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ą.

Uwierzytelnianie za pomocą uwierzytelniania aplikacji umożliwia aplikacji Google Chat otrzymywanie czatów, do których ta aplikacja ma dostęp w Google Chat (np. czatów, których jest członkiem). Uwierzytelnianie z uwierzytelnianiem użytkownika zwraca czaty, do których ma dostęp uwierzytelniony użytkownik.

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 google-auth
    
  • Projekt Google Cloud z włączonym i skonfigurowanym interfejsem Google Chat API. Instrukcje znajdziesz w artykule Tworzenie aplikacji Google Chat.
  • Skonfigurowano autoryzację dla aplikacji Google Chat. Gdy znaleźć czat, obsługujemy:

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.
  • Skonfigurowano autoryzację dla aplikacji Google Chat. Gdy znaleźć czat, obsługujemy:

Znajdowanie czatu

Aby znaleźć czat w Google Chat, podaj w prośbie:

  • W przypadku uwierzytelniania aplikacji określ zakres autoryzacji chat.bot. W przypadku uwierzytelniania użytkownika określ zakres autoryzacji chat.spaces.readonly lub chat.spaces.
  • Wywołaj metodę findDirectMessage w zasobie User, przekazując w czacie name innego użytkownika, aby ją zwrócić. W przypadku uwierzytelniania użytkownika ta metoda zwraca czat między użytkownikiem wywołującym a określonym użytkownikiem. W przypadku uwierzytelniania aplikacji ta metoda zwraca czat między aplikacją wywołującą a określonym użytkownikiem.
  • 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ą interfejsu People API resourceName jest people/123456789, możesz dodać użytkownika do pokoju, dodając członkostwo z users/123456789 jako member.name.

Znajdowanie czatu z uwierzytelnianiem użytkownika

Aby znaleźć czat z uwierzytelnianiem użytkownika:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_space_find_dm_user.py.
  2. Umieść ten kod w elemencie chat_space_find_dm_user.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.readonly"]
    
    def main():
        '''
        Authenticates with Chat API via user credentials,
        then returns details about a specified DM.
        '''
    
        # 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().findDirectMessage(
    
              # The other user in the direct message (DM) to return.
              #
              # Replace USER with a user name.
              name='users/USER'
    
          ).execute()
    
        # Prints details about the created membership.
        print(result)
    
    if __name__ == '__main__':
        main()
    
  3. W kodzie zastąp USER wartością name elementu User w Google Chat.

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

    python3 chat_space_find_dm_user.py
    

Node.js

  1. W katalogu roboczym utwórz plik o nazwie find-direct-message-space.js.

  2. Umieść ten kod w elemencie find-direct-message-space.js:

    const chat = require('@googleapis/chat');
    const {authenticate} = require('@google-cloud/local-auth');
    
    /**
    * Find a direct message Chat space for a user.
    * @return {!Promise<!Object>}
    */
    async function findDirectMessageSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.spaces.readonly',
      ];
    
      const authClient =
          await authenticate({scopes, keyfilePath: 'client_secrets.json'});
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.findDirectMessage(
          {name: 'users/USER'});
    }
    
    findDirectMessageSpace().then(console.log);
    
  3. W kodzie zastąp USER wartością name elementu User w Google Chat.

  4. W katalogu roboczym uruchom przykład:

    node find-direct-message-space.js
    

Interfejs Chat API zwraca instancję Space ze szczegółami określonego czatu.

Znajdowanie wiadomości na czacie dzięki uwierzytelnianiu w aplikacji

Aby znaleźć czat z uwierzytelnianiem aplikacji:

Python

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

    from google.oauth2 import service_account
    from apiclient.discovery import build
    
    # Specify required scopes.
    SCOPES = ['https://www.googleapis.com/auth/chat.bot']
    
    # Specify service account details.
    CREDENTIALS = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )
    
    # Build the URI and authenticate with the service account.
    chat = build('chat', 'v1', credentials=CREDENTIALS)
    
    # Use the service endpoint to call Chat API.
    result = chat.spaces().findDirectMessage(
    
        # The other user in the direct message (DM) to return.
        #
        # Replace USER with a user name.
        name='users/USER'
    
    ).execute()
    
    print(result)
    
  3. W kodzie zastąp USER wartością name elementu User w Google Chat.

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

    python3 chat_space_find_dm_app.py
    

Node.js

  1. W katalogu roboczym utwórz plik o nazwie app-find-direct-message-space.js.

  2. Umieść ten kod w elemencie app-find-direct-message-space.js:

    const chat = require('@googleapis/chat');
    
    /**
    * Find a direct message Chat space for a user.
    * @return {!Promise<!Object>}
    */
    async function findDirectMessageSpace() {
      const scopes = [
        'https://www.googleapis.com/auth/chat.bot',
      ];
    
      const auth = new chat.auth.GoogleAuth({
        scopes,
        keyFilename: 'credentials.json',
      });
    
      const authClient = await auth.getClient();
    
      const chatClient = await chat.chat({version: 'v1', auth: authClient});
    
      return await chatClient.spaces.findDirectMessage(
          {name: 'users/USER'});
    }
    
    findDirectMessageSpace().then(console.log);
    
  3. W kodzie zastąp USER wartością name elementu User w Google Chat.

  4. W katalogu roboczym uruchom przykład:

    node app-find-direct-message-space.js
    

Interfejs Chat API zwraca instancję Space zawierającą szczegóły określonego czatu.