Transloadit

Export files to Google Storage

🤖/google/store exports encoding results to Google Storage.

The URL to the exported file in your Google bucket will be presented in the Transloadit Assembly Status JSON. This Robot can also be used to export encoded files to Google's Firebase as demonstrated in this blogpost.

Usage example

Export uploaded files to my_target_folder on Google Storage:

{
  "steps": {
    "exported": {
      "robot": "/google/store",
      "use": ":original",
      "credentials": "YOUR_GOOGLE_CREDENTIALS",
      "path": "my_target_folder/${unique_prefix}/${file.url_name}"
    }
  }
}

Parameters

  • output_meta

    Record<string, boolean> | boolean

    Allows you to specify a set of metadata that is more expensive on CPU power to calculate, and thus is disabled by default to keep your Assemblies processing fast.

    For images, you can add "has_transparency": true in this object to extract if the image contains transparent parts and "dominant_colors": true to extract an array of hexadecimal color codes from the image.

    For videos, you can add the "colorspace: true" parameter to extract the colorspace of the output video.

    For audio, you can add "mean_volume": true to get a single value representing the mean average volume of the audio file.

    You can also set this to false to skip metadata extraction and speed up transcoding.

  • result

    boolean

    Whether the results of this Step should be present in the Assembly Status JSON

  • queue

    "batch"

    Setting the queue to 'batch', manually downgrades the priority of jobs for this step to avoid consuming Priority job slots for jobs that don't need zero queue waiting times

  • force_accept

    boolean (default: false)
      Force a Robot to accept a file type it would have ignored.
    

    By default Robots ignore files they are not familiar with. 🤖/video/encode, for example, will happily ignore input images.

    With the force_accept parameter set to true you can force Robots to accept all files thrown at them. This will typically lead to errors and should only be used for debugging or combatting edge cases.

  • use

    string | Array<string> | Array<object> | object

    Specifies which Step(s) to use as input.

    • You can pick any names for Steps except ":original" (reserved for user uploads handled by Transloadit)
    • You can provide several Steps as input with arrays:
      {
        "use": [
          ":original",
          "encoded",
          "resized"
        ]
      }
      
  • credentials

    string · required

    Create a new Google service account. Set its role to "Storage Object Creator". Choose "JSON" for the key file format and download it to your computer. You will need to upload this file when creating your Template Credentials.

    Go back to your Google credentials project and enable the "Google Cloud Storage JSON API" for it. Wait around ten minutes for the action to propagate through the Google network. Grab the project ID from the dropdown menu in the header bar on the Google site. You will also need it later on.

    Now you can set up the storage.objects.create and storage.objects.delete permissions. The latter is optional and only required if you intend to overwrite existing paths.

    To do this from the Google Cloud console, navigate to "IAM & Admin" and select "Roles". From here, select "+CREATE ROLE", enter a name, set the role launch stage as general availability and set the permissions stated above.

    Next, relocate to your storage browser and select the ellipsis on your bucket to edit bucket permissions. From here, select "ADD MEMBER", enter your service account as a new member and select your newly created role.

    Then, create your associated Template Credentials in your Transloadit account and use the name of your Template Credentials as this parameter's value.

  • path

    string (default: "${unique_prefix}/${file.url_name}")

    The path at which the file is to be stored. This may include any available Assembly Variables.

  • acl

    | null (default: "public-read")

    The permissions used for this file.

  • cache_control

    string

    The Cache-Control header determines how long browsers are allowed to cache your object for. Values specified with this parameter will be added to the object's metadata under the Cache-Control header. For more information on valid values, take a look at the official Google documentation.

  • url_template

    string (default: "https://{HOST}/{PATH}")

    The URL of the file in the result JSON. This may include any of the following supported Assembly variables.

  • ssl_url_template

    string (default: "https://{HOST}/{PATH}")

    The SSL URL of the file in the result JSON. The following Assembly variables are supported.

Demos

Related blog posts