Google Cloud Storage

Filestack can also be configured to store users' files directly into your Google Cloud Storage account. To do this click the GoogleCloud link in your developer portal under Storage.

You will need to specify the Google Cloud Access Key, as well as the container name and the Google Project ID.

Google Cloud Storage Installation

This video walks through the steps listed below
  1. Go to http://cloud.google.com/storage and sign up for an account and create a project. Next use the menu to select Storage if you are not already on the page as shown here.
    Navigate to the GCS main page
  2. Create a new bucket. This can be a Multi-Region, Single Region, Nearline, or Coldline Bucket.
  3. Now with your bucket created, use the menu to go to the API Manager and select credentials. Then choose to create a new service account key. Finally, click create and download the JSON key.
    a. Click Create Credentials and choose Service Account Key
    b. Select new service account and set the role as "Owner". Select JSON as the key type
    c. Click create and save the JSON key
  4. Now go to your developer portal and click on GoogleCloud, copy the entire contents of the JSON file and enter them in Google Cloud Access Key (JSON), then enter the bucket name, and the project ID.
  5. Click test to make sure everything worked.

Congratulations your Google Cloud Storage integration is all set up!. You may now enter 'gcs' as a value for the location storage options parameter.

Storing to Gcs Storage using the Javascript API

You can store your files to Storage with the filepicker.pickAndStore Javascript API method.

filepicker.pickAndStore( { mimetype:"image/*", multiple: true }, { location:"gcs" }, function(Blobs){ console.log(JSON.stringify(Blobs)); } );

Gcs Storage Options for Javascript API

storage options
An optional dictionary of key-value pairs that configure how to store the data.
Filename
String
{filename: 'MyCoolPhoto.png'}

The name of the file as it will be stored. If this isn't provided, we do the best we can to come up with one.

Mimetype
String
{mimetype: 'text/html'}

The type of the file as it will be stored. If this isn't provided, we do the best we can, defaulting to "text/plain" if you give us raw data.

Base64 Decoding
Boolean
{base64decode: true}

Specify that you want the data to be first decoded from base64 before being written to the file. For example, if you have base64 encoded image data, you can use this flag to first decode the data before writing the image file.

Location
String
{location: 'gcs'}

Where to store the file. The default is S3. Other options are 'azure', 'dropbox', 'rackspace' and 'gcs'. You must have configured your storage in the developer portal to enable this feature. Note:> Rackspace, Azure, Dropbox and Google Cloud are only available on the PLUS and higher plans.

Path
String
{path: '/myfiles/1234.png'}

The path to store the file at within the specified file store. For gcs, this is the key where the file will be stored at. By default, Filestack stores the file at the root at a unique id, followed by an underscore, followed by the filename, for example "3AB239102DB_myphoto.png".

If the provided path ends in a '/', it will be treated as a folder, so if the provided path is "myfiles/" and the uploaded file is named "myphoto.png", the file will be stored at "myfiles/909DFAC9CB12_myphoto.png", for example.

If the multiple option is set to true, only paths that end in '/' are allowed.

Store Container
String
{storeContainer: 'user-photos'}

The bucket or container in the specified file store where the file should end up. This is especially useful if you have different containers for testing and production and you want to use them both on the same Filestack app. If this parameter is omitted, the file is stored in the default container specified in your developer portal. For pick functions, the parameter is storeContainer, for the filepicker.store() method the parameter is container.

Note: This parameter does not apply to the Dropbox file store.

Store Region
String
{storeRegion: 'us-east-1'}

The region where your storage container is located. This setting currently applies only to S3 buckets. If you are using a different bucket and region than the one you set up in your developer portal you can pass the storeRegion as part of your store options. If this parameter is not set we will do our best to determine the region your S3 bucket is located so that we can properly authenticate our connection request. You can find a list of the S3 regions here: in the "region" column.

Public Access
String
{access: 'public'}

Indicates that the file should be stored in a way that allows public access going directly to the underlying file store. For instance, if the file is stored on gcs, this will allow the gcs url to be used directly. This has no impact on the ability of users to read from the Filestack file URL. Defaults to 'private'.

Security
String
{policy: POLICY, signature: SIGNATURE}

If you have security enabled, you'll need to have a valid Filestack policy and signature in order to perform the requested call. This allows you to select who can and cannot perform certain actions on your site. Read more about security and how to generate policies and signatures

Gcs Storage Options for REST API

Similar to the filepicker.store call in javascript, you can use the Filestack files library to send files directly to your gcs bucket and get back a Blob for further operations. To do this, issue a POST to the /api/store/gcs endpoint, along with your apikey, the file, and an optional set of parameters.

Store local file to gcs:
Request:
>>> curl -X POST -F fileUpload=@filename.txt https://www.filestackapi.com/api/store/gcs?key=MY_API_KEY
Result:
{"url": "https://www.filestackapi.com/api/file/HLOon3NcTS6w7rqyZ3ei", "size": 234, "type": "text/plain", "filename": "tester.txt", "key": "1ilWxmaRRqhMd2vSbSyB_tester.txt"}
Store URL to gcs
Request:
>>> curl -X POST -d url="https://d3urzlae3olibs.cloudfront.net/watermark.png" https://www.filestackapi.com/api/store/gcs?key=MY_API_KEY
Request:
{"url": "https://www.filestackapi.com/api/file/s7tdGfE5RRKFUxwsZoYv", "size": 8331, "type": "image/png", "filename": "watermark.png", "key": "a1RyBxiglW92bS2SRmqM_watermark.png"}
Store URL to gcs and set parameters
Request:
>>> curl  -X POST  -d  url="https://d3urzlae3olibs.cloudfront.net/watermark.png"  "https://www.filestackapi.com/api/store/gcs?key=AhTgLagciQByzXpFGRI0Az&path=/myfiles/1234.png&mimetype=image/png"
Request:
{"container": "custom_source", "url": "https://www.filestackapi.com/api/file/rLNF34IvRWybiNIATg4D", "filename": "watermark.png", "key": "myfiles/1234.png", "type": "image/png", "size": 8331}

The REST Store parameter names are exactly the same as the Javascript ones.

If you set additional parameters make sure that the URL is given in quotes.

syntax
https://www.filestackapi.com/api/store/gcs?key=MY_API_KEY&[options]

These parameters can be appended to your URL, after your API key with the & symbol and parameter_name=

Filename
String
{filename=MyCoolPhoto.png}

The name of the file as it will be stored. If this isn't provided, we do the best we can to come up with one.

Path
String
{path=/myfiles/1234.png}

The path to store the file at within the specified file store. For gcs, this is the key where the file will be stored at. By default, Filestack stores the file at the root at a unique id, followed by an underscore, followed by the filename, for example "3AB239102DB_myphoto.png".

If the provided path ends in a '/', it will be treated as a folder, so if the provided path is "myfiles/" and the uploaded file is named "myphoto.png", the file will be stored at "myfiles/909DFAC9CB12_myphoto.png", for example.

If the multiple option is set to true, only paths that end in '/' are allowed.

Mimetype
String
{mimetype=text/html}

The type of the file as it will be stored. If this isn't provided, we do the best we can, defaulting to "text/plain" if you give us raw data.

Base64 Decoding
Boolean
{base64decode=true}

Specify that you want the data to be first decoded from base64 before being written to the file. For example, if you have base64 encoded image data, you can use this flag to first decode the data before writing the image file.

Store Container
String
{container=user-photos}

The bucket or container in the specified file store where the file should end up. This is especially useful if you have different containers for testing and production and you want to use them both on the same Filestack app. If this parameter is omitted, the file is stored in the default container specified in your developer portal.

Note: This parameter does not apply to the Dropbox file store.

Store Region
String
{storeRegion=us-east-1}

The region where your storage container is located. This setting currently applies only to S3 buckets. If you are using a different bucket and region than the one you set up in your developer portal you can pass the storeRegion as part of your store options. If this parameter is not set we will do our best to determine the region your S3 bucket is located so that we can properly authenticate our connection request. You can find a list of the S3 regions here: in the "region" column.

Public Access
String
{access=public}

Indicates that the file should be stored in a way that allows public access going directly to the underlying file store. For instance, if the file is stored on gcs, this will allow the gcs url to be used directly. This has no impact on the ability of users to read from the Filestack file URL. Defaults to 'private'.

Security
String
{policy=POLICY&signature=SIGNATURE}

If you have security enabled, you'll need to have a valid Filestack policy and signature in order to perform the requested call. This allows you to select who can and cannot perform certain actions on your site. Read more about security and how to generate policies and signatures