google_api_drive

v0.15.0

google_api_drive v0.15.0 GoogleApi.Drive.V3.Api.Files View Source

API calls for all endpoints tagged Files.

Link to this section Summary

Functions

drive_files_copy(connection, file_id, optional_params \\ [], opts \\ [])

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

drive_files_create(connection, optional_params \\ [], opts \\ [])

Creates a new file.

drive_files_create_iodata(connection, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Creates a new file.

drive_files_create_resumable(connection, upload_type, optional_params \\ [], opts \\ [])

Creates a new file.

drive_files_create_simple(connection, upload_type, metadata, data, optional_params \\ [], opts \\ [])

Creates a new file.

drive_files_delete(connection, file_id, optional_params \\ [], opts \\ [])

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.

drive_files_empty_trash(connection, optional_params \\ [], opts \\ [])

Permanently deletes all of the user's trashed files.

drive_files_export(connection, file_id, mime_type, optional_params \\ [], opts \\ [])

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

drive_files_generate_ids(connection, optional_params \\ [], opts \\ [])

Generates a set of file IDs which can be provided in create or copy requests.

drive_files_get(connection, file_id, optional_params \\ [], opts \\ [])

Gets a file's metadata or content by ID.

drive_files_list(connection, optional_params \\ [], opts \\ [])

Lists or searches files.

drive_files_update(connection, file_id, optional_params \\ [], opts \\ [])

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

drive_files_update_iodata(connection, file_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

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

drive_files_update_resumable(connection, file_id, upload_type, optional_params \\ [], opts \\ [])

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

drive_files_update_simple(connection, file_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

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

drive_files_watch(connection, file_id, optional_params \\ [], opts \\ [])

Subscribes to changes to a file

Link to this section Functions

Link to this function

drive_files_copy(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_copy(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a copy of a file and applies any requested updates with patch semantics. Folders cannot be copied.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
    • :ignoreDefaultVisibility (type: boolean()) - Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :body (type: GoogleApi.Drive.V3.Model.File.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_create(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new file.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
    • :ignoreDefaultVisibility (type: boolean()) - Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
    • :body (type: GoogleApi.Drive.V3.Model.File.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_create_iodata(connection, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_create_iodata(
  Tesla.Env.client(),
  String.t(),
  GoogleApi.Drive.V3.Model.File.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new file.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Drive.V3.Model.File.t) - object metadata
  • data (type: iodata) - Content to upload, as a string or iolist
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
    • :ignoreDefaultVisibility (type: boolean()) - Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_create_resumable(connection, upload_type, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_create_resumable(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Creates a new file.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • upload_type (type: String.t) - Upload type. Must be "resumable".
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
    • :ignoreDefaultVisibility (type: boolean()) - Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
    • :body (type: GoogleApi.Drive.V3.Model.File.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_files_create_simple(connection, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_create_simple(
  Tesla.Env.client(),
  String.t(),
  GoogleApi.Drive.V3.Model.File.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Creates a new file.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Drive.V3.Model.File.t) - object metadata
  • data (type: String.t) - Path to file containing content to upload
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. Requests that specify more than one parent fail.
    • :ignoreDefaultVisibility (type: boolean()) - Whether to ignore the domain's default visibility settings for the created file. Domain administrators can choose to make all uploaded files visible to the domain by default; this parameter bypasses that behavior for the request. Permissions are still inherited from parent folders.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_delete(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Permanently deletes a file owned by the user without moving it to the trash. If the file belongs to a shared drive the user must be an organizer on the parent. If the target is a folder, all descendants owned by the user are also deleted.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_files_empty_trash(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_empty_trash(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Permanently deletes all of the user's trashed files.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_files_export(connection, file_id, mime_type, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_export(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

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

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • mime_type (type: String.t) - The MIME type of the format requested for this export.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_files_generate_ids(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_generate_ids(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.GeneratedIds.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Generates a set of file IDs which can be provided in create or copy requests.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :count (type: integer()) - The number of IDs to return.
    • :space (type: String.t) - The space in which the IDs can be used to create new files. Supported values are 'drive' and 'appDataFolder'.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.GeneratedIds{}} on success
  • {:error, info} on failure
Link to this function

drive_files_get(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a file's metadata or content by ID.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :acknowledgeAbuse (type: boolean()) - Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.FileList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Lists or searches files.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :corpora (type: String.t) - Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.
    • :corpus (type: String.t) - The source of files to list. Deprecated: use 'corpora' instead.
    • :driveId (type: String.t) - ID of the shared drive to search.
    • :includeItemsFromAllDrives (type: boolean()) - Whether both My Drive and shared drive items should be included in results.
    • :includeTeamDriveItems (type: boolean()) - Deprecated use includeItemsFromAllDrives instead.
    • :orderBy (type: String.t) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
    • :pageSize (type: integer()) - 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.
    • :pageToken (type: String.t) - The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
    • :q (type: String.t) - A query for filtering the file results. See the "Search for Files" guide for supported syntax.
    • :spaces (type: String.t) - A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :teamDriveId (type: String.t) - Deprecated use driveId instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.FileList{}} on success
  • {:error, info} on failure
Link to this function

drive_files_update(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :addParents (type: String.t) - A comma-separated list of parent IDs to add.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :removeParents (type: String.t) - A comma-separated list of parent IDs to remove.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
    • :body (type: GoogleApi.Drive.V3.Model.File.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_update_iodata(connection, file_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_update_iodata(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Drive.V3.Model.File.t(),
  iodata(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Drive.V3.Model.File.t) - object metadata
  • data (type: iodata) - Content to upload, as a string or iolist
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :addParents (type: String.t) - A comma-separated list of parent IDs to add.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :removeParents (type: String.t) - A comma-separated list of parent IDs to remove.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_update_resumable(connection, file_id, upload_type, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_update_resumable(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • upload_type (type: String.t) - Upload type. Must be "resumable".
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :addParents (type: String.t) - A comma-separated list of parent IDs to add.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :removeParents (type: String.t) - A comma-separated list of parent IDs to remove.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
    • :body (type: GoogleApi.Drive.V3.Model.File.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

drive_files_update_simple(connection, file_id, upload_type, metadata, data, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_update_simple(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  GoogleApi.Drive.V3.Model.File.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Drive.V3.Model.File.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • upload_type (type: String.t) - Upload type. Must be "multipart".
  • metadata (type: GoogleApi.Drive.V3.Model.File.t) - object metadata
  • data (type: String.t) - Path to file containing content to upload
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :addParents (type: String.t) - A comma-separated list of parent IDs to add.
    • :enforceSingleParent (type: boolean()) - Set to true to opt in to API behavior that aims for all items to have exactly one parent. This parameter only takes effect if the item is not in a shared drive. If the item's owner makes a request to add a single parent, the item is removed from all current folders and placed in the requested folder. Other requests that increase the number of parents fail, except when the canAddMyDriveParent file capability is true and a single parent is being added.
    • :keepRevisionForever (type: boolean()) - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions.
    • :ocrLanguage (type: String.t) - A language hint for OCR processing during image import (ISO 639-1 code).
    • :removeParents (type: String.t) - A comma-separated list of parent IDs to remove.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :useContentAsIndexableText (type: boolean()) - Whether to use the uploaded content as indexable text.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.File{}} on success
  • {:error, info} on failure
Link to this function

drive_files_watch(connection, file_id, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_watch(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.Channel.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Subscribes to changes to a file

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • file_id (type: String.t) - The ID of the file.
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :acknowledgeAbuse (type: boolean()) - Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :resource (type: GoogleApi.Drive.V3.Model.Channel.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.Channel{}} on success
  • {:error, info} on failure