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)

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

תפקיד

מגדיר את התפקידים השונים שיכולים להיות לישות.

Enums
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)

משמש אם התוכן של קטע זה הוא רשימה.

תוכן טקסט

קטע הטקסט של קטע טקסט יחיד או של פריט רשימה.

ייצוג JSON 
{
  "text": string
}
שדות
text

string

הטקסט של ההערה. המגבלות על האפשרות הזו משתנות עם השדה הספציפי מהסוג הזה.

תוכן רשימה

רשימת הפריטים של הערה יחידה ברשימה.

ייצוג JSON 
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
שדות
listItems[]

object (ListItem)

הפריטים ברשימה. מספר הפריטים חייב להיות פחות מ-1,000.

פריט ברשימה

פריט אחד ברשימה של הערה.

ייצוג JSON 
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
שדות
childListItems[]

object (ListItem)

אם המדיניות מוגדרת, רשימת פריטי רשימה מקוננים מתחת לפריט הרשימה הזה. מותר לקנן ברמה אחת בלבד.
text

object (TextContent)

הטקסט של הפריט הזה. האורך חייב להיות פחות מ-1,000 תווים.
checked

boolean

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

שיטות

create

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

delete

 מחיקת הערה.

get

 מקבל הערה.

list

 הצגת הערות.