Google Docs · Schema

Location

A particular location in the document.

CollaborationDocumentsGoogle WorkspaceProductivityWord Processing

Properties

Name	Type	Description
segmentId	string	The ID of the header, footer, or footnote the location is in. An empty segment ID signifies the document body.
index	integer	The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segmentId.
tabId	string	The tab that the location is in.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Location",
  "type": "object",
  "description": "A particular location in the document.",
  "properties": {
    "segmentId": {
      "type": "string",
      "description": "The ID of the header, footer, or footnote the location is in. An empty segment ID signifies the document body."
    },
    "index": {
      "type": "integer",
      "description": "The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segmentId."
    },
    "tabId": {
      "type": "string",
      "description": "The tab that the location is in."
    }
  }
}