Request

HTTP request

This method provides media upload functionality through two separate URIs. For more details, see the document on media upload .

• Upload URI, for media upload requests:

  POST https://www.googleapis.com/upload/storage/v1beta2/b/bucket/o

• Metadata URI, for metadata-only requests:

  POST https://www.googleapis.com/storage/v1beta2/b/bucket/o

Parameters

Request body

In the request body, supply an object resource with the following properties as the metadata. For more information, see the document on media upload .

Response

By default, this responds with an object resource in the response body. If you provide the URL parameter alt=media , then it will respond with the object data in the response body. If you use alt=media , then you can use the Range HTTP header to specify the portion of the object you wish to retrieve.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

// Given
InputStream inputStream;  // object data, e.g., FileInputStream
long byteCount;  // size of input stream

InputStreamContent mediaContent = new InputStreamContent("application/octet-stream", inputStream);
// Knowing the stream length allows server-side optimization, and client-side progress
// reporting with a MediaHttpUploaderProgressListener.
mediaContent.setLength(byteCount);

StorageObject objectMetadata = null;

if (useCustomMetadata) {
  // If you have custom settings for metadata on the object you want to set
  // then you can allocate a StorageObject and set the values here. You can
  // leave out setBucket(), since the bucket is in the insert command's
  // parameters.
  objectMetadata = new StorageObject()
      .setName("myobject")
      .setMetadata(ImmutableMap.of("key1", "value1", "key2", "value2"))
      .setAcl(ImmutableList.of(
          new ObjectAccessControl().setEntity("domain-example.com").setRole("READER"),
          new ObjectAccessControl().setEntity("[email protected]").setRole("OWNER")
          ))
      .setContentDisposition("attachment");
}

Storage.Objects.Insert insertObject = storage.objects().insert("mybucket", objectMetadata,
    mediaContent);

if (!useCustomMetadata) {
  // If you don't provide metadata, you will have specify the object
  // name by parameter. You will probably also want to ensure that your
  // default object ACLs (a bucket property) are set appropriately:
  // https://developers.google.com/storage/docs/json_api/v1beta2/buckets#defaultObjectAcl
  insertObject.setName("myobject");
}

// For small files, you may wish to call setDirectUploadEnabled(true), to
// reduce the number of HTTP requests made to the server.
if (mediaContent.getLength() > 0 && mediaContent.getLength() <= 2 * 1000 * 1000 /* 2MB */) {
  insertObject.getMediaHttpUploader().setDirectUploadEnabled(true);
}

insertObject.execute();

# The BytesIO object may be replaced with any io.Base instance.
media = http.MediaIoBaseUpload(io.BytesIO('some data'), 'text/plain')
# All object_resource fields here are optional.
object_resource = {
        'metadata': {'my-key': 'my-value'},
        'contentLanguage': 'en',
        'md5Hash': 'HlAhCgICSX+3m8OLat5sNA==',
        'crc32c': 'rPZE1w==',

}
req = client.objects().insert(
        bucket=bucket_name,
        name=object_name,
        body=object_resource,     # optional
        media_body=media)
resp = req.execute()
print json.dumps(resp, indent=2)

# Resumable upload
resumable_media = Google::APIClient::UploadIO.new(FILENAME, MIME_TYPE)
resumable_result = client.execute(
  api_method: storage.objects.insert,
  media: resumable_media,
  parameters: {
    uploadType: 'resumable',
    bucket: BUCKET,
    name: OBJECT
  },
  body_object: {contentType: MIME_TYPE}
)
# Does actual upload of file
upload = resumable_result.resumable_upload
if upload.resumable?
  client.execute(upload)
end
puts "\nResumable insert: "
puts "Created object #{upload.parameters['name']}"

// Insert an object into a bucket.
filename := "FILE_NAME"
file, err := os.Open(filename)
if err != nil {
	fmt.Printf("error opening %q: %v", filename, err)
}
result, err := service.Objects.Insert("BUCKET_NAME",
	&storage.Object{Name: filename}).Media(file).Do()
fmt.Printf("\nCreated object %v at location %v",
	result.Name, result.SelfLink)

Try it!

Note: APIs Explorer currently supports metadata requests only.

Use the APIs Explorer below to call this method on live data and see the response. Alternatively, try the standalone Explorer .