Class: Google::Apis::DriveV3::DriveService

Inherits:

Core::BaseService

Object
Core::BaseService
Google::Apis::DriveV3::DriveService

show all

Defined in:: lib/google/apis/drive_v3/service.rb

Overview

Google Drive API

The Google Drive API allows clients to access resources from Google Drive.

Examples:

require 'google/apis/drive_v3'

Drive = Google::Apis::DriveV3 # Alias the module
service = Drive::DriveService.new

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE =

"https://www.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::File
Creates a copy of a file and applies any requested updates with patch semantics.
#create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment
Creates a comment on a file.
#create_drive(request_id, drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive
Creates a shared drive.
#create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::File
Creates a file.
#create_permission(file_id, permission_object = nil, email_message: nil, enforce_expansive_access: nil, enforce_single_parent: nil, move_to_new_owners_root: nil, send_notification_email: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Permission
Creates a permission for a file or shared drive.
#create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply
Creates a reply to a comment.
#create_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive
Deprecated: Use drives.create instead.
#delete_comment(file_id, comment_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes a comment.
#delete_drive(drive_id, allow_item_deletion: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Permanently deletes a shared drive for which the user is an organizer.
#delete_file(file_id, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Permanently deletes a file owned by the user without moving it to the trash.
#delete_permission(file_id, permission_id, enforce_expansive_access: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes a permission.
#delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deletes a reply.
#delete_revision(file_id, revision_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Permanently deletes a file version.
#delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Deprecated: Use drives.delete instead.
#download_file(file_id, mime_type: nil, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Operation
Downloads the content of a file.
#empty_file_trash(drive_id: nil, enforce_single_parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Permanently deletes all of the user's trashed files.
#export_file(file_id, mime_type, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }
Exports a Google Workspace document to the requested MIME type and returns exported byte content.
#generate_file_ids(count: nil, space: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::GeneratedIds
Generates a set of file IDs which can be provided in create or copy requests.
#get_about(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::About
Gets information about the user, the user's Drive, and system capabilities.
#get_accessproposal(file_id, proposal_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::AccessProposal
Retrieves an access proposal by ID.
#get_app(app_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::App
Gets a specific app.
#get_changes_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::StartPageToken
Gets the starting pageToken for listing future changes.
#get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment
Gets a comment by ID.
#get_drive(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive
Gets a shared drive's metadata by ID.
#get_file(file_id, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::File
Gets a file's metadata or content by ID.
#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Operation
Gets the latest state of a long-running operation.
#get_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Permission
Gets a permission by ID.
#get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply
Gets a reply by ID.
#get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Revision
Gets a revision's metadata or content by ID.
#get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive
Deprecated: Use drives.get instead.
#hide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive
Hides a shared drive from the default view.
#initialize ⇒ DriveService constructor
A new instance of DriveService.
#list_accessproposals(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ListAccessProposalsResponse
List the access proposals on a file.
#list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::AppList
Lists a user's installed apps.
#list_changes(page_token, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ChangeList
Lists the changes for a user or shared drive.
#list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::CommentList
Lists a file's comments.
#list_drives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::DriveList
Lists the user's shared drives.
#list_file_labels(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::LabelList
Lists the labels on a file.
#list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_team_drive_items: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::FileList
Lists the user's files.
#list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::PermissionList
Lists a file's or shared drive's permissions.
#list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ReplyList
Lists a comment's replies.
#list_revisions(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::RevisionList
Lists a file's revisions.
#list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDriveList
Deprecated: Use drives.list instead.
#modify_file_labels(file_id, modify_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ModifyLabelsResponse
Modifies the set of labels applied to a file.
#resolve_accessproposal_access_proposal(file_id, proposal_id, resolve_access_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Approves or denies an access proposal.
#stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }
Stops watching resources through this channel.
#unhide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive
Restores a shared drive to the default view.
#update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment
Updates a comment with patch semantics.
#update_drive(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive
Updates the metadata for a shared drive.
#update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::File
Updates a file's metadata, content, or both.
#update_permission(file_id, permission_id, permission_object = nil, enforce_expansive_access: nil, remove_expiration: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Permission
Updates a permission with patch semantics.
#update_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply
Updates a reply with patch semantics.
#update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Revision
Updates a revision with patch semantics.
#update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive
Deprecated: Use drives.update instead.
#watch_change(page_token, channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Channel
Subscribes to changes for a user.
#watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Channel
Subscribes to changes to a file.

Constructor Details

#initialize ⇒ `DriveService`

Returns a new instance of DriveService.

# File 'lib/google/apis/drive_v3/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, 'drive/v3/',
        client_name: 'google-apis-drive_v3',
        client_version: Google::Apis::DriveV3::GEM_VERSION)
  @batch_path = 'batch/drive/v3'
end

Instance Attribute Details

#key ⇒ `String`

Returns 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.

Returns:

(String) —
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.



40
41
42

# File 'lib/google/apis/drive_v3/service.rb', line 40

def key
  @key
end

#quota_user ⇒ `String`

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

(String) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47

# File 'lib/google/apis/drive_v3/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::File`

Creates a copy of a file and applies any requested updates with patch semantics. For more information, see Create and manage files.

Parameters:

file_id (String) —
The ID of the file.
file_object (Google::Apis::DriveV3::File) (defaults to: nil)
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: Copying files into multiple folders is no longer supported. Use shortcuts instead.
ignore_default_visibility (Boolean) (defaults to: nil) —
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.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
keep_revision_forever (Boolean) (defaults to: nil) —
Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocr_language (String) (defaults to: nil) —
A language hint for OCR processing during image import (ISO 639-1 code).
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::File) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::File)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1022

def copy_file(file_id, file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/copy', options)
  command.request_representation = Google::Apis::DriveV3::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV3::File::Representation
  command.response_class = Google::Apis::DriveV3::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

Creates a comment on a file. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Parameters:

file_id (String) —
The ID of the file.
comment_object (Google::Apis::DriveV3::Comment) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Comment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Comment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 538

def create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/comments', options)
  command.request_representation = Google::Apis::DriveV3::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::DriveV3::Comment::Representation
  command.response_class = Google::Apis::DriveV3::Comment
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_drive(request_id, drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

Creates a shared drive. For more information, see Manage shared drives.

Parameters:

request_id (String) —
Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a shared drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same shared drive. If the shared drive already exists a 409 error will be returned.
drive_object (Google::Apis::DriveV3::Drive) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Drive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Drive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 738

def create_drive(request_id, drive_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'drives', options)
  command.request_representation = Google::Apis::DriveV3::Drive::Representation
  command.request_object = drive_object
  command.response_representation = Google::Apis::DriveV3::Drive::Representation
  command.response_class = Google::Apis::DriveV3::Drive
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::File`

Creates a file. For more information, see Create and manage files. 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. Apps creating shortcuts with the create method must specify the MIME type application/vnd.google- apps.shortcut. Apps should specify a file extension in the name property when inserting files with the API. For example, an operation to insert a JPEG file should specify something like "name": "cat.jpg" in the metadata. Subsequent GET requests include the read-only fileExtension property populated with the extension originally specified in the name 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 name. In cases where the extension is missing, Drive attempts to determine the extension based on the file's MIME type.

Parameters:

file_object (Google::Apis::DriveV3::File) (defaults to: nil)
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: Creating files in multiple folders is no longer supported.
ignore_default_visibility (Boolean) (defaults to: nil) —
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.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
keep_revision_forever (Boolean) (defaults to: nil) —
Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocr_language (String) (defaults to: nil) —
A language hint for OCR processing during image import (ISO 639-1 code).
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
use_content_as_indexable_text (Boolean) (defaults to: nil) —
Whether to use the uploaded content as indexable text.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::File) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::File)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1109

def create_file(file_object = nil, enforce_single_parent: nil, ignore_default_visibility: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:post, 'files', options)
  else
    command = make_upload_command(:post, 'files', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DriveV3::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV3::File::Representation
  command.response_class = Google::Apis::DriveV3::File
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['ignoreDefaultVisibility'] = ignore_default_visibility unless ignore_default_visibility.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['useContentAsIndexableText'] = use_content_as_indexable_text unless use_content_as_indexable_text.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_permission(file_id, permission_object = nil, email_message: nil, enforce_expansive_access: nil, enforce_single_parent: nil, move_to_new_owners_root: nil, send_notification_email: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Permission`

Creates 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.

Parameters:

file_id (String) —
The ID of the file or shared drive.
permission_object (Google::Apis::DriveV3::Permission) (defaults to: nil)
email_message (String) (defaults to: nil) —
A plain text custom message to include in the notification email.
enforce_expansive_access (Boolean) (defaults to: nil) —
Whether the request should enforce expansive access rules.
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: See moveToNewOwnersRoot for details.
move_to_new_owners_root (Boolean) (defaults to: nil) —
This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to true, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to false, parents are not changed.
send_notification_email (Boolean) (defaults to: nil) —
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.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
transfer_ownership (Boolean) (defaults to: nil) —
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.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Permission) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Permission)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1811

def create_permission(file_id, permission_object = nil, email_message: nil, enforce_expansive_access: nil, enforce_single_parent: nil, move_to_new_owners_root: nil, send_notification_email: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/permissions', options)
  command.request_representation = Google::Apis::DriveV3::Permission::Representation
  command.request_object = permission_object
  command.response_representation = Google::Apis::DriveV3::Permission::Representation
  command.response_class = Google::Apis::DriveV3::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['emailMessage'] = email_message unless email_message.nil?
  command.query['enforceExpansiveAccess'] = enforce_expansive_access unless enforce_expansive_access.nil?
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['moveToNewOwnersRoot'] = move_to_new_owners_root unless move_to_new_owners_root.nil?
  command.query['sendNotificationEmail'] = send_notification_email unless send_notification_email.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

Creates a reply to a comment.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
reply_object (Google::Apis::DriveV3::Reply) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Reply) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Reply)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2062

def create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/comments/{commentId}/replies', options)
  command.request_representation = Google::Apis::DriveV3::Reply::Representation
  command.request_object = reply_object
  command.response_representation = Google::Apis::DriveV3::Reply::Representation
  command.response_class = Google::Apis::DriveV3::Reply
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

Deprecated: Use drives.create instead.

Parameters:

request_id (String) —
Required. 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.
team_drive_object (Google::Apis::DriveV3::TeamDrive) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::TeamDrive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::TeamDrive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2416

def create_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'teamdrives', options)
  command.request_representation = Google::Apis::DriveV3::TeamDrive::Representation
  command.request_object = team_drive_object
  command.response_representation = Google::Apis::DriveV3::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV3::TeamDrive
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_comment(file_id, comment_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a comment. For more information, see Manage comments and replies.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 573

def delete_comment(file_id, comment_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/{fileId}/comments/{commentId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_drive(drive_id, allow_item_deletion: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. For more information, see Manage shared drives.

Parameters:

drive_id (String) —
The ID of the shared drive.
allow_item_deletion (Boolean) (defaults to: nil) —
Whether any items inside the shared drive should also be deleted. This option is only supported when useDomainAdminAccess is also set to true.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as 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 shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 780

def delete_drive(drive_id, allow_item_deletion: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'drives/{driveId}', options)
  command.params['driveId'] = drive_id unless drive_id.nil?
  command.query['allowItemDeletion'] = allow_item_deletion unless allow_item_deletion.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_file(file_id, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a file owned by the user without moving it to the trash. For more information, see Trash or delete files and folders. 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.

Parameters:

file_id (String) —
The ID of the file.
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1166

def delete_file(file_id, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/{fileId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_permission(file_id, permission_id, enforce_expansive_access: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a permission. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.

Parameters:

file_id (String) —
The ID of the file or shared drive.
permission_id (String) —
The ID of the permission.
enforce_expansive_access (Boolean) (defaults to: nil) —
Whether the request should enforce expansive access rules.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1866

def delete_permission(file_id, permission_id, enforce_expansive_access: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/{fileId}/permissions/{permissionId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['enforceExpansiveAccess'] = enforce_expansive_access unless enforce_expansive_access.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a reply.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
reply_id (String) —
The ID of the reply.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2099

def delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.params['replyId'] = reply_id unless reply_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_revision(file_id, revision_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes a file version. You can only delete revisions for files with binary content in Google Drive, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. For more information, see Manage file revisions.

Parameters:

file_id (String) —
The ID of the file.
revision_id (String) —
The ID of the revision.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2258

def delete_revision(file_id, revision_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/{fileId}/revisions/{revisionId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['revisionId'] = revision_id unless revision_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deprecated: Use drives.delete instead.

Parameters:

team_drive_id (String) —
The ID of the Team Drive
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2448

def delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'teamdrives/{teamDriveId}', options)
  command.params['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#download_file(file_id, mime_type: nil, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Operation`

Downloads the content of a file. For more information, see Download and export files. Operations are valid for 24 hours from the time of creation.

Parameters:

file_id (String) —
Required. The ID of the file to download.
mime_type (String) (defaults to: nil) —
Optional. The MIME type the file should be downloaded as. This field can only be set when downloading Google Workspace documents. For a list of supported MIME types, see Export MIME types for Google Workspace documents. If not set, a Google Workspace document is downloaded with a default MIME type. The default MIME type might change in the future.
revision_id (String) (defaults to: nil) —
Optional. The revision ID of the file to download. This field can only be set when downloading blob files, Google Docs, and Google Sheets. Returns INVALID_ARGUMENT if downloading a specific revision on the file is unsupported.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1211

def download_file(file_id, mime_type: nil, revision_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/download', options)
  command.response_representation = Google::Apis::DriveV3::Operation::Representation
  command.response_class = Google::Apis::DriveV3::Operation
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['mimeType'] = mime_type unless mime_type.nil?
  command.query['revisionId'] = revision_id unless revision_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#empty_file_trash(drive_id: nil, enforce_single_parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes all of the user's trashed files. For more information, see Trash or delete files and folders.

Parameters:

drive_id (String) (defaults to: nil) —
If set, empties the trash of the provided shared drive.
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: If an item isn't in a shared drive and its last parent is deleted but the item itself isn't, the item will be placed under its owner's root.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1248

def empty_file_trash(drive_id: nil, enforce_single_parent: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'files/trash', options)
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_file(file_id, mime_type, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Exports a Google Workspace document to the requested MIME type and returns exported byte content. For more information, see Download and export files. Note that the exported content is limited to 10 MB.

Parameters:

file_id (String) —
The ID of the file.
mime_type (String) —
Required. The MIME type of the format requested for this export. For a list of supported MIME types, see Export MIME types for Google Workspace documents.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
download_dest (IO, String) (defaults to: nil) —
IO stream or filename to receive content download
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1286

def export_file(file_id, mime_type, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'files/{fileId}/export', options)
  else
    command = make_download_command(:get, 'files/{fileId}/export', options)
    command.download_dest = download_dest
  end
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['mimeType'] = mime_type unless mime_type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#generate_file_ids(count: nil, space: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::GeneratedIds`

Generates a set of file IDs which can be provided in create or copy requests. For more information, see Create and manage files.

Parameters:

count (Fixnum) (defaults to: nil) —
The number of IDs to return.
space (String) (defaults to: nil) —
The space in which the IDs can be used to create files. Supported values are drive and appDataFolder. (Default: drive.) For more information, see File organization.
type (String) (defaults to: nil) —
The type of items which the IDs can be used for. Supported values are files and shortcuts. Note that shortcuts are only supported in the drive space. (Default: files.) For more information, see File organization.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::GeneratedIds) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::GeneratedIds)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1333

def generate_file_ids(count: nil, space: nil, type: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/generateIds', options)
  command.response_representation = Google::Apis::DriveV3::GeneratedIds::Representation
  command.response_class = Google::Apis::DriveV3::GeneratedIds
  command.query['count'] = count unless count.nil?
  command.query['space'] = space unless space.nil?
  command.query['type'] = type unless type.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_about(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::About`

Gets information about the user, the user's Drive, and system capabilities. For more information, see Return user info. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Parameters:

fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::About) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::About)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 76

def get_about(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'about', options)
  command.response_representation = Google::Apis::DriveV3::About::Representation
  command.response_class = Google::Apis::DriveV3::About
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_accessproposal(file_id, proposal_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::AccessProposal`

Retrieves an access proposal by ID. For more information, see Manage pending access proposals.

Parameters:

file_id (String) —
Required. The ID of the item the request is on.
proposal_id (String) —
Required. The ID of the access proposal to resolve.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::AccessProposal) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::AccessProposal)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 109

def get_accessproposal(file_id, proposal_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/accessproposals/{proposalId}', options)
  command.response_representation = Google::Apis::DriveV3::AccessProposal::Representation
  command.response_class = Google::Apis::DriveV3::AccessProposal
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_app(app_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::App`

Gets a specific app. For more information, see Return user info.

Parameters:

app_id (String) —
The ID of the app.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::App) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::App)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 216

def get_app(app_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apps/{appId}', options)
  command.response_representation = Google::Apis::DriveV3::App::Representation
  command.response_class = Google::Apis::DriveV3::App
  command.params['appId'] = app_id unless app_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_changes_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::StartPageToken`

Gets the starting pageToken for listing future changes. For more information, see Retrieve changes.

Parameters:

drive_id (String) (defaults to: nil) —
The ID of the shared drive for which the starting pageToken for listing future changes from that shared drive will be returned.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
team_drive_id (String) (defaults to: nil) —
Deprecated: Use driveId instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::StartPageToken) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::StartPageToken)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 299

def get_changes_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'changes/startPageToken', options)
  command.response_representation = Google::Apis::DriveV3::StartPageToken::Representation
  command.response_class = Google::Apis::DriveV3::StartPageToken
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

Gets a comment by ID. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
include_deleted (Boolean) (defaults to: nil) —
Whether to return deleted comments. Deleted comments will not include their original content.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Comment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Comment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 611

def get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}', options)
  command.response_representation = Google::Apis::DriveV3::Comment::Representation
  command.response_class = Google::Apis::DriveV3::Comment
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_drive(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

Gets a shared drive's metadata by ID. For more information, see Manage shared drives.

Parameters:

drive_id (String) —
The ID of the shared drive.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as 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 shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Drive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Drive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 816

def get_drive(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'drives/{driveId}', options)
  command.response_representation = Google::Apis::DriveV3::Drive::Representation
  command.response_class = Google::Apis::DriveV3::Drive
  command.params['driveId'] = drive_id unless drive_id.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_file(file_id, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::File`

Gets a file's metadata or content by ID. For more information, see Search for files and folders. 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 and export files.

Parameters:

file_id (String) —
The ID of the file.
acknowledge_abuse (Boolean) (defaults to: nil) —
Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
download_dest (IO, String) (defaults to: nil) —
IO stream or filename to receive content download
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::File) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::File)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1389

def get_file(file_id, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'files/{fileId}', options)
  else
    command = make_download_command(:get, 'files/{fileId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DriveV3::File::Representation
  command.response_class = Google::Apis::DriveV3::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Operation`

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

name (String) —
The name of the operation resource.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1750

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'operations/{name}', options)
  command.response_representation = Google::Apis::DriveV3::Operation::Representation
  command.response_class = Google::Apis::DriveV3::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Permission`

Gets a permission by ID.

Parameters:

file_id (String) —
The ID of the file.
permission_id (String) —
The ID of the permission.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Permission) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Permission)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1910

def get_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/permissions/{permissionId}', options)
  command.response_representation = Google::Apis::DriveV3::Permission::Representation
  command.response_class = Google::Apis::DriveV3::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

Gets a reply by ID.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
reply_id (String) —
The ID of the reply.
include_deleted (Boolean) (defaults to: nil) —
Whether to return deleted replies. Deleted replies will not include their original content.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Reply) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Reply)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2136

def get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.response_representation = Google::Apis::DriveV3::Reply::Representation
  command.response_class = Google::Apis::DriveV3::Reply
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.params['replyId'] = reply_id unless reply_id.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Revision`

Gets a revision's metadata or content by ID. For more information, see Manage file revisions.

Parameters:

file_id (String) —
The ID of the file.
revision_id (String) —
The ID of the revision.
acknowledge_abuse (Boolean) (defaults to: nil) —
Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
download_dest (IO, String) (defaults to: nil) —
IO stream or filename to receive content download
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Revision) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Revision)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2298

def get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command = make_simple_command(:get, 'files/{fileId}/revisions/{revisionId}', options)
  else
    command = make_download_command(:get, 'files/{fileId}/revisions/{revisionId}', options)
    command.download_dest = download_dest
  end
  command.response_representation = Google::Apis::DriveV3::Revision::Representation
  command.response_class = Google::Apis::DriveV3::Revision
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['revisionId'] = revision_id unless revision_id.nil?
  command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

Deprecated: Use drives.get instead.

Parameters:

team_drive_id (String) —
The ID of the Team Drive
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as 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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::TeamDrive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::TeamDrive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2480

def get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'teamdrives/{teamDriveId}', options)
  command.response_representation = Google::Apis::DriveV3::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV3::TeamDrive
  command.params['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#hide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

Hides a shared drive from the default view. For more information, see Manage shared drives.

Parameters:

drive_id (String) —
The ID of the shared drive.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Drive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Drive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 849

def hide_drive(drive_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'drives/{driveId}/hide', options)
  command.response_representation = Google::Apis::DriveV3::Drive::Representation
  command.response_class = Google::Apis::DriveV3::Drive
  command.params['driveId'] = drive_id unless drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_accessproposals(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ListAccessProposalsResponse`

List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.

Parameters:

file_id (String) —
Required. The ID of the item the request is on.
page_size (Fixnum) (defaults to: nil) —
Optional. The number of results per page.
page_token (String) (defaults to: nil) —
Optional. The continuation token on the list of access requests.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::ListAccessProposalsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::ListAccessProposalsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 147

def list_accessproposals(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/accessproposals', options)
  command.response_representation = Google::Apis::DriveV3::ListAccessProposalsResponse::Representation
  command.response_class = Google::Apis::DriveV3::ListAccessProposalsResponse
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::AppList`

Lists a user's installed apps. For more information, see Return user info.

Parameters:

app_filter_extensions (String) (defaults to: nil) —
A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given file extensions are included in the response. If appFilterMimeTypes are provided as well, the result is a union of the two resulting app lists.
app_filter_mime_types (String) (defaults to: nil) —
A comma-separated list of file extensions to limit returned results. All results within the given app query scope which can open any of the given MIME types will be included in the response. If appFilterExtensions are provided as well, the result is a union of the two resulting app lists.
language_code (String) (defaults to: nil) —
A language or locale code, as defined by BCP 47, with some extensions from Unicode's LDML format (http://www.unicode.org/reports/tr35/).
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::AppList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::AppList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 258

def list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'apps', options)
  command.response_representation = Google::Apis::DriveV3::AppList::Representation
  command.response_class = Google::Apis::DriveV3::AppList
  command.query['appFilterExtensions'] = app_filter_extensions unless app_filter_extensions.nil?
  command.query['appFilterMimeTypes'] = app_filter_mime_types unless app_filter_mime_types.nil?
  command.query['languageCode'] = language_code unless language_code.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_changes(page_token, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ChangeList`

Lists the changes for a user or shared drive. For more information, see Retrieve changes.

Parameters:

page_token (String) —
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.
drive_id (String) (defaults to: nil) —
The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
include_corpus_removals (Boolean) (defaults to: nil) —
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.
include_items_from_all_drives (Boolean) (defaults to: nil) —
Whether both My Drive and shared drive items should be included in results.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
include_removed (Boolean) (defaults to: nil) —
Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
include_team_drive_items (Boolean) (defaults to: nil) —
Deprecated: Use includeItemsFromAllDrives instead.
page_size (Fixnum) (defaults to: nil) —
The maximum number of changes to return per page.
restrict_to_my_drive (Boolean) (defaults to: nil) —
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.
spaces (String) (defaults to: nil) —
A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
team_drive_id (String) (defaults to: nil) —
Deprecated: Use driveId instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::ChangeList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::ChangeList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 373

def list_changes(page_token, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'changes', options)
  command.response_representation = Google::Apis::DriveV3::ChangeList::Representation
  command.response_class = Google::Apis::DriveV3::ChangeList
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
  command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['includeRemoved'] = include_removed unless include_removed.nil?
  command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['restrictToMyDrive'] = restrict_to_my_drive unless restrict_to_my_drive.nil?
  command.query['spaces'] = spaces unless spaces.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::CommentList`

Lists a file's comments. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Parameters:

file_id (String) —
The ID of the file.
include_deleted (Boolean) (defaults to: nil) —
Whether to include deleted comments. Deleted comments will not include their original content.
page_size (Fixnum) (defaults to: nil) —
The maximum number of comments to return per page.
page_token (String) (defaults to: nil) —
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.
start_modified_time (String) (defaults to: nil) —
The minimum value of 'modifiedTime' for the result comments (RFC 3339 date- time).
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::CommentList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::CommentList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 658

def list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/comments', options)
  command.response_representation = Google::Apis::DriveV3::CommentList::Representation
  command.response_class = Google::Apis::DriveV3::CommentList
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['startModifiedTime'] = start_modified_time unless start_modified_time.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_drives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::DriveList`

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.

Parameters:

page_size (Fixnum) (defaults to: nil) —
Maximum number of shared drives to return per page.
page_token (String) (defaults to: nil) —
Page token for shared drives.
q (String) (defaults to: nil) —
Query string for searching shared drives.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::DriveList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::DriveList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 889

def list_drives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'drives', options)
  command.response_representation = Google::Apis::DriveV3::DriveList::Representation
  command.response_class = Google::Apis::DriveV3::DriveList
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_file_labels(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::LabelList`

Lists the labels on a file. For more information, see List labels on a file.

Parameters:

file_id (String) —
The ID for the file.
max_results (Fixnum) (defaults to: nil) —
The maximum number of labels to return per page. When not set, defaults to 100.
page_token (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::LabelList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::LabelList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1538

def list_file_labels(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/listLabels', options)
  command.response_representation = Google::Apis::DriveV3::LabelList::Representation
  command.response_class = Google::Apis::DriveV3::LabelList
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_team_drive_items: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::FileList`

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.

Parameters:

corpora (String) (defaults to: nil) —
Bodies of items (files or documents) to which the query applies. Supported bodies are: * user * domain * drive * allDrives Prefer user or drive to allDrives for efficiency. By default, corpora is set to user. However, this can change depending on the filter set through the q parameter. For more information, see File organization.
corpus (String) (defaults to: nil) —
Deprecated: The source of files to list. Use corpora instead.
drive_id (String) (defaults to: nil) —
ID of the shared drive to search.
include_items_from_all_drives (Boolean) (defaults to: nil) —
Whether both My Drive and shared drive items should be included in results.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
include_team_drive_items (Boolean) (defaults to: nil) —
Deprecated: Use includeItemsFromAllDrives instead.
order_by (String) (defaults to: nil) —
A comma-separated list of sort keys. Valid keys are: * createdTime: When the file was created. * folder: The folder ID. This field is sorted using alphabetical ordering. * modifiedByMeTime: The last time the file was modified by the user. * modifiedTime: The last time the file was modified by anyone. * name: The name of the file. This field is sorted using alphabetical ordering, so 1, 12, 2, 22. * name_natural: The name of the file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. * quotaBytesUsed: The number of storage quota bytes used by the file. * recency: The most recent timestamp from the file's date-time fields. * sharedWithMeTime: When the file was shared with the user, if applicable. * starred: Whether the user has starred the file. * viewedByMeTime: The last time the file was viewed by the user. Each key sorts ascending by default, but can be reversed with the desc modifier. Example usage: ?orderBy=folder, modifiedTime desc,name.
page_size (Fixnum) (defaults to: nil) —
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.
page_token (String) (defaults to: nil) —
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.
q (String) (defaults to: nil) —
A query for filtering the file results. For supported syntax, see Search for files and folders.
spaces (String) (defaults to: nil) —
A comma-separated list of spaces to query within the corpora. Supported values are drive and appDataFolder. For more information, see File organization.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
team_drive_id (String) (defaults to: nil) —
Deprecated: Use driveId instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::FileList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::FileList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1488

def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_team_drive_items: nil, order_by: nil, page_size: nil, page_token: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files', options)
  command.response_representation = Google::Apis::DriveV3::FileList::Representation
  command.response_class = Google::Apis::DriveV3::FileList
  command.query['corpora'] = corpora unless corpora.nil?
  command.query['corpus'] = corpus unless corpus.nil?
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['spaces'] = spaces unless spaces.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::PermissionList`

Lists a file's or shared drive's permissions.

Parameters:

file_id (String) —
The ID of the file or shared drive.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
page_size (Fixnum) (defaults to: nil) —
The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
page_token (String) (defaults to: nil) —
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.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::PermissionList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::PermissionList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1963

def list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/permissions', options)
  command.response_representation = Google::Apis::DriveV3::PermissionList::Representation
  command.response_class = Google::Apis::DriveV3::PermissionList
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ReplyList`

Lists a comment's replies.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
include_deleted (Boolean) (defaults to: nil) —
Whether to include deleted replies. Deleted replies will not include their original content.
page_size (Fixnum) (defaults to: nil) —
The maximum number of replies to return per page.
page_token (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::ReplyList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::ReplyList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2179

def list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies', options)
  command.response_representation = Google::Apis::DriveV3::ReplyList::Representation
  command.response_class = Google::Apis::DriveV3::ReplyList
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_revisions(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::RevisionList`

Lists a file's revisions. For more information, see Manage file revisions.

Parameters:

file_id (String) —
The ID of the file.
page_size (Fixnum) (defaults to: nil) —
The maximum number of revisions to return per page.
page_token (String) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::RevisionList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::RevisionList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2341

def list_revisions(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'files/{fileId}/revisions', options)
  command.response_representation = Google::Apis::DriveV3::RevisionList::Representation
  command.response_class = Google::Apis::DriveV3::RevisionList
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDriveList`

Deprecated: Use drives.list instead.

Parameters:

page_size (Fixnum) (defaults to: nil) —
Maximum number of Team Drives to return.
page_token (String) (defaults to: nil) —
Page token for Team Drives.
q (String) (defaults to: nil) —
Query string for searching Team Drives.
use_domain_admin_access (Boolean) (defaults to: nil) —
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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::TeamDriveList) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::TeamDriveList)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2518

def list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'teamdrives', options)
  command.response_representation = Google::Apis::DriveV3::TeamDriveList::Representation
  command.response_class = Google::Apis::DriveV3::TeamDriveList
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#modify_file_labels(file_id, modify_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ModifyLabelsResponse`

Modifies the set of labels applied to a file. For more information, see Set a label field on a file. Returns a list of the labels that were added or modified.

Parameters:

file_id (String) —
The ID of the file to which the labels belong.
modify_labels_request_object (Google::Apis::DriveV3::ModifyLabelsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::ModifyLabelsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::ModifyLabelsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1573

def modify_file_labels(file_id, modify_labels_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/modifyLabels', options)
  command.request_representation = Google::Apis::DriveV3::ModifyLabelsRequest::Representation
  command.request_object = modify_labels_request_object
  command.response_representation = Google::Apis::DriveV3::ModifyLabelsResponse::Representation
  command.response_class = Google::Apis::DriveV3::ModifyLabelsResponse
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#resolve_accessproposal_access_proposal(file_id, proposal_id, resolve_access_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Approves or denies an access proposal. For more information, see Manage pending access proposals.

Parameters:

file_id (String) —
Required. The ID of the item the request is on.
proposal_id (String) —
Required. The ID of the access proposal to resolve.
resolve_access_proposal_request_object (Google::Apis::DriveV3::ResolveAccessProposalRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 184

def resolve_accessproposal_access_proposal(file_id, proposal_id, resolve_access_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/accessproposals/{proposalId}:resolve', options)
  command.request_representation = Google::Apis::DriveV3::ResolveAccessProposalRequest::Representation
  command.request_object = resolve_access_proposal_request_object
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['proposalId'] = proposal_id unless proposal_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Stops watching resources through this channel. For more information, see Notifications for resource changes.

Parameters:

channel_object (Google::Apis::DriveV3::Channel) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (NilClass) —
No result returned for this method
err (StandardError) —
error object if request failed

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 504

def stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'channels/stop', options)
  command.request_representation = Google::Apis::DriveV3::Channel::Representation
  command.request_object = channel_object
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#unhide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

Restores a shared drive to the default view. For more information, see Manage shared drives.

Parameters:

drive_id (String) —
The ID of the shared drive.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Drive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Drive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 924

def unhide_drive(drive_id, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'drives/{driveId}/unhide', options)
  command.response_representation = Google::Apis::DriveV3::Drive::Representation
  command.response_class = Google::Apis::DriveV3::Drive
  command.params['driveId'] = drive_id unless drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

Updates a comment with patch semantics. For more information, see Manage comments and replies. Required: The fields parameter must be set. To return the exact fields you need, see Return specific fields.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
comment_object (Google::Apis::DriveV3::Comment) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Comment) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Comment)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 699

def update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'files/{fileId}/comments/{commentId}', options)
  command.request_representation = Google::Apis::DriveV3::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::DriveV3::Comment::Representation
  command.response_class = Google::Apis::DriveV3::Comment
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_drive(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

Updates the metadata for a shared drive. For more information, see Manage shared drives.

Parameters:

drive_id (String) —
The ID of the shared drive.
drive_object (Google::Apis::DriveV3::Drive) (defaults to: nil)
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as 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 shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Drive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Drive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 961

def update_drive(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'drives/{driveId}', options)
  command.request_representation = Google::Apis::DriveV3::Drive::Representation
  command.request_object = drive_object
  command.response_representation = Google::Apis::DriveV3::Drive::Representation
  command.response_class = Google::Apis::DriveV3::Drive
  command.params['driveId'] = drive_id unless drive_id.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::File`

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.

Parameters:

file_id (String) —
The ID of the file.
file_object (Google::Apis::DriveV3::File) (defaults to: nil)
add_parents (String) (defaults to: nil) —
A comma-separated list of parent IDs to add.
enforce_single_parent (Boolean) (defaults to: nil) —
Deprecated: Adding files to multiple folders is no longer supported. Use shortcuts instead.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
keep_revision_forever (Boolean) (defaults to: nil) —
Whether to set the keepForever field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
ocr_language (String) (defaults to: nil) —
A language hint for OCR processing during image import (ISO 639-1 code).
remove_parents (String) (defaults to: nil) —
A comma-separated list of parent IDs to remove.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
use_content_as_indexable_text (Boolean) (defaults to: nil) —
Whether to use the uploaded content as indexable text.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_source (IO, String) (defaults to: nil) —
IO stream or filename containing content to upload
content_type (String) (defaults to: nil) —
Content type of the uploaded content.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::File) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::File)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1646

def update_file(file_id, file_object = nil, add_parents: nil, enforce_single_parent: nil, include_labels: nil, include_permissions_for_view: nil, keep_revision_forever: nil, ocr_language: nil, remove_parents: nil, supports_all_drives: nil, supports_team_drives: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command = make_simple_command(:patch, 'files/{fileId}', options)
  else
    command = make_upload_command(:patch, 'files/{fileId}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DriveV3::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV3::File::Representation
  command.response_class = Google::Apis::DriveV3::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['addParents'] = add_parents unless add_parents.nil?
  command.query['enforceSingleParent'] = enforce_single_parent unless enforce_single_parent.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['keepRevisionForever'] = keep_revision_forever unless keep_revision_forever.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['removeParents'] = remove_parents unless remove_parents.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['useContentAsIndexableText'] = use_content_as_indexable_text unless use_content_as_indexable_text.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_permission(file_id, permission_id, permission_object = nil, enforce_expansive_access: nil, remove_expiration: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Permission`

Updates a permission with patch semantics. Warning: Concurrent permissions operations on the same file are not supported; only the last update is applied.

Parameters:

file_id (String) —
The ID of the file or shared drive.
permission_id (String) —
The ID of the permission.
permission_object (Google::Apis::DriveV3::Permission) (defaults to: nil)
enforce_expansive_access (Boolean) (defaults to: nil) —
Whether the request should enforce expansive access rules.
remove_expiration (Boolean) (defaults to: nil) —
Whether to remove the expiration date.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
transfer_ownership (Boolean) (defaults to: nil) —
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.
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Permission) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Permission)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2020

def update_permission(file_id, permission_id, permission_object = nil, enforce_expansive_access: nil, remove_expiration: nil, supports_all_drives: nil, supports_team_drives: nil, transfer_ownership: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'files/{fileId}/permissions/{permissionId}', options)
  command.request_representation = Google::Apis::DriveV3::Permission::Representation
  command.request_object = permission_object
  command.response_representation = Google::Apis::DriveV3::Permission::Representation
  command.response_class = Google::Apis::DriveV3::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['permissionId'] = permission_id unless permission_id.nil?
  command.query['enforceExpansiveAccess'] = enforce_expansive_access unless enforce_expansive_access.nil?
  command.query['removeExpiration'] = remove_expiration unless remove_expiration.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['transferOwnership'] = transfer_ownership unless transfer_ownership.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

Updates a reply with patch semantics.

Parameters:

file_id (String) —
The ID of the file.
comment_id (String) —
The ID of the comment.
reply_id (String) —
The ID of the reply.
reply_object (Google::Apis::DriveV3::Reply) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Reply) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Reply)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2218

def update_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.request_representation = Google::Apis::DriveV3::Reply::Representation
  command.request_object = reply_object
  command.response_representation = Google::Apis::DriveV3::Reply::Representation
  command.response_class = Google::Apis::DriveV3::Reply
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['commentId'] = comment_id unless comment_id.nil?
  command.params['replyId'] = reply_id unless reply_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Revision`

Updates a revision with patch semantics. For more information, see Manage file revisions.

Parameters:

file_id (String) —
The ID of the file.
revision_id (String) —
The ID of the revision.
revision_object (Google::Apis::DriveV3::Revision) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Revision) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Revision)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2378

def update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'files/{fileId}/revisions/{revisionId}', options)
  command.request_representation = Google::Apis::DriveV3::Revision::Representation
  command.request_object = revision_object
  command.response_representation = Google::Apis::DriveV3::Revision::Representation
  command.response_class = Google::Apis::DriveV3::Revision
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['revisionId'] = revision_id unless revision_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

Deprecated: Use drives.update instead.

Parameters:

team_drive_id (String) —
The ID of the Team Drive
team_drive_object (Google::Apis::DriveV3::TeamDrive) (defaults to: nil)
use_domain_admin_access (Boolean) (defaults to: nil) —
Issue the request as 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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::TeamDrive) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::TeamDrive)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 2556

def update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'teamdrives/{teamDriveId}', options)
  command.request_representation = Google::Apis::DriveV3::TeamDrive::Representation
  command.request_object = team_drive_object
  command.response_representation = Google::Apis::DriveV3::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV3::TeamDrive
  command.params['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['useDomainAdminAccess'] = use_domain_admin_access unless use_domain_admin_access.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#watch_change(page_token, channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Channel`

Subscribes to changes for a user. For more information, see Notifications for resource changes.

Parameters:

page_token (String) —
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.
channel_object (Google::Apis::DriveV3::Channel) (defaults to: nil)
drive_id (String) (defaults to: nil) —
The shared drive from which changes will be returned. If specified the change IDs will be reflective of the shared drive; use the combined drive ID and change ID as an identifier.
include_corpus_removals (Boolean) (defaults to: nil) —
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.
include_items_from_all_drives (Boolean) (defaults to: nil) —
Whether both My Drive and shared drive items should be included in results.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only 'published' is supported.
include_removed (Boolean) (defaults to: nil) —
Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.
include_team_drive_items (Boolean) (defaults to: nil) —
Deprecated: Use includeItemsFromAllDrives instead.
page_size (Fixnum) (defaults to: nil) —
The maximum number of changes to return per page.
restrict_to_my_drive (Boolean) (defaults to: nil) —
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.
spaces (String) (defaults to: nil) —
A comma-separated list of spaces to query within the corpora. Supported values are 'drive' and 'appDataFolder'.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
team_drive_id (String) (defaults to: nil) —
Deprecated: Use driveId instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Channel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Channel)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 458

def watch_change(page_token, channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_items_from_all_drives: nil, include_labels: nil, include_permissions_for_view: nil, include_removed: nil, include_team_drive_items: nil, page_size: nil, restrict_to_my_drive: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'changes/watch', options)
  command.request_representation = Google::Apis::DriveV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DriveV3::Channel::Representation
  command.response_class = Google::Apis::DriveV3::Channel
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
  command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['includeRemoved'] = include_removed unless include_removed.nil?
  command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['restrictToMyDrive'] = restrict_to_my_drive unless restrict_to_my_drive.nil?
  command.query['spaces'] = spaces unless spaces.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['teamDriveId'] = team_drive_id unless team_drive_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Channel`

Subscribes to changes to a file. For more information, see Notifications for resource changes.

Parameters:

file_id (String) —
The ID of the file.
channel_object (Google::Apis::DriveV3::Channel) (defaults to: nil)
acknowledge_abuse (Boolean) (defaults to: nil) —
Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the alt parameter is set to media and the user is the owner of the file or an organizer of the shared drive in which the file resides.
include_labels (String) (defaults to: nil) —
A comma-separated list of IDs of labels to include in the labelInfo part of the response.
include_permissions_for_view (String) (defaults to: nil) —
Specifies which additional view's permissions to include in the response. Only published is supported.
supports_all_drives (Boolean) (defaults to: nil) —
Whether the requesting application supports both My Drives and shared drives.
supports_team_drives (Boolean) (defaults to: nil) —
Deprecated: Use supportsAllDrives instead.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::DriveV3::Channel) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::DriveV3::Channel)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/drive_v3/service.rb', line 1712

def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'files/{fileId}/watch', options)
  command.request_representation = Google::Apis::DriveV3::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DriveV3::Channel::Representation
  command.response_class = Google::Apis::DriveV3::Channel
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
  command.query['includeLabels'] = include_labels unless include_labels.nil?
  command.query['includePermissionsForView'] = include_permissions_for_view unless include_permissions_for_view.nil?
  command.query['supportsAllDrives'] = supports_all_drives unless supports_all_drives.nil?
  command.query['supportsTeamDrives'] = supports_team_drives unless supports_team_drives.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::DriveV3::DriveService

Overview

Examples:

Constant Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DriveService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

Instance Method Details

#create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment

#create_drive(request_id, drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive

#create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply

#create_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive

#delete_comment(file_id, comment_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_drive(drive_id, allow_item_deletion: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_file(file_id, enforce_single_parent: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_permission(file_id, permission_id, enforce_expansive_access: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_revision(file_id, revision_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#download_file(file_id, mime_type: nil, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Operation

#empty_file_trash(drive_id: nil, enforce_single_parent: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#export_file(file_id, mime_type, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... }

#generate_file_ids(count: nil, space: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::GeneratedIds

#get_about(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::About

#get_accessproposal(file_id, proposal_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::AccessProposal

#get_app(app_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::App

#get_changes_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::StartPageToken

#get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment

#get_drive(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive

#get_file(file_id, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::File

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Operation

#get_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Permission

#get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply

#get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Revision

#get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive

#hide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive

#list_accessproposals(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ListAccessProposalsResponse

#list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::AppList

#list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::CommentList

#list_drives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::DriveList

#list_file_labels(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::LabelList

#list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::PermissionList

#list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ReplyList

#list_revisions(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::RevisionList

#list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDriveList

#modify_file_labels(file_id, modify_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::ModifyLabelsResponse

#resolve_accessproposal_access_proposal(file_id, proposal_id, resolve_access_proposal_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#stop_channel(channel_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... }

#unhide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive

#update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Comment

#update_drive(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Drive

#update_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Reply

#update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Revision

#update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::TeamDrive

#watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV3::Channel

#initialize ⇒ `DriveService`

#key ⇒ `String`

#quota_user ⇒ `String`

#create_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

#create_drive(request_id, drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

#create_reply(file_id, comment_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

#create_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

#download_file(file_id, mime_type: nil, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Operation`

#generate_file_ids(count: nil, space: nil, type: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::GeneratedIds`

#get_about(fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::About`

#get_accessproposal(file_id, proposal_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::AccessProposal`

#get_app(app_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::App`

#get_changes_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::StartPageToken`

#get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

#get_drive(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

#get_file(file_id, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::File`

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Operation`

#get_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Permission`

#get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

#get_revision(file_id, revision_id, acknowledge_abuse: nil, fields: nil, quota_user: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Revision`

#get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

#hide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

#list_accessproposals(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ListAccessProposalsResponse`

#list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::AppList`

#list_comments(file_id, include_deleted: nil, page_size: nil, page_token: nil, start_modified_time: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::CommentList`

#list_drives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::DriveList`

#list_file_labels(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::LabelList`

#list_permissions(file_id, include_permissions_for_view: nil, page_size: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::PermissionList`

#list_replies(file_id, comment_id, include_deleted: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ReplyList`

#list_revisions(file_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::RevisionList`

#list_teamdrives(page_size: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDriveList`

#modify_file_labels(file_id, modify_labels_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::ModifyLabelsResponse`

#unhide_drive(drive_id, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

#update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Comment`

#update_drive(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Drive`

#update_reply(file_id, comment_id, reply_id, reply_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Reply`

#update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Revision`

#update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::TeamDrive`

#watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, include_labels: nil, include_permissions_for_view: nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::DriveV3::Channel`