Sprawdzanie szczegółów wiadomości

Z tego przewodnika dowiesz się, jak używać metody get w zasobie Message interfejsu Google Chat API do zwracania szczegółów wiadomości tekstowej lub karty.

Zasób Message reprezentuje tekst lub kartę w Google Chat. Możesz create, get, update lub delete wysłać wiadomość w Google Chat API, wywołując odpowiednie metody. Więcej informacji o SMS-ach i kartach znajdziesz w artykule Omówienie wiadomości w Google Chat.

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. Otrzymywanie wiadomości obsługuje obie metody uwierzytelniania:

Otrzymywanie wiadomości po uwierzytelnieniu użytkownika

Aby uzyskać szczegóły wiadomości z uwierzytelnianiem użytkownika, przekaż w żądaniu te informacje:

  • Określ zakres autoryzacji chat.messages.readonly lub chat.messages.
  • Wywołaj metodę get w zasobie Message.
  • Ustaw name na nazwę zasobu wiadomości, którą chcesz pobrać.

Poniższy przykład otrzymuje wiadomość z uwierzytelnianiem użytkownika:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_message_get_user.py.

  2. Umieść ten kod w pliku chat_message_get_user.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.messages.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets a message.
    '''

    # 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().messages().get(

        # The message to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace MESSAGE with a message name.
        # Obtain the message name from the response body returned
        # after creating a message asynchronously with Chat REST API.
        name = 'spaces/SPACE/messages/MESSAGE'

    ).execute()

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

if __name__ == '__main__':
    main()

  3. W kodzie zastąp następujący fragment:

    • SPACE: nazwa pokoju, którą można uzyskać, korzystając z metody spaces.list w Chat API lub z adresu URL pokoju.
    • MESSAGE: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.

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

    python3 chat_message_get_user.py

Interfejs Chat API zwraca instancję Message, która zawiera szczegóły określonej wiadomości.

Otrzymywanie wiadomości za pomocą uwierzytelniania aplikacji

Aby uzyskać szczegółowe informacje o wiadomości z uwierzytelnianiem aplikacji, przekaż w żądaniu te informacje:

  • Określ zakres autoryzacji chat.bot.
  • Wywołaj metodę get w zasobie Message.
  • Ustaw name na nazwę zasobu wiadomości, którą chcesz pobrać.

Poniższy przykład otrzymuje wiadomość z uwierzytelnianiem aplikacji:

Python

  1. W katalogu roboczym utwórz plik o nazwie chat_get_message_app.py.

  2. Umieść ten kod w pliku chat_get_message_app.py:

    from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'credentials.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

# Get a Chat message.
result = chat.spaces().messages().get(

    # The message to get.
    #
    # Replace SPACE with a space name.
    # Obtain the space name from the spaces resource of Chat API,
    # or from a space's URL.
    #
    # Replace MESSAGE with a message name.
    # Obtain the message name from the response body returned
    # after creating a message asynchronously with Chat REST API.
    name='spaces/SPACE/messages/MESSAGE'

  ).execute()

# Print Chat API's response in your command line interface.
print(result)

  3. W kodzie zastąp następujący fragment:

    • SPACE: name pokoju, w którym została opublikowana wiadomość, który możesz uzyskać, korzystając z metody spaces.list w Chat API lub z adresu URL pokoju.

    • MESSAGE: nazwa wiadomości, którą można uzyskać z treści odpowiedzi zwróconej po utworzeniu wiadomości asynchronicznej za pomocą interfejsu Chat API lub z niestandardową nazwą przypisaną do wiadomości podczas jej tworzenia.

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

    python3 chat_get_message_app.py

Interfejs Chat API zwraca instancję Message, która zawiera szczegóły określonej wiadomości.