Upload Media
Stay organized with collections
Save and categorize content based on your preferences.
Several API methods support uploading media in addition to a regular body.
In that case, the regular request method is overloaded to get an additional Stream
to upload.
Overview
For any Stream
you wish to upload, you should use resumable
media upload, which allows streams to be uploaded in smaller chunks.
This is especially useful if you are transferring large files,
and the likelihood of a network interruption or some other transmission
failure is high.
It can also reduce your bandwidth usage in the event of network failures
because you don't have to restart large file uploads from the beginning.
Resumable Media Upload has been a feature in the Google API .NET client library
since 1.2.0-beta.
The Google API-specific libraries contain convenience methods for
interacting with this feature.
The resumable media upload protocol is described, for example, on the media upload page for the Drive API
.
The main class of interest is ResumableUpload
.
In this implementation, the media content is uploaded in chunks.
The default chunk size is 10MB, but you can change it by
setting the ChunkSize
property on the request to any multiple of 256KB.
If a server error is encountered in a request then exponential backoff
policy is used to resend the bytes that were not successfully uploaded.
By default, exponential backoff is enabled for each client request.
You can change the default behavior when you construct
a new service object by changing the DefaultExponentialBackOffPolicy
property on BaseClientService.Initializer
and/or setting the HttpClientInitializer
property to your own implementation of IConfigurableHttpClientInitializer
that adds some backoff policy.
The methods that support media upload are identified
in the reference documentation for the API-specific documentation.
For these API methods, convenience Upload
and UploadAsync
methods are added.
Those methods take a Stream
to upload and its content type as parameters.
Make sure that the position of the stream you upload is 0, otherwise you will receive an error, such as
"System.InvalidOperationException: The given header was not found".
Note that due to the behavior of the framework's HttpClient
class, if the upload times out, a TaskCanceledException
is thrown.
If you see this exception, consider manually increasing the Timeout
property in
the client used by your service object.
Sample Code
//
Create
the
service
using
the
client
credentials
.
var
service
=
new
DriveService
(
new
BaseClientService
.
Initializer
()
{
HttpClientInitializer
=
credential
,
ApplicationName
=
"Application_Name"
});
using
var
uploadStream
=
System
.
IO
.
File
.
OpenRead
(
"Local_File_Name"
);
//
Create
the
File
resource
to
upload
.
Google
.
Apis
.
Drive
.
v3
.
Data
.
File
driveFile
=
new
Google
.
Apis
.
Drive
.
v3
.
Data
.
File
{
Name
=
"Drive_File_Name"
};
//
Get
the
media
upload
request
object
.
FilesResource
.
CreateMediaUpload
insertRequest
=
service
.
Files
.
Create
(
driveFile
,
uploadStream
,
"image/jpeg"
);
//
Add
handlers
which
will
be
notified
on
progress
changes
and
upload
completion
.
//
Notification
of
progress
changed
will
be
invoked
when
the
upload
was
started
,
//
on
each
upload
chunk
,
and
on
success
or
failure
.
insertRequest
.
ProgressChanged
+=
Upload_ProgressChanged
;
insertRequest
.
ResponseReceived
+=
Upload_ResponseReceived
;
await
insertRequest
.
UploadAsync
();
static
void
Upload_ProgressChanged
(
IUploadProgress
progress
)
=>
Console
.
WriteLine
(
progress
.
Status
+
" "
+
progress
.
BytesSent
);
static
void
Upload_ResponseReceived
(
Google
.
Apis
.
Drive
.
v3
.
Data
.
File
file
)
=>
Console
.
WriteLine
(
file
.
Name
+
" was uploaded successfully"
);
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-17 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-17 UTC."],[[["\u003cp\u003eSome API methods allow uploading media using resumable media upload, enabling the transfer of large files in smaller chunks, reducing bandwidth usage, and minimizing interruptions.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eResumableUpload\u003c/code\u003e class facilitates resumable media uploads with a default chunk size of 10MB, adjustable to multiples of 256KB, and includes exponential backoff for error handling.\u003c/p\u003e\n"],["\u003cp\u003eConvenience methods \u003ccode\u003eUpload\u003c/code\u003e and \u003ccode\u003eUploadAsync\u003c/code\u003e are available for API methods supporting media upload, accepting a stream and its content type as parameters, ensuring the stream's position is at 0 to avoid errors.\u003c/p\u003e\n"],["\u003cp\u003eConsider increasing the \u003ccode\u003eHttpClient\u003c/code\u003e timeout property to prevent \u003ccode\u003eTaskCanceledException\u003c/code\u003e during prolonged uploads, as demonstrated in the provided sample code.\u003c/p\u003e\n"],["\u003cp\u003eResumable media upload functionality is accessible through the Google API .NET client library, offering detailed documentation and progress tracking capabilities.\u003c/p\u003e\n"]]],[],null,["# Upload Media\n\nSeveral API methods support uploading media in addition to a regular body.\nIn that case, the regular request method is overloaded to get an additional\n`Stream` to upload.\n\nOverview\n--------\n\n\nFor any `Stream` you wish to upload, you should use resumable\nmedia upload, which allows streams to be uploaded in smaller chunks.\nThis is especially useful if you are transferring large files,\nand the likelihood of a network interruption or some other transmission\nfailure is high.\nIt can also reduce your bandwidth usage in the event of network failures\nbecause you don't have to restart large file uploads from the beginning.\n\nResumableMediaUpload\n--------------------\n\n\nResumable Media Upload has been a feature in the Google API .NET client library\nsince 1.2.0-beta.\nThe Google API-specific libraries contain convenience methods for\ninteracting with this feature.\n\n\nThe resumable media upload protocol is described, for example, on the\n[media upload page for the Drive API](https://developers.google.com/drive/manage-uploads#resumable).\nThe main class of interest is\n[`ResumableUpload`](https://googleapis.dev/dotnet/Google.Apis/latest/api/Google.Apis.Upload.ResumableUpload.html).\nIn this implementation, the media content is uploaded in chunks.\n\n\nThe default chunk size is 10MB, but you can change it by\nsetting the `ChunkSize` property on the request to any multiple of 256KB.\nIf a server error is encountered in a request then exponential backoff\npolicy is used to resend the bytes that were not successfully uploaded.\nBy default, exponential backoff is enabled for each client request.\nYou can change the default behavior when you construct\na new service object by changing the\n[`DefaultExponentialBackOffPolicy`](https://googleapis.dev/dotnet/Google.Apis/latest/api/Google.Apis.Services.BaseClientService.Initializer.html#Google_Apis_Services_BaseClientService_Initializer_DefaultExponentialBackOffPolicy) property on `BaseClientService.Initializer`\nand/or setting the\n[`HttpClientInitializer`](https://googleapis.dev/dotnet/Google.Apis/latest/api/Google.Apis.Services.BaseClientService.Initializer.html#Google_Apis_Services_BaseClientService_Initializer_HttpClientInitializer)\nproperty to your own implementation of `IConfigurableHttpClientInitializer`\nthat adds some backoff policy.\n\n\nThe methods that support media upload are identified\nin the reference documentation for the API-specific documentation.\nFor these API methods, convenience `Upload` and\n`UploadAsync` methods are added.\nThose methods take a `Stream` to upload and its content type as parameters.\n\n\nMake sure that the position of the stream you upload is 0, otherwise you will receive an error, such as\n\"System.InvalidOperationException: The given header was not found\".\n\n\nNote that due to the behavior of the framework's `HttpClient`\nclass, if the upload times out, a `TaskCanceledException` is thrown.\nIf you see this exception, consider manually increasing the `Timeout` property in\nthe client used by your service object.\n\nSample Code\n-----------\n\n```gdscript\n// Create the service using the client credentials.\nvar service = new DriveService(new BaseClientService.Initializer()\n{\n HttpClientInitializer = credential,\n ApplicationName = \"Application_Name\"\n});\n\nusing var uploadStream = System.IO.File.OpenRead(\"Local_File_Name\");\n\n// Create the File resource to upload.\nGoogle.Apis.Drive.v3.Data.File driveFile = new Google.Apis.Drive.v3.Data.File\n{\n Name = \"Drive_File_Name\"\n};\n// Get the media upload request object.\nFilesResource.CreateMediaUpload insertRequest = service.Files.Create(\n driveFile, uploadStream, \"image/jpeg\");\n\n// Add handlers which will be notified on progress changes and upload completion.\n// Notification of progress changed will be invoked when the upload was started,\n// on each upload chunk, and on success or failure.\ninsertRequest.ProgressChanged += Upload_ProgressChanged;\ninsertRequest.ResponseReceived += Upload_ResponseReceived;\n\nawait insertRequest.UploadAsync();\n\nstatic void Upload_ProgressChanged(IUploadProgress progress) =\u003e\n Console.WriteLine(progress.Status + \" \" + progress.BytesSent);\n\nstatic void Upload_ResponseReceived(Google.Apis.Drive.v3.Data.File file) =\u003e\n Console.WriteLine(file.Name + \" was uploaded successfully\");\n```"]]
