Method: spaces.messages.patch

メッセージを更新します。patch メソッドと update メソッドには違いがあります。patch メソッドは patch リクエストを使用し、update メソッドは put リクエストを使用します。patch メソッドを使用することをおすすめします。例については、メッセージを更新するをご覧ください。

次のタイプの認証をサポートしています。

  • 認可スコープを使用したアプリ認証:

    • https://www.googleapis.com/auth/chat.bot

  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import（インポート モードのスペースのみ）

アプリ認証を使用する場合、リクエストで更新できるのは、呼び出し元の Chat 用アプリによって作成されたメッセージのみです。

HTTP リクエスト

PATCH https://chat.googleapis.com/v1/{message.name=spaces/*/messages/*}

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
message.name

string

ID。メッセージのリソース名。

形式: spaces/{space}/messages/{message}

ここで、{space} はメッセージが投稿されたスペースの ID、{message} はシステムによって割り当てられたメッセージの ID です。例: spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB

メッセージの作成時にカスタム ID を設定した場合は、この ID を使用してリクエストでメッセージを指定できます。その際は、{message} を clientAssignedMessageId フィールドの値に置き換えます。例: spaces/AAAAAAAAAAA/messages/client-custom-name。詳しくは、メッセージに名前を付けるをご覧ください。

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

必須。更新するフィールド パス。複数の値を指定する場合はカンマで区切るか、* を使用してすべてのフィールド パスを更新します。

現在サポートされているフィールド パス:
allowMissing

boolean

省略可。true とメッセージが見つからない場合は、新しいメッセージが作成され、updateMask は無視されます。指定されたメッセージ ID はクライアント割り当てである必要があります。そうでない場合、リクエストは失敗します。

リクエストの本文

リクエストの本文には Message のインスタンスが含まれます。

レスポンスの本文

成功した場合、レスポンスの本文には Message のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages

詳しくは、承認ガイドをご覧ください。