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

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