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 הוא 1, ההערה נמחקת בסופו של דבר. אם ההערה לא הועברה לאשפה, השדה הזה לא מוגדר (והשדה 'אשפה' הוא false).
trashed

boolean

פלט בלבד. true אם ההערה הזו הועברה לאשפה. אם ההערה תועבר לאשפה, היא תימחק בסופו של דבר.
attachments[]

object (Attachment)

פלט בלבד. הקבצים שמצורפים לפתק הזה.
permissions[]

object (Permission)

פלט בלבד. רשימת ההרשאות שהוגדרו בהערה. מכיל לפחות רשומה אחת של בעל ההערה.
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 לא מוגדר. הערך של 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

אם הפריט הזה מסומן או לא.

Methods

create

 יצירת הערה חדשה.

delete

 מחיקת פתק.

get

 מקבלת הערה.

list

 הצגת רשימה של הערות.