Method: notes.list

メモを一覧表示します。

リスト呼び出しごとに、返されるアイテムの上限として pageSize を含む結果ページが返されます。pageSize を 0 にすると、サーバーが上限を選択できます。

ListNotesResponse には最大 pageSize 個のエントリが含まれます。一覧表示する項目がさらにある場合は、nextPageToken 値が返されます。（ページトークンは不透明な値です）。

次のページの結果を取得するには、結果の nextPageToken を次のリクエストの pageToken にコピーします。結果のページとともに返される nextPageToken が空になるまで繰り返します。

notes.list は、同時変更が発生した場合でも一貫した結果を返します。また、ABORTED エラーで、返せないことを通知します。

HTTP リクエスト

GET https://keep.googleapis.com/v1/notes

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

クエリ パラメータ

パラメータ
pageSize

integer

返される結果の最大件数です。
pageToken

string

前のページの nextPageToken フィールド。
filter

string

リスト結果をフィルタします。フィルタが指定されていない場合、デフォルトで trashed フィルタが適用されます。フィルタに使用できる有効なフィールドは、createTime、updateTime、trashTime、trashed です。

フィルタの構文は、Google AIP フィルタリング仕様に従います。

リクエストの本文

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

レスポンスの本文

メモのページをリストしたときのレスポンス。

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

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

object (Note)

メモのページ。
nextPageToken

string

次のページの pageToken フィールド。

認可スコープ

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

  • https://www.googleapis.com/auth/keep
  • https://www.googleapis.com/auth/keep.readonly

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