このページは Cloud Translation API によって翻訳されました。

Method: spaces.messages.patch

HTTP リクエスト
パスパラメータ
クエリパラメータ
リクエストの本文
レスポンスの本文
認可スコープ
試してみる

メッセージを更新します。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` ID。メッセージのリソース名。形式: `spaces/{space}/messages/{message}` ここで、`{space}` はメッセージが投稿されているスペースの ID、`{message}` はシステムによって割り当てられたメッセージ ID です。例: `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB` メッセージの作成時にカスタム ID を設定する場合、`{message}` を `clientAssignedMessageId` フィールドの値に置き換えることで、この ID を使用してリクエストでメッセージを指定できます。例: `spaces/AAAAAAAAAAA/messages/client-custom-name`。詳しくは、メッセージに名前を付けるをご覧ください。

message.name

string

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

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

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

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

クエリパラメータ

パラメータ

パラメータ
`updateMask`	`string (FieldMask format)` 必須。更新するフィールドパス。複数の値をカンマで区切るか、`*` を使用してすべてのフィールドパスを更新します。現在サポートされているフィールドパスは次のとおりです。 `text` `attachment` `cards`（アプリの認証が必要です） `cardsV2`（アプリの認証が必要です） `accessoryWidgets`（アプリの認証が必要です）
`allowMissing`	`boolean` 省略可。`true` とメッセージが見つからない場合は、新しいメッセージが作成され、`updateMask` は無視されます。指定したメッセージ ID はクライアントが割り当てた ID である必要があります。そうでない場合、リクエストは失敗します。

updateMask

string (FieldMask format)

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

現在サポートされているフィールドパスは次のとおりです。

text
attachment
cards（アプリの認証が必要です）
cardsV2（アプリの認証が必要です）
accessoryWidgets（アプリの認証が必要です）

allowMissing

boolean

省略可。true とメッセージが見つからない場合は、新しいメッセージが作成され、updateMask は無視されます。指定したメッセージ ID はクライアントが割り当てた 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

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