List
|
|||||
|
|
Deprecated use drives.list instead
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, create, and delete all of your Google Drive files
- See and download all your Google Drive files
Input
This building block consumes 4 input parameters
Name | Format | Description |
---|---|---|
pageSize |
INTEGER |
Maximum number of Team Drives to return |
pageToken |
STRING |
Page token for Team Drives |
q |
STRING |
Query string for searching Team Drives |
useDomainAdminAccess |
BOOLEAN |
Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned |
= Parameter name
= Format
pageSize INTEGER Maximum number of Team Drives to return |
pageToken STRING Page token for Team Drives |
q STRING Query string for searching Team Drives |
useDomainAdminAccess BOOLEAN Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned |
Output
This building block provides 40 output parameters
Name | Format | Description |
---|---|---|
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList" |
nextPageToken |
STRING |
The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results |
teamDrives[] |
OBJECT |
Deprecated: use the drive collection instead |
teamDrives[].backgroundImageFile |
OBJECT |
An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set |
teamDrives[].backgroundImageFile.id |
STRING |
The ID of an image file in Drive to use for the background image |
teamDrives[].backgroundImageFile.width |
FLOAT |
The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high |
teamDrives[].backgroundImageFile.xCoordinate |
FLOAT |
The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image |
teamDrives[].backgroundImageFile.yCoordinate |
FLOAT |
The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image |
teamDrives[].backgroundImageLink |
STRING |
A short-lived link to this Team Drive's background image |
teamDrives[].capabilities |
OBJECT |
Capabilities the current user has on this Team Drive |
teamDrives[].capabilities.canAddChildren |
BOOLEAN |
Whether the current user can add children to folders in this Team Drive |
teamDrives[].capabilities.canChangeCopyRequiresWriterPermissionRestriction |
BOOLEAN |
Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive |
teamDrives[].capabilities.canChangeDomainUsersOnlyRestriction |
BOOLEAN |
Whether the current user can change the domainUsersOnly restriction of this Team Drive |
teamDrives[].capabilities.canChangeTeamDriveBackground |
BOOLEAN |
Whether the current user can change the background of this Team Drive |
teamDrives[].capabilities.canChangeTeamMembersOnlyRestriction |
BOOLEAN |
Whether the current user can change the teamMembersOnly restriction of this Team Drive |
teamDrives[].capabilities.canComment |
BOOLEAN |
Whether the current user can comment on files in this Team Drive |
teamDrives[].capabilities.canCopy |
BOOLEAN |
Whether the current user can copy files in this Team Drive |
teamDrives[].capabilities.canDeleteChildren |
BOOLEAN |
Whether the current user can delete children from folders in this Team Drive |
teamDrives[].capabilities.canDeleteTeamDrive |
BOOLEAN |
Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive |
teamDrives[].capabilities.canDownload |
BOOLEAN |
Whether the current user can download files in this Team Drive |
teamDrives[].capabilities.canEdit |
BOOLEAN |
Whether the current user can edit files in this Team Drive |
teamDrives[].capabilities.canListChildren |
BOOLEAN |
Whether the current user can list the children of folders in this Team Drive |
teamDrives[].capabilities.canManageMembers |
BOOLEAN |
Whether the current user can add members to this Team Drive or remove them or change their role |
teamDrives[].capabilities.canReadRevisions |
BOOLEAN |
Whether the current user can read the revisions resource of files in this Team Drive |
teamDrives[].capabilities.canRemoveChildren |
BOOLEAN |
Deprecated - use canDeleteChildren or canTrashChildren instead |
teamDrives[].capabilities.canRename |
BOOLEAN |
Whether the current user can rename files or folders in this Team Drive |
teamDrives[].capabilities.canRenameTeamDrive |
BOOLEAN |
Whether the current user can rename this Team Drive |
teamDrives[].capabilities.canShare |
BOOLEAN |
Whether the current user can share files or folders in this Team Drive |
teamDrives[].capabilities.canTrashChildren |
BOOLEAN |
Whether the current user can trash children from folders in this Team Drive |
teamDrives[].colorRgb |
STRING |
The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId |
teamDrives[].createdTime |
DATE_TIME |
The time at which the Team Drive was created (RFC 3339 date-time) |
teamDrives[].id |
STRING |
The ID of this Team Drive which is also the ID of the top level folder of this Team Drive |
teamDrives[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive" |
teamDrives[].name |
STRING |
The name of this Team Drive |
teamDrives[].restrictions |
OBJECT |
A set of restrictions that apply to this Team Drive or items inside this Team Drive |
teamDrives[].restrictions.adminManagedRestrictions |
BOOLEAN |
Whether administrative privileges on this Team Drive are required to modify restrictions |
teamDrives[].restrictions.copyRequiresWriterPermission |
BOOLEAN |
Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive |
teamDrives[].restrictions.domainUsersOnly |
BOOLEAN |
Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive |
teamDrives[].restrictions.teamMembersOnly |
BOOLEAN |
Whether access to items inside this Team Drive is restricted to members of this Team Drive |
teamDrives[].themeId |
STRING |
The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile |
= Parameter name
= Format
kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList" |
nextPageToken STRING The page token for the next page of Team Drives. This will be absent if the end of the Team Drives list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results |
teamDrives[] OBJECT Deprecated: use the drive collection instead |
teamDrives[].backgroundImageFile OBJECT An image file and cropping parameters from which a background image for this Team Drive is set. This is a write only field; it can only be set on drive.teamdrives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set |
teamDrives[].backgroundImageFile.id STRING The ID of an image file in Drive to use for the background image |
teamDrives[].backgroundImageFile.width FLOAT The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high |
teamDrives[].backgroundImageFile.xCoordinate FLOAT The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image |
teamDrives[].backgroundImageFile.yCoordinate FLOAT The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image |
teamDrives[].backgroundImageLink STRING A short-lived link to this Team Drive's background image |
teamDrives[].capabilities OBJECT Capabilities the current user has on this Team Drive |
teamDrives[].capabilities.canAddChildren BOOLEAN Whether the current user can add children to folders in this Team Drive |
teamDrives[].capabilities.canChangeCopyRequiresWriterPermissionRestriction BOOLEAN Whether the current user can change the copyRequiresWriterPermission restriction of this Team Drive |
teamDrives[].capabilities.canChangeDomainUsersOnlyRestriction BOOLEAN Whether the current user can change the domainUsersOnly restriction of this Team Drive |
teamDrives[].capabilities.canChangeTeamDriveBackground BOOLEAN Whether the current user can change the background of this Team Drive |
teamDrives[].capabilities.canChangeTeamMembersOnlyRestriction BOOLEAN Whether the current user can change the teamMembersOnly restriction of this Team Drive |
teamDrives[].capabilities.canComment BOOLEAN Whether the current user can comment on files in this Team Drive |
teamDrives[].capabilities.canCopy BOOLEAN Whether the current user can copy files in this Team Drive |
teamDrives[].capabilities.canDeleteChildren BOOLEAN Whether the current user can delete children from folders in this Team Drive |
teamDrives[].capabilities.canDeleteTeamDrive BOOLEAN Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive |
teamDrives[].capabilities.canDownload BOOLEAN Whether the current user can download files in this Team Drive |
teamDrives[].capabilities.canEdit BOOLEAN Whether the current user can edit files in this Team Drive |
teamDrives[].capabilities.canListChildren BOOLEAN Whether the current user can list the children of folders in this Team Drive |
teamDrives[].capabilities.canManageMembers BOOLEAN Whether the current user can add members to this Team Drive or remove them or change their role |
teamDrives[].capabilities.canReadRevisions BOOLEAN Whether the current user can read the revisions resource of files in this Team Drive |
teamDrives[].capabilities.canRemoveChildren BOOLEAN Deprecated - use canDeleteChildren or canTrashChildren instead |
teamDrives[].capabilities.canRename BOOLEAN Whether the current user can rename files or folders in this Team Drive |
teamDrives[].capabilities.canRenameTeamDrive BOOLEAN Whether the current user can rename this Team Drive |
teamDrives[].capabilities.canShare BOOLEAN Whether the current user can share files or folders in this Team Drive |
teamDrives[].capabilities.canTrashChildren BOOLEAN Whether the current user can trash children from folders in this Team Drive |
teamDrives[].colorRgb STRING The color of this Team Drive as an RGB hex string. It can only be set on a drive.teamdrives.update request that does not set themeId |
teamDrives[].createdTime DATE_TIME The time at which the Team Drive was created (RFC 3339 date-time) |
teamDrives[].id STRING The ID of this Team Drive which is also the ID of the top level folder of this Team Drive |
teamDrives[].kind STRING Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive" |
teamDrives[].name STRING The name of this Team Drive |
teamDrives[].restrictions OBJECT A set of restrictions that apply to this Team Drive or items inside this Team Drive |
teamDrives[].restrictions.adminManagedRestrictions BOOLEAN Whether administrative privileges on this Team Drive are required to modify restrictions |
teamDrives[].restrictions.copyRequiresWriterPermission BOOLEAN Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this Team Drive |
teamDrives[].restrictions.domainUsersOnly BOOLEAN Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive |
teamDrives[].restrictions.teamMembersOnly BOOLEAN Whether access to items inside this Team Drive is restricted to members of this Team Drive |
teamDrives[].themeId STRING The ID of the theme from which the background image and color will be set. The set of possible teamDriveThemes can be retrieved from a drive.about.get response. When not specified on a drive.teamdrives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile |