メッセージの一覧表示

このガイドでは、Google Chat API の Message リソースで list() メソッドを使用して、スペース内のメッセージのページ分割されたフィルタ可能なリストを表示する方法について説明します。

Chat API では、Chat メッセージは Message リソースで表されます。 Chat ユーザーはテキストを含むメッセージのみを送信できますが、Chat アプリは、静的またはインタラクティブなユーザーインターフェースの表示、ユーザーからの情報の収集、メッセージの非公開配信など、他の多くのメッセージング機能を使用できます。Chat API で使用できるメッセージング機能について詳しくは、 Google Chat メッセージの概要をご覧ください。

前提条件

Node.js

Google Chat へのアクセス権を持つ Business または Enterprise Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Node.js 用 Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。リクエスト:
  - Chat ユーザーとして認証するには、 OAuth クライアント ID 認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとして保存します。
ユーザーとして認証するか、 Chat アプリとして認証するかに応じて、認可スコープを選択します。

Google Chat スペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、次のヘルプセンターのドキュメントをご覧ください。

Python

Google Chat へのアクセス権を持つ Business または Enterprise Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Python 用 Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。リクエスト:
  - Chat ユーザーとして認証するには、 OAuth クライアント ID 認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとして保存します。
ユーザーとして認証するか、 Chat アプリとして認証するかに応じて、認可スコープを選択します。

Google Chat スペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、次のヘルプセンターのドキュメントをご覧ください。

Java

Google Chat へのアクセス権を持つ Business または Enterprise Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Java 用 Cloud クライアントライブラリをインストールします。
- Google Chat API リクエストで認証を行う方法に基づいてアクセス認証情報を作成します。リクエスト:
  - Chat ユーザーとして認証するには、 OAuth クライアント ID 認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとしてローカルディレクトリに保存します。
  - Chat アプリとして認証するには、サービスアカウントの認証情報を作成し、認証情報を credentials.jsonという名前の JSON ファイルとして保存します。
ユーザーとして認証するか、 Chat アプリとして認証するかに応じて、認可スコープを選択します。

Google Chat スペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、次のヘルプセンターのドキュメントをご覧ください。

Apps Script

Google Chat へのアクセス権を持つ Business または Enterprise Google Workspace アカウント。

環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成します。
- Chat アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- スタンドアロンの Apps Script プロジェクトを作成し、高度な Chat サービスを有効にします。
- このガイドでは、ユーザーまたはアプリ認証を使用する必要があります。Chat アプリとして認証するには、サービスアカウントの認証情報を作成します。手順については、 Google Chat アプリとして認証して承認するをご覧ください。
ユーザーとして認証するか、 Chat アプリとして認証するかに応じて、認可スコープを選択します。

Google Chat スペース。Google Chat API を使用して作成するには、スペースを作成するをご覧ください。Chat で作成するには、次のヘルプセンターのドキュメントをご覧ください。

ユーザーとしてメッセージを一覧表示する

ユーザー認証でメッセージを一覧表示するには、リクエストで次の情報を渡します。

chat.messages.readonly または chat.messages 認可スコープを指定します。
ListMessages() メソッドを呼び出します。

次の例では、Chat スペース内のメッセージを一覧表示します。

Node.js

chat/client-libraries/cloud/list-messages-user-cred.js

GitHub で表示

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.messages.readonly',
];

// This sample shows how to list messages with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
  };

  // Make the request
  const pageResult = chatClient.listMessagesAsync(request);

  // Handle the response. Iterating over pageResult will yield results
  // and resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

Python

chat/client-libraries/cloud/list_messages_user_cred.py

GitHub で表示

from authentication_utils import create_client_with_user_credentials
from google.apps import chat_v1 as google_chat

SCOPES = ["https://www.googleapis.com/auth/chat.messages.readonly"]

# This sample shows how to list messages with user credential
def list_messages_with_user_cred():
    # Create a client
    client = create_client_with_user_credentials(SCOPES)

    # Initialize request argument(s)
    request = google_chat.ListMessagesRequest(
        # Replace SPACE_NAME here
        parent = 'spaces/SPACE_NAME',
        # Number of results that will be returned at once
        page_size = 100
    )

    # Make the request
    page_result = client.list_messages(request)

    # Handle the response. Iterating over page_result will yield results and
    # resolve additional pages automatically.
    for response in page_result:
        print(response)

list_messages_with_user_cred()

Java

chat/client-libraries/cloud/src/main/java/com/google/workspace/api/chat/samples/ListMessagesUserCred.java

GitHub で表示

import com.google.chat.v1.ChatServiceClient;
import com.google.chat.v1.ListMessagesRequest;
import com.google.chat.v1.ListMessagesResponse;
import com.google.chat.v1.Message;

// This sample shows how to list messages with user credential.
public class ListMessagesUserCred {

  private static final String SCOPE =
    "https://www.googleapis.com/auth/chat.messages.readonly";

  public static void main(String[] args) throws Exception {
    try (ChatServiceClient chatServiceClient =
        AuthenticationUtils.createClientWithUserCredentials(
          ImmutableList.of(SCOPE))) {
      ListMessagesRequest.Builder request = ListMessagesRequest.newBuilder()
        // Replace SPACE_NAME here.
        .setParent("spaces/SPACE_NAME")
        // Number of results that will be returned at once.
        .setPageSize(10);

      // Iterate over results and resolve additional pages automatically.
      for (Message response :
          chatServiceClient.listMessages(request.build()).iterateAll()) {
        System.out.println(JsonFormat.printer().print(response));
      }
    }
  }
}

Apps Script

chat/advanced-service/Main.gs

GitHub で表示

/**
 * This sample shows how to list messages with user credential
 *
 * It relies on the OAuth2 scope 'https://www.googleapis.com/auth/chat.messages.readonly'
 * referenced in the manifest file (appsscript.json).
 */
function listMessagesUserCred() {
  // Initialize request argument(s)
  // TODO(developer): Replace SPACE_NAME here
  const parent = "spaces/SPACE_NAME";

  // Iterate through the response pages using page tokens
  let responsePage;
  let pageToken = null;
  do {
    // Request response pages
    responsePage = Chat.Spaces.Messages.list(parent, {
      pageSize: 10,
      pageToken: pageToken,
    });
    // Handle response pages
    if (responsePage.messages) {
      for (const message of responsePage.messages) {
        console.log(message);
      }
    }
    // Update the page token to the next one
    pageToken = responsePage.nextPageToken;
  } while (pageToken);
}

このサンプルを実行するには、SPACE_NAME をスペースの name フィールドの ID に置き換えます。ID は、 ListSpaces() メソッドを呼び出すか、スペースの URL から取得できます。

Chat API は、指定されたスペースに送信されたメッセージのリストを返します。リクエストにメッセージがない場合、Chat API レスポンスは空のオブジェクトを返します。REST/HTTP インターフェースを使用する場合、レスポンスには空の JSON オブジェクト{}が含まれます。

Chat アプリとしてメッセージを一覧表示する

アプリ認証には、管理者の 1 回限りの承認が必要です。

Chat REST API を使用してアプリ認証でスペースからメッセージを一覧表示するには、リクエストで次の情報を渡します。

次のいずれかの認可スコープを指定します。
- https://www.googleapis.com/auth/chat.app.messages.readonly
list メソッドを messages リソースで呼び出します。
メッセージを一覧表示するスペースの name を渡します。

Chat API を呼び出すスクリプトを作成する

アプリ認証とChat REST APIを使用してメッセージを一覧表示する方法は次のとおりです。

Python

作業ディレクトリに chat_messages_list_app.py という名前のファイルを作成します。

chat_messages_list_app.py に次のコードを追加します。

from google.oauth2 import service_account
from apiclient.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.app.messages.readonly"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists messages from a specified space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

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

        # The space to list messages from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        parent='spaces/SPACE_NAME'

    ).execute()

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

if __name__ == '__main__':
    main()

コードで、次のように置き換えます。
- SPACE_NAME: スペース名。Chat API の spaces.list メソッドまたはスペースの URL から取得できます。
作業ディレクトリで、サンプルをビルドして実行します。
```
python3 chat_messages_list_app.py
```

メッセージの一覧表示 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

前提条件

Node.js

Python

Java

Apps Script

ユーザーとしてメッセージを一覧表示する

Node.js

Python

Java

Apps Script

Chat アプリとしてメッセージを一覧表示する

Chat API を呼び出すスクリプトを作成する

Python

関連トピック

メッセージの一覧表示