משאב: הערה
הערה אחת.
ייצוג JSON |
---|
{ "name": string, "createTime": string, "updateTime": string, "trashTime": string, "trashed": boolean, "attachments": [ { object ( |
שדות | |
---|---|
name |
פלט בלבד. שם המשאב של ההערה הזו. יש לעיין בהערה כללית לגבי מזהים ב-KeepService. |
createTime |
פלט בלבד. כשההערה הזו נוצרה. |
updateTime |
פלט בלבד. תאריך השינוי האחרון של ההערה. |
trashTime |
פלט בלבד. כשההערה הזו הועברה לאשפה. אם |
trashed |
פלט בלבד. |
attachments[] |
פלט בלבד. הקבצים המצורפים להערה הזו. |
permissions[] |
פלט בלבד. רשימת ההרשאות שהוגדרו בהערה. מכיל לפחות רשומה אחת של בעל ההערה. |
title |
הכותרת של ההערה. האורך חייב להיות פחות מ-1,000 תווים. |
body |
גוף ההערה. |
קובץ מצורף
קובץ מצורף להערה.
ייצוג JSON |
---|
{ "name": string, "mimeType": [ string ] } |
שדות | |
---|---|
name |
שם המשאב; |
mimeType[] |
סוגי MIME (סוגי מדיה של IANA) שבהם הקובץ המצורף זמין. |
הרשאה
הרשאה אחת בהערה. משייכת member
עם role
.
ייצוג JSON |
---|
{ "name": string, "role": enum ( |
שדות | |
---|---|
name |
פלט בלבד. שם המשאב |
role |
התפקיד שקיבל ההרשאה הזו. התפקיד קובע את יכולתה של הישות לקרוא, לכתוב ולשתף הערות. |
email |
כתובת האימייל שמשויכת לחבר הקבוצה. אם בחרתם באפשרות 'יצירה', השדה |
deleted |
פלט בלבד. אם חבר זה נמחק. אם חברי הקבוצה ישוחזרו, הערך הזה יהיה False והחבר שקיבל את התפקיד ישמור על ההערה. |
שדה איחוד member . מציין את הזהות שניתנה לתפקיד. סטטוס החברות של חבר הקבוצה בוטל. member יכול להיות רק אחד מהבאים: |
|
user |
פלט בלבד. המשתמש שעליו התפקיד הזה חל. |
group |
פלט בלבד. הקבוצה שעליה חל התפקיד הזה. |
family |
פלט בלבד. משפחת Google שעליה התפקיד הזה חל. |
תפקיד
מגדיר את התפקידים השונים שיכולים להיות לישות.
Enums | |
---|---|
ROLE_UNSPECIFIED |
תפקיד לא מוגדר. |
OWNER |
תפקיד המעניק גישה מלאה. לא ניתן להוסיף או להסיר את התפקיד הזה. ההגדרה נקבעה על ידי מי שיצר את ההערה. |
WRITER |
תפקיד המעניק את היכולת לתרום תוכן ולשנות הרשאות הערות. |
משתמש
מתאר משתמש יחיד.
ייצוג JSON |
---|
{ "email": string } |
שדות | |
---|---|
email |
כתובת האימייל של המשתמש. |
קבוצה
מתאר קבוצה אחת.
ייצוג JSON |
---|
{ "email": string } |
שדות | |
---|---|
email |
האימייל של הקבוצה. |
משפחתי
מתאר משפחת Google אחת.
קטע
תוכן ההערה.
ייצוג JSON |
---|
{ // Union field |
שדות | |
---|---|
שדה איחוד Content . תוכן הקטע חייב להיות אחד מסוגי הערכים האלה. Content יכול להיות רק אחד מהבאים: |
|
text |
משמש אם התוכן של קטע זה הוא גוש טקסט. האורך של תוכן הטקסט חייב להיות קצר מ-20,000 תווים. |
list |
משמש אם התוכן של קטע זה הוא רשימה. |
תוכן טקסט
קטע הטקסט של קטע טקסט יחיד או של פריט רשימה.
ייצוג JSON |
---|
{ "text": string } |
שדות | |
---|---|
text |
הטקסט של ההערה. המגבלות על האפשרות הזו משתנות עם השדה הספציפי מהסוג הזה. |
תוכן רשימה
רשימת הפריטים של הערה יחידה ברשימה.
ייצוג JSON |
---|
{
"listItems": [
{
object ( |
שדות | |
---|---|
listItems[] |
הפריטים ברשימה. מספר הפריטים חייב להיות פחות מ-1,000. |
פריט ברשימה
פריט אחד ברשימה של הערה.
ייצוג JSON |
---|
{ "childListItems": [ { object ( |
שדות | |
---|---|
childListItems[] |
אם המדיניות מוגדרת, רשימת פריטי רשימה מקוננים מתחת לפריט הרשימה הזה. מותר לקנן ברמה אחת בלבד. |
text |
הטקסט של הפריט הזה. האורך חייב להיות פחות מ-1,000 תווים. |
checked |
גם אם הפריט הזה סומן וגם אם לא. |
שיטות |
|
---|---|
|
יצירת הערה חדשה. |
|
מחיקת הערה. |
|
מקבל הערה. |
|
הצגת הערות. |