REST Resource: tasks

リソース: Task

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 スペース、ドキュメント）にすることはできません。このフィールドは読み取り専用です。
position

string

出力専用。同じ親タスクの下にある兄弟タスク間、または最上位レベルでのタスクの位置を示す文字列。この文字列が別のタスクの対応する位置文字列よりも辞書式順序で大きい場合、タスクは同じ親タスクの下（または最上位）で別のタスクの後に配置されます。「move」メソッドを使用して、タスクを別の位置に移動します。
notes

string

タスクの説明のメモ。Google ドキュメントから割り当てられたタスクにはメモを追加できません。省略可。最大文字数: 8,192 文字。
status

string

タスクのステータス。値は「needsAction」または「completed」のいずれかです。
due

string

タスクの予定日（RFC 3339 タイムスタンプ）。省略可。これは、タスクを完了する日、またはタスクがカレンダーのグリッドに表示される日を表します。タスクの締め切りを表すものではありません。日付情報のみが記録されます。このフィールドを設定すると、タイムスタンプの時刻部分は破棄されます。API を使用してタスクのスケジュール設定時刻を読み書きすることはできません。
completed

string

タスクの完了日（RFC 3339 タイムスタンプ形式）。タスクが完了していない場合、このフィールドは省略されます。
deleted

boolean

タスクが削除されたかどうかを示すフラグ。割り当てられたタスクの場合、このフィールドは読み取り専用です。割り当てられたタスクは、tasks.delete を呼び出すことによってのみ削除できます。この場合、割り当てられたタスクと元のタスク（ドキュメントまたは Chat スペース内）の両方が削除されます。割り当てられたタスクのみを削除するには、割り当て画面に移動して、そこからタスクの割り当てを解除します。デフォルトは False です。
hidden

boolean

タスクが非表示かどうかを示すフラグ。これは、タスクリストが最後にクリアされたときにタスクが完了とマークされていた場合に当てはまります。デフォルトは False です。このフィールドは読み取り専用です。
links[].type

string

リンクのタイプ（「email」、「generic」、「chat_message」、「keep_note」など）。
links[].description

string

説明（空の場合もあります）。
links[].link

string

URL。
assignmentInfo

object (AssignmentInfo)

出力専用。割り当てられたタスクのコンテキスト情報。タスクをユーザーに割り当てることができます。現在、ドキュメントや Chat スペースなどのサーフェスから割り当てることが可能です。このフィールドには、現在のユーザーに割り当てられたタスクが入力され、タスクが割り当てられた場所が識別されます。このフィールドは読み取り専用です。

AssignmentInfo

タスクの割り当て元（ドキュメント、Chat スペース）に関する情報。

JSON 表現 
{
  "linkToTask": string,
  "surfaceType": enum (ContextType),

  "driveResourceInfo": {
    object (DriveResourceInfo)
  },
  "spaceInfo": {
    object (SpaceInfo)
  }
}
フィールド
surfaceType

enum (ContextType)

出力専用。この割り当てられたタスクの発生元のサーフェスのタイプ。現在は DOCUMENT または SPACE に限定されています。
共用体フィールド surface_info。このタスクが割り当てられたサーフェス（ドキュメント、Chat スペース）に関する情報。surface_info は次のいずれかになります。
driveResourceInfo

object (DriveResourceInfo)

出力専用。このタスクの発生元であるドライブ ファイルに関する情報。現在、ドライブ ファイルはドキュメントのみです。このフィールドは読み取り専用です。
spaceInfo

object (SpaceInfo)

出力専用。このタスクの作成元の Chat スペースに関する情報。このフィールドは読み取り専用です。

ContextType

タスクに関連付けられているプロダクト。

列挙型
CONTEXT_TYPE_UNSPECIFIED このタスクのコンテキストの値が不明です。
GMAIL タスクは Gmail から作成されます。
DOCUMENT タスクはドキュメントから割り当てられます。
SPACE タスクが Chat スペースから割り当てられている。

DriveResourceInfo

タスクが割り当てられたドライブ リソース（ドキュメント、シートなど）に関する情報。

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}」です。

メソッド

clear

 指定したタスクリストから完了したすべてのタスクをクリアします。

delete

 タスクリストから指定されたタスクを削除します。

get

 指定されたタスクを返します。

insert

 指定したタスクリストに新しいタスクを作成します。

list

 指定されたタスクリスト内のすべてのタスクを返します。

move

 指定されたタスクを宛先タスクリストの別の位置に移動します。

patch

 指定されたタスクを更新します。

update

 指定されたタスクを更新します。