Method: spaces.messages.patch

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
message.name

string

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

形式: 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

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