Method: notes.list

یادداشت ها را فهرست می کند.

هر فراخوانی فهرستی صفحه ای از نتایج را با pageSize به عنوان کران بالای آیتم های برگشتی برمی گرداند. pageSize صفر به سرور اجازه می دهد تا کران بالایی را انتخاب کند.

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.