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

เอาต์พุตเท่านั้น สมาชิกรายนี้ถูกลบแล้วหรือไม่ หากมีการกู้คืนสมาชิก ค่านี้จะตั้งเป็น "เท็จ" และสมาชิกที่ได้รับการกู้คืนจะยังคงมีบทบาทในโน้ตอยู่
ช่อง Union 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 Family รายการเดียว

ส่วน

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

การแสดง 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.
}
ช่อง
ช่อง Union Content เนื้อหาของส่วนนี้ต้องเป็นประเภทค่าเหล่านี้ Content ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้
text

object (TextContent)

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

object (ListContent)

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

เนื้อหาข้อความ

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

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

string

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

เนื้อหารายการ

รายการสินค้าสําหรับโน้ตเดียว

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

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