Spreadsheet Integrator - Online Help
Available for:
Spreadsheet Integrator
Questions / Feedback?

GoogleSheet Component

Properties   Methods   Events   Configuration Settings   Errors  

The GoogleSheet component is used to work with Google spreadsheets.




The GoogleSheet component provides an easy-to-use interface to create and modify Google spreadsheets.

This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ
Assign this value to the Authorization property before attempting any operations. Consult the Google documentation for this particular service for more information about supported scope values and more details on OAuth authentication.

Creating and Loading Spreadsheets

The component supports creating new spreadsheets and loading existing spreadsheets from Google drive.

Creating a new spreadsheet is as simple as calling Create. To upload an existing spreadsheet (.xlsx) set LocalFile before calling Create.

To load an existing spreadsheet in Google drive simply call Load.

Working with Sheets

After a spreadsheet is loaded the first sheet will automatically be loaded. Set SheetIndex to select a sheet. After selecting a sheet SheetName will be populated with the sheet's name. Other methods such as AddSheet, DeleteSheet, and RenameSheet can be used to further manage sheets.

Working with Cells

After a spreadsheet is loaded set Cell using A1 notation to select a cell. The following properties will be populated:

To set a new value for a cell set CellValue and call Save.

Rows and columns may be managed by using the AddRows, AddColumns, DeleteRows, and DeleteColumns methods.

Spreadsheet Management

The component also provides functionality to manage spreadsheets. To list available spreadsheets call ListSpreadsheets. This populates the Spreadsheets collection with information about the spreadsheets including Title and Id.

The methods Create, Delete, Load, Rename, and Save may be used to manage spreadsheets.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

AuthorizationOAuth 2.0 Authorization Token.
CellThe selected cell in A1 notation.
CellNumericValueThe numeric value of the cell, if any.
CellTextThe displayed text of the cell.
CellValueThe value of the cell.
ColumnCountThe number of columns in the sheet.
FirewallA set of properties related to firewall access.
LocalFileThe path to the localfile for upload.
ProxyA set of properties related to proxy access.
RowCountThe number of rows in the sheet.
SheetCountThe number of sheets in the current spreadsheet.
SheetIndexSpecifies the currently selected sheet.
SheetNameThe name of the sheet specified by SheetIndex.
SpreadsheetsA collection of spreadsheet information.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AddColumnsAdds the specified number of columns.
AddRowsAdds the specified number of rows.
AddSheetAdds a new sheet with the specified number of rows and columns.
ConfigSets or retrieves a configuration setting .
CreateCreates the sheet with the specified title.
DeleteDeletes the spreadsheet.
DeleteColumnsDeletes the specified number of columns.
DeleteRowsDeletes rows from the specified index.
DeleteSheetDeletes the sheet specified by SheetIndex.
InterruptInterrupts the current HTTP operation.
ListSpreadsheetsLists all spreadsheets.
LoadLoads a spreadsheet by title.
RenameRenames a sheet.
RenameSheetRenames the sheet specified by SheetIndex.
ResetReset the component.
SaveSaves the spreadsheet.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
SheetInfoFired for each sheet in the spreadsheet when Load is called.
SpreadsheetListFires once for each spreadsheet when ListSpreadsheets is called.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired while a document transfers (delivers document).

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

AuthorThe author of spreadsheet.
AuthorFormatThe format of the Author information.
CellLastUpdatedTimeThe last time the cell was updated.
DateFormatThe format string to be used for formatting the DateTime values received from the server.
IdThe unique Id of the spreadsheet.
LastUpdatedTimeThe last time the spreadsheet was updated.
LoadNewSpreadsheetWhether to automatically load a newly created spreadsheet.
PreloadCellsThe size of an area to pre-load.
RowLastUpdatedTimeThe last time the row was updated.
TitleThe title of the spreadsheet.
LogRawDataWhether to include all request and response data for debugging.
RawRequestThe request data for debugging.
RawResponseThe response data for debugging.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether or not to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
SSLAlgorithmListA string that controls the cipher algorithms to be used by SSL.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

Copyright (c) 2016 /n software inc. - All rights reserved.
Build 1.0.6094.0