REST Resource: notes

แหล่งข้อมูล: หมายเหตุ

โน้ตเดียว

การแสดง JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "trashTime": string,
  "trashed": boolean,
  "attachments": [
    {
      object (Attachment)
    }
  ],
  "permissions": [
    {
      object (Permission)
    }
  ],
  "title": string,
  "body": {
    object (Section)
  }
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของโน้ตนี้ ดูหมายเหตุทั่วไปเกี่ยวกับตัวระบุใน KeepService
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่สร้างโน้ตนี้
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่แก้ไขโน้ตนี้ครั้งล่าสุด
trashTime

string (Timestamp format)

เอาต์พุตเท่านั้น เวลาที่มีการทิ้งโน้ตนี้ หากเป็น trashed ระบบจะลบโน้ตในที่สุด หากไม่ได้ทิ้งโน้ต ระบบจะไม่ตั้งค่าฟิลด์นี้ (และฟิลด์ที่ทิ้งคือ false)
trashed

boolean

เอาต์พุตเท่านั้น true หากโน้ตนี้ถูกทิ้ง หากย้ายไปอยู่ในถังขยะ ระบบจะลบโน้ตนั้นในที่สุด
attachments[]

object (Attachment)

เอาต์พุตเท่านั้น ไฟล์แนบของโน้ตนี้
permissions[]

object (Permission)

เอาต์พุตเท่านั้น รายการสิทธิ์ที่ตั้งค่าไว้ในโน้ต มีรายการสำหรับเจ้าของโน้ตอย่างน้อย 1 รายการ
title

string

ชื่อโน้ต ความยาวต้องน้อยกว่า 1,000 อักขระ
body

object (Section)

เนื้อความของโน้ต

ไฟล์แนบ

ไฟล์แนบของโน้ต

การแสดง JSON 
{
  "name": string,
  "mimeType": [
    string
  ]
}
ช่อง
name

string

ชื่อทรัพยากร
mimeType[]

string

ประเภท MIME (ประเภทสื่อ IANA) ที่ไฟล์แนบพร้อมใช้งาน

สิทธิ์

สิทธิ์เดียวในโน้ต เชื่อมโยง member กับ role

การแสดง JSON 
{
  "name": string,
  "role": enum (Role),
  "email": string,
  "deleted": boolean,

  // Union field member can be only one of the following:
  "user": {
    object (User)
  },
  "group": {
    object (Group)
  },
  "family": {
    object (Family)
  }
  // End of list of possible types for union field member.
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากร
role

enum (Role)

บทบาทที่ได้รับสิทธิ์นี้ บทบาทจะเป็นตัวกำหนดความสามารถของบุคคลในการอ่าน เขียน และแชร์โน้ต
email

string

อีเมลที่เชื่อมโยงกับสมาชิก หากตั้งค่าไว้เมื่อสร้าง ช่อง email ในข้อความ User หรือ Group ต้องว่างเปล่าหรือตรงกับช่องนี้ เมื่ออ่านแล้ว ระบบอาจไม่ได้ตั้งค่าหากสมาชิกไม่มีอีเมลที่เชื่อมโยง
deleted

boolean

เอาต์พุตเท่านั้น ระบุว่าสมาชิกนี้ถูกลบหรือไม่ หากกู้คืนสมาชิกได้ ระบบจะตั้งค่านี้เป็นเท็จและสมาชิกที่กู้คืนจะยังคงมีบทบาทในโน้ต
ฟิลด์สหภาพ member ระบุข้อมูลประจำตัวที่ได้รับบทบาท ระบบจะไม่ตั้งค่าสมาชิกหากมีการลบสมาชิกออกแล้ว member ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
user

object (User)

เอาต์พุตเท่านั้น ผู้ใช้ที่มีบทบาทนี้
group

object (Group)

เอาต์พุตเท่านั้น กลุ่มที่มีบทบาทนี้
family

object (Family)

เอาต์พุตเท่านั้น ครอบครัว Google ที่มีบทบาทนี้

บทบาท

กำหนดบทบาทต่างๆ ที่เอนทิตีโตนมีได้

Enum
ROLE_UNSPECIFIED บทบาทที่ไม่ระบุ
OWNER บทบาทที่ให้สิทธิ์เข้าถึงแบบเต็ม เพิ่มหรือนำบทบาทนี้ออกไม่ได้ กำหนดโดยผู้สร้างหมายเหตุ
WRITER บทบาทที่ให้สิทธิ์ในการมีส่วนร่วมในเนื้อหาและแก้ไขสิทธิ์ของโน้ต

ผู้ใช้

อธิบายผู้ใช้รายเดียว

การแสดง JSON 
{
  "email": string
}
ช่อง
email

string

อีเมลของผู้ใช้

กลุ่ม

อธิบายกลุ่มเดียว

การแสดง JSON 
{
  "email": string
}
ช่อง
email

string

อีเมลกลุ่ม

ครอบครัว

ประเภทนี้ไม่มีช่อง

อธิบายครอบครัว Google ครอบครัวเดียว

ส่วน

เนื้อหาของโน้ต

การแสดง JSON 
{

  // Union field Content can be only one of the following:
  "text": {
    object (TextContent)
  },
  "list": {
    object (ListContent)
  }
  // End of list of possible types for union field Content.
}
ช่อง
ฟิลด์สหภาพ Content เนื้อหาของส่วนต้องเป็นประเภทค่าอย่างใดอย่างหนึ่งต่อไปนี้ Content ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
text

object (TextContent)

ใช้ในกรณีที่เนื้อหาของส่วนนี้เป็นบล็อกข้อความ เนื้อหาข้อความต้องมีความยาวไม่เกิน 20,000 อักขระ
list

object (ListContent)

ใช้ในกรณีที่เนื้อหาของส่วนนี้เป็นรายการ

TextContent

บล็อกข้อความสำหรับส่วนข้อความหรือรายการรายการเดียว

การแสดง JSON 
{
  "text": string
}
ช่อง
text

string

ข้อความของโน้ต ขีดจํากัดของข้อมูลนี้แตกต่างกันไปตามแต่ละช่องที่ใช้ประเภทนี้

ListContent

รายการของรายการสำหรับโน้ตลิสต์รายการเดียว

การแสดง JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
ช่อง
listItems[]

object (ListItem)

รายการในลิสต์ จำนวนรายการต้องน้อยกว่า 1,000 รายการ

ListItem

รายการลิสต์รายการเดียวในรายการของโน้ต

การแสดง JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
ช่อง
childListItems[]

object (ListItem)

หากตั้งค่าไว้ รายการรายการที่ฝังอยู่ภายใต้รายการนี้ อนุญาตให้ฝังได้เพียง 1 ระดับเท่านั้น
text

object (TextContent)

ข้อความของรายการนี้ ความยาวต้องน้อยกว่า 1,000 อักขระ
checked

boolean

มีการเลือกรายการนี้หรือไม่

เมธอด

create

 สร้างโน้ตใหม่

delete

 ลบโน้ต

get

 รับโน้ต

list

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