Google.Apis.Drive.v3
The Drive Service.
The API version.
The discovery version used to generate this service.
Constructs a new service.
Constructs a new service.
The service initializer.
Gets the service supported features.
Gets the service name.
Gets the service base URI.
Gets the service base path.
Gets the batch base URI; null if unspecified.
Gets the batch base path; null if unspecified.
Available OAuth 2.0 scopes for use with the Drive API.
View and manage the files in your Google Drive
View and manage its own configuration data in your Google Drive
View and manage Google Drive files and folders that you have opened or created with this
app
View and manage metadata of files in your Google Drive
View metadata for files in your Google Drive
View the photos, videos and albums in your Google Photos
View the files in your Google Drive
Modify your Google Apps Script scripts' behavior
Gets the About resource.
Gets the Changes resource.
Gets the Channels resource.
Gets the Comments resource.
Gets the Files resource.
Gets the Permissions resource.
Gets the Replies resource.
Gets the Revisions resource.
Gets the Teamdrives resource.
A base abstract class for Drive requests.
Constructs a new DriveBaseServiceRequest instance.
Data format for the response.
[default: json]
Data format for the response.
Responses with Content-Type of application/json
Selector specifying which fields to include in a partial response.
API key. Your API key identifies your project and provides you with API access, quota, and reports.
Required unless you provide an OAuth 2.0 token.
OAuth 2.0 token for the current user.
Returns response with indentations and line breaks.
[default: true]
An opaque string that represents a user for quota purposes. Must not exceed 40
characters.
Deprecated. Please use quotaUser instead.
Initializes Drive parameter list.
The "about" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Gets information about the user, the user's Drive, and system capabilities.
Gets information about the user, the user's Drive, and system capabilities.
Constructs a new Get request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
The "changes" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Gets the starting pageToken for listing future changes.
Gets the starting pageToken for listing future changes.
Constructs a new GetStartPageToken request.
Whether the requesting application supports Team Drives.
[default: false]
The ID of the Team Drive for which the starting pageToken for listing future changes from that
Team Drive will be returned.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes GetStartPageToken parameter list.
Lists the changes for a user or Team Drive.
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response or to the response from the getStartPageToken
method.
Lists the changes for a user or Team Drive.
Constructs a new List request.
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response or to the response from the getStartPageToken
method.
Whether changes should include the file resource if the file is still accessible by the user at
the time of the request, even when a file was removed from the list of changes and there will be no
further change entries for this file.
[default: false]
Whether to include changes indicating that items have been removed from the list of changes,
for example by deletion or loss of access.
[default: true]
Whether Team Drive files or changes should be included in results.
[default: false]
The maximum number of changes to return per page.
[default: 100]
[minimum: 1]
[maximum: 1000]
Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to
files such as those in the Application Data folder or shared files which have not been added to My
Drive.
[default: false]
A comma-separated list of spaces to query within the user corpus. Supported values are 'drive',
'appDataFolder' and 'photos'.
[default: drive]
Whether the requesting application supports Team Drives.
[default: false]
The Team Drive from which changes will be returned. If specified the change IDs will be
reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Subscribes to changes for a user.
The body of the request.
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response or to the response from the getStartPageToken
method.
Subscribes to changes for a user.
Constructs a new Watch request.
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response or to the response from the getStartPageToken
method.
Whether changes should include the file resource if the file is still accessible by the user at
the time of the request, even when a file was removed from the list of changes and there will be no
further change entries for this file.
[default: false]
Whether to include changes indicating that items have been removed from the list of changes,
for example by deletion or loss of access.
[default: true]
Whether Team Drive files or changes should be included in results.
[default: false]
The maximum number of changes to return per page.
[default: 100]
[minimum: 1]
[maximum: 1000]
Whether to restrict the results to changes inside the My Drive hierarchy. This omits changes to
files such as those in the Application Data folder or shared files which have not been added to My
Drive.
[default: false]
A comma-separated list of spaces to query within the user corpus. Supported values are 'drive',
'appDataFolder' and 'photos'.
[default: drive]
Whether the requesting application supports Team Drives.
[default: false]
The Team Drive from which changes will be returned. If specified the change IDs will be
reflective of the Team Drive; use the combined Team Drive ID and change ID as an identifier.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Watch parameter list.
The "channels" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Stop watching resources through this channel
The body of the request.
Stop watching resources through this channel
Constructs a new Stop request.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Stop parameter list.
The "comments" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Creates a new comment on a file.
The body of the request.
The ID of the file.
Creates a new comment on a file.
Constructs a new Create request.
The ID of the file.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Create parameter list.
Deletes a comment.
The ID of the file.
The ID of the comment.
Deletes a comment.
Constructs a new Delete request.
The ID of the file.
The ID of the comment.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Gets a comment by ID.
The ID of the file.
The ID of the comment.
Gets a comment by ID.
Constructs a new Get request.
The ID of the file.
The ID of the comment.
Whether to return deleted comments. Deleted comments will not include their original
content.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Lists a file's comments.
The ID of the file.
Lists a file's comments.
Constructs a new List request.
The ID of the file.
Whether to include deleted comments. Deleted comments will not include their original
content.
[default: false]
The maximum number of comments to return per page.
[default: 20]
[minimum: 1]
[maximum: 100]
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response.
The minimum value of 'modifiedTime' for the result comments (RFC 3339 date-time).
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a comment with patch semantics.
The body of the request.
The ID of the file.
The ID of the comment.
Updates a comment with patch semantics.
Constructs a new Update request.
The ID of the file.
The ID of the comment.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
The "files" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Creates a copy of a file and applies any requested updates with patch semantics.
The body of the request.
The ID of the file.
Creates a copy of a file and applies any requested updates with patch semantics.
Constructs a new Copy request.
The ID of the file.
Whether to ignore the domain's default visibility settings for the created file. Domain
administrators can choose to make all uploaded files visible to the domain by default; this parameter
bypasses that behavior for the request. Permissions are still inherited from parent folders.
[default: false]
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Drive.
[default: false]
A language hint for OCR processing during image import (ISO 639-1 code).
Whether the requesting application supports Team Drives.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Copy parameter list.
Creates a new file.
The body of the request.
Creates a new file.
Constructs a new Create request.
Whether to ignore the domain's default visibility settings for the created file. Domain
administrators can choose to make all uploaded files visible to the domain by default; this parameter
bypasses that behavior for the request. Permissions are still inherited from parent folders.
[default: false]
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Drive.
[default: false]
A language hint for OCR processing during image import (ISO 639-1 code).
Whether the requesting application supports Team Drives.
[default: false]
Whether to use the uploaded content as indexable text.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Create parameter list.
Creates a new file.
The body of the request.
The stream to upload.
The content type of the stream to upload.
Create media upload which supports resumable upload.
Data format for the response.
[default: json]
Data format for the response.
Responses with Content-Type of application/json
Selector specifying which fields to include in a partial response.
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
OAuth 2.0 token for the current user.
Returns response with indentations and line breaks.
[default: true]
An opaque string that represents a user for quota purposes. Must not exceed 40
characters.
Deprecated. Please use quotaUser instead.
Whether to ignore the domain's default visibility settings for the created file. Domain
administrators can choose to make all uploaded files visible to the domain by default; this parameter
bypasses that behavior for the request. Permissions are still inherited from parent folders.
[default: false]
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Drive.
[default: false]
A language hint for OCR processing during image import (ISO 639-1 code).
Whether the requesting application supports Team Drives.
[default: false]
Whether to use the uploaded content as indexable text.
[default: false]
Constructs a new Create media upload instance.
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to
a Team Drive the user must be an organizer on the parent. If the target is a folder, all descendants owned
by the user are also deleted.
The ID of the file.
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to
a Team Drive the user must be an organizer on the parent. If the target is a folder, all descendants owned
by the user are also deleted.
Constructs a new Delete request.
The ID of the file.
Whether the requesting application supports Team Drives.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Permanently deletes all of the user's trashed files.
Permanently deletes all of the user's trashed files.
Constructs a new EmptyTrash request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes EmptyTrash parameter list.
Exports a Google Doc to the requested MIME type and returns the exported content. Please note that
the exported content is limited to 10MB.
The ID of the file.
The MIME type of the format
requested for this export.
Exports a Google Doc to the requested MIME type and returns the exported content. Please note that
the exported content is limited to 10MB.
Constructs a new Export request.
The ID of the file.
The MIME type of the format requested for this export.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Export parameter list.
Gets the media downloader.
Synchronously download the media into the given stream.
Warning: This method hides download errors; use instead.
Synchronously download the media into the given stream.
The final status of the download; including whether the download succeeded or failed.
Asynchronously download the media into the given stream.
Asynchronously download the media into the given stream.
Synchronously download a range of the media into the given stream.
Asynchronously download a range of the media into the given stream.
Generates a set of file IDs which can be provided in create requests.
Generates a set of file IDs which can be provided in create requests.
Constructs a new GenerateIds request.
The number of IDs to return.
[default: 10]
[minimum: 1]
[maximum: 1000]
The space in which the IDs can be used to create new files. Supported values are 'drive' and
'appDataFolder'.
[default: drive]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes GenerateIds parameter list.
Gets a file's metadata or content by ID.
The ID of the file.
Gets a file's metadata or content by ID.
Constructs a new Get request.
The ID of the file.
Whether the user is acknowledging the risk of downloading known malware or other abusive files.
This is only applicable when alt=media.
[default: false]
Whether the requesting application supports Team Drives.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Gets the media downloader.
Synchronously download the media into the given stream.
Warning: This method hides download errors; use instead.
Synchronously download the media into the given stream.
The final status of the download; including whether the download succeeded or failed.
Asynchronously download the media into the given stream.
Asynchronously download the media into the given stream.
Synchronously download a range of the media into the given stream.
Asynchronously download a range of the media into the given stream.
Lists or searches files.
Lists or searches files.
Constructs a new List request.
Comma-separated list of bodies of items (files/documents) to which the query applies. Supported
bodies are 'user', 'domain', 'teamDrive' and 'allTeamDrives'. 'allTeamDrives' must be combined with
'user'; all other values must be used in isolation. Prefer 'user' or 'teamDrive' to 'allTeamDrives' for
efficiency.
The source of files to list. Deprecated: use 'corpora' instead.
The source of files to list. Deprecated: use 'corpora' instead.
Files shared to the user's domain.
Files owned by or shared to the user.
Whether Team Drive items should be included in results.
[default: false]
A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder',
'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency',
'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be
reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note
that there is a current limitation for users with approximately one million files in which the requested
sort order is ignored.
The maximum number of files to return per page. Partial or empty result pages are possible even
before the end of the files list has been reached.
[default: 100]
[minimum: 1]
[maximum: 1000]
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response.
A query for filtering the file results. See the "Search for Files" guide for supported
syntax.
A comma-separated list of spaces to query within the corpus. Supported values are 'drive',
'appDataFolder' and 'photos'.
[default: drive]
Whether the requesting application supports Team Drives.
[default: false]
ID of Team Drive to search.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a file's metadata and/or content with patch semantics.
The body of the request.
The ID of the file.
Updates a file's metadata and/or content with patch semantics.
Constructs a new Update request.
The ID of the file.
A comma-separated list of parent IDs to add.
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Drive.
[default: false]
A language hint for OCR processing during image import (ISO 639-1 code).
A comma-separated list of parent IDs to remove.
Whether the requesting application supports Team Drives.
[default: false]
Whether to use the uploaded content as indexable text.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
Updates a file's metadata and/or content with patch semantics.
The body of the request.
The ID of the file.
The stream to upload.
The content type of the stream to upload.
Update media upload which supports resumable upload.
Data format for the response.
[default: json]
Data format for the response.
Responses with Content-Type of application/json
Selector specifying which fields to include in a partial response.
API key. Your API key identifies your project and provides you with API access, quota, and
reports. Required unless you provide an OAuth 2.0 token.
OAuth 2.0 token for the current user.
Returns response with indentations and line breaks.
[default: true]
An opaque string that represents a user for quota purposes. Must not exceed 40
characters.
Deprecated. Please use quotaUser instead.
The ID of the file.
A comma-separated list of parent IDs to add.
Whether to set the 'keepForever' field in the new head revision. This is only applicable to
files with binary content in Drive.
[default: false]
A language hint for OCR processing during image import (ISO 639-1 code).
A comma-separated list of parent IDs to remove.
Whether the requesting application supports Team Drives.
[default: false]
Whether to use the uploaded content as indexable text.
[default: false]
Constructs a new Update media upload instance.
Subscribes to changes to a file
The body of the request.
The ID of the file.
Subscribes to changes to a file
Constructs a new Watch request.
The ID of the file.
Whether the user is acknowledging the risk of downloading known malware or other abusive files.
This is only applicable when alt=media.
[default: false]
Whether the requesting application supports Team Drives.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Watch parameter list.
Gets the media downloader.
Synchronously download the media into the given stream.
Warning: This method hides download errors; use instead.
Synchronously download the media into the given stream.
The final status of the download; including whether the download succeeded or failed.
Asynchronously download the media into the given stream.
Asynchronously download the media into the given stream.
Synchronously download a range of the media into the given stream.
Asynchronously download a range of the media into the given stream.
The "permissions" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Creates a permission for a file or Team Drive.
The body of the request.
The ID of the file or Team Drive.
Creates a permission for a file or Team Drive.
Constructs a new Create request.
The ID of the file or Team Drive.
A plain text custom message to include in the notification email.
Whether to send a notification email when sharing to users or groups. This defaults to true for
users and groups, and is not allowed for other requests. It must not be disabled for ownership
transfers.
Whether the requesting application supports Team Drives.
[default: false]
Whether to transfer ownership to the specified user and downgrade the current owner to a
writer. This parameter is required as an acknowledgement of the side effect.
[default: false]
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
item belongs.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Create parameter list.
Deletes a permission.
The ID of the file or Team Drive.
The ID of the
permission.
Deletes a permission.
Constructs a new Delete request.
The ID of the file or Team Drive.
The ID of the permission.
Whether the requesting application supports Team Drives.
[default: false]
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
item belongs.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Gets a permission by ID.
The ID of the file.
The ID of the
permission.
Gets a permission by ID.
Constructs a new Get request.
The ID of the file.
The ID of the permission.
Whether the requesting application supports Team Drives.
[default: false]
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
item belongs.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Lists a file's or Team Drive's permissions.
The ID of the file or Team Drive.
Lists a file's or Team Drive's permissions.
Constructs a new List request.
The ID of the file or Team Drive.
The maximum number of permissions to return per page. When not set for files in a Team Drive,
at most 100 results will be returned. When not set for files that are not in a Team Drive, the entire
list will be returned.
[minimum: 1]
[maximum: 100]
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response.
Whether the requesting application supports Team Drives.
[default: false]
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
item belongs.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a permission with patch semantics.
The body of the request.
The ID of the file or Team Drive.
The ID of the
permission.
Updates a permission with patch semantics.
Constructs a new Update request.
The ID of the file or Team Drive.
The ID of the permission.
Whether to remove the expiration date.
[default: false]
Whether the requesting application supports Team Drives.
[default: false]
Whether to transfer ownership to the specified user and downgrade the current owner to a
writer. This parameter is required as an acknowledgement of the side effect.
[default: false]
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
item belongs.
[default: false]
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
The "replies" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Creates a new reply to a comment.
The body of the request.
The ID of the file.
The ID of the comment.
Creates a new reply to a comment.
Constructs a new Create request.
The ID of the file.
The ID of the comment.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Create parameter list.
Deletes a reply.
The ID of the file.
The ID of the
comment.
The ID of the reply.
Deletes a reply.
Constructs a new Delete request.
The ID of the file.
The ID of the comment.
The ID of the reply.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Gets a reply by ID.
The ID of the file.
The ID of the
comment.
The ID of the reply.
Gets a reply by ID.
Constructs a new Get request.
The ID of the file.
The ID of the comment.
The ID of the reply.
Whether to return deleted replies. Deleted replies will not include their original
content.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Lists a comment's replies.
The ID of the file.
The ID of the comment.
Lists a comment's replies.
Constructs a new List request.
The ID of the file.
The ID of the comment.
Whether to include deleted replies. Deleted replies will not include their original
content.
[default: false]
The maximum number of replies to return per page.
[default: 20]
[minimum: 1]
[maximum: 100]
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a reply with patch semantics.
The body of the request.
The ID of the file.
The ID of the
comment.
The ID of the reply.
Updates a reply with patch semantics.
Constructs a new Update request.
The ID of the file.
The ID of the comment.
The ID of the reply.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
The "revisions" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Permanently deletes a revision. This method is only applicable to files with binary content in
Drive.
The ID of the file.
The ID of the
revision.
Permanently deletes a revision. This method is only applicable to files with binary content in
Drive.
Constructs a new Delete request.
The ID of the file.
The ID of the revision.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Gets a revision's metadata or content by ID.
The ID of the file.
The ID of the
revision.
Gets a revision's metadata or content by ID.
Constructs a new Get request.
The ID of the file.
The ID of the revision.
Whether the user is acknowledging the risk of downloading known malware or other abusive files.
This is only applicable when alt=media.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Gets the media downloader.
Synchronously download the media into the given stream.
Warning: This method hides download errors; use instead.
Synchronously download the media into the given stream.
The final status of the download; including whether the download succeeded or failed.
Asynchronously download the media into the given stream.
Asynchronously download the media into the given stream.
Synchronously download a range of the media into the given stream.
Asynchronously download a range of the media into the given stream.
Lists a file's revisions.
The ID of the file.
Lists a file's revisions.
Constructs a new List request.
The ID of the file.
The maximum number of revisions to return per page.
[default: 200]
[minimum: 1]
[maximum: 1000]
The token for continuing a previous list request on the next page. This should be set to the
value of 'nextPageToken' from the previous response.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a revision with patch semantics.
The body of the request.
The ID of the file.
The ID of the
revision.
Updates a revision with patch semantics.
Constructs a new Update request.
The ID of the file.
The ID of the revision.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
The "teamdrives" collection of methods.
The service which this resource belongs to.
Constructs a new resource.
Creates a new Team Drive.
The body of the request.
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.
Creates a new Team Drive.
Constructs a new Create request.
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.
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Create parameter list.
Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain
any untrashed items.
The ID of the Team Drive
Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain
any untrashed items.
Constructs a new Delete request.
The ID of the Team Drive
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Delete parameter list.
Gets a Team Drive's metadata by ID.
The ID of the Team Drive
Gets a Team Drive's metadata by ID.
Constructs a new Get request.
The ID of the Team Drive
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then the requester will be granted access if they are an administrator of the domain to which the
Team Drive belongs.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Get parameter list.
Lists the user's Team Drives.
Lists the user's Team Drives.
Constructs a new List request.
Maximum number of Team Drives to return.
[default: 10]
[minimum: 1]
[maximum: 100]
Page token for Team Drives.
Query string for searching Team Drives.
Whether the request should be treated as if it was issued by a domain administrator; if set to
true, then all Team Drives of the domain in which the requester is an administrator are
returned.
[default: false]
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes List parameter list.
Updates a Team Drive's metadata
The body of the request.
The ID of the Team Drive
Updates a Team Drive's metadata
Constructs a new Update request.
The ID of the Team Drive
Gets or sets the body of this request.
Returns the body of the request.
Gets the method name.
Gets the HTTP method.
Gets the REST path.
Initializes Update parameter list.
Information about the user, the user's Drive, and system capabilities.
Whether the user has installed the requesting app.
Whether the user can create Team Drives.
A map of source MIME type to possible targets for all supported exports.
The currently supported folder colors as RGB hex strings.
A map of source MIME type to possible targets for all supported imports.
Identifies what kind of resource this is. Value: the fixed string "drive#about".
A map of maximum import sizes by MIME type, in bytes.
The maximum upload size in bytes.
The user's storage quota limits and usage. All fields are measured in bytes.
A list of themes that are supported for Team Drives.
The authenticated user.
The ETag of the item.
The user's storage quota limits and usage. All fields are measured in bytes.
The usage limit, if applicable. This will not be present if the user has unlimited
storage.
The total usage across all services.
The usage by all files in Google Drive.
The usage by trashed files in Google Drive.
A link to this Team Drive theme's background image.
The color of this Team Drive theme as an RGB hex string.
The ID of the theme.
A change to a file or Team Drive.
The updated state of the file. Present if the type is file and the file has not been removed from
this list of changes.
The ID of the file which has changed.
Identifies what kind of resource this is. Value: the fixed string "drive#change".
Whether the file or Team Drive has been removed from this list of changes, for example by deletion
or loss of access.
The updated state of the Team Drive. Present if the type is teamDrive, the user is still a member
of the Team Drive, and the Team Drive has not been removed.
The ID of the Team Drive associated with this change.
The time of this change (RFC 3339 date-time).
representation of .
The type of the change. Possible values are file and teamDrive.
The ETag of the item.
A list of changes for a user.
The list of changes. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
The starting page token for future changes. This will be present only if the end of the current
changes list has been reached.
The page token for the next page of changes. This will be absent if the end of the changes 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.
The ETag of the item.
An notification channel used to watch for resource changes.
The address where notifications are delivered for this channel.
Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds.
Optional.
A UUID or similar unique string that identifies this channel.
Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed
string "api#channel".
Additional parameters controlling delivery channel behavior. Optional.
A Boolean value to indicate whether payload is wanted. Optional.
An opaque ID that identifies the resource being watched on this channel. Stable across different
API versions.
A version-specific identifier for the watched resource.
An arbitrary string delivered to the target address with each notification delivered over this
channel. Optional.
The type of delivery mechanism used for this channel.
The ETag of the item.
A comment on a file.
A region of the document represented as a JSON string. See anchor documentation for details on how
to define and interpret anchor properties.
The user who created the comment.
The plain text content of the comment. This field is used for setting the content, while
htmlContent should be displayed.
The time at which the comment was created (RFC 3339 date-time).
representation of .
Whether the comment has been deleted. A deleted comment has no content.
The content of the comment with HTML formatting.
The ID of the comment.
Identifies what kind of resource this is. Value: the fixed string "drive#comment".
The last time the comment or any of its replies was modified (RFC 3339 date-time).
representation of .
The file content to which the comment refers, typically within the anchor region. For a text file,
for example, this would be the text at the location of the comment.
The full list of replies to the comment in chronological order.
Whether the comment has been resolved by one of its replies.
The ETag of the item.
The file content to which the comment refers, typically within the anchor region. For a text file,
for example, this would be the text at the location of the comment.
The MIME type of the quoted content.
The quoted content itself. This is interpreted as plain text if set through the API.
A list of comments on a file.
The list of comments. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
Identifies what kind of resource this is. Value: the fixed string "drive#commentList".
The page token for the next page of comments. This will be absent if the end of the comments 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.
The ETag of the item.
The metadata for a file.
A collection of arbitrary key-value pairs which are private to the requesting app. Entries with
null values are cleared in update and copy requests.
Capabilities the current user has on this file. Each capability corresponds to a fine-grained
action that a user may take.
Additional information about the content of the file. These fields are never populated in
responses.
The time at which the file was created (RFC 3339 date-time).
representation of .
A short description of the file.
Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent
folder.
The final component of fullFileExtension. This is only available for files with binary content in
Drive.
The color for a folder as an RGB hex string. The supported colors are published in the
folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in
the palette will be used instead.
The full file extension extracted from the name field. May contain multiple concatenated
extensions, such as "tar.gz". This is only available for files with binary content in Drive. This is
automatically updated when the name field changes, however it is not cleared if the new name does not
contain a valid extension.
Whether any users are granted file access directly on this file. This field is only populated for
Team Drive files.
Whether this file has a thumbnail. This does not indicate whether the requesting app has access to
the thumbnail. To check access, look for the presence of the thumbnailLink field.
The ID of the file's head revision. This is currently only available for files with binary content
in Drive.
A static, unauthenticated link to the file's icon.
The ID of the file.
Additional metadata about image media, if available.
Whether the file was created or opened by the requesting app.
Identifies what kind of resource this is. Value: the fixed string "drive#file".
The last user to modify the file.
The MD5 checksum for the content of the file. This is only applicable to files with binary content
in Drive.
The MIME type of the file. Drive will attempt to automatically detect an appropriate value from
uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If
a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The
supported import formats are published in the About resource.
Whether the file has been modified by this user.
The last time the file was modified by the user (RFC 3339 date-time).
representation of .
The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime
will also update modifiedByMeTime for the user.
representation of .
The name of the file. This is not necessarily unique within a folder. Note that for immutable items
such as the top level folders of Team Drives, My Drive root folder, and Application Data folder the name is
constant.
The original filename of the uploaded content if available, or else the original value of the name
field. This is only available for files with binary content in Drive.
Whether the user owns the file. Not populated for Team Drive files.
The owners of the file. Currently, only certain legacy files may have more than one owner. Not
populated for Team Drive files.
The IDs of the parent folders which contain the file. If not specified as part of a create request,
the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request,
the file will inherit any discoverable parents of the source file. Update requests must use the addParents
and removeParents parameters to modify the parents list.
List of permission IDs for users with access to this file.
The full list of permissions for the file. This is only available if the requesting user can share
the file. Not populated for Team Drive files.
A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values
are cleared in update and copy requests.
The number of storage quota bytes used by the file. This includes the head revision as well as
previous revisions with keepForever enabled.
Whether the file has been shared. Not populated for Team Drive files.
The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
representation of .
The user who shared the file with the requesting user, if applicable.
The size of the file's content in bytes. This is only applicable to files with binary content in
Drive.
The list of spaces which contain the file. The currently supported values are 'drive',
'appDataFolder' and 'photos'.
Whether the user has starred the file.
ID of the Team Drive the file resides in.
A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours.
Only populated when the requesting app can access the file's content.
The thumbnail version for use in thumbnail cache invalidation.
Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the
owner may trash a file, and other users cannot see files in the owner's trash.
The time that the item was trashed (RFC 3339 date-time). Only populated for Team Drive
files.
representation of .
If the file has been explicitly trashed, the user who trashed it. Only populated for Team Drive
files.
A monotonically increasing version number for the file. This reflects every change made to the file
on the server, even those not visible to the user.
Additional metadata about video media. This may not be available immediately upon upload.
Whether the file has been viewed by this user.
The last time the file was viewed by the user (RFC 3339 date-time).
representation of .
Whether users with only reader or commenter permission can copy the file's content. This affects
copy, download, and print operations.
A link for downloading the content of the file in a browser. This is only available for files with
binary content in Drive.
A link for opening the file in a relevant Google editor or viewer in a browser.
Whether users with only writer permission can modify the file's permissions. Not populated for Team
Drive files.
The ETag of the item.
Capabilities the current user has on this file. Each capability corresponds to a fine-grained
action that a user may take.
Whether the current user can add children to this folder. This is always false when the item is
not a folder.
Whether the current user can change whether viewers can copy the contents of this
file.
Whether the current user can comment on this file.
Whether the current user can copy this file. For a Team Drive item, whether the current user
can copy non-folder descendants of this item, or this item itself if it is not a folder.
Whether the current user can delete this file.
Whether the current user can download this file.
Whether the current user can edit this file.
Whether the current user can list the children of this folder. This is always false when the
item is not a folder.
Whether the current user can move this item into a Team Drive. If the item is in a Team Drive,
this field is equivalent to canMoveTeamDriveItem.
Whether the current user can move this Team Drive item by changing its parent. Note that a
request to change the parent for this item may still fail depending on the new parent that is being
added. Only populated for Team Drive files.
Whether the current user can read the revisions resource of this file. For a Team Drive item,
whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can
be read.
Whether the current user can read the Team Drive to which this file belongs. Only populated for
Team Drive files.
Whether the current user can remove children from this folder. This is always false when the
item is not a folder.
Whether the current user can rename this file.
Whether the current user can modify the sharing settings for this file.
Whether the current user can move this file to trash.
Whether the current user can restore this file from trash.
Additional information about the content of the file. These fields are never populated in
responses.
Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length
and may contain HTML elements.
A thumbnail for the file. This will only be used if Drive cannot generate a standard
thumbnail.
A thumbnail for the file. This will only be used if Drive cannot generate a standard
thumbnail.
The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5).
The MIME type of the thumbnail.
Additional metadata about image media, if available.
The aperture used to create the photo (f-number).
The make of the camera used to create the photo.
The model of the camera used to create the photo.
The color space of the photo.
The exposure bias of the photo (APEX value).
The exposure mode used to create the photo.
The length of the exposure, in seconds.
Whether a flash was used to create the photo.
The focal length used to create the photo, in millimeters.
The height of the image in pixels.
The ISO speed used to create the photo.
The lens used to create the photo.
Geographic location information stored in the image.
The smallest f-number of the lens at the focal length used to create the photo (APEX
value).
The metering mode used to create the photo.
The rotation in clockwise degrees from the image's original orientation.
The type of sensor used to create the photo.
The distance to the subject of the photo, in meters.
The date and time the photo was taken (EXIF DateTime).
The white balance mode used to create the photo.
The width of the image in pixels.
Geographic location information stored in the image.
The altitude stored in the image.
The latitude stored in the image.
The longitude stored in the image.
Additional metadata about video media. This may not be available immediately upon upload.
The duration of the video in milliseconds.
The height of the video in pixels.
The width of the video in pixels.
A list of files.
The list of files. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
Whether the search process was incomplete. If true, then some search results may be missing, since
all documents were not searched. This may occur when searching multiple Team Drives with the
"user,allTeamDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that
clients narrow their query by choosing a different corpus such as "user" or "teamDrive".
Identifies what kind of resource this is. Value: the fixed string "drive#fileList".
The page token for the next page of files. This will be absent if the end of the files 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.
The ETag of the item.
A list of generated file IDs which can be provided in create requests.
The IDs generated for the requesting user in the specified space.
Identifies what kind of resource this is. Value: the fixed string "drive#generatedIds".
The type of file that can be created with these IDs.
The ETag of the item.
A permission for a file. A permission grants a user, group, domain or the world access to a file or a
folder hierarchy.
Whether the permission allows the file to be discovered through search. This is only applicable for
permissions of type domain or anyone.
Whether the account associated with this permission has been deleted. This field only pertains to
user and group permissions.
A displayable name for users, groups or domains.
The domain to which this permission refers.
The email address of the user or group to which this permission refers.
The time at which this permission will expire (RFC 3339 date-time). Expiration times have the
following restrictions: - They can only be set on user and group permissions - The time must be in the
future - The time cannot be more than a year in the future
representation of .
The ID of this permission. This is a unique identifier for the grantee, and is published in User
resources as permissionId.
Identifies what kind of resource this is. Value: the fixed string "drive#permission".
A link to the user's profile photo, if available.
The role granted by this permission. While new values may be supported in the future, the following
are currently allowed: - organizer - owner - writer - commenter - reader
Details of whether the permissions on this Team Drive item are inherited or directly on this item.
This is an output-only field which is present only for Team Drive items.
The type of the grantee. Valid values are: - user - group - domain - anyone
The ETag of the item.
Whether this permission is inherited. This field is always populated. This is an output-only
field.
The ID of the item from which this permission is inherited. This is an output-only field and is
only populated for members of the Team Drive.
The primary role for this user. While new values may be added in the future, the following are
currently possible: - organizer - writer - commenter - reader
The Team Drive permission type for this user. While new values may be added in future, the
following are currently possible: - file - member
A list of permissions for a file.
Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
The page token for the next page of permissions. This field will be absent if the end of the
permissions 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.
The list of permissions. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
The ETag of the item.
A reply to a comment on a file.
The action the reply performed to the parent comment. Valid values are: - resolve -
reopen
The user who created the reply.
The plain text content of the reply. This field is used for setting the content, while htmlContent
should be displayed. This is required on creates if no action is specified.
The time at which the reply was created (RFC 3339 date-time).
representation of .
Whether the reply has been deleted. A deleted reply has no content.
The content of the reply with HTML formatting.
The ID of the reply.
Identifies what kind of resource this is. Value: the fixed string "drive#reply".
The last time the reply was modified (RFC 3339 date-time).
representation of .
The ETag of the item.
A list of replies to a comment on a file.
Identifies what kind of resource this is. Value: the fixed string "drive#replyList".
The page token for the next page of replies. This will be absent if the end of the replies 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.
The list of replies. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
The ETag of the item.
The metadata for a revision to a file.
The ID of the revision.
Whether to keep this revision forever, even if it is no longer the head revision. If not set, the
revision will be automatically purged 30 days after newer content is uploaded. This can be set on a maximum
of 200 revisions for a file. This field is only applicable to files with binary content in Drive.
Identifies what kind of resource this is. Value: the fixed string "drive#revision".
The last user to modify this revision.
The MD5 checksum of the revision's content. This is only applicable to files with binary content in
Drive.
The MIME type of the revision.
The last time the revision was modified (RFC 3339 date-time).
representation of .
The original filename used to create this revision. This is only applicable to files with binary
content in Drive.
Whether subsequent revisions will be automatically republished. This is only applicable to Google
Docs.
Whether this revision is published. This is only applicable to Google Docs.
Whether this revision is published outside the domain. This is only applicable to Google
Docs.
The size of the revision's content in bytes. This is only applicable to files with binary content
in Drive.
The ETag of the item.
A list of revisions of a file.
Identifies what kind of resource this is. Value: the fixed string "drive#revisionList".
The page token for the next page of revisions. This will be absent if the end of the revisions 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.
The list of revisions. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
The ETag of the item.
Identifies what kind of resource this is. Value: the fixed string "drive#startPageToken".
The starting page token for listing changes.
The ETag of the item.
Representation of a Team Drive.
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.
A short-lived link to this Team Drive's background image.
Capabilities the current user has on this Team Drive.
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.
The time at which the Team Drive was created (RFC 3339 date-time).
representation of .
The ID of this Team Drive which is also the ID of the top level folder for this Team
Drive.
Identifies what kind of resource this is. Value: the fixed string "drive#teamDrive".
The name of this Team Drive.
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.
The ETag of the item.
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.
The ID of an image file in Drive to use for the background image.
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.
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.
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.
Capabilities the current user has on this Team Drive.
Whether the current user can add children to folders in this Team Drive.
Whether the current user can change the background of this Team Drive.
Whether the current user can comment on files in this Team Drive.
Whether the current user can copy files in this Team Drive.
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.
Whether the current user can download files in this Team Drive.
Whether the current user can edit files in this Team Drive
Whether the current user can list the children of folders in this Team Drive.
Whether the current user can add members to this Team Drive or remove them or change their
role.
Whether the current user can read the revisions resource of files in this Team Drive.
Whether the current user can remove children from folders in this Team Drive.
Whether the current user can rename files or folders in this Team Drive.
Whether the current user can rename this Team Drive.
Whether the current user can share files or folders in this Team Drive.
A list of Team Drives.
Identifies what kind of resource this is. Value: the fixed string "drive#teamDriveList".
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.
The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an
additional page of results should be fetched.
The ETag of the item.
Information about a Drive user.
A plain text displayable name for this user.
The email address of the user. This may not be present in certain contexts if the user has not made
their email address visible to the requester.
Identifies what kind of resource this is. Value: the fixed string "drive#user".
Whether this user is the requesting user.
The user's ID as visible in Permission resources.
A link to the user's profile photo, if available.
The ETag of the item.