セクションを更新する

このガイドでは、Google Chat API の Section リソースの patch メソッドを使用して、Google Chat のカスタム セクションを更新する方法について説明します。

更新できるのは、タイプ CUSTOM_SECTION のセクションのみです。詳しくは、Google Chat でセクションを作成して整理するをご覧ください。

前提条件

Python

セクションを更新する

ユーザー認証を使用してセクションを更新するには、リクエストで次の情報を渡します。

  • chat.users.sections 認証スコープを指定します。
  • UpdateSection メソッドを呼び出します。
  • リクエストの本文に、Section リソースとフィールド マスクを指定します。
    • 更新するセクションの name を設定します。
    • displayName をセクションの新しい名前に設定します。
    • updateMask を displayName に設定します。

次の例では、セクションを更新します。

Python

from google.cloud import chat_v1
from google.protobuf import field_mask_pb2

def update_section():
    # Create a client
    client = chat_v1.ChatServiceClient()

    # Initialize request
    request = chat_v1.UpdateSectionRequest(
        section=chat_v1.Section(
            name="SECTION_NAME",
            display_name="NEW_SECTION_DISPLAY_NAME"
        ),
        update_mask=field_mask_pb2.FieldMask(paths=["display_name"])
    )

    # Make the request
    response = client.update_section(request=request)

    print(response)

このサンプルを実行するには、次の値を置き換えます。

  • SECTION_NAME: セクションのリソース名。リソース名を取得するには、ListSections メソッドを呼び出します。
  • NEW_SECTION_DISPLAY_NAME: セクションの新しい名前。

Chat API は、更新された Section のインスタンスを返します。