GoogleDrive Class

Properties Methods Events Configuration Settings Errors

The GoogleDrive class makes it easy to upload, download, and manage files and folders within Google Drive.

Syntax

class ipworkscloud.GoogleDrive

Remarks

The GoogleDrive class provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.

To begin, first create an account and register your application with Google. Consult the Google Drive documentation for more information on this process.

Authentication

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

Assign this value to the authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

The list_resources method is used to list resources within the scope specified by the list_resources_scope property.

The list_children, list_parents, and get_resource_info methods are also available for finer-grained control.

// ResourceList event handler.
googledrive.OnResourceList += (s, e) => {
  Console.WriteLine(e.Name);
};

// List all of the current user's resources.
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser;
do {
  googledrive.ListResources();

  for (int i = 0; i < googledrive.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

// List all of the resources in the specified shared drive.
googledrive.SharedDrive = "wfsr789vusijfv";
googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive;
do {
  googledrive.ListResources();

  for (int i = 0; i < googledrive.Resources.Count; i++) {
    // Process resources here.
  }
} while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

Downloading Files

The download_file method is used to download files.

Download Notes

Downloading an Encrypted File

To decrypt an encrypted file set encryption_algorithm and encryption_password before calling this method.

googledrive.LocalFile = "../MyFile.zip";
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download.

string downloadFile = "../MyFile.zip";
googledrive.LocalFile = downloadFile;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially downloaded file
googledrive.StartByte = new FileInfo(downloadFile).Length;
googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file.

googledrive.LocalFile = "../MyFile.zip";
googledrive.EncryptionPassword = "password";
googledrive.DownloadFile(googledrive.Resource[0].Id, "");

//The transfer is interrupted and DownloadFile() above fails. Later, resume the download:

//Get the size of the partially download temp file
googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length;
googledrive.DownloadFile(googledrive.Resource[0].Id, "");

Uploading Files

The upload_file method is used to upload files.

Upload Notes

Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism.

googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that resume_url and start_byte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. get_upload_status may be used to check the status of a resumable upload.

googledrive.LocalFile = "../MyFile.zip";
googledrive.UploadFile("MyFile.zip", "");

//The transfer is interrupted and UploadFile() above fails. Later, resume the download.
//Using the same instance StartByte and ResumeURL are already populated from the previous
//upload attempt.
googledrive.UploadFile("MyFile.zip", "");

Shared Drive Support

The GoogleDrive class has full support for Google Shared Drives. For the most common use-cases (such as those described above), there is very little difference when using a shared drive versus a personal Google Drive ("My Drive").

For more information about how to use the class with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like list_resources, move_resource, update_permissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the add_shared_drive_member and list_shared_drives methods, the shared_drive property, etc.

Additional Functionality

The GoogleDrive class offers advanced functionality beyond simple uploads and downloads. For instance:

Encrypt and decrypt files using the encryption_algorithm and encryption_password properties.
Basic file and folder manipulation and organization using methods such as copy_resource, create_folder, delete_resource, move_resource, and update_resource.
Enumeration and manipulation of parent-child relationships using the add_parents, list_children, list_parents, and remove_parents methods.
Resourcing trashing and deletion: delete_resource, trash_resource, restore_resource.
Control over permissions using list_permissions and update_permissions.
Change tracking with list_changes.
And more!

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


account_can_create_shared_drives	Whether the account has permission to create shared drives.
account_drive_usage	Amount of storage used in Google Drive.
account_email	The email address of the account.
account_name	The name of the account's user.
account_permission_id	The permission Id associated with the account.
account_storage_quota	The account's storage quota.
account_storage_usage	Amount of storage used across all Google services.
account_trash_usage	Amount of storage used by trashed items in Google Drive.
authorization	OAuth 2.0 Authorization Token.
change_marker	A marker indicating what page of changes to return next.
change_count	The number of records in the Change arrays.
change_removed	Whether the file or shared drive has been removed.
change_resource_id	The Id of the file to which the change applies.
change_shared_drive_id	The Id of the shared drive.
change_time	The time of the change.
change_type	Whether the change is for a file or a shared drive.
child_marker	A marker when child resources are paged.
child_count	The number of records in the Child arrays.
child_content_accessible	Whether the resource's content is accessible to less-privileged users.
child_created_time	The creation date of the resource.
child_description	A short description of the resource.
child_extension	The file extension of the resource.
child_id	The Id of the resource.
child_md5_checksum	The MD5 checksum of the file resource.
child_mime_type	The MIME type of the resource.
child_modified_time	The last modified date of the resource.
child_name	The name of the resource.
child_original_name	The original name of the file resource.
child_owner	The name of the resource's owner.
child_owner_email	The email address of the resource's owner.
child_parent_ids	The Ids of the resource's parent folders.
child_shared_drive_id	The Id of the shared drive the resource is in.
child_size	The size of the file resource in bytes.
child_starred	Whether the resource is starred.
child_trashed	Whether the resource is in the trash.
child_type	The resource's type.
child_viewed	Whether the resource has been viewed.
child_view_link	A link for opening the resource in a relevant Google editor or viewer in a browser.
encryption_algorithm	The encryption algorithm.
encryption_password	The encryption password.
firewall_auto_detect	This property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_type	This property determines the type of firewall to connect through.
firewall_host	This property contains the name or IP address of firewall (optional).
firewall_password	This property contains a password if authentication is to be used when connecting through the firewall.
firewall_port	This property contains the TCP port for the firewall Host .
firewall_user	This property contains a user name if authentication is to be used connecting through a firewall.
idle	The current status of the class.
list_resources_scope	Controls the scope of the results when listing resources.
local_file	The location of the local file.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
next_change_marker	A marker indicating what page of changes to return in the future.
other_headers	Other headers as determined by the user (optional).
overwrite	Determines if local files are overwritten.
parsed_header_count	The number of records in the ParsedHeader arrays.
parsed_header_field	This property contains the name of the HTTP header (same case as it is delivered).
parsed_header_value	This property contains the header contents.
permission_marker	A marker when permissions are paged.
permission_count	The number of records in the Permission arrays.
permission_allow_file_discovery	Whether the permission allows the file or folder to be discovered through search.
permission_domain	The domain to which the permission applies.
permission_email	The user or group to which the permission applies.
permission_id	The Id of the permission.
permission_mod_op	The operation to perform on the permission.
permission_role	The role specified by the permission.
permission_type	The set of users to which the permission applies.
proxy_auth_scheme	This property is used to tell the class which type of authorization to perform when connecting to the proxy.
proxy_auto_detect	This property tells the class whether or not to automatically detect and use proxy system settings, if available.
proxy_password	This property contains a password if authentication is to be used for the proxy.
proxy_port	This property contains the TCP port for the proxy Server (default 80).
proxy_server	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
proxy_ssl	This property determines when to use SSL for the connection to the proxy.
proxy_user	This property contains a user name, if authentication is to be used for the proxy.
query_param_count	The number of records in the QueryParam arrays.
query_param_name	The name of the query parameter.
query_param_value	The value of the query parameter.
resource_data	The data that was downloaded, or that should be uploaded.
resource_marker	A marker indicating what page of resources to return next.
resource_count	The number of records in the Resource arrays.
resource_content_accessible	Whether the resource's content is accessible to less-privileged users.
resource_created_time	The creation date of the resource.
resource_description	A short description of the resource.
resource_extension	The file extension of the resource.
resource_id	The Id of the resource.
resource_md5_checksum	The MD5 checksum of the file resource.
resource_mime_type	The MIME type of the resource.
resource_modified_time	The last modified date of the resource.
resource_name	The name of the resource.
resource_original_name	The original name of the file resource.
resource_owner	The name of the resource's owner.
resource_owner_email	The email address of the resource's owner.
resource_parent_ids	The Ids of the resource's parent folders.
resource_shared_drive_id	The Id of the shared drive the resource is in.
resource_size	The size of the file resource in bytes.
resource_starred	Whether the resource is starred.
resource_trashed	Whether the resource is in the trash.
resource_type	The resource's type.
resource_viewed	Whether the resource has been viewed.
resource_view_link	A link for opening the resource in a relevant Google editor or viewer in a browser.
resume_url	The resumable upload URL.
shared_drive	The shared drive to list file and folder resources for.
shared_drive_marker	A marker when shared drives are paged.
shared_drive_count	The number of records in the SharedDrive arrays.
shared_drive_capabilities	The capabilities that the current user has for the shared drive.
shared_drive_created_time	The creation date of the shared drive.
shared_drive_hidden	Whether the shared drive is hidden from default view.
shared_drive_id	The Id of the shared drive.
shared_drive_name	The name of the shared drive.
shared_drive_restrictions	The restrictions that apply to the shared drive.
ssl_accept_server_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_encoded	The certificate (PEM/base64 encoded).
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
ssl_cert_store_type	The type of certificate store for this certificate.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/base64 encoded).
start_byte	The byte offset from which to start the upload or download.
timeout	A timeout for the class.
use_resumable_upload	Whether to use resumable uploads.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


add_parents	Adds folders to the list of parents for a file or folder.
add_query_param	Adds a query parameter to the QueryParams properties.
add_shared_drive_member	Creates a new shared drive member.
config	Sets or retrieves a configuration setting.
copy_resource	Copies a file.
create_folder	Creates a new folder.
create_shared_drive	Creates a new shared drive.
delete_resource	Deletes the specified file or folder permanently.
delete_shared_drive	Deletes a shared drive.
download_file	Downloads, and optionally converts, a file.
empty_trash	Permanently deletes all of the current user's trashed files.
get_account_info	Gets information about the current user's account and space usage.
get_current_change_marker	Gets the most current change marker.
get_permission_info	Gets information about a specific permission.
get_resource_info	Gets information about specific files and folders.
get_shared_drive_info	Gets information about a specific shared drive.
get_upload_status	Gets the status of a resumable upload session.
interrupt	Interrupt the current method.
list_changes	Lists changes to resources and shared drives.
list_children	Lists the child resources of one or more folders.
list_parents	Lists the parent folders of a file or folder.
list_permissions	Lists the permissions for a file, folder, or shared drive.
list_resources	Lists files and folders.
list_shared_drives	Lists shared drives that the current user is a member of.
move_resource	Moves a file or folder.
remove_parents	Removes folders from the list of parents for a file or folder.
remove_shared_drive_member	Removes an existing shared drive member.
reset	Resets the class to its initial state.
restore_resource	Restores a file or folder from the trash.
send_custom_request	Sends a custom request to the Google Drive API.
toggle_shared_drive_hidden	Hides or unhides a shared drive.
trash_resource	Moves the specified file or folder to the trash.
update_permissions	Create, update, and delete permissions on a file, folder, or shared drive.
update_resource	Updates a file or folder.
update_shared_drive	Updates a shared drive.
update_shared_drive_member	Updates an existing shared drive member's role.
upload_file	Uploads, and optionally converts, a new file.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


on_change_list	Fires once for each change when ListChanges is called.
on_end_transfer	Fired when a document finishes transferring.
on_error	Information about errors during data delivery.
on_fragment_complete	Fires after each fragment of a resumable upload is completed.
on_header	Fired every time a header line comes in.
on_log	Fires once for each log message.
on_permission_list	This event fires once for each permission returned when listing permissions.
on_progress	Fires during an upload or download to indicate transfer progress.
on_resource_list	Fires once for each resource returned when listing resources.
on_shared_drive_list	Fires once for each shared drive returned when listing shared drives.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Shows the progress of the secure connection.
on_start_transfer	Fired when a document starts transferring (after the headers).
on_transfer	Fired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


AccumulatePages	Whether the class should accumulate subsequent pages of results when listing them.
DocsExportFormat	The file format to export Google Docs files as when downloading.
DownloadTempFile	The temporary file used when downloading encrypted data.
DrawingsExportFormat	The file format to export Google Drawings files as when downloading.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during encryption/decryption.
FragmentSize	The fragment size.
IconLink[i]	A static, unauthenticated link to the file icon for the specified resource.
IncludeAllFields	Whether to request all fields when listing resources.
IncludeFolderProperties	Whether resource properties apply when calling CreateFolder.
ListResourcesMode	What items to include when listing resources.
MaxPermissionResults	Limits the number of permissions results.
MaxResults	Limits the number of resource and change results.
MaxSharedDriveResults	Limits the number of shared drive results.
NormalizedFileName[i]	File name constructed using the specified resource's information.
ProgressAbsolute	Whether the class should track transfer progress absolutely.
ProgressStep	How often the progress event should be fired, in terms of percentage.
RawRequest	Returns the data that was sent to the server.
RawResponse	Returns the data that was received from the server.
ResourceKey[i]	The resource key used to access a file.
SearchIncomplete	Indicates whether the server declined to search all possible locations when listing resources.
SheetsExportFormat	The file format to export Google Sheets files as when downloading.
SlidesExportFormat	The file format to export Google Slides files as when downloading.
TempPath	The path to the directory where temporary files are created.
TransferOwnership	Must be set to True before modifying permissions in a manner that causes the owner of a resource to change.
UseDomainAdminAccess	Whether to make requests using domain administrator permissions.
XChildCount	The number of child elements of the current element.
XChildName[i]	The name of the child element.
XChildXText[i]	The inner text of the child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the returned XML or JSON response.
XSubTree	A snapshot of the current element in the document.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to true the URL will be encoded by the class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the class.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the class.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the class binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACertFilePaths	The paths to CA certificate files on Unix/Linux.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
ProcessIdleEvents	Whether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillis	The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

IPWorks Cloud 2020 Python Edition