منبع: توجه
یک یادداشت واحد
نمایندگی JSON |
---|
{ "name": string, "createTime": string, "updateTime": string, "trashTime": string, "trashed": boolean, "attachments": [ { object ( |
فیلدها | |
---|---|
name | فقط خروجی نام منبع این یادداشت. به یادداشت کلی در مورد شناسه ها در KeepService مراجعه کنید. |
createTime | فقط خروجی زمانی که این یادداشت ایجاد شد. |
updateTime | فقط خروجی آخرین باری که این یادداشت اصلاح شد. |
trashTime | فقط خروجی وقتی این یادداشت حذف شد. در صورت |
trashed | فقط خروجی اگر این یادداشت حذف شده باشد |
attachments[] | فقط خروجی پیوست های پیوست شده به این یادداشت |
permissions[] | فقط خروجی لیست مجوزهای تنظیم شده در یادداشت. حاوی حداقل یک ورودی برای صاحب یادداشت است. |
title | عنوان یادداشت. طول باید کمتر از 1000 کاراکتر باشد. |
body | بدنه یادداشت. |
پیوست
پیوست به یادداشت.
نمایندگی JSON |
---|
{ "name": string, "mimeType": [ string ] } |
فیلدها | |
---|---|
name | نام منبع؛ |
mimeType[] | انواع MIME (انواع رسانه IANA) که در آنها پیوست موجود است. |
اجازه
یک مجوز واحد در یادداشت. member
با یک role
مرتبط می کند.
نمایندگی JSON |
---|
{ "name": string, "role": enum ( |
فیلدها | |
---|---|
name | فقط خروجی نام منبع |
role | نقش اعطا شده توسط این مجوز. این نقش توانایی نهاد را برای خواندن، نوشتن و اشتراکگذاری یادداشتها تعیین میکند. |
email | ایمیل مرتبط با عضو اگر روی ایجاد تنظیم شده باشد، فیلد |
deleted | فقط خروجی آیا این عضو حذف شده است. اگر عضو بازیابی شود، این مقدار روی false تنظیم می شود و عضو بازیابی شده نقش روی یادداشت را حفظ می کند. |
member میدان اتحادیه هویت اعطا شده به نقش را مشخص می کند. اگر عضو حذف شده باشد، عضو تنظیم نشده است. member فقط می تواند یکی از موارد زیر باشد: | |
user | فقط خروجی کاربری که این نقش برای او اعمال می شود. |
group | فقط خروجی گروهی که این نقش در مورد آنها اعمال می شود. |
family | فقط خروجی خانواده Google که این نقش برای آن اعمال می شود. |
نقش
نقش های مختلفی را که یک موجودیت می تواند داشته باشد را تعریف می کند.
Enums | |
---|---|
ROLE_UNSPECIFIED | نقشی تعریف نشده |
OWNER | نقشی که دسترسی کامل را اعطا می کند. این نقش را نمی توان اضافه یا حذف کرد. توسط سازنده یادداشت تعریف شده است. |
WRITER | نقشی که امکان مشارکت در محتوا و اصلاح مجوزهای یادداشت را اعطا می کند. |
کاربر
یک کاربر را توصیف می کند.
نمایندگی JSON |
---|
{ "email": string } |
فیلدها | |
---|---|
email | ایمیل کاربر. |
گروه
یک گروه واحد را توصیف می کند.
نمایندگی JSON |
---|
{ "email": string } |
فیلدها | |
---|---|
email | ایمیل گروه |
خانواده
این نوع هیچ فیلدی ندارد.
یک خانواده Google را توصیف می کند.
بخش
محتوای یادداشت.
نمایندگی JSON |
---|
{ // Union field |
فیلدها | |
---|---|
Content فیلد اتحادیه محتوای بخش باید یکی از این انواع ارزش باشد. Content فقط می تواند یکی از موارد زیر باشد: | |
text | اگر محتوای این بخش یک بلوک متن باشد استفاده می شود. طول محتوای متن باید کمتر از 20000 کاراکتر باشد. |
list | اگر محتوای این بخش یک لیست باشد استفاده می شود. |
محتوای متنی
بلوک متن برای یک بخش متنی یا آیتم فهرست.
نمایندگی JSON |
---|
{ "text": string } |
فیلدها | |
---|---|
text | متن یادداشت. محدودیتهای این مورد با فیلد خاصی که از این نوع استفاده میکند، متفاوت است. |
فهرست محتوا
فهرست موارد برای یک یادداشت فهرست واحد.
نمایندگی JSON |
---|
{
"listItems": [
{
object ( |
فیلدها | |
---|---|
listItems[] | موارد موجود در لیست تعداد موارد باید کمتر از 1000 باشد. |
List Item
یک مورد فهرست واحد در فهرست یادداشت.
نمایندگی JSON |
---|
{ "childListItems": [ { object ( |
فیلدها | |
---|---|
childListItems[] | در صورت تنظیم، فهرستی از موارد فهرست که در زیر این مورد فهرست قرار دارند. فقط یک سطح لانه سازی مجاز است. |
text | متن این مطلب طول باید کمتر از 1000 کاراکتر باشد. |
checked | آیا این مورد بررسی شده است یا خیر. |
روش ها | |
---|---|
| یک یادداشت جدید ایجاد می کند. |
| یک یادداشت را حذف می کند. |
| یادداشت می گیرد. |
| یادداشت ها را فهرست می کند. |