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

שם המשימה. האורך המקסימלי המותר: 1,024 תווים.

updated

string

פלט בלבד. זמן השינוי האחרון של המשימה (כחותמת זמן בפורמט RFC 3339).

parent

string

פלט בלבד. מזהה משימת ההורה. השדה הזה מושמט אם מדובר במשימה ברמה העליונה. משתמשים בשיטה 'העברה' כדי להעביר את המשימה לרמת הורה אחרת או לרמה העליונה. משימת אב אף פעם לא יכולה להיות משימה שהוקצתה (ממרחבים ב-Chat, מ-Docs). השדה הזה הוא לקריאה בלבד.

position

string

פלט בלבד. מחרוזת שמציינת את המיקום של המשימה בין המשימות האחיות שלה באותה משימת הורה או ברמה העליונה. אם המחרוזת הזו גדולה יותר ממחרוזת המיקום התואמת של משימה אחרת לפי סדר לקסיקוגרפי, המשימה ממוקמת אחרי המשימה האחרת באותה משימת אב (או ברמה העליונה). משתמשים בשיטה 'הזזה' כדי להעביר את המשימה למיקום אחר.

notes

string

הערות שמתארות את המשימה. אי אפשר להוסיף הערות למשימות שמוקצות מ-Google Docs. אופציונלי. האורך המקסימלי המותר: 8,192 תווים.

status

string

הסטטוס של המשימה. הערך יכול להיות needsAction או completed.

due

string

תאריך היעד של המשימה (כחותמת זמן בפורמט RFC 3339). אופציונלי. התאריך הזה מייצג את היום שבו המשימה צריכה להתבצע, או את היום שבו המשימה מופיעה במשבצות היומן. הוא לא מייצג את המועד האחרון של המשימה. רק פרטי התאריך מתועדים. כשמגדירים את השדה הזה, החלק של השעה בחותמת הזמן מושמט. אי אפשר לקרוא או לכתוב את השעה שבה מתוזמנת משימה באמצעות ה-API.

completed

string

תאריך הסיום של המשימה (חותמת זמן בפורמט RFC 3339). השדה הזה מושמט אם המשימה לא הושלמה.

deleted

boolean

סימון שמציין אם המשימה נמחקה. בשביל משימות שהוקצו, השדה הזה הוא לקריאה בלבד. אפשר למחוק אותן רק באמצעות קריאה לפונקציה tasks.delete, ובמקרה כזה גם המשימה שהוקצתה וגם המשימה המקורית (ב-Docs או במרחבים ב-Chat) נמחקות. כדי למחוק רק את המשימה שהוקצתה, עוברים לממשק ההקצאה ומבטלים את ההקצאה של המשימה משם. ברירת המחדל היא False.

hidden

boolean

סימון שמציין אם המשימה מוסתרת. זה קורה אם המשימה סומנה כהושלמה בפעם האחרונה שרשימת המשימות נוקתה. ברירת המחדל היא False. השדה הזה הוא לקריאה בלבד.

links[].type

string

סוג הקישור, לדוגמה: 'אימייל', 'כללי', 'הודעה בצ'אט', 'הערה ב-Keep'.

links[].description

string

התיאור (יכול להיות ריק).

links[].link

string

כתובת ה-URL.

assignmentInfo

object (AssignmentInfo)

פלט בלבד. מידע על ההקשר של המשימות שהוקצו. אפשר להקצות משימה למשתמש, כרגע אפשר לעשות את זה בפלטפורמות כמו Docs ומרחבים ב-Chat. השדה הזה מאוכלס במשימות שהוקצו למשתמש הנוכחי, ומציין מאיפה הוקצתה המשימה. השדה הזה הוא לקריאה בלבד.

AssignmentInfo

מידע על המקור של הקצאת המשימה (מסמך, מרחב ב-Chat).

ייצוג ב-JSON
{
  "linkToTask": string,
  "surfaceType": enum (ContextType),

  "driveResourceInfo": {
    object (DriveResourceInfo)
  },
  "spaceInfo": {
    object (SpaceInfo)
  }
}
שדות
surfaceType

enum (ContextType)

פלט בלבד. סוג הפלטפורמה שממנה נוצרה המשימה שהוקצתה. הערך מוגבל כרגע ל-DOCUMENT או ל-SPACE.

שדה איחוד surface_info. מידע על הפלטפורמה (Docs, מרחבים ב-Chat) שממנה הוקצתה המשימה. הערך surface_info יכול להיות רק אחד מהבאים:
driveResourceInfo

object (DriveResourceInfo)

פלט בלבד. מידע על קובץ Drive שממנו נוצר המשימה. נכון לעכשיו, הקובץ ב-Drive יכול להיות רק מסמך. השדה הזה הוא לקריאה בלבד.

spaceInfo

object (SpaceInfo)

פלט בלבד. מידע על המרחב ב-Chat שבו נוצרה המשימה. השדה הזה הוא לקריאה בלבד.

ContextType

המוצר שמשויך למשימה.

טיפוסים בני מנייה (enum)
CONTEXT_TYPE_UNSPECIFIED ערך לא ידוע בהקשר של המשימה הזו.
GMAIL המשימה נוצרת מ-Gmail.
DOCUMENT המשימה הוקצתה ממסמך.
SPACE המשימה מוקצית ממרחב ב-Chat.

DriveResourceInfo

מידע על משאב ב-Drive שממנו הוקצתה המשימה (המסמך, הגיליון האלקטרוני וכו').

ייצוג ב-JSON
{
  "driveFileId": string,
  "resourceKey": string
}
שדות
driveFileId

string

פלט בלבד. מזהה הקובץ ב-Drive API.

resourceKey

string

פלט בלבד. נדרש מפתח משאב כדי לגשת לקבצים ששותפו באמצעות קישור משותף. לא חובה לכל הקבצים. מידע נוסף זמין גם בכתובת developers.google.com/drive/api/guides/resource-keys.

SpaceInfo

מידע על המרחב ב-Chat שממנו הוקצתה המשימה.

ייצוג ב-JSON
{
  "space": string
}
שדות
space

string

פלט בלבד. המרחב ב-Chat שממנו נוצרה המשימה. הפורמט הוא spaces/{space}.

Methods

clear

מחיקת כל המשימות שהושלמו מרשימת המשימות שצוינה.

delete

מחיקת המשימה שצוינה מרשימת המשימות.

get

מחזירה את המשימה שצוינה.

insert

יצירת משימה חדשה ברשימת המשימות שצוינה.

list

מחזירה את כל המשימות ברשימת המשימות שצוינה.

move

מעבירה את המשימה שצוינה למיקום אחר ברשימת המשימות של היעד.

patch

מעדכן את המשימה שצוינה.

update

מעדכן את המשימה שצוינה.