Method: notes.list

แสดงรายการโน้ต

การเรียกใช้รายการทุกรายการจะแสดงผลลัพธ์ 1 หน้าโดยมี pageSize เป็นขีดจำกัดบนของรายการที่แสดง pageSize ที่เป็น 0 จะช่วยให้เซิร์ฟเวอร์เลือกขีดจำกัดบนได้

ListNotesResponse มีรายการได้สูงสุด pageSize รายการ หากยังมีรายการอื่นๆ เหลืออยู่ ระบบจะแสดงค่า nextPageToken (โทเค็นหน้าคือค่าแบบทึบ)

หากต้องการดูผลการค้นหาหน้าถัดไป ให้คัดลอก nextPageToken ของผลการค้นหาลงใน pageToken ของคําขอถัดไป ทำซ้ำจนกว่า nextPageToken ที่แสดงผลพร้อมกับหน้าผลการค้นหาจะว่างเปล่า

notes.list จะแสดงผลลัพธ์ที่สอดคล้องกันเมื่อเกิดการเปลี่ยนแปลงพร้อมกัน หรือจะแสดงสัญญาณว่าดำเนินการไม่ได้พร้อมข้อผิดพลาด "ยกเลิก"

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์การค้นหา

พารามิเตอร์
pageSize

integer

จำนวนผลลัพธ์สูงสุดที่จะแสดง
pageToken

string

ช่อง nextPageToken ของหน้าก่อนหน้า
filter

string

กรองผลการค้นหารายการ หากไม่ได้ระบุตัวกรอง ระบบจะใช้ตัวกรอง trashed โดยค่าเริ่มต้น ฟิลด์ที่ใช้กรองได้ ได้แก่ createTime, updateTime, trashTime และ trashed

ไวยากรณ์ตัวกรองเป็นไปตามข้อกำหนดการกรอง AIP ของ Google

เนื้อหาของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

การตอบสนองเมื่อแสดงรายการโน้ต 1 หน้า

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง 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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์