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

النتائج فقط. ما إذا تم حذف هذا العضو إذا تم استرداد المستخدم، يتم ضبط هذه القيمة على خطأ ويحتفظ المستخدم المستردّ بدوره في الملاحظة.
حقل الربط 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

عنوان البريد الإلكتروني للمجموعة

Family

لا يحتوي هذا النوع على أي حقول.

يصف عائلة واحدة على 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

 يعرض الملاحظات.