REST Resource: tasks

منبع: وظیفه

نمایش JSON 
{
  "kind": string,
  "id": string,
  "etag": string,
  "title": string,
  "updated": string,
  "selfLink": string,
  "parent": string,
  "position": string,
  "notes": string,
  "status": string,
  "due": string,
  "completed": string,
  "deleted": boolean,
  "hidden": boolean,
  "links": [
    {
      "type": string,
      "description": string,
      "link": string
    }
  ],
  "webViewLink": string,
  "assignmentInfo": {
    object (AssignmentInfo)
  }
}
فیلدها
kind

string

فقط خروجی. نوع منبع. این همیشه "tasks#task" است.

id

string

شناسه وظیفه.

etag

string

برچسب منبع (ETag).

title

string

عنوان وظیفه. حداکثر طول مجاز: ۱۰۲۴ کاراکتر.

updated

string

فقط خروجی. آخرین زمان اصلاح وظیفه (به عنوان مهر زمانی RFC 3339).

parent

string

فقط خروجی. شناسه وظیفه والد. اگر وظیفه سطح بالا باشد، این فیلد حذف می‌شود. از متد "move" برای انتقال وظیفه به زیر یک والد متفاوت یا به سطح بالا استفاده کنید. وظیفه والد هرگز نمی‌تواند یک وظیفه اختصاص داده شده باشد (از فضاهای چت، اسناد). این فیلد فقط خواندنی است.

position

string

فقط خروجی. رشته‌ای که موقعیت وظیفه را در بین وظایف خواهر و برادر خود تحت همان وظیفه والد یا در سطح بالا نشان می‌دهد. اگر این رشته بر اساس ترتیب لغوی بزرگتر از رشته موقعیت متناظر وظیفه دیگر باشد، وظیفه پس از وظیفه دیگر تحت همان وظیفه والد (یا در سطح بالا) قرار می‌گیرد. از روش "move" برای انتقال وظیفه به موقعیت دیگر استفاده کنید.

notes

string

یادداشت‌هایی که وظیفه را شرح می‌دهند. وظایفی که از Google Docs تعیین می‌شوند نمی‌توانند یادداشت داشته باشند. اختیاری. حداکثر طول مجاز: ۸۱۹۲ کاراکتر.

status

string

وضعیت وظیفه. این یا "نیاز به اقدام" است یا "تکمیل شده".

due

string

تاریخ زمان‌بندی‌شده برای وظیفه (به‌صورت یک مهر زمانی RFC 3339). اختیاری. این نشان‌دهنده روزی است که وظیفه باید انجام شود، یا اینکه وظیفه در جدول تقویم قابل مشاهده است. این نشان‌دهنده مهلت وظیفه نیست. فقط اطلاعات تاریخ ثبت می‌شود؛ بخش زمانی مهر زمانی هنگام تنظیم این فیلد حذف می‌شود. خواندن یا نوشتن زمانی که یک وظیفه برای آن زمان‌بندی شده است با استفاده از API امکان‌پذیر نیست.

completed

string

تاریخ تکمیل وظیفه (به عنوان مهر زمانی RFC 3339). اگر وظیفه تکمیل نشده باشد، این فیلد حذف می‌شود.

deleted

boolean

پرچمی که نشان می‌دهد آیا وظیفه حذف شده است یا خیر. برای وظایف واگذار شده، این فیلد فقط خواندنی است. آن‌ها را فقط می‌توان با فراخوانی tasks.delete حذف کرد، که در این صورت هم وظیفه واگذار شده و هم وظیفه اصلی (در Docs یا Chat Spaces) حذف می‌شوند. برای حذف فقط وظیفه واگذار شده، به سطح واگذاری بروید و وظیفه را از آنجا لغو واگذاری کنید. مقدار پیش‌فرض False است.

hidden

boolean

پرچمی که نشان می‌دهد آیا وظیفه پنهان است یا خیر. این در صورتی است که وظیفه هنگام آخرین پاک کردن لیست وظایف، به عنوان «کامل‌شده» علامت‌گذاری شده باشد. مقدار پیش‌فرض False است. این فیلد فقط خواندنی است.

links[].type

string

نوع لینک، مثلاً "email"، "generic"، "chat_message"، "keep_note".

links[].description

string

توضیحات (ممکن است خالی باشد).

links[].link

string

آدرس اینترنتی (URL).

assignmentInfo

object ( AssignmentInfo )

فقط خروجی. اطلاعات زمینه‌ای برای وظایف محول‌شده. یک وظیفه می‌تواند به یک کاربر اختصاص داده شود، که در حال حاضر از سطوحی مانند Docs و Chat Spaces امکان‌پذیر است. این فیلد برای وظایف اختصاص داده‌شده به کاربر فعلی پر می‌شود و مشخص می‌کند که وظیفه از کجا اختصاص داده شده است. این فیلد فقط خواندنی است.

اطلاعات تکلیف

اطلاعات مربوط به منبع تعیین تکلیف (سند، فضای چت).

نمایش JSON 
{
  "linkToTask": string,
  "surfaceType": enum (ContextType),

  "driveResourceInfo": {
    object (DriveResourceInfo)
  },
  "spaceInfo": {
    object (SpaceInfo)
  }
}
فیلدها
surfaceType

enum ( ContextType )

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

فیلد یونیون surface_info . اطلاعاتی درباره سطحی (اسناد، فضاهای گفتگو) که این وظیفه از آنجا به آن اختصاص داده شده است. surface_info فقط می‌تواند یکی از موارد زیر باشد:
driveResourceInfo

object ( DriveResourceInfo )

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

spaceInfo

object ( SpaceInfo )

فقط خروجی. اطلاعاتی درباره فضای گفتگو که این وظیفه از آنجا سرچشمه می‌گیرد. این فیلد فقط خواندنی است.

نوع متن

محصول مرتبط با وظیفه.

انوم‌ها
CONTEXT_TYPE_UNSPECIFIED مقدار ناشناخته برای زمینه این کار.
GMAIL این وظیفه از طریق جیمیل ایجاد شده است.
DOCUMENT وظیفه از یک سند تعیین شده است.
SPACE این وظیفه از یک فضای گفتگو (Chat Space) تعیین می‌شود.

اطلاعات منابع درایو

اطلاعات مربوط به منبع درایو که وظیفه از آنجا تعیین شده است (سند، برگه و غیره).

نمایش JSON 
{
  "driveFileId": string,
  "resourceKey": string
}
فیلدها
driveFileId

string

فقط خروجی. شناسه فایل در Drive API.

resourceKey

string

فقط خروجی. برای دسترسی به فایل‌های اشتراک‌گذاری‌شده از طریق یک لینک مشترک، کلید منبع لازم است. برای همه فایل‌ها لازم نیست. همچنین به developers.google.com/drive/api/guides/resource-keys مراجعه کنید.

اطلاعات فضایی

اطلاعات مربوط به فضای گفتگو که وظیفه از آنجا تعیین شده است.

نمایش JSON 
{
  "space": string
}
فیلدها
space

string

فقط خروجی. فضای چتی که این وظیفه از آن سرچشمه می‌گیرد. فرمت آن "spaces/{space}" است.

روش‌ها

clear

 تمام وظایف تکمیل‌شده را از لیست وظایف مشخص‌شده پاک می‌کند.

delete

 وظیفه مشخص شده را از لیست وظایف حذف می‌کند.

get

 وظیفه مشخص شده را برمی‌گرداند.

insert

 یک وظیفه جدید در لیست وظایف مشخص شده ایجاد می‌کند.

list

 تمام وظایف موجود در لیست وظایف مشخص شده را برمی‌گرداند.

move

 وظیفه مشخص شده را به موقعیت دیگری در لیست وظایف مقصد منتقل می‌کند.

patch

 وظیفه مشخص شده را به‌روزرسانی می‌کند.

update

 وظیفه مشخص شده را به‌روزرسانی می‌کند.