googleDocsExport

Export a document in a specific format.

Required Parameters

localfile	The path where the downloaded file will be stored.
format	The format of the downloaded file. The allowed values are: PDF, DOC, ODT, RTF, TXT, PNG, HTML, ZIP, PPT, SWF, XLS, ODS, CSV, TSV.

Optional Parameters

authtoken	The authentication token retrieved from a previous authentication. If left empty, email and password are required.
email	The email address used to authenticate with Google. The email is required unless an authtoken is used.
password	The password used to authenticate with Google. The password is required unless an authtoken is used.
timeout	Timeout, in seconds, for the operation to complete. Zero (0) means no timeout.
proxy_server	IP Address or host name of the proxy server used for the request.
proxy_auto	Whether or not Proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are: TRUE, FALSE.
proxy_port	Port number of the proxy server.
proxy_user	User ID used to authenticate with the proxy server.
proxy_password	Password used to authenticate with the proxy server.
proxy_authscheme	The proxy server The allowed values are: BASIC, DIGEST, PROPRIETARY, NONE, NTLM.
proxy_authtoken	The proxy authentication token.
proxy_ssltype	The proxy server The allowed values are: AUTO, ALWAYS, NEVER, TUNNEL.
firewall_server	IP Address or host name of the firewall.
firewall_port	Port number of the firewall.
firewall_user	User ID used to authenticate with the firewall.
firewall_password	Password used to authenticate with the firewall.
firewall_type	The type of the firewall. The allowed values are: TUNNEL, SOCKS4, SOCKS5.
logfile	The connector will log the exchange/transferred data to this file.
name	The name of the document. Required if 'id' is not specified.
id	The ID of the document to be exported. This value is returned from call to 'googleDocsListDocs' and 'googleDocsUpload'. Providing this instead of 'name' saves on traffic to the Google server.
sheet	The # of the sheet to be exported. This is required when exporting a spreadsheet in either 'CSV' or 'TSV' format. This is a 0-based index.
shareauthtoken	Whether or not to use the shared authentication token from a previous request, if one exists that matches the user name and password.

Output Attributes

ggl:format	The format of the downloaded file.
ggl:localfile	The path where the downloaded file is stored.
ggl:size	The size of the downloaded document.
ggl:success	Indication that the operation was successfully completed.