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

فقط خروجی آیا این عضو حذف شده است. اگر عضو بازیابی شود، این مقدار روی false تنظیم می شود و عضو بازیابی شده نقش روی یادداشت را حفظ می کند.

member میدان اتحادیه هویت اعطا شده به نقش را مشخص می کند. اگر عضو حذف شده باشد، عضو تنظیم نشده است. member فقط می تواند یکی از موارد زیر باشد:
user

object ( User )

فقط خروجی کاربری که این نقش برای او اعمال می شود.

group

object ( Group )

فقط خروجی گروهی که این نقش در مورد آنها اعمال می شود.

family

object ( Family )

فقط خروجی خانواده Google که این نقش برای آن اعمال می شود.

نقش

نقش های مختلفی را که یک موجودیت می تواند داشته باشد را تعریف می کند.

Enums
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 باشد.

List Item

یک مورد فهرست واحد در فهرست یادداشت.

نمایندگی JSON
{
  "childListItems": [
    {
      object (ListItem)
    }
  ],
  "text": {
    object (TextContent)
  },
  "checked": boolean
}
فیلدها
childListItems[]

object ( ListItem )

در صورت تنظیم، فهرستی از موارد فهرست که در زیر این مورد فهرست قرار دارند. فقط یک سطح لانه سازی مجاز است.

text

object ( TextContent )

متن این مطلب طول باید کمتر از 1000 کاراکتر باشد.

checked

boolean

آیا این مورد بررسی شده است یا خیر.

روش ها

create

یک یادداشت جدید ایجاد می کند.

delete

یک یادداشت را حذف می کند.

get

یادداشت می گیرد.

list

یادداشت ها را فهرست می کند.