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

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

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

object (TextContent)

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

boolean

รายการนี้ถูกขีดฆ่าแล้วหรือไม่

เมธอด

create

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

delete

 ลบโน้ต

get

 รับโน้ต

list

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