Skip to main content

Module read

Module read 

Source
Expand description

drive docs read engine — one documents.get, flattened into an index-ordered element list per tab.

Ungated, exactly as sheets read and the rest of the Drive read surface are. ADR-0071 §11 records read-path enforcement as a known, scoped gap across the whole integration, pending a batching/caching design; this command inherits that gap rather than opting out of it, and will inherit its resolution.

There is deliberately no per-tab cap of the kind sheets read’s MAX_SHEETS_PER_READ imposes. That cap exists because a whole-workbook read fans out into N values.batchGet requests and could return a partially-fetched workbook. documents.get is exactly one request whose result is all-or-nothing, so a cap could only refuse a document already in hand; MAX_DOCUMENT_BYTES is the analogous protection and it sits at the right layer.

Structs§

FlatElement
One element, with the document and tab identity denormalised onto it.
ReadOptions
Per-call options.
ReadOutcome
The full result of one read.
SegmentContent
One header, footer or footnote segment’s flattened content.
SegmentRef
Identifies a header/footer/footnote segment on a -o jsonl line.
TabContent
One tab’s flattened content.

Enums§

SegmentKind
Which kind of segment a header, footer or footnote is.

Functions§

read
Reads a document and flattens each tab’s body and segments.