DownloadDocument
Downloads a file from the user's Google Sheets resouces specified by the Id of the spreadsheet and exported in the format specified in the FileFormat property.
Input
Name | Type | Accepts Output Streams | Description |
Id | String | False | The Id of the resource to be downloaded. |
FileFormat | String | False | If this property is not specified, the file will be downloaded as-is. If you need to convert the file before downloading it in one of the formats shown below, use the MIME types shown on the right. MS Excel --> application/vnd.openxmlformats-officedocument.spreadsheetml.sheet Open Office sheet --> application/x-vnd.oasis.opendocument.spreadsheet Web Page (HTML) --> application/zip PDF --> application/pdf CSV --> (first sheet only) text/csv The default value is application/vnd.openxmlformats-officedocument.spreadsheetml.sheet. |
LocalFile | String | False | The local file path including the file name for the location where the file will be saved on disk. Leave empty to keep the file in memory. |
Encoding | String | False | If the LocalFile input is left empty, the data will be output to FileData in the specified encoding.
The allowed values are NONE, BASE64. The default value is BASE64. |
Overwrite | Boolean | False | What to do when downloaded file exists. Set true to overwrite.
The default value is false. |
FileStream | String | True | An instance of an output stream where file data is written to. Only used if LocalFile is not set. |
Result Set Columns
Name | Type | Description |
Success | String | This value shows a boolean indication of whether the operation was successful or not. |
FileData | String | If the LocalFile and FileStream inputs are empty, file data will be output in the format specified by the Encoding input. |