GOOGLE WORKSPACE Get structure function

The GOOGLE WORKSPACE Get structure function in RPA.

Help CentreFunctions & Formulas

This article describes the RPA Google Workspace connector function to get the document structure of a Google Docs document.

For a full list of available functions, please read GOOGLE WORKSPACE functions.


Description

The Get structure function retrieves the structural outline of a Google Docs document, including headings, sections, tables, and their index positions. This provides a high-level view of the document layout.


Input parameters

ParameterRequiredTypeDefaultDescription
ConnectorYesSelect-Select the Google Workspace connector to use
Document IDYesText-Google Docs document ID
VariableYesText-Variable to store the structure

Output variables

VariableTypeDescription
VariableObjectObject containing headings array, tables array, and sections array with index positions

Errors

  • Document not found – the document ID is invalid or you lack access

Tips

  • Use this to navigate large documents and find the correct indices for editing
  • Headings include the heading level (1-6) and text content

Related functions

  • Get content – Get full document content with all details
  • Get text – Get plain text content

See it working on your own data

Everything documented here ships with the platform – try the document tools free, or go live in 7 days.