Method: spaces.messagePins.list

スペース内のメッセージのピン留めの一覧を取得します。スペースで重要なメッセージをピン留めして、簡単にアクセスできるようにすることができます。詳しくは、Google Chat で会話を固定または固定解除するをご覧ください。

次のいずれかの認可スコープを使用したユーザー認証が必要です。

  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces

HTTP リクエスト

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messagePins

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

パスパラメータ

パラメータ
parent

string

必須。固定アイテムのコレクションを所有する親スペース。形式: spaces/{space}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返されるメッセージのピン留めの最大数。サービスが返すメッセージの数は、この値よりも少ないことがあります。最大値は 100 です。100 を超える値を使用すると、自動的に 100 に変更されます。指定されていない場合は、最大で 100 件のメッセージのピン留めが返されます。負の値は INVALID_ARGUMENT エラーを返します。
pageToken

string

省略可。前回の list メッセージのピン留め呼び出しから受け取ったページトークン。後続のページを取得するには、このパラメータを指定します。

ページ分割を行う場合、指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。他のパラメータに異なる値を渡すと、予期しない結果が生じる可能性があります。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

メッセージのピン留めを一覧表示するためのレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
フィールド
messagePins[]

object (MessagePin)

指定されたスペースの固定メッセージ。
nextPageToken

string

トークンを pageToken として送信して、結果の次のページを取得できます。空の場合、後続のページはありません。

認可スコープ

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

  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly

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