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

タスク ID。
etag

string

リソースの ETag。
title

string

タスクのタイトル。最大長: 1,024 文字。
updated

string

出力専用。タスクの最終更新日時（RFC 3339 タイムスタンプ）。
parent

string

出力専用。親タスクの ID。トップレベルのタスクの場合は、このフィールドは省略されます。「move」メソッドを使用して、タスクを別の親の下に移動するか、最上位レベルに移動します。親タスクは、（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」など）。
links[].description

string

説明。HTML で言うと、<a> と </a> の間にあるすべてです。
links[].link

string

URL。
assignmentInfo

object (AssignmentInfo)

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

AssignmentInfo

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

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

  // Union field surface_info can be only one of the following:
  "driveResourceInfo": {
    object (DriveResourceInfo)
  },
  "spaceInfo": {
    object (SpaceInfo)
  }
  // End of list of possible types for union field surface_info.
}
フィールド
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

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