このガイドでは、Google Chat API の Section リソースで
position
メソッドを使用して、Google Chat のセクションの並べ替え順序を変更する方法について説明します。
詳細については、 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認可スコープを指定します。PositionSectionメソッドを呼び出します。- リクエストの本文で、配置するセクションの
nameと新しい位置を指定します。sortOrderを絶対位置(0 より大きい)に設定します。- または、
relativePositionをSTARTまたはENDに設定します。
次の例では、セクションをリストの先頭に移動します。
Python
from google.cloud import chat_v1
def position_section():
# Create a client
client = chat_v1.ChatServiceClient()
# Initialize request
request = chat_v1.PositionSectionRequest(
name="SECTION_NAME",
relative_position=chat_v1.PositionSectionRequest.Position.START
)
# Make the request
response = client.position_section(request=request)
print(response)
このサンプルを実行するには、次の値を置き換えます。
SECTION_NAME: セクションのリソース名。リソース名は、ListSectionsメソッドを呼び出すことで取得できます。
Chat API は、更新されたインスタンスを返します
Section。