このガイドでは、Google Chat API の SectionItem リソースで list メソッドを使用して、セクション内のアイテム(スペースなど)を一覧表示する方法について説明します。
セクション アイテムにできるのはスペースのみです。詳しくは、Google Chat でセクションを作成して整理するをご覧ください。
前提条件
Python
- Google Chat へのアクセス権を持つ Business または Enterprise の Google Workspace アカウント。
- 環境を設定します。
- Google Cloud プロジェクトを作成します。
- OAuth 同意画面を構成する。
- Chat 用アプリの名前、アイコン、説明を使用して、Google Chat API を有効にして構成します。
- Python Cloud クライアント ライブラリをインストールします。
- デスクトップ アプリケーション用の
OAuth クライアント ID 認証情報を作成します。このガイドのサンプルを実行するには、認証情報を
credentials.jsonという名前の JSON ファイルとしてローカル ディレクトリに保存します。
- ユーザー認証をサポートする 認可スコープを選択します。
セクション内のスペースを一覧表示する
ユーザー認証を使用してセクション内のスペースを一覧表示するには、リクエストで次の値を渡します。
chat.users.sectionsまたはchat.users.sections.readonly認証スコープを指定します。ListSectionItemsメソッドを呼び出します。parentをセクションのリソース名に設定します。
次の例では、セクション内のスペースを一覧表示します。
Python
from google.cloud import chat_v1
def list_section_items():
# Create a client
client = chat_v1.ChatServiceClient()
# Initialize request
request = chat_v1.ListSectionItemsRequest(
parent="SECTION_NAME"
)
# Make the request
page_result = client.list_section_items(request=request)
# Handle the response
for item in page_result:
print(item)
このサンプルを実行するには、次の値を置き換えます。
SECTION_NAME: セクションのリソース名。リソース名を取得するには、ListSectionsメソッドを呼び出します。
Chat API は、SectionItem リソースのリストを返します。