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

تمثل هذه الخاصية عنوان الملاحظة. يجب أن يكون الطول أقل من 1000 حرف.

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

الإخراج فقط. ما إذا تم حذف هذا العضو. في حال استرداد العضو، يتم تعيين هذه القيمة إلى "خطأ" ويحتفظ العضو الذي تم استرداده بالدور في الملاحظة.

حقل الاتحاد member. لتحديد الهوية التي تم منحها للدور. عدم ضبط العضو إذا تم حذف العضو. يمكن أن يكون member واحدًا مما يلي فقط:
user

object (User)

الإخراج فقط. المستخدم الذي ينطبق عليه هذا الدور.

group

object (Group)

الإخراج فقط. المجموعة التي ينطبق عليها هذا الدور.

family

object (Family)

الإخراج فقط. عائلة Google التي ينطبق عليها هذا الدور.

الدور

تحدد الأدوار المختلفة التي يمكن أن يمتلكها الكيان.

عمليات التعداد
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)

يتم استخدامه إذا كان محتوى هذا القسم عبارة عن جزء من نص. يجب أن يكون طول المحتوى النصي أقل من 20000 حرف.

list

object (ListContent)

يتم استخدامه إذا كان محتوى هذا القسم على شكل قائمة.

محتوى النص

الجزء النصي من قسم نص أو عنصر قائمة واحد.

تمثيل JSON
{
  "text": string
}
الحقول
text

string

نص الملاحظة. وتختلف الحدود القصوى المسموح بها على هذا الحقل المحدَّد باستخدام هذا النوع.

محتوى القائمة

قائمة العناصر لملاحظة قائمة واحدة.

تمثيل JSON
{
  "listItems": [
    {
      object (ListItem)
    }
  ]
}
الحقول
listItems[]

object (ListItem)

العناصر في القائمة. يجب أن يكون عدد العناصر أقل من 1000.

ListItem

عنصر قائمة واحد في قائمة ملاحظة.

تمثيل JSON
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
الحقول
childListItems[]

object (ListItem)

في حالة التعيين، قم بإدراج عناصر القائمة المدمجة ضمن عنصر القائمة هذا. مسموح بمستوى واحد فقط من التداخل.

text

object (TextContent)

نص هذا العنصر. يجب أن يكون الطول أقل من 1000 حرف.

checked

boolean

ما إذا تم وضع علامة على هذا العنصر أم لا.

الطُرق

create

لإنشاء ملاحظة جديدة.

delete

حذف ملاحظة.

get

الحصول على ملاحظة.

list

يسرد الملاحظات.