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 שעליה חל התפקיד הזה.

תפקיד

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

טיפוסים בני מנייה (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

 בתיבת הדו-שיח הזו מופיעה רשימה של הערות.