Module api

Module api 

Source

Structs§

About
An item with user information and settings.
AboutAdditionalRoleInfo
Information about supported additional roles per file type. The most specific type takes precedence.
AboutAdditionalRoleInfoRoleSets
The supported additional roles per primary role.
AboutDriveThemes
A list of themes that are supported for shared drives.
AboutExportFormats
The allowable export formats.
AboutFeatures
List of additional features enabled on this account.
AboutGetCall
Gets the information about the current user along with Drive API settings
AboutImportFormats
The allowable import formats.
AboutMaxUploadSizes
List of max upload sizes for each file type. The most specific type takes precedence.
AboutMethods
A builder providing access to all methods supported on about resources. It is not used directly, but through the DriveHub hub.
AboutQuotaBytesByService
The amount of storage quota used by different Google services.
AboutTeamDriveThemes
Deprecated: Use driveThemes instead.
App
The apps resource provides a list of the apps that a user has installed, with information about each app’s supported MIME types, file extensions, and other details. Some resource methods (such as apps.get) require an appId. Use the apps.list method to retrieve the ID for an installed application.
AppGetCall
Gets a specific app.
AppIcons
The various icons for the app.
AppList
A list of third-party applications which the user has installed or given access to Google Drive.
AppListCall
Lists a user’s installed apps.
AppMethods
A builder providing access to all methods supported on app resources. It is not used directly, but through the DriveHub hub.
Change
Representation of a change to a file or shared drive.
ChangeGetCall
Deprecated: Use changes.getStartPageToken and changes.list to retrieve recent changes.
ChangeGetStartPageTokenCall
Gets the starting pageToken for listing future changes.
ChangeList
A list of changes for a user.
ChangeListCall
Lists the changes for a user or shared drive.
ChangeMethods
A builder providing access to all methods supported on change resources. It is not used directly, but through the DriveHub hub.
ChangeWatchCall
Subscribe to changes for a user.
Channel
A notification channel used to watch for resource changes.
ChannelMethods
A builder providing access to all methods supported on channel resources. It is not used directly, but through the DriveHub hub.
ChannelStopCall
Stops watching resources through this channel.
ChildDeleteCall
Removes a child from a folder.
ChildGetCall
Gets a specific child reference.
ChildInsertCall
Inserts a file into a folder.
ChildList
A list of children of a file.
ChildListCall
Lists a folder’s children.
ChildMethods
A builder providing access to all methods supported on child resources. It is not used directly, but through the DriveHub hub.
ChildReference
A reference to a folder’s child. Some resource methods (such as children.get) require a childId. Use the children.list method to retrieve the ID of the child.
Comment
A comment on a file in Google Drive.
CommentContext
Context of a file which is being commented on.
CommentDeleteCall
Deletes a comment.
CommentGetCall
Gets a comment by ID.
CommentInsertCall
Creates a new comment on the given file.
CommentList
A list of comments on a file in Google Drive.
CommentListCall
Lists a file’s comments.
CommentMethods
A builder providing access to all methods supported on comment resources. It is not used directly, but through the DriveHub hub.
CommentPatchCall
Updates an existing comment.
CommentReply
A reply to a comment on a file in Google Drive.
CommentReplyList
A list of replies to a comment on a file in Google Drive.
CommentUpdateCall
Updates an existing comment.
ContentRestriction
A restriction for accessing the content of the file.
Drive
Representation of a shared drive. Some resource methods (such as drives.update) require a driveId. Use the drives.list method to retrieve the ID for a shared drive.
DriveBackgroundImageFile
An image file and cropping parameters from which a background image for this shared drive is set. This is a write only field; it can only be set on drive.drives.update requests that don’t set themeId. When specified, all fields of the backgroundImageFile must be set.
DriveCapabilities
Output only. Capabilities the current user has on this shared drive.
DriveDeleteCall
Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items.
DriveGetCall
Gets a shared drive’s metadata by ID.
DriveHideCall
Hides a shared drive from the default view.
DriveHub
Central instance to access all DriveHub related resource activities
DriveInsertCall
Creates a new shared drive.
DriveList
A list of shared drives.
DriveListCall
Lists the user’s shared drives. This method accepts the q parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide.
DriveMethods
A builder providing access to all methods supported on drive resources. It is not used directly, but through the DriveHub hub.
DriveRestrictions
A set of restrictions that apply to this shared drive or items inside this shared drive.
DriveUnhideCall
Restores a shared drive to the default view.
DriveUpdateCall
Updates the metadata for a shared drive.
File
The metadata for a file. Some resource methods (such as files.update) require a fileId. Use the files.list method to retrieve the ID for a file.
FileCapabilities
Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
FileCopyCall
Creates a copy of the specified file.
FileDeleteCall
Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive, the user must be an organizer on the parent folder. If the target is a folder, all descendants owned by the user are also deleted.
FileEmptyTrashCall
Permanently deletes all of the user’s trashed files.
FileExportCall
Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.
FileGenerateIdCall
Generates a set of file IDs which can be provided in insert or copy requests.
FileGetCall
Gets a file’s metadata or content by ID. If you provide the URL parameter alt=media, then the response includes the file contents in the response body. Downloading content with alt=media only works if the file is stored in Drive. To download Google Docs, Sheets, and Slides use files.export instead. For more information, see Download & export files.
FileImageMediaMetadata
Output only. Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.
FileImageMediaMetadataLocation
Output only. Geographic location information stored in the image.
FileIndexableText
Indexable text attributes for the file (can only be written)
FileInsertCall
Inserts a new file. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types:*/* Note: Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information on uploading files, see Upload file data. Apps creating shortcuts with files.insert must specify the MIME type application/vnd.google-apps.shortcut. Apps should specify a file extension in the title property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "title": "cat.jpg" in the metadata. Subsequent GET requests include the read-only fileExtension property populated with the extension originally specified in the title property. When a Google Drive user requests to download a file, or when the file is downloaded through the sync client, Drive builds a full filename (with extension) based on the title. In cases where the extension is missing, Drive attempts to determine the extension based on the file’s MIME type.
FileLabelInfo
Output only. An overview of the labels on the file.
FileLabels
A group of labels for the file.
FileLinkShareMetadata
Contains details about the link URLs that clients are using to refer to this item.
FileList
A list of files.
FileListCall
Lists the user’s files. For more information, see Search for files and folders. This method accepts the q parameter, which is a search query combining one or more search terms. This method returns all files by default, including trashed files. If you don’t want trashed files to appear in the list, use the trashed=false query parameter to remove trashed files from the results.
FileListLabelCall
Lists the labels on a file.
FileMethods
A builder providing access to all methods supported on file resources. It is not used directly, but through the DriveHub hub.
FileModifyLabelCall
Modifies the set of labels applied to a file. Returns a list of the labels that were added or modified.
FilePatchCall
Updates a file’s metadata and/or content. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might change automatically, such as modifiedDate. This method supports patch semantics.
FileShortcutDetails
Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. Can only be set on files.insert requests.
FileThumbnail
A thumbnail for the file. This will only be used if a standard thumbnail cannot be generated.
FileTouchCall
Set the file’s updated time to the current server time.
FileTrashCall
Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.
FileUntrashCall
Restores a file from the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.
FileUpdateCall
Updates a file’s metadata, content, or both. When calling this method, only populate fields in the request that you want to modify. When updating fields, some fields might be changed automatically, such as modifiedDate. This method supports patch semantics. This method supports an /upload URI and accepts uploaded media with the following characteristics: - Maximum file size: 5,120 GB - Accepted Media MIME types: */* (Specify a valid MIME type, rather than the literal */* value. The literal */* is only used to indicate that any valid MIME type can be uploaded. For more information, see Google Workspace and Google Drive supported MIME types.) For more information on uploading files, see Upload file data.
FileVideoMediaMetadata
Output only. Metadata about video media. This will only be present for video types.
FileWatchCall
Subscribes to changes to a file.
GeneratedIds
A list of generated IDs which can be provided in insert requests
Label
Representation of a label and label fields.
LabelField
Representation of field, which is a typed key-value pair.
LabelFieldModification
A modification to a label’s field.
LabelList
A list of labels applied to a file.
LabelModification
A modification to a label on a file. A LabelModification can be used to apply a label to a file, update an existing label on a file, or remove a label from a file.
ModifyLabelsRequest
A request to modify the set of labels on a file. This request may contain many modifications that will either all succeed or all fail atomically.
ModifyLabelsResponse
Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.
ParentDeleteCall
Removes a parent from a file.
ParentGetCall
Gets a specific parent reference.
ParentInsertCall
Adds a parent folder for a file.
ParentList
A list of a file’s parents.
ParentListCall
Lists a file’s parents.
ParentMethods
A builder providing access to all methods supported on parent resources. It is not used directly, but through the DriveHub hub.
ParentReference
A reference to a file’s parent. A file can only have one parent folder; specifying multiple parents isn’t supported. Some resource methods (such as parents.get) require a parentId. Use the parents.list method to retrieve the ID for a parent.
Permission
A permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. Some resource methods (such as permissions.update) require a permissionId. Use the permissions.list method to retrieve the ID for a file, folder, or shared drive.
PermissionDeleteCall
Deletes a permission from a file or shared drive. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
PermissionGetCall
Gets a permission by ID.
PermissionGetIdForEmailCall
Returns the permission ID for an email address.
PermissionId
An ID for a user or group as seen in Permission items.
PermissionInsertCall
Inserts a permission for a file or shared drive. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
PermissionList
A list of permissions associated with a file.
PermissionListCall
Lists a file’s or shared drive’s permissions.
PermissionMethods
A builder providing access to all methods supported on permission resources. It is not used directly, but through the DriveHub hub.
PermissionPatchCall
Updates a permission using patch semantics. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
PermissionPermissionDetails
Output only. Details of whether the permissions on this item are inherited or directly on this item.
PermissionTeamDrivePermissionDetails
Output only. Deprecated: Use permissionDetails instead.
PermissionUpdateCall
Updates a permission. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.
Property
A key-value pair attached to a file that is either public or private to an application. The following limits apply to file properties: * Maximum of 100 properties total per file * Maximum of 30 private properties per app * Maximum of 30 public properties * Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property Some resource methods (such as properties.update) require a propertyKey. Use the properties.list method to retrieve the key for a property.
PropertyDeleteCall
Deletes a property.
PropertyGetCall
Gets a property by its key.
PropertyInsertCall
Adds a property to a file, or updates it if it already exists.
PropertyList
A collection of properties, key-value pairs that are either public or private to an application.
PropertyListCall
Lists a file’s properties.
PropertyMethods
A builder providing access to all methods supported on property resources. It is not used directly, but through the DriveHub hub.
PropertyPatchCall
Updates a property.
PropertyUpdateCall
Updates a property.
ReplyDeleteCall
Deletes a reply.
ReplyGetCall
Gets a reply.
ReplyInsertCall
Creates a new reply to the given comment.
ReplyListCall
Lists all of the replies to a comment.
ReplyMethods
A builder providing access to all methods supported on reply resources. It is not used directly, but through the DriveHub hub.
ReplyPatchCall
Updates an existing reply.
ReplyUpdateCall
Updates an existing reply.
Revision
A revision of a file. Some resource methods (such as revisions.update) require a revisionId. Use the revisions.list method to retrieve the ID for a revision.
RevisionDeleteCall
Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can’t be deleted.
RevisionGetCall
Gets a specific revision.
RevisionList
A list of revisions of a file.
RevisionListCall
Lists a file’s revisions. Important: The list of revisions returned by this method might be incomplete for files with a large revision history, including frequently edited Google Docs, Sheets, and Slides. Older revisions might be omitted from the response, meaning the first revision returned may not be the oldest existing revision. The revision history visible in the Workspace editor user interface might be more complete than the list returned by the API.
RevisionMethods
A builder providing access to all methods supported on revision resources. It is not used directly, but through the DriveHub hub.
RevisionPatchCall
Updates a revision.
RevisionUpdateCall
Updates a revision.
StartPageToken
There is no detailed description.
TeamDrive
Deprecated: Use the drive collection instead.
TeamDriveBackgroundImageFile
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.
TeamDriveCapabilities
Capabilities the current user has on this Team Drive.
TeamDriveList
A list of Team Drives.
TeamDriveRestrictions
A set of restrictions that apply to this Team Drive or items inside this Team Drive.
TeamdriveDeleteCall
Deprecated: Use drives.delete instead.
TeamdriveGetCall
Deprecated: Use drives.get instead.
TeamdriveInsertCall
Deprecated: Use drives.insert instead.
TeamdriveListCall
Deprecated: Use drives.list instead.
TeamdriveMethods
A builder providing access to all methods supported on teamdrive resources. It is not used directly, but through the DriveHub hub.
TeamdriveUpdateCall
Deprecated: Use drives.update instead.
User
Information about a Drive user.
UserPicture
Output only. The user’s profile picture.

Enums§

Scope
Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.