Class: Google::Apis::DriveV2::DriveService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/drive_v2/service.rb

Overview

Drive API

Manages files in Drive including uploading, downloading, searching, detecting changes, and updating sharing permissions.

Examples:

require 'google/apis/drive_v2'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeDriveService

Returns a new instance of DriveService



50
51
52
53
# File 'generated/google/apis/drive_v2/service.rb', line 50

def initialize
  super('https://www.googleapis.com/', 'drive/v2/')
  @batch_path = 'batch/drive/v2'
end

Instance Attribute Details

#keyString

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.



39
40
41
# File 'generated/google/apis/drive_v2/service.rb', line 39

def key
  @key
end

#quota_userString

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

  • (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.



44
45
46
# File 'generated/google/apis/drive_v2/service.rb', line 44

def quota_user
  @quota_user
end

#user_ipString

Returns Deprecated. Please use quotaUser instead.

Returns:

  • (String)

    Deprecated. Please use quotaUser instead.



48
49
50
# File 'generated/google/apis/drive_v2/service.rb', line 48

def user_ip
  @user_ip
end

Instance Method Details

#copy_file(file_id, file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Creates a copy of the specified file.

Parameters:

  • file_id (String)

    The ID of the file to copy.

  • file_object (Google::Apis::DriveV2::File) (defaults to: nil)
  • convert (Boolean)

    Whether to convert this file to the corresponding Google Docs format.

  • ocr (Boolean)

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • ocr_language (String)

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • pinned (Boolean)

    Whether to pin the head revision of the new copy. A file can have a maximum of 200 pinned revisions.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • timed_text_language (String)

    The language of the timed text.

  • timed_text_track_name (String)

    The timed text track name.

  • visibility (String)

    The visibility of the new file. This parameter is only relevant when the source is not a native Google Doc and convert=false.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
# File 'generated/google/apis/drive_v2/service.rb', line 1165

def copy_file(file_id, file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/copy', options)
  command.request_representation = Google::Apis::DriveV2::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['convert'] = convert unless convert.nil?
  command.query['ocr'] = ocr unless ocr.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['pinned'] = pinned unless pinned.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['timedTextLanguage'] = timed_text_language unless timed_text_language.nil?
  command.query['timedTextTrackName'] = timed_text_track_name unless timed_text_track_name.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_child(folder_id, child_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a child from a folder.

Parameters:

  • folder_id (String)

    The ID of the folder.

  • child_id (String)

    The ID of the child.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



486
487
488
489
490
491
492
493
494
# File 'generated/google/apis/drive_v2/service.rb', line 486

def delete_child(folder_id, child_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'files/{folderId}/children/{childId}', options)
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.params['childId'] = child_id unless child_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes a comment.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



649
650
651
652
653
654
655
656
657
# File 'generated/google/apis/drive_v2/service.rb', line 649

def delete_comment(file_id, comment_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_drife(drive_id, fields: nil, quota_user: nil, user_ip: 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.

Parameters:

  • drive_id (String)

    The ID of the shared drive.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



885
886
887
888
889
890
891
892
# File 'generated/google/apis/drive_v2/service.rb', line 885

def delete_drife(drive_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'drives/{driveId}', options)
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for shared drive files.

Parameters:

  • file_id (String)

    The ID of the file to delete.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
# File 'generated/google/apis/drive_v2/service.rb', line 1214

def delete_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'files/{fileId}', options)
  command.params['fileId'] = file_id unless file_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_parent(file_id, parent_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Removes a parent from a file.

Parameters:

  • file_id (String)

    The ID of the file.

  • parent_id (String)

    The ID of the parent.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



1949
1950
1951
1952
1953
1954
1955
1956
1957
# File 'generated/google/apis/drive_v2/service.rb', line 1949

def delete_parent(file_id, parent_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'files/{fileId}/parents/{parentId}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['parentId'] = parent_id unless parent_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Deletes a permission from a file or shared drive.

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • permission_id (String)

    The ID for the permission.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
# File 'generated/google/apis/drive_v2/service.rb', line 2103

def delete_permission(file_id, permission_id, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: 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['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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_property(file_id, property_key, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Deletes a property.

Parameters:

  • file_id (String)

    The ID of the file.

  • property_key (String)

    The key of the property.

  • visibility (String)

    The visibility of the property.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
# File 'generated/google/apis/drive_v2/service.rb', line 2448

def delete_property(file_id, property_key, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'files/{fileId}/properties/{propertyKey}', options)
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['propertyKey'] = property_key unless property_key.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, user_ip: 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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
# File 'generated/google/apis/drive_v2/service.rb', line 2771

def delete_reply(file_id, comment_id, reply_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_revision(file_id, revision_id, fields: nil, quota_user: nil, user_ip: 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, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted.

Parameters:

  • file_id (String)

    The ID of the file.

  • revision_id (String)

    The ID of the revision.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



3021
3022
3023
3024
3025
3026
3027
3028
3029
# File 'generated/google/apis/drive_v2/service.rb', line 3021

def delete_revision(file_id, revision_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, user_ip: 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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



3207
3208
3209
3210
3211
3212
3213
3214
# File 'generated/google/apis/drive_v2/service.rb', line 3207

def delete_teamdrive(team_drive_id, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#empty_trash(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Permanently deletes all of the user's trashed files.

Parameters:

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



1245
1246
1247
1248
1249
1250
1251
# File 'generated/google/apis/drive_v2/service.rb', line 1245

def empty_trash(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'files/trash', options)
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB.

Parameters:

  • file_id (String)

    The ID of the file.

  • mime_type (String)

    The MIME type of the format requested for this export.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • download_dest (IO, String)

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions)

    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:



1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
# File 'generated/google/apis/drive_v2/service.rb', line 1280

def export_file(file_id, mime_type, fields: nil, quota_user: nil, user_ip: 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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#generate_file_ids(max_results: nil, space: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::GeneratedIds

Generates a set of file IDs which can be provided in insert requests.

Parameters:

  • max_results (Fixnum)

    Maximum number of IDs to return.

  • space (String)

    The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
# File 'generated/google/apis/drive_v2/service.rb', line 1320

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

#get_about(include_subscribed: nil, max_change_id_count: nil, start_change_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::About

Gets the information about the current user along with Drive API settings

Parameters:

  • include_subscribed (Boolean)

    Whether to count changes outside the My Drive hierarchy. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the maxChangeIdCount.

  • max_change_id_count (Fixnum)

    Maximum number of remaining change IDs to count

  • start_change_id (Fixnum)

    Change ID to start counting from when calculating number of remaining change IDs

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



85
86
87
88
89
90
91
92
93
94
95
96
# File 'generated/google/apis/drive_v2/service.rb', line 85

def get_about(include_subscribed: nil, max_change_id_count: nil, start_change_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'about', options)
  command.response_representation = Google::Apis::DriveV2::About::Representation
  command.response_class = Google::Apis::DriveV2::About
  command.query['includeSubscribed'] = include_subscribed unless include_subscribed.nil?
  command.query['maxChangeIdCount'] = max_change_id_count unless max_change_id_count.nil?
  command.query['startChangeId'] = start_change_id unless start_change_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a specific app.

Parameters:

  • app_id (String)

    The ID of the app.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



120
121
122
123
124
125
126
127
128
129
# File 'generated/google/apis/drive_v2/service.rb', line 120

def get_app(app_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'apps/{appId}', options)
  command.response_representation = Google::Apis::DriveV2::App::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_change(change_id, drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Change

Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes.

Parameters:

  • change_id (String)

    The ID of the change.

  • drive_id (String)

    The shared drive from which the change will be returned.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • team_drive_id (String)

    Deprecated use driveId instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'generated/google/apis/drive_v2/service.rb', line 208

def get_change(change_id, drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'changes/{changeId}', options)
  command.response_representation = Google::Apis::DriveV2::Change::Representation
  command.response_class = Google::Apis::DriveV2::Change
  command.params['changeId'] = change_id unless change_id.nil?
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets the starting pageToken for listing future changes.

Parameters:

  • drive_id (String)

    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)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • team_drive_id (String)

    Deprecated use driveId instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'generated/google/apis/drive_v2/service.rb', line 252

def get_change_start_page_token(drive_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'changes/startPageToken', options)
  command.response_representation = Google::Apis::DriveV2::StartPageToken::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_child(folder_id, child_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ChildReference

Gets a specific child reference.

Parameters:

  • folder_id (String)

    The ID of the folder.

  • child_id (String)

    The ID of the child.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



520
521
522
523
524
525
526
527
528
529
530
# File 'generated/google/apis/drive_v2/service.rb', line 520

def get_child(folder_id, child_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{folderId}/children/{childId}', options)
  command.response_representation = Google::Apis::DriveV2::ChildReference::Representation
  command.response_class = Google::Apis::DriveV2::ChildReference
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.params['childId'] = child_id unless child_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a comment by ID.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • include_deleted (Boolean)

    If set, this will succeed when retrieving a deleted comment, and will include any deleted replies.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



686
687
688
689
690
691
692
693
694
695
696
697
# File 'generated/google/apis/drive_v2/service.rb', line 686

def get_comment(file_id, comment_id, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/comments/{commentId}', options)
  command.response_representation = Google::Apis::DriveV2::Comment::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a shared drive's metadata by ID.

Parameters:

  • drive_id (String)

    The ID of the shared drive.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



920
921
922
923
924
925
926
927
928
929
930
# File 'generated/google/apis/drive_v2/service.rb', line 920

def get_drife(drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'drives/{driveId}', options)
  command.response_representation = Google::Apis::DriveV2::Drive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_file(file_id, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Gets a file's metadata by ID.

Parameters:

  • file_id (String)

    The ID for the file in question.

  • acknowledge_abuse (Boolean)

    Whether the user is acknowledging the risk of downloading known malware or other abusive files.

  • projection (String)

    This parameter is deprecated and has no function.

  • revision_id (String)

    Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • update_viewed_date (Boolean)

    Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • download_dest (IO, String)

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
# File 'generated/google/apis/drive_v2/service.rb', line 1371

def get_file(file_id, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: 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::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['revisionId'] = revision_id unless revision_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['updateViewedDate'] = update_viewed_date unless update_viewed_date.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_parent(file_id, parent_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ParentReference

Gets a specific parent reference.

Parameters:

  • file_id (String)

    The ID of the file.

  • parent_id (String)

    The ID of the parent.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'generated/google/apis/drive_v2/service.rb', line 1983

def get_parent(file_id, parent_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/parents/{parentId}', options)
  command.response_representation = Google::Apis::DriveV2::ParentReference::Representation
  command.response_class = Google::Apis::DriveV2::ParentReference
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['parentId'] = parent_id unless parent_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Permission

Gets a permission by ID.

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • permission_id (String)

    The ID for the permission.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
# File 'generated/google/apis/drive_v2/service.rb', line 2149

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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/permissions/{permissionId}', options)
  command.response_representation = Google::Apis::DriveV2::Permission::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_permission_id_for_email(email, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::PermissionId

Returns the permission ID for an email address.

Parameters:

  • email (String)

    The email address for which to return a permission ID

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
# File 'generated/google/apis/drive_v2/service.rb', line 2186

def get_permission_id_for_email(email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'permissionIds/{email}', options)
  command.response_representation = Google::Apis::DriveV2::PermissionId::Representation
  command.response_class = Google::Apis::DriveV2::PermissionId
  command.params['email'] = email unless email.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_property(file_id, property_key, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Property

Gets a property by its key.

Parameters:

  • file_id (String)

    The ID of the file.

  • property_key (String)

    The key of the property.

  • visibility (String)

    The visibility of the property.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
# File 'generated/google/apis/drive_v2/service.rb', line 2485

def get_property(file_id, property_key, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/properties/{propertyKey}', options)
  command.response_representation = Google::Apis::DriveV2::Property::Representation
  command.response_class = Google::Apis::DriveV2::Property
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['propertyKey'] = property_key unless property_key.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_realtime(file_id, revision: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Exports the contents of the Realtime API data model associated with this file as JSON.

Parameters:

  • file_id (String)

    The ID of the file that the Realtime API data model is associated with.

  • revision (Fixnum)

    The revision of the Realtime API data model to export. Revisions start at 1 ( the initial empty data model) and are incremented with each change. If this parameter is excluded, the most recent data model will be returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • download_dest (IO, String)

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions)

    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:



2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
# File 'generated/google/apis/drive_v2/service.rb', line 2682

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

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

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

  • include_deleted (Boolean)

    If set, this will succeed when retrieving a deleted reply.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
# File 'generated/google/apis/drive_v2/service.rb', line 2810

def get_reply(file_id, comment_id, reply_id, include_deleted: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.response_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.response_class = Google::Apis::DriveV2::CommentReply
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Gets a specific revision.

Parameters:

  • file_id (String)

    The ID of the file.

  • revision_id (String)

    The ID of the revision.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
# File 'generated/google/apis/drive_v2/service.rb', line 3055

def get_revision(file_id, revision_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/revisions/{revisionId}', options)
  command.response_representation = Google::Apis::DriveV2::Revision::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Deprecated use drives.get instead.

Parameters:

  • team_drive_id (String)

    The ID of the Team Drive

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
# File 'generated/google/apis/drive_v2/service.rb', line 3242

def get_teamdrive(team_drive_id, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'teamdrives/{teamDriveId}', options)
  command.response_representation = Google::Apis::DriveV2::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Hides a shared drive from the default view.

Parameters:

  • drive_id (String)

    The ID of the shared drive.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



954
955
956
957
958
959
960
961
962
963
# File 'generated/google/apis/drive_v2/service.rb', line 954

def hide_drife(drive_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'drives/{driveId}/hide', options)
  command.response_representation = Google::Apis::DriveV2::Drive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_child(folder_id, child_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ChildReference

Inserts a file into a folder.

Parameters:

  • folder_id (String)

    The ID of the folder.

  • child_reference_object (Google::Apis::DriveV2::ChildReference) (defaults to: nil)
  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



559
560
561
562
563
564
565
566
567
568
569
570
571
572
# File 'generated/google/apis/drive_v2/service.rb', line 559

def insert_child(folder_id, child_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{folderId}/children', options)
  command.request_representation = Google::Apis::DriveV2::ChildReference::Representation
  command.request_object = child_reference_object
  command.response_representation = Google::Apis::DriveV2::ChildReference::Representation
  command.response_class = Google::Apis::DriveV2::ChildReference
  command.params['folderId'] = folder_id unless folder_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a new comment on the given file.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_object (Google::Apis::DriveV2::Comment) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



722
723
724
725
726
727
728
729
730
731
732
733
# File 'generated/google/apis/drive_v2/service.rb', line 722

def insert_comment(file_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/comments', options)
  command.request_representation = Google::Apis::DriveV2::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::DriveV2::Comment::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Creates a new shared drive.

Parameters:

  • request_id (String)

    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::DriveV2::Drive) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



992
993
994
995
996
997
998
999
1000
1001
1002
1003
# File 'generated/google/apis/drive_v2/service.rb', line 992

def insert_drife(request_id, drive_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'drives', options)
  command.request_representation = Google::Apis::DriveV2::Drive::Representation
  command.request_object = drive_object
  command.response_representation = Google::Apis::DriveV2::Drive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_file(file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Insert a new file.

Parameters:

  • file_object (Google::Apis::DriveV2::File) (defaults to: nil)
  • convert (Boolean)

    Whether to convert this file to the corresponding Google Docs format.

  • ocr (Boolean)

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • ocr_language (String)

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • pinned (Boolean)

    Whether to pin the head revision of the uploaded file. A file can have a maximum of 200 pinned revisions.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • timed_text_language (String)

    The language of the timed text.

  • timed_text_track_name (String)

    The timed text track name.

  • use_content_as_indexable_text (Boolean)

    Whether to use the content as indexable text.

  • visibility (String)

    The visibility of the new file. This parameter is only relevant when convert= false.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String)

    IO stream or filename containing content to upload

  • content_type (String)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
# File 'generated/google/apis/drive_v2/service.rb', line 1440

def insert_file(file_object = nil, convert: nil, ocr: nil, ocr_language: nil, pinned: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, use_content_as_indexable_text: nil, visibility: nil, fields: nil, quota_user: nil, user_ip: 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::DriveV2::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.query['convert'] = convert unless convert.nil?
  command.query['ocr'] = ocr unless ocr.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['pinned'] = pinned unless pinned.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['timedTextLanguage'] = timed_text_language unless timed_text_language.nil?
  command.query['timedTextTrackName'] = timed_text_track_name unless timed_text_track_name.nil?
  command.query['useContentAsIndexableText'] = use_content_as_indexable_text unless use_content_as_indexable_text.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_parent(file_id, parent_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ParentReference

Adds a parent folder for a file.

Parameters:

  • file_id (String)

    The ID of the file.

  • parent_reference_object (Google::Apis::DriveV2::ParentReference) (defaults to: nil)
  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
# File 'generated/google/apis/drive_v2/service.rb', line 2022

def insert_parent(file_id, parent_reference_object = nil, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/parents', options)
  command.request_representation = Google::Apis::DriveV2::ParentReference::Representation
  command.request_object = parent_reference_object
  command.response_representation = Google::Apis::DriveV2::ParentReference::Representation
  command.response_class = Google::Apis::DriveV2::ParentReference
  command.params['fileId'] = file_id unless file_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_permission(file_id, permission_object = nil, email_message: nil, send_notification_emails: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Permission

Inserts a permission for a file or shared drive.

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • permission_object (Google::Apis::DriveV2::Permission) (defaults to: nil)
  • email_message (String)

    A plain text custom message to include in notification emails.

  • send_notification_emails (Boolean)

    Whether to send notification emails when sharing to users or groups. This parameter is ignored and an email is sent if the role is owner.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
# File 'generated/google/apis/drive_v2/service.rb', line 2234

def insert_permission(file_id, permission_object = nil, email_message: nil, send_notification_emails: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/permissions', options)
  command.request_representation = Google::Apis::DriveV2::Permission::Representation
  command.request_object = permission_object
  command.response_representation = Google::Apis::DriveV2::Permission::Representation
  command.response_class = Google::Apis::DriveV2::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['emailMessage'] = email_message unless email_message.nil?
  command.query['sendNotificationEmails'] = send_notification_emails unless send_notification_emails.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_property(file_id, property_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Property

Adds a property to a file, or updates it if it already exists.

Parameters:

  • file_id (String)

    The ID of the file.

  • property_object (Google::Apis::DriveV2::Property) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
# File 'generated/google/apis/drive_v2/service.rb', line 2521

def insert_property(file_id, property_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/properties', options)
  command.request_representation = Google::Apis::DriveV2::Property::Representation
  command.request_object = property_object
  command.response_representation = Google::Apis::DriveV2::Property::Representation
  command.response_class = Google::Apis::DriveV2::Property
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#insert_reply(file_id, comment_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::CommentReply

Creates a new reply to the given comment.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • comment_reply_object (Google::Apis::DriveV2::CommentReply) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
# File 'generated/google/apis/drive_v2/service.rb', line 2849

def insert_reply(file_id, comment_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/comments/{commentId}/replies', options)
  command.request_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.request_object = comment_reply_object
  command.response_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.response_class = Google::Apis::DriveV2::CommentReply
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Deprecated use drives.insert instead.

Parameters:

  • request_id (String)

    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::DriveV2::TeamDrive) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
# File 'generated/google/apis/drive_v2/service.rb', line 3281

def insert_teamdrive(request_id, team_drive_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'teamdrives', options)
  command.request_representation = Google::Apis::DriveV2::TeamDrive::Representation
  command.request_object = team_drive_object
  command.response_representation = Google::Apis::DriveV2::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::AppList

Lists a user's installed apps.

Parameters:

  • app_filter_extensions (String)

    A comma-separated list of file extensions for open with filtering. All apps within the given app query scope which can open any of the given file extensions will be 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)

    A comma-separated list of MIME types for open with filtering. All apps 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)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



164
165
166
167
168
169
170
171
172
173
174
175
# File 'generated/google/apis/drive_v2/service.rb', line 164

def list_apps(app_filter_extensions: nil, app_filter_mime_types: nil, language_code: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'apps', options)
  command.response_representation = Google::Apis::DriveV2::AppList::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_changes(drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ChangeList

Lists the changes for a user or shared drive.

Parameters:

  • drive_id (String)

    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)

    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_deleted (Boolean)

    Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

  • include_items_from_all_drives (Boolean)

    Whether both My Drive and shared drive items should be included in results.

  • include_subscribed (Boolean)

    Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.

  • include_team_drive_items (Boolean)

    Deprecated use includeItemsFromAllDrives instead.

  • max_results (Fixnum)

    Maximum number of changes to return.

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

  • spaces (String)

    A comma-separated list of spaces to query. Supported values are 'drive', ' appDataFolder' and 'photos'.

  • start_change_id (Fixnum)

    Deprecated - use pageToken instead.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • team_drive_id (String)

    Deprecated use driveId instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# File 'generated/google/apis/drive_v2/service.rb', line 324

def list_changes(drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'changes', options)
  command.response_representation = Google::Apis::DriveV2::ChangeList::Representation
  command.response_class = Google::Apis::DriveV2::ChangeList
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
  command.query['includeSubscribed'] = include_subscribed unless include_subscribed.nil?
  command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['spaces'] = spaces unless spaces.nil?
  command.query['startChangeId'] = start_change_id unless start_change_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_children(folder_id, max_results: nil, order_by: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ChildList

Lists a folder's children.

Parameters:

  • folder_id (String)

    The ID of the folder.

  • max_results (Fixnum)

    Maximum number of children to return.

  • order_by (String)

    A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', ' lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', ' recency', 'sharedWithMeDate', 'starred', and 'title'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ? orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

  • page_token (String)

    Page token for children.

  • q (String)

    Query string for searching children.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



610
611
612
613
614
615
616
617
618
619
620
621
622
623
# File 'generated/google/apis/drive_v2/service.rb', line 610

def list_children(folder_id, max_results: nil, order_by: nil, page_token: nil, q: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{folderId}/children', options)
  command.response_representation = Google::Apis::DriveV2::ChildList::Representation
  command.response_class = Google::Apis::DriveV2::ChildList
  command.params['folderId'] = folder_id unless folder_id.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_comments(file_id, include_deleted: nil, max_results: nil, page_token: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::CommentList

Lists a file's comments.

Parameters:

  • file_id (String)

    The ID of the file.

  • include_deleted (Boolean)

    If set, all comments and replies, including deleted comments and replies (with content stripped) will be returned.

  • max_results (Fixnum)

    The maximum number of discussions to include in the response, used for paging.

  • page_token (String)

    The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • updated_min (String)

    Only discussions that were updated after this timestamp will be returned. Formatted as an RFC 3339 timestamp.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



769
770
771
772
773
774
775
776
777
778
779
780
781
782
# File 'generated/google/apis/drive_v2/service.rb', line 769

def list_comments(file_id, include_deleted: nil, max_results: nil, page_token: nil, updated_min: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/comments', options)
  command.response_representation = Google::Apis::DriveV2::CommentList::Representation
  command.response_class = Google::Apis::DriveV2::CommentList
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['updatedMin'] = updated_min unless updated_min.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Lists the user's shared drives.

Parameters:

  • max_results (Fixnum)

    Maximum number of shared drives to return.

  • page_token (String)

    Page token for shared drives.

  • q (String)

    Query string for searching shared drives.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
# File 'generated/google/apis/drive_v2/service.rb', line 1034

def list_drives(max_results: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'drives', options)
  command.response_representation = Google::Apis::DriveV2::DriveList::Representation
  command.response_class = Google::Apis::DriveV2::DriveList
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_team_drive_items: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::FileList

Lists the user's files.

Parameters:

  • corpora (String)

    Bodies of items (files/documents) to which the query applies. Supported bodies are 'default', 'domain', 'drive' and 'allDrives'. Prefer 'default' or 'drive' to 'allDrives' for efficiency.

  • corpus (String)

    The body of items (files/documents) to which the query applies. Deprecated: use 'corpora' instead.

  • drive_id (String)

    ID of the shared drive to search.

  • include_items_from_all_drives (Boolean)

    Whether both My Drive and shared drive items should be included in results.

  • include_team_drive_items (Boolean)

    Deprecated use includeItemsFromAllDrives instead.

  • max_results (Fixnum)

    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.

  • order_by (String)

    A comma-separated list of sort keys. Valid keys are 'createdDate', 'folder', ' lastViewedByMeDate', 'modifiedByMeDate', 'modifiedDate', 'quotaBytesUsed', ' recency', 'sharedWithMeDate', 'starred', 'title', and 'title_natural'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedDate desc,title. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.

  • page_token (String)

    Page token for files.

  • projection (String)

    This parameter is deprecated and has no function.

  • q (String)

    Query string for searching files.

  • spaces (String)

    A comma-separated list of spaces to query. Supported values are 'drive', ' appDataFolder' and 'photos'.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • team_drive_id (String)

    Deprecated use driveId instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
# File 'generated/google/apis/drive_v2/service.rb', line 1527

def list_files(corpora: nil, corpus: nil, drive_id: nil, include_items_from_all_drives: nil, include_team_drive_items: nil, max_results: nil, order_by: nil, page_token: nil, projection: nil, q: nil, spaces: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files', options)
  command.response_representation = Google::Apis::DriveV2::FileList::Representation
  command.response_class = Google::Apis::DriveV2::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['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['projection'] = projection unless projection.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_parents(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::ParentList

Lists a file's parents.

Parameters:

  • file_id (String)

    The ID of the file.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
# File 'generated/google/apis/drive_v2/service.rb', line 2059

def list_parents(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/parents', options)
  command.response_representation = Google::Apis::DriveV2::ParentList::Representation
  command.response_class = Google::Apis::DriveV2::ParentList
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

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

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • max_results (Fixnum)

    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)

    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)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
# File 'generated/google/apis/drive_v2/service.rb', line 2290

def list_permissions(file_id, max_results: nil, page_token: nil, supports_all_drives: nil, supports_team_drives: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/permissions', options)
  command.response_representation = Google::Apis::DriveV2::PermissionList::Representation
  command.response_class = Google::Apis::DriveV2::PermissionList
  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['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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_properties(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::PropertyList

Lists a file's properties.

Parameters:

  • file_id (String)

    The ID of the file.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
# File 'generated/google/apis/drive_v2/service.rb', line 2556

def list_properties(file_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/properties', options)
  command.response_representation = Google::Apis::DriveV2::PropertyList::Representation
  command.response_class = Google::Apis::DriveV2::PropertyList
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#list_replies(file_id, comment_id, include_deleted: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::CommentReplyList

Lists all of the replies to a comment.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • include_deleted (Boolean)

    If set, all replies, including deleted replies (with content stripped) will be returned.

  • max_results (Fixnum)

    The maximum number of replies to include in the response, used for paging.

  • page_token (String)

    The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
# File 'generated/google/apis/drive_v2/service.rb', line 2896

def list_replies(file_id, comment_id, include_deleted: nil, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/comments/{commentId}/replies', options)
  command.response_representation = Google::Apis::DriveV2::CommentReplyList::Representation
  command.response_class = Google::Apis::DriveV2::CommentReplyList
  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['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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Lists a file's revisions.

Parameters:

  • file_id (String)

    The ID of the file.

  • max_results (Fixnum)

    Maximum number of revisions to return.

  • page_token (String)

    Page token for revisions. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
# File 'generated/google/apis/drive_v2/service.rb', line 3094

def list_revisions(file_id, max_results: nil, page_token: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'files/{fileId}/revisions', options)
  command.response_representation = Google::Apis::DriveV2::RevisionList::Representation
  command.response_class = Google::Apis::DriveV2::RevisionList
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Deprecated use drives.list instead.

Parameters:

  • max_results (Fixnum)

    Maximum number of Team Drives to return.

  • page_token (String)

    Page token for Team Drives.

  • q (String)

    Query string for searching Team Drives.

  • use_domain_admin_access (Boolean)

    Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
# File 'generated/google/apis/drive_v2/service.rb', line 3323

def list_teamdrives(max_results: nil, page_token: nil, q: nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'teamdrives', options)
  command.response_representation = Google::Apis::DriveV2::TeamDriveList::Representation
  command.response_class = Google::Apis::DriveV2::TeamDriveList
  command.query['maxResults'] = max_results unless max_results.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing comment. This method supports patch semantics.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • comment_object (Google::Apis::DriveV2::Comment) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



809
810
811
812
813
814
815
816
817
818
819
820
821
# File 'generated/google/apis/drive_v2/service.rb', line 809

def patch_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}/comments/{commentId}', options)
  command.request_representation = Google::Apis::DriveV2::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::DriveV2::Comment::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Updates file metadata and/or content. This method supports patch semantics.

Parameters:

  • file_id (String)

    The ID of the file to update.

  • file_object (Google::Apis::DriveV2::File) (defaults to: nil)
  • add_parents (String)

    Comma-separated list of parent IDs to add.

  • convert (Boolean)

    This parameter is deprecated and has no function.

  • modified_date_behavior (String)

    Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

  • new_revision (Boolean)

    Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

  • ocr (Boolean)

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • ocr_language (String)

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • pinned (Boolean)

    Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.

  • remove_parents (String)

    Comma-separated list of parent IDs to remove.

  • set_modified_date (Boolean)

    Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • timed_text_language (String)

    The language of the timed text.

  • timed_text_track_name (String)

    The timed text track name.

  • update_viewed_date (Boolean)

    Whether to update the view date after successfully updating the file.

  • use_content_as_indexable_text (Boolean)

    Whether to use the content as indexable text.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
# File 'generated/google/apis/drive_v2/service.rb', line 1614

def patch_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}', options)
  command.request_representation = Google::Apis::DriveV2::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['addParents'] = add_parents unless add_parents.nil?
  command.query['convert'] = convert unless convert.nil?
  command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil?
  command.query['newRevision'] = new_revision unless new_revision.nil?
  command.query['ocr'] = ocr unless ocr.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['pinned'] = pinned unless pinned.nil?
  command.query['removeParents'] = remove_parents unless remove_parents.nil?
  command.query['setModifiedDate'] = set_modified_date unless set_modified_date.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['timedTextLanguage'] = timed_text_language unless timed_text_language.nil?
  command.query['timedTextTrackName'] = timed_text_track_name unless timed_text_track_name.nil?
  command.query['updateViewedDate'] = update_viewed_date unless update_viewed_date.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_permission(file_id, permission_id, permission_object = 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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Permission

Updates a permission using patch semantics.

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • permission_id (String)

    The ID for the permission.

  • permission_object (Google::Apis::DriveV2::Permission) (defaults to: nil)
  • remove_expiration (Boolean)

    Whether to remove the expiration date.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • transfer_ownership (Boolean)

    Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
# File 'generated/google/apis/drive_v2/service.rb', line 2345

def patch_permission(file_id, permission_id, permission_object = 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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}/permissions/{permissionId}', options)
  command.request_representation = Google::Apis::DriveV2::Permission::Representation
  command.request_object = permission_object
  command.response_representation = Google::Apis::DriveV2::Permission::Representation
  command.response_class = Google::Apis::DriveV2::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['permissionId'] = permission_id unless permission_id.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_property(file_id, property_key, property_object = nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Property

Updates a property.

Parameters:

  • file_id (String)

    The ID of the file.

  • property_key (String)

    The key of the property.

  • property_object (Google::Apis::DriveV2::Property) (defaults to: nil)
  • visibility (String)

    The visibility of the property. Allowed values are PRIVATE and PUBLIC. ( Default: PRIVATE)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
# File 'generated/google/apis/drive_v2/service.rb', line 2595

def patch_property(file_id, property_key, property_object = nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}/properties/{propertyKey}', options)
  command.request_representation = Google::Apis::DriveV2::Property::Representation
  command.request_object = property_object
  command.response_representation = Google::Apis::DriveV2::Property::Representation
  command.response_class = Google::Apis::DriveV2::Property
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['propertyKey'] = property_key unless property_key.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#patch_reply(file_id, comment_id, reply_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::CommentReply

Updates an existing reply. This method supports 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.

  • comment_reply_object (Google::Apis::DriveV2::CommentReply) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
# File 'generated/google/apis/drive_v2/service.rb', line 2938

def patch_reply(file_id, comment_id, reply_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.request_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.request_object = comment_reply_object
  command.response_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.response_class = Google::Apis::DriveV2::CommentReply
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates a revision. This method supports patch semantics.

Parameters:

  • file_id (String)

    The ID for the file.

  • revision_id (String)

    The ID for the revision.

  • revision_object (Google::Apis::DriveV2::Revision) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
# File 'generated/google/apis/drive_v2/service.rb', line 3132

def patch_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'files/{fileId}/revisions/{revisionId}', options)
  command.request_representation = Google::Apis::DriveV2::Revision::Representation
  command.request_object = revision_object
  command.response_representation = Google::Apis::DriveV2::Revision::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

This method returns an undefined value.

Stop watching resources through this channel

Parameters:

  • channel_object (Google::Apis::DriveV2::Channel) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    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:



452
453
454
455
456
457
458
459
460
# File 'generated/google/apis/drive_v2/service.rb', line 452

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

#touch_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Set the file's updated time to the current server time.

Parameters:

  • file_id (String)

    The ID of the file to update.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
# File 'generated/google/apis/drive_v2/service.rb', line 1668

def touch_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/touch', options)
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#trash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for shared drive files.

Parameters:

  • file_id (String)

    The ID of the file to trash.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
# File 'generated/google/apis/drive_v2/service.rb', line 1708

def trash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/trash', options)
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Restores a shared drive to the default view.

Parameters:

  • drive_id (String)

    The ID of the shared drive.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
# File 'generated/google/apis/drive_v2/service.rb', line 1070

def unhide_drife(drive_id, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'drives/{driveId}/unhide', options)
  command.response_representation = Google::Apis::DriveV2::Drive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#untrash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Restores a file from the trash.

Parameters:

  • file_id (String)

    The ID of the file to untrash.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
# File 'generated/google/apis/drive_v2/service.rb', line 1747

def untrash_file(file_id, supports_all_drives: nil, supports_team_drives: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'files/{fileId}/untrash', options)
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_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['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates an existing comment.

Parameters:

  • file_id (String)

    The ID of the file.

  • comment_id (String)

    The ID of the comment.

  • comment_object (Google::Apis::DriveV2::Comment) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



848
849
850
851
852
853
854
855
856
857
858
859
860
# File 'generated/google/apis/drive_v2/service.rb', line 848

def update_comment(file_id, comment_id, comment_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'files/{fileId}/comments/{commentId}', options)
  command.request_representation = Google::Apis::DriveV2::Comment::Representation
  command.request_object = comment_object
  command.response_representation = Google::Apis::DriveV2::Comment::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates the metadata for a shared drive.

Parameters:

  • drive_id (String)

    The ID of the shared drive.

  • drive_object (Google::Apis::DriveV2::Drive) (defaults to: nil)
  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
# File 'generated/google/apis/drive_v2/service.rb', line 1108

def update_drife(drive_id, drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'drives/{driveId}', options)
  command.request_representation = Google::Apis::DriveV2::Drive::Representation
  command.request_object = drive_object
  command.response_representation = Google::Apis::DriveV2::Drive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::File

Updates file metadata and/or content.

Parameters:

  • file_id (String)

    The ID of the file to update.

  • file_object (Google::Apis::DriveV2::File) (defaults to: nil)
  • add_parents (String)

    Comma-separated list of parent IDs to add.

  • convert (Boolean)

    This parameter is deprecated and has no function.

  • modified_date_behavior (String)

    Determines the behavior in which modifiedDate is updated. This overrides setModifiedDate.

  • new_revision (Boolean)

    Whether a blob upload should create a new revision. If false, the blob data in the current head revision is replaced. If true or not set, a new blob is created as head revision, and previous unpinned revisions are preserved for a short period of time. Pinned revisions are stored indefinitely, using additional storage quota, up to a maximum of 200 revisions. For details on how revisions are retained, see the Drive Help Center.

  • ocr (Boolean)

    Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads.

  • ocr_language (String)

    If ocr is true, hints at the language to use. Valid values are BCP 47 codes.

  • pinned (Boolean)

    Whether to pin the new revision. A file can have a maximum of 200 pinned revisions.

  • remove_parents (String)

    Comma-separated list of parent IDs to remove.

  • set_modified_date (Boolean)

    Whether to set the modified date using the value supplied in the request body. Setting this field to true is equivalent to modifiedDateBehavior=fromBodyOrNow, and false is equivalent to modifiedDateBehavior=now. To prevent any changes to the modified date set modifiedDateBehavior=noChange.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • timed_text_language (String)

    The language of the timed text.

  • timed_text_track_name (String)

    The timed text track name.

  • update_viewed_date (Boolean)

    Whether to update the view date after successfully updating the file.

  • use_content_as_indexable_text (Boolean)

    Whether to use the content as indexable text.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String)

    IO stream or filename containing content to upload

  • content_type (String)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
# File 'generated/google/apis/drive_v2/service.rb', line 1827

def update_file(file_id, file_object = nil, add_parents: nil, convert: nil, modified_date_behavior: nil, new_revision: nil, ocr: nil, ocr_language: nil, pinned: nil, remove_parents: nil, set_modified_date: nil, supports_all_drives: nil, supports_team_drives: nil, timed_text_language: nil, timed_text_track_name: nil, update_viewed_date: nil, use_content_as_indexable_text: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:put, 'files/{fileId}', options)
  else
    command = make_upload_command(:put, 'files/{fileId}', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.request_representation = Google::Apis::DriveV2::File::Representation
  command.request_object = file_object
  command.response_representation = Google::Apis::DriveV2::File::Representation
  command.response_class = Google::Apis::DriveV2::File
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['addParents'] = add_parents unless add_parents.nil?
  command.query['convert'] = convert unless convert.nil?
  command.query['modifiedDateBehavior'] = modified_date_behavior unless modified_date_behavior.nil?
  command.query['newRevision'] = new_revision unless new_revision.nil?
  command.query['ocr'] = ocr unless ocr.nil?
  command.query['ocrLanguage'] = ocr_language unless ocr_language.nil?
  command.query['pinned'] = pinned unless pinned.nil?
  command.query['removeParents'] = remove_parents unless remove_parents.nil?
  command.query['setModifiedDate'] = set_modified_date unless set_modified_date.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['timedTextLanguage'] = timed_text_language unless timed_text_language.nil?
  command.query['timedTextTrackName'] = timed_text_track_name unless timed_text_track_name.nil?
  command.query['updateViewedDate'] = update_viewed_date unless update_viewed_date.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_permission(file_id, permission_id, permission_object = 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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Permission

Updates a permission.

Parameters:

  • file_id (String)

    The ID for the file or shared drive.

  • permission_id (String)

    The ID for the permission.

  • permission_object (Google::Apis::DriveV2::Permission) (defaults to: nil)
  • remove_expiration (Boolean)

    Whether to remove the expiration date.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • transfer_ownership (Boolean)

    Whether changing a role to 'owner' downgrades the current owners to writers. Does nothing if the specified role is not 'owner'.

  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
# File 'generated/google/apis/drive_v2/service.rb', line 2403

def update_permission(file_id, permission_id, permission_object = 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, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'files/{fileId}/permissions/{permissionId}', options)
  command.request_representation = Google::Apis::DriveV2::Permission::Representation
  command.request_object = permission_object
  command.response_representation = Google::Apis::DriveV2::Permission::Representation
  command.response_class = Google::Apis::DriveV2::Permission
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['permissionId'] = permission_id unless permission_id.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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_property(file_id, property_key, property_object = nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Property

Updates a property.

Parameters:

  • file_id (String)

    The ID of the file.

  • property_key (String)

    The key of the property.

  • property_object (Google::Apis::DriveV2::Property) (defaults to: nil)
  • visibility (String)

    The visibility of the property. Allowed values are PRIVATE and PUBLIC. ( Default: PRIVATE)

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
# File 'generated/google/apis/drive_v2/service.rb', line 2638

def update_property(file_id, property_key, property_object = nil, visibility: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'files/{fileId}/properties/{propertyKey}', options)
  command.request_representation = Google::Apis::DriveV2::Property::Representation
  command.request_object = property_object
  command.response_representation = Google::Apis::DriveV2::Property::Representation
  command.response_class = Google::Apis::DriveV2::Property
  command.params['fileId'] = file_id unless file_id.nil?
  command.params['propertyKey'] = property_key unless property_key.nil?
  command.query['visibility'] = visibility unless visibility.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_realtime(file_id, base_revision: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil) {|result, err| ... }

This method returns an undefined value.

Overwrites the Realtime API data model associated with this file with the provided JSON data model.

Parameters:

  • file_id (String)

    The ID of the file that the Realtime API data model is associated with.

  • base_revision (String)

    The revision of the model to diff the uploaded model against. If set, the uploaded model is diffed against the provided revision and those differences are merged with any changes made to the model after the provided revision. If not set, the uploaded model replaces the current model on the server.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • upload_source (IO, String)

    IO stream or filename containing content to upload

  • content_type (String)

    Content type of the uploaded content.

  • options (Google::Apis::RequestOptions)

    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:



2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
# File 'generated/google/apis/drive_v2/service.rb', line 2729

def update_realtime(file_id, base_revision: nil, fields: nil, quota_user: nil, user_ip: nil, upload_source: nil, content_type: nil, options: nil, &block)
  if upload_source.nil?
    command =  make_simple_command(:put, 'files/{fileId}/realtime', options)
  else
    command = make_upload_command(:put, 'files/{fileId}/realtime', options)
    command.upload_source = upload_source
    command.upload_content_type = content_type
  end
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['baseRevision'] = base_revision unless base_revision.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#update_reply(file_id, comment_id, reply_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::CommentReply

Updates an existing 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.

  • comment_reply_object (Google::Apis::DriveV2::CommentReply) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
# File 'generated/google/apis/drive_v2/service.rb', line 2980

def update_reply(file_id, comment_id, reply_id, comment_reply_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'files/{fileId}/comments/{commentId}/replies/{replyId}', options)
  command.request_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.request_object = comment_reply_object
  command.response_representation = Google::Apis::DriveV2::CommentReply::Representation
  command.response_class = Google::Apis::DriveV2::CommentReply
  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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

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

Updates a revision.

Parameters:

  • file_id (String)

    The ID for the file.

  • revision_id (String)

    The ID for the revision.

  • revision_object (Google::Apis::DriveV2::Revision) (defaults to: nil)
  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
# File 'generated/google/apis/drive_v2/service.rb', line 3171

def update_revision(file_id, revision_id, revision_object = nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'files/{fileId}/revisions/{revisionId}', options)
  command.request_representation = Google::Apis::DriveV2::Revision::Representation
  command.request_object = revision_object
  command.response_representation = Google::Apis::DriveV2::Revision::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.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, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::TeamDrive

Deprecated use drives.update instead.

Parameters:

  • team_drive_id (String)

    The ID of the Team Drive

  • team_drive_object (Google::Apis::DriveV2::TeamDrive) (defaults to: nil)
  • use_domain_admin_access (Boolean)

    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)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
# File 'generated/google/apis/drive_v2/service.rb', line 3364

def update_teamdrive(team_drive_id, team_drive_object = nil, use_domain_admin_access: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:put, 'teamdrives/{teamDriveId}', options)
  command.request_representation = Google::Apis::DriveV2::TeamDrive::Representation
  command.request_object = team_drive_object
  command.response_representation = Google::Apis::DriveV2::TeamDrive::Representation
  command.response_class = Google::Apis::DriveV2::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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_change(channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Channel

Subscribe to changes for a user.

Parameters:

  • channel_object (Google::Apis::DriveV2::Channel) (defaults to: nil)
  • drive_id (String)

    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)

    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_deleted (Boolean)

    Whether to include changes indicating that items have been removed from the list of changes, for example by deletion or loss of access.

  • include_items_from_all_drives (Boolean)

    Whether both My Drive and shared drive items should be included in results.

  • include_subscribed (Boolean)

    Whether to include changes outside the My Drive hierarchy in the result. When set to false, changes to files such as those in the Application Data folder or shared files which have not been added to My Drive will be omitted from the result.

  • include_team_drive_items (Boolean)

    Deprecated use includeItemsFromAllDrives instead.

  • max_results (Fixnum)

    Maximum number of changes to return.

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

  • spaces (String)

    A comma-separated list of spaces to query. Supported values are 'drive', ' appDataFolder' and 'photos'.

  • start_change_id (Fixnum)

    Deprecated - use pageToken instead.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • team_drive_id (String)

    Deprecated use driveId instead.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# File 'generated/google/apis/drive_v2/service.rb', line 406

def watch_change(channel_object = nil, drive_id: nil, include_corpus_removals: nil, include_deleted: nil, include_items_from_all_drives: nil, include_subscribed: nil, include_team_drive_items: nil, max_results: nil, page_token: nil, spaces: nil, start_change_id: nil, supports_all_drives: nil, supports_team_drives: nil, team_drive_id: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'changes/watch', options)
  command.request_representation = Google::Apis::DriveV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DriveV2::Channel::Representation
  command.response_class = Google::Apis::DriveV2::Channel
  command.query['driveId'] = drive_id unless drive_id.nil?
  command.query['includeCorpusRemovals'] = include_corpus_removals unless include_corpus_removals.nil?
  command.query['includeDeleted'] = include_deleted unless include_deleted.nil?
  command.query['includeItemsFromAllDrives'] = include_items_from_all_drives unless include_items_from_all_drives.nil?
  command.query['includeSubscribed'] = include_subscribed unless include_subscribed.nil?
  command.query['includeTeamDriveItems'] = include_team_drive_items unless include_team_drive_items.nil?
  command.query['maxResults'] = max_results unless max_results.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['spaces'] = spaces unless spaces.nil?
  command.query['startChangeId'] = start_change_id unless start_change_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?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::DriveV2::Channel

Subscribe to changes on a file

Parameters:

  • file_id (String)

    The ID for the file in question.

  • channel_object (Google::Apis::DriveV2::Channel) (defaults to: nil)
  • acknowledge_abuse (Boolean)

    Whether the user is acknowledging the risk of downloading known malware or other abusive files.

  • projection (String)

    This parameter is deprecated and has no function.

  • revision_id (String)

    Specifies the Revision ID that should be downloaded. Ignored unless alt=media is specified.

  • supports_all_drives (Boolean)

    Whether the requesting application supports both My Drives and shared drives.

  • supports_team_drives (Boolean)

    Deprecated use supportsAllDrives instead.

  • update_viewed_date (Boolean)

    Deprecated: Use files.update with modifiedDateBehavior=noChange, updateViewedDate=true and an empty request body.

  • fields (String)

    Selector specifying which fields to include in a partial response.

  • quota_user (String)

    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • user_ip (String)

    Deprecated. Please use quotaUser instead.

  • download_dest (IO, String)

    IO stream or filename to receive content download

  • options (Google::Apis::RequestOptions)

    Request-specific options

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
# File 'generated/google/apis/drive_v2/service.rb', line 1901

def watch_file(file_id, channel_object = nil, acknowledge_abuse: nil, projection: nil, revision_id: nil, supports_all_drives: nil, supports_team_drives: nil, update_viewed_date: nil, fields: nil, quota_user: nil, user_ip: nil, download_dest: nil, options: nil, &block)
  if download_dest.nil?
    command =  make_simple_command(:post, 'files/{fileId}/watch', options)
  else
    command = make_download_command(:post, 'files/{fileId}/watch', options)
    command.download_dest = download_dest
  end
  command.request_representation = Google::Apis::DriveV2::Channel::Representation
  command.request_object = channel_object
  command.response_representation = Google::Apis::DriveV2::Channel::Representation
  command.response_class = Google::Apis::DriveV2::Channel
  command.params['fileId'] = file_id unless file_id.nil?
  command.query['acknowledgeAbuse'] = acknowledge_abuse unless acknowledge_abuse.nil?
  command.query['projection'] = projection unless projection.nil?
  command.query['revisionId'] = revision_id unless revision_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['updateViewedDate'] = update_viewed_date unless update_viewed_date.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end