Drive API . teamdrives

Instance Methods

delete(teamDriveId)

Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.

get(teamDriveId)

Gets a Team Drive's metadata by ID.

insert(requestId, body)

Creates a new Team Drive.

list(pageToken=None, maxResults=None)

Lists the user's Team Drives.

list_next(previous_request, previous_response)

Retrieves the next page of results.

update(teamDriveId, body)

Updates a Team Drive's metadata

Method Details

delete(teamDriveId)
Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items.

Args:
  teamDriveId: string, The ID of the Team Drive (required)
get(teamDriveId)
Gets a Team Drive's metadata by ID.

Args:
  teamDriveId: string, The ID of the Team Drive (required)

Returns:
  An object of the form:

    { # Representation of a Team Drive.
    "kind": "drive#teamDrive", # This is always drive#teamDrive
    "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
    "capabilities": { # Capabilities the current user has on this Team Drive.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
      "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
      "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
      "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
      "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
      "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
      "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
      "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
      "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
      "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
      "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
      "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
      "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
    },
    "name": "A String", # The name of this Team Drive.
  }
insert(requestId, body)
Creates a new Team Drive.

Args:
  requestId: string, An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of a Team Drive.
  "kind": "drive#teamDrive", # This is always drive#teamDrive
  "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
  "capabilities": { # Capabilities the current user has on this Team Drive.
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
    "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
    "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
    "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
    "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
    "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
    "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
    "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
    "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
    "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
    "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
    "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
    "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
  },
  "name": "A String", # The name of this Team Drive.
}


Returns:
  An object of the form:

    { # Representation of a Team Drive.
    "kind": "drive#teamDrive", # This is always drive#teamDrive
    "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
    "capabilities": { # Capabilities the current user has on this Team Drive.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
      "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
      "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
      "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
      "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
      "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
      "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
      "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
      "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
      "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
      "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
      "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
      "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
    },
    "name": "A String", # The name of this Team Drive.
  }
list(pageToken=None, maxResults=None)
Lists the user's Team Drives.

Args:
  pageToken: string, Page token for Team Drives.
  maxResults: integer, Maximum number of Team Drives to return.

Returns:
  An object of the form:

    { # A list of Team Drives.
    "nextPageToken": "A String", # The page token for the next page of Team Drives.
    "items": [ # The list of Team Drives.
      { # Representation of a Team Drive.
        "kind": "drive#teamDrive", # This is always drive#teamDrive
        "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
        "capabilities": { # Capabilities the current user has on this Team Drive.
          "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
          "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
          "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
          "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
          "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
          "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
          "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
          "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
          "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
          "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
          "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
          "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
          "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
        },
        "name": "A String", # The name of this Team Drive.
      },
    ],
    "kind": "drive#teamDriveList", # This is always drive#teamDriveList
  }
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.
    
update(teamDriveId, body)
Updates a Team Drive's metadata

Args:
  teamDriveId: string, The ID of the Team Drive (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # Representation of a Team Drive.
  "kind": "drive#teamDrive", # This is always drive#teamDrive
  "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
  "capabilities": { # Capabilities the current user has on this Team Drive.
    "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
    "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
    "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
    "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
    "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
    "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
    "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
    "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
    "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
    "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
    "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
    "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
    "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
  },
  "name": "A String", # The name of this Team Drive.
}


Returns:
  An object of the form:

    { # Representation of a Team Drive.
    "kind": "drive#teamDrive", # This is always drive#teamDrive
    "id": "A String", # The ID of this Team Drive which is also the ID of the top level folder for this Team Drive.
    "capabilities": { # Capabilities the current user has on this Team Drive.
      "canReadRevisions": True or False, # Whether the current user has read access to the Revisions resource of files in this Team Drive.
      "canCopy": True or False, # Whether files in this Team Drive can be copied by the current user.
      "canRename": True or False, # Whether files or folders in this Team Drive can be renamed by the current user.
      "canListChildren": True or False, # Whether the current user can list the children of folders in this Team Drive.
      "canShare": True or False, # Whether the current user can share files or folders in this Team Drive.
      "canManageMembers": True or False, # Whether the current user can add members to this Team Drive or remove them or change their role.
      "canDownload": True or False, # Whether files in this Team Drive can be downloaded by the current user.
      "canComment": True or False, # Whether the current user can comment on files in this Team Drive.
      "canDeleteTeamDrive": True or False, # Whether this Team Drive can be deleted by the current user.
      "canRenameTeamDrive": True or False, # Whether this Team Drive can be renamed by the current user.
      "canRemoveChildren": True or False, # Whether the current user can remove children from folders in this Team Drive.
      "canAddChildren": True or False, # Whether the current user can add children to folders in this Team Drive.
      "canEdit": True or False, # Whether files in this Team Drive can be edited by the current user.
    },
    "name": "A String", # The name of this Team Drive.
  }