View Source API Reference google_api_drive v0.27.1
Modules
API client metadata for GoogleApi.Drive.V3.
API calls for all endpoints tagged About
.
API calls for all endpoints tagged Apps
.
API calls for all endpoints tagged Changes
.
API calls for all endpoints tagged Channels
.
API calls for all endpoints tagged Comments
.
API calls for all endpoints tagged Drives
.
API calls for all endpoints tagged Files
.
API calls for all endpoints tagged Permissions
.
API calls for all endpoints tagged Replies
.
API calls for all endpoints tagged Revisions
.
API calls for all endpoints tagged Teamdrives
.
Handle Tesla connections for GoogleApi.Drive.V3.
Information about the user, the user's Drive, and system capabilities.
The user's storage quota limits and usage. All fields are measured in bytes.
The apps
resource provides a list of 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.
Attributes
-
category
(type:String.t
, default:nil
) - Category of the icon. Allowed values are:application
- The icon for the application.document
- The icon for a file associated with the app. *documentShared
- The icon for a shared file associated with the app. -
iconUrl
(type:String.t
, default:nil
) - URL for the icon. -
size
(type:integer()
, default:nil
) - Size of the icon. Represented as the maximum of the width and height.
A list of third-party applications which the user has installed or given access to Google Drive.
A change to a file or shared drive.
A list of changes for a user.
A notification channel used to watch for resource changes.
A comment on a file. Some resource methods (such as comments.update
) require a commentId
. Use the comments.list
method to retrieve the ID for a comment in a file.
A list of comments on a file.
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.
A restriction for accessing the content of the file.
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.
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.
Output only. Capabilities the current user has on this shared drive.
A list of shared drives.
A set of restrictions that apply to this shared drive or items inside this shared drive. Note that restrictions can't be set when creating a shared drive. To add a restriction, first create a shared drive and then use drives.update
to add restrictions.
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.
Output only. 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.
A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.
Output only. Additional metadata about image media, if available.
Output only. Geographic location information stored in the image.
Output only. An overview of the labels on the file.
Contains details about the link URLs that clients are using to refer to this item.
A list of files.
Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut
.
Output only. Additional metadata about video media. This may not be available immediately upon upload.
A list of generated file IDs which can be provided in create requests.
Representation of label and label fields.
Representation of field, which is a typed key-value pair.
A modification to a label's field.
A list of labels applied to a file.
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.
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.
Response to a ModifyLabels request. This contains only those labels which were added or updated by the request.
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.
A list of permissions for a file.
Attributes
-
inherited
(type:boolean()
, default:nil
) - Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. -
inheritedFrom
(type:String.t
, default:nil
) - Output only. The ID of the item from which this permission is inherited. This is an output-only field. -
permissionType
(type:String.t
, default:nil
) - Output only. The permission type for this user. While new values may be added in future, the following are currently possible:file
member
-
role
(type:String.t
, default:nil
) - Output only. The primary role for this user. While new values may be added in the future, the following are currently possible:organizer
fileOrganizer
writer
commenter
*reader
Attributes
-
inherited
(type:boolean()
, default:nil
) - Deprecated: Output only. UsepermissionDetails/inherited
instead. -
inheritedFrom
(type:String.t
, default:nil
) - Deprecated: Output only. UsepermissionDetails/inheritedFrom
instead. -
role
(type:String.t
, default:nil
) - Deprecated: Output only. UsepermissionDetails/role
instead. -
teamDrivePermissionType
(type:String.t
, default:nil
) - Deprecated: Output only. UsepermissionDetails/permissionType
instead.
A reply to a comment on a file. Some resource methods (such as replies.update
) require a replyId
. Use the replies.list
method to retrieve the ID for a reply.
A list of replies to a comment on a file.
The metadata for a revision to a file. Some resource methods (such as revisions.update
) require a revisionId
. Use the revisions.list
method to retrieve the ID for a revision.
A list of revisions of a file.
Deprecated: use the drive collection instead.
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.
Capabilities the current user has on this Team Drive.
A list of Team Drives.
A set of restrictions that apply to this Team Drive or items inside this Team Drive.
Information about a Drive user.