Import files from Google Storage

Usage example

Import files from the path/to/files directory and its subdirectories:

{
  "steps": {
    "imported": {
      "robot": "/google/import",
      "credentials": "YOUR_GOOGLE_CREDENTIALS",
      "path": "path/to/files/",
      "recursive": true
    }
  }
}

Parameters

• ignore_errors

  Array of Strings / Boolean ⋅ default: []

  Possible array members are "meta" and "import".

  You might see an error when trying to extract metadata from your imported files. This happens, for example, for files with a size of zero bytes. Including "meta" in the array will cause the Robot to not stop the import (and the entire Assembly) when that happens.

  Including "import" in the array will ensure the Robot does not cease to function on any import errors either.

  To keep backwards compatibility, setting this parameter to true will set it to ["meta", "import"] internally.

• credentials

  Stringrequired

  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 / Array of Stringsrequired

  The path in your bucket to the specific file or directory. If the path points to a file, only this file will be imported. For example: images/avatar.jpg.

  If it points to a directory, indicated by a trailing slash (/), then all files that are direct descendants of this directory will be imported. For example: images/.

  Directories are not imported recursively. If you want to import files from subdirectories and sub-subdirectories, enable the recursive parameter.

  If you want to import all files from the root directory, please use / as the value here. In this case, make sure all your objects belong to a path. If you have objects in the root of your bucket that aren't prefixed with /, you'll receive a 404 GOOGLE_IMPORT_NOT_FOUND error.

  You can also use an array of path strings here to import multiple paths in the same Robot's Step.

• recursive

  Boolean ⋅ default: false

  Setting this to true will enable importing files from subdirectories and sub-subdirectories (etc.) of the given path.

  Please use the pagination parameters start_file_name and files_per_page wisely here.

• next_page_token

  String ⋅ default: ""

  A string token used for pagination. The returned files of one paginated call have the next page token inside of their meta data, which needs to be used for the subsequent paging call.

• files_per_page

  Integer ⋅ default: 1000

  The pagination page size. This only works when recursive is true for now, in order to not break backwards compatibility in non-recursive imports.