Skip to content
Zoan Docs

Google Sheets — Open

Google Sheets — Open

Section titled “Google Sheets — Open”

Type: googlesheets-open  ·  Package: Google Sheets Activities v1.0.0  ·  Output: ZoanGoogleSheetsSession

Opens an authenticated session with a Google Sheets and returns it as ZoanGoogleSheetsSession. It is the obligatory starting point: all other activities work on this session.

How it works

Section titled “How it works”

It authenticates with Google and opens the session over the sheet ID (spreadsheetId). Two body modes:

  • With body: activities inside inherit the session; when finished it closes itself.
  • Without body: returns the session as output; pass it as session to the activities and close it with Google Sheets — Close.

Authentication

Section titled “Authentication”

The authType parameter chooses how to authenticate (the Designer shows only the fields for the selected mode):

  • oauth (default): uses a Zoan Cloud Google OAuth connection (credential field). Requires a user’s consent; ideal when the bot acts on a specific account.
  • service-account: uses a service account key stored as a credential (serviceAccount field). No consent required — ideal for unattended runs. The sheet must be shared with the service account’s email. Optionally, impersonateUser acts on behalf of a Workspace user (domain-wide delegation).

Required parameters

Section titled “Required parameters”
ParameterEditorDescription
spreadsheetIdexpressionSheet ID, from URL docs.google.com/spreadsheets/d/{ID}/edit.

Optional parameters

Section titled “Optional parameters”
ParameterEditorDescription
authTypeenumoauth (default) or service-account.
credentialcredentialOAuth mode: name of the Google OAuth connection on Zoan Cloud.
serviceAccountcredentialService account mode: credential holding the full JSON key.
impersonateUserexpressionService account mode (optional): email of the Workspace user to impersonate.

Subflows (lanes)

Section titled “Subflows (lanes)”

body optional

Section titled “body optional”

Activities to be executed within the session. It closes when finished.

Output

Section titled “Output”

Returns a ZoanGoogleSheetsSession. Pass it as session to the other activities.

Example

Section titled “Example”
Google Sheets — Open   credential = "google-clinica"   spreadsheetId = "1AbC...XyZ"
 └─ body:
      Google Sheets — Read sheet   sheet = "Citas"   has-headers = true   → output: citas
Section titled “Related activities”