Google Sheets Writer Parameters

Service Connection

Information About FME and Web Connections

Connections store authentication information.

For general information about web connections, please see Using Web Connections.

For information about managing web services (including authorization credentials such as Client Id and Client Secret), please see Managing Web Services.

Connection

Select an existing connection, or Add Web Connection to define a new connection.

The new connection can be made visible only to the current user, or can be shared among multiple users.

Note: For production use, we recommend users obtain their own Client ID and Client Secret from the web service provider.

This parameter specifies a refresh token for OAuth 2.0 authentication to a specific Google account.

Notice: Refresh token handling is available to maintain compatibility with workspaces older than FME version 2018.0.

If you already know the token, you can copy/paste it into this parameter. To obtain a new token, click the browse button. This will prompt for a Google account authentication page from Google.

It is recommended that you save the defaults (from the Defaults button on the dialog) once the refresh token is retrieved so you will not have to re-authenticate in the future.

Note: Refresh tokens generated for the Google Sheets Writer have a read-write scope. Do not share the Refresh Token with others.

Sheet Name

This parameter specifies the spreadsheet to write. Two types of values are supported:

  • URL: To obtain the Spreadsheet URL, open the Google Sheet in a browser and copy the URL from the address bar. The domain in the URL must be docs.google.com or spreadsheets.google.com. It is an error if no such spreadsheet exists, or if the sharing settings for the Spreadsheet do not grant write access to your account.
  • Name: If the value is not a URL, it is assumed to be a name that uniquely identifies a spreadsheet stored in your Google Drive account. If no such spreadsheet exists, it will be created.

A single spreadsheet must be specified.

Note: To write to multiple spreadsheets, use multiple instances of the Google Sheets Writer.

Worksheet Creation

The parameter in this section takes effect only when FME creates a worksheet.

This parameter is applicable only when the Use Attribute Names As Column Positions Advanced parameter is set to No.

If this parameter is set to Yes, the first row, as specified by the Start Writing At Row parameter, is populated with field names in the same order as their definition on the feature type.

Advanced

  • Yes: Attributes on writer feature types will be interpreted as column positions. For instance, an attribute named C will be interpreted as corresponding to column 3. Attributes that do not correspond to a column position are ignored.
  • No: The attribute order, as defined on the feature type, determines the columns where values are written. Values are written in this order, starting from the column specified by the Start Writing At Column parameter.

This parameter determines how many cells are written in a single request, and approximately how many rows are retrieved in a single request. If not specified, a default value of 5000 is used.

Note: This parameter influences memory usage and progress logging. Under most circumstances, you will not have to change the default value.