Method: users.spaces.threads.updateThreadReadState

スレッド内のユーザーの既読状態を更新します。既読メッセージと未読メッセージを識別するために使用されます。例については、ユーザーのスレッドの既読状態を更新するをご覧ください。

認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.users.readstate

HTTP リクエスト

PATCH https://chat.googleapis.com/v1/{threadReadState.name=users/*/spaces/*/threads/*/threadReadState}

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

パスパラメータ

パラメータ
threadReadState.name

string

スレッドの既読状態のリソース名。

形式: users/{user}/spaces/{space}/threads/{thread}/threadReadState

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

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

  • lastReadTime

lastReadTime が最新のメッセージの作成時刻より前の場合、スレッドは UI で未読として表示されます。

スレッドを既読としてマークするには、lastReadTime を最新のメッセージの作成時刻以降のタイムスタンプに設定します。将来のタイムスタンプは、現在のリクエスト時刻に強制変換されます。負のタイムスタンプ(1970-01-01T00:00:00Z より前)を設定すると、INVALID_ARGUMENT エラーが返されます。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/chat.users.readstate

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