Tasks API . tasks

Instance Methods

clear(tasklist, x__xgafv=None)

Clears all completed tasks from the specified task list. The affected tasks

delete(tasklist, task, x__xgafv=None)

Deletes the specified task from the task list.

get(tasklist, task, x__xgafv=None)

Returns the specified task.

insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)

Creates a new task on the specified task list.

list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)

Returns all tasks in the specified task list.

list_next(previous_request, previous_response)

Retrieves the next page of results.

move(tasklist, task, parent=None, previous=None, x__xgafv=None)

Moves the specified task to another position in the task list. This can

patch(tasklist, task, body=None, x__xgafv=None)

Updates the specified task. This method supports patch semantics.

update(tasklist, task, body=None, x__xgafv=None)

Updates the specified task.

Method Details

clear(tasklist, x__xgafv=None)
Clears all completed tasks from the specified task list. The affected tasks
will be marked as 'hidden' and no longer be returned by default when
retrieving all tasks for a task list.

Args:
  tasklist: string, Task list identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
delete(tasklist, task, x__xgafv=None)
Deletes the specified task from the task list.

Args:
  tasklist: string, Task list identifier. (required)
  task: string, Task identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
get(tasklist, task, x__xgafv=None)
Returns the specified task.

Args:
  tasklist: string, Task list identifier. (required)
  task: string, Task identifier. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
      "etag": "A String", # ETag of the resource.
      "title": "A String", # Title of the task.
      "kind": "A String", # Type of the resource. This is always "tasks#task".
      "id": "A String", # Task identifier.
      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
          # This field is read-only. Use the "move" method to move the task under a
          # different parent or to the top level.
      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
      "notes": "A String", # Notes describing the task. Optional.
      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
      "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
      "position": "A String", # String indicating the position of the task among its sibling tasks under
          # the same parent task or at the top level. If this string is greater than
          # another task's corresponding position string according to lexicographical
          # ordering, the task is positioned after the other task under the same parent
          # task (or at the top level). This field is read-only. Use the "move" method
          # to move the task to another position.
      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
          # records date information; the time portion of the timestamp is discarded
          # when setting the due date. It isn't possible to read or write the time that
          # a task is due via the API.
      "links": [ # Collection of links. This collection is read-only.
        {
          "type": "A String", # Type of the link, e.g. "email".
          "link": "A String", # The URL.
          "description": "A String", # The description. In HTML speak: Everything between <a> and
              # </a>.
        },
      ],
      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
          # omitted if the task has not been completed.
      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
          # had been marked completed when the task list was last cleared. The default
          # is False. This field is read-only.
    }
insert(tasklist, body=None, parent=None, previous=None, x__xgafv=None)
Creates a new task on the specified task list.

Args:
  tasklist: string, Task list identifier. (required)
  body: object, The request body.
    The object takes the form of:

{
    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
    "etag": "A String", # ETag of the resource.
    "title": "A String", # Title of the task.
    "kind": "A String", # Type of the resource. This is always "tasks#task".
    "id": "A String", # Task identifier.
    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
        # This field is read-only. Use the "move" method to move the task under a
        # different parent or to the top level.
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
    "notes": "A String", # Notes describing the task. Optional.
    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
    "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
    "position": "A String", # String indicating the position of the task among its sibling tasks under
        # the same parent task or at the top level. If this string is greater than
        # another task's corresponding position string according to lexicographical
        # ordering, the task is positioned after the other task under the same parent
        # task (or at the top level). This field is read-only. Use the "move" method
        # to move the task to another position.
    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
        # records date information; the time portion of the timestamp is discarded
        # when setting the due date. It isn't possible to read or write the time that
        # a task is due via the API.
    "links": [ # Collection of links. This collection is read-only.
      {
        "type": "A String", # Type of the link, e.g. "email".
        "link": "A String", # The URL.
        "description": "A String", # The description. In HTML speak: Everything between <a> and
            # </a>.
      },
    ],
    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
        # omitted if the task has not been completed.
    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
        # had been marked completed when the task list was last cleared. The default
        # is False. This field is read-only.
  }

  parent: string, Parent task identifier. If the task is created at the top level, this
parameter is omitted. Optional.
  previous: string, Previous sibling task identifier. If the task is created at the first
position among its siblings, this parameter is omitted. Optional.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
      "etag": "A String", # ETag of the resource.
      "title": "A String", # Title of the task.
      "kind": "A String", # Type of the resource. This is always "tasks#task".
      "id": "A String", # Task identifier.
      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
          # This field is read-only. Use the "move" method to move the task under a
          # different parent or to the top level.
      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
      "notes": "A String", # Notes describing the task. Optional.
      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
      "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
      "position": "A String", # String indicating the position of the task among its sibling tasks under
          # the same parent task or at the top level. If this string is greater than
          # another task's corresponding position string according to lexicographical
          # ordering, the task is positioned after the other task under the same parent
          # task (or at the top level). This field is read-only. Use the "move" method
          # to move the task to another position.
      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
          # records date information; the time portion of the timestamp is discarded
          # when setting the due date. It isn't possible to read or write the time that
          # a task is due via the API.
      "links": [ # Collection of links. This collection is read-only.
        {
          "type": "A String", # Type of the link, e.g. "email".
          "link": "A String", # The URL.
          "description": "A String", # The description. In HTML speak: Everything between <a> and
              # </a>.
        },
      ],
      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
          # omitted if the task has not been completed.
      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
          # had been marked completed when the task list was last cleared. The default
          # is False. This field is read-only.
    }
list(tasklist, completedMin=None, updatedMin=None, dueMin=None, showHidden=None, showCompleted=None, maxResults=None, pageToken=None, dueMax=None, completedMax=None, showDeleted=None, x__xgafv=None)
Returns all tasks in the specified task list.

Args:
  tasklist: string, Task list identifier. (required)
  completedMin: string, Lower bound for a task's completion date (as a RFC 3339 timestamp) to
filter by. Optional. The default is not to filter by completion date.
  updatedMin: string, Lower bound for a task's last modification time (as a RFC 3339 timestamp)
to filter by. Optional. The default is not to filter by last modification
time.
  dueMin: string, Lower bound for a task's due date (as a RFC 3339 timestamp) to filter by.
Optional. The default is not to filter by due date.
  showHidden: boolean, Flag indicating whether hidden tasks are returned in the result. Optional.
The default is False.
  showCompleted: boolean, Flag indicating whether completed tasks are returned in the result.
Optional. The default is True.
  maxResults: integer, Maximum number of task lists returned on one page. Optional. The default is
20 (max allowed: 100).
  pageToken: string, Token specifying the result page to return. Optional.
  dueMax: string, Upper bound for a task's due date (as a RFC 3339 timestamp) to filter by.
Optional. The default is not to filter by due date.
  completedMax: string, Upper bound for a task's completion date (as a RFC 3339 timestamp) to
filter by. Optional. The default is not to filter by completion date.
  showDeleted: boolean, Flag indicating whether deleted tasks are returned in the result. Optional.
The default is False.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "nextPageToken": "A String", # Token used to access the next page of this result.
    "etag": "A String", # ETag of the resource.
    "items": [ # Collection of tasks.
      {
          "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
          "etag": "A String", # ETag of the resource.
          "title": "A String", # Title of the task.
          "kind": "A String", # Type of the resource. This is always "tasks#task".
          "id": "A String", # Task identifier.
          "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
              # This field is read-only. Use the "move" method to move the task under a
              # different parent or to the top level.
          "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
          "notes": "A String", # Notes describing the task. Optional.
          "status": "A String", # Status of the task. This is either "needsAction" or "completed".
          "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
          "position": "A String", # String indicating the position of the task among its sibling tasks under
              # the same parent task or at the top level. If this string is greater than
              # another task's corresponding position string according to lexicographical
              # ordering, the task is positioned after the other task under the same parent
              # task (or at the top level). This field is read-only. Use the "move" method
              # to move the task to another position.
          "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
              # records date information; the time portion of the timestamp is discarded
              # when setting the due date. It isn't possible to read or write the time that
              # a task is due via the API.
          "links": [ # Collection of links. This collection is read-only.
            {
              "type": "A String", # Type of the link, e.g. "email".
              "link": "A String", # The URL.
              "description": "A String", # The description. In HTML speak: Everything between <a> and
                  # </a>.
            },
          ],
          "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
              # omitted if the task has not been completed.
          "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
              # had been marked completed when the task list was last cleared. The default
              # is False. This field is read-only.
        },
    ],
    "kind": "A String", # Type of the resource. This is always "tasks#tasks".
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
move(tasklist, task, parent=None, previous=None, x__xgafv=None)
Moves the specified task to another position in the task list. This can
include putting it as a child task under a new parent and/or move it to a
different position among its sibling tasks.

Args:
  tasklist: string, Task list identifier. (required)
  task: string, Task identifier. (required)
  parent: string, New parent task identifier. If the task is moved to the top level, this
parameter is omitted. Optional.
  previous: string, New previous sibling task identifier. If the task is moved to the first
position among its siblings, this parameter is omitted. Optional.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
      "etag": "A String", # ETag of the resource.
      "title": "A String", # Title of the task.
      "kind": "A String", # Type of the resource. This is always "tasks#task".
      "id": "A String", # Task identifier.
      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
          # This field is read-only. Use the "move" method to move the task under a
          # different parent or to the top level.
      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
      "notes": "A String", # Notes describing the task. Optional.
      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
      "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
      "position": "A String", # String indicating the position of the task among its sibling tasks under
          # the same parent task or at the top level. If this string is greater than
          # another task's corresponding position string according to lexicographical
          # ordering, the task is positioned after the other task under the same parent
          # task (or at the top level). This field is read-only. Use the "move" method
          # to move the task to another position.
      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
          # records date information; the time portion of the timestamp is discarded
          # when setting the due date. It isn't possible to read or write the time that
          # a task is due via the API.
      "links": [ # Collection of links. This collection is read-only.
        {
          "type": "A String", # Type of the link, e.g. "email".
          "link": "A String", # The URL.
          "description": "A String", # The description. In HTML speak: Everything between <a> and
              # </a>.
        },
      ],
      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
          # omitted if the task has not been completed.
      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
          # had been marked completed when the task list was last cleared. The default
          # is False. This field is read-only.
    }
patch(tasklist, task, body=None, x__xgafv=None)
Updates the specified task. This method supports patch semantics.

Args:
  tasklist: string, Task list identifier. (required)
  task: string, Task identifier. (required)
  body: object, The request body.
    The object takes the form of:

{
    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
    "etag": "A String", # ETag of the resource.
    "title": "A String", # Title of the task.
    "kind": "A String", # Type of the resource. This is always "tasks#task".
    "id": "A String", # Task identifier.
    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
        # This field is read-only. Use the "move" method to move the task under a
        # different parent or to the top level.
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
    "notes": "A String", # Notes describing the task. Optional.
    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
    "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
    "position": "A String", # String indicating the position of the task among its sibling tasks under
        # the same parent task or at the top level. If this string is greater than
        # another task's corresponding position string according to lexicographical
        # ordering, the task is positioned after the other task under the same parent
        # task (or at the top level). This field is read-only. Use the "move" method
        # to move the task to another position.
    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
        # records date information; the time portion of the timestamp is discarded
        # when setting the due date. It isn't possible to read or write the time that
        # a task is due via the API.
    "links": [ # Collection of links. This collection is read-only.
      {
        "type": "A String", # Type of the link, e.g. "email".
        "link": "A String", # The URL.
        "description": "A String", # The description. In HTML speak: Everything between <a> and
            # </a>.
      },
    ],
    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
        # omitted if the task has not been completed.
    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
        # had been marked completed when the task list was last cleared. The default
        # is False. This field is read-only.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
      "etag": "A String", # ETag of the resource.
      "title": "A String", # Title of the task.
      "kind": "A String", # Type of the resource. This is always "tasks#task".
      "id": "A String", # Task identifier.
      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
          # This field is read-only. Use the "move" method to move the task under a
          # different parent or to the top level.
      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
      "notes": "A String", # Notes describing the task. Optional.
      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
      "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
      "position": "A String", # String indicating the position of the task among its sibling tasks under
          # the same parent task or at the top level. If this string is greater than
          # another task's corresponding position string according to lexicographical
          # ordering, the task is positioned after the other task under the same parent
          # task (or at the top level). This field is read-only. Use the "move" method
          # to move the task to another position.
      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
          # records date information; the time portion of the timestamp is discarded
          # when setting the due date. It isn't possible to read or write the time that
          # a task is due via the API.
      "links": [ # Collection of links. This collection is read-only.
        {
          "type": "A String", # Type of the link, e.g. "email".
          "link": "A String", # The URL.
          "description": "A String", # The description. In HTML speak: Everything between <a> and
              # </a>.
        },
      ],
      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
          # omitted if the task has not been completed.
      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
          # had been marked completed when the task list was last cleared. The default
          # is False. This field is read-only.
    }
update(tasklist, task, body=None, x__xgafv=None)
Updates the specified task.

Args:
  tasklist: string, Task list identifier. (required)
  task: string, Task identifier. (required)
  body: object, The request body.
    The object takes the form of:

{
    "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
    "etag": "A String", # ETag of the resource.
    "title": "A String", # Title of the task.
    "kind": "A String", # Type of the resource. This is always "tasks#task".
    "id": "A String", # Task identifier.
    "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
        # This field is read-only. Use the "move" method to move the task under a
        # different parent or to the top level.
    "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
    "notes": "A String", # Notes describing the task. Optional.
    "status": "A String", # Status of the task. This is either "needsAction" or "completed".
    "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
    "position": "A String", # String indicating the position of the task among its sibling tasks under
        # the same parent task or at the top level. If this string is greater than
        # another task's corresponding position string according to lexicographical
        # ordering, the task is positioned after the other task under the same parent
        # task (or at the top level). This field is read-only. Use the "move" method
        # to move the task to another position.
    "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
        # records date information; the time portion of the timestamp is discarded
        # when setting the due date. It isn't possible to read or write the time that
        # a task is due via the API.
    "links": [ # Collection of links. This collection is read-only.
      {
        "type": "A String", # Type of the link, e.g. "email".
        "link": "A String", # The URL.
        "description": "A String", # The description. In HTML speak: Everything between <a> and
            # </a>.
      },
    ],
    "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
        # omitted if the task has not been completed.
    "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
        # had been marked completed when the task list was last cleared. The default
        # is False. This field is read-only.
  }

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
      "updated": "A String", # Last modification time of the task (as a RFC 3339 timestamp).
      "etag": "A String", # ETag of the resource.
      "title": "A String", # Title of the task.
      "kind": "A String", # Type of the resource. This is always "tasks#task".
      "id": "A String", # Task identifier.
      "parent": "A String", # Parent task identifier. This field is omitted if it is a top-level task.
          # This field is read-only. Use the "move" method to move the task under a
          # different parent or to the top level.
      "selfLink": "A String", # URL pointing to this task. Used to retrieve, update, or delete this task.
      "notes": "A String", # Notes describing the task. Optional.
      "status": "A String", # Status of the task. This is either "needsAction" or "completed".
      "deleted": True or False, # Flag indicating whether the task has been deleted. The default is False.
      "position": "A String", # String indicating the position of the task among its sibling tasks under
          # the same parent task or at the top level. If this string is greater than
          # another task's corresponding position string according to lexicographical
          # ordering, the task is positioned after the other task under the same parent
          # task (or at the top level). This field is read-only. Use the "move" method
          # to move the task to another position.
      "due": "A String", # Due date of the task (as a RFC 3339 timestamp). Optional. The due date only
          # records date information; the time portion of the timestamp is discarded
          # when setting the due date. It isn't possible to read or write the time that
          # a task is due via the API.
      "links": [ # Collection of links. This collection is read-only.
        {
          "type": "A String", # Type of the link, e.g. "email".
          "link": "A String", # The URL.
          "description": "A String", # The description. In HTML speak: Everything between <a> and
              # </a>.
        },
      ],
      "completed": "A String", # Completion date of the task (as a RFC 3339 timestamp). This field is
          # omitted if the task has not been completed.
      "hidden": True or False, # Flag indicating whether the task is hidden. This is the case if the task
          # had been marked completed when the task list was last cleared. The default
          # is False. This field is read-only.
    }