Google Documents API
Operations related to Documents
Google Documents API is one of 125 APIs that Google publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and an API reference.
This API exposes 3 operations across 3 paths, and defines 151 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against a single base URL, https://www.googleapis.com/books/v1.
3 operations
3 paths
151 schemas
1 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Google Documents API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.
OAuth2— OAuth 2.0 authentication for Google Books API
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Documents 3
Operations related to Documents
POST
/v1/documents
Google Post Documents
GET
/v1/documents/{documentId}
Google Get Documents
POST
/v1/documents/{documentId}:batchUpdate
Google Post Documents Batch Update
Schemas 151
The contract defines 151 schemas that model the data the API accepts and returns. The most detailed are Request (33 properties), ParagraphStyle (22 properties), ParagraphStyleSuggestionState (21 properties), DocumentStyleSuggestionState (18 properties). Each schema is shown below with its type and property counts.
InsertSectionBreakRequest
object
Inserts a section break at the given location. A newline character will be inserted before the section break.
3 properties
BulletSuggestionState
object
A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value.
3 properties
AutoText
object
A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number.
5 properties
TableCellLocation
object
Location of a single cell within a table.
3 properties
ParagraphStyle
object
Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where…
22 properties
TableCell
object
The contents and style of a cell in a Table.
7 properties
NestingLevel
object
Contains properties describing the look and feel of a list bullet at a given level of nesting.
8 properties
DocumentStyleSuggestionState
object
A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested va…
18 properties
EndOfSegmentLocation
object
Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment.
1 property
CreateFootnoteRequest
object
Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline…
2 properties
DeleteTableRowRequest
object
Deletes a row from a table.
1 property
Header
object
A document header.
2 properties
ReplaceAllTextRequest
object
Replaces all instances of text matching a criteria with replace text.
2 properties
Person
object
A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address.
6 properties
InlineObjectPropertiesSuggestionState
object
A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new sug…
1 property
SuggestedDocumentStyle
object
A suggested change to the DocumentStyle.
2 properties
CreateNamedRangeRequest
object
Creates a NamedRange referencing the given range.
2 properties
StructuralElement
object
A StructuralElement describes content that provides structure to the document.
6 properties
SheetsChartReferenceSuggestionState
object
A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new sugge…
2 properties
PageBreak
object
A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page.
4 properties
ImagePropertiesSuggestionState
object
A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested…
7 properties
ParagraphBorder
object
A border around a paragraph.
4 properties
Paragraph
object
A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character.
7 properties
NamedStyle
object
A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
3 properties
PositionedObject
object
An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an im…
5 properties
EmbeddedDrawingProperties
object
The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note t…
InsertTableColumnRequest
object
Inserts an empty column into a table.
2 properties
TableCellStyle
object
The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style.
12 properties
InlineObjectElement
object
A ParagraphElement that contains an InlineObject.
5 properties
InsertInlineSheetsChartResponse
object
The result of inserting an embedded Google Sheets chart.
1 property
SuggestedNamedStyles
object
A suggested change to the NamedStyles.
2 properties
List
object
A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list…
4 properties
TableCellBorder
object
A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0.
3 properties
DeleteNamedRangeRequest
object
Deletes a NamedRange.
2 properties
InsertTextRequest
object
Inserts text at the specified location.
3 properties
UpdateParagraphStyleRequest
object
Update the styling of all paragraphs that overlap with the given range.
3 properties
CreateNamedRangeResponse
object
The result of creating a named range.
1 property
EmbeddedObjectBorder
object
A border around an EmbeddedObject.
4 properties
PositionedObjectProperties
object
Properties of a PositionedObject.
2 properties
TextStyle
object
Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on whe…
11 properties
TableColumnProperties
object
The properties of a column in a table.
2 properties
ImageProperties
object
The properties of an image.
7 properties
CreateFootnoteResponse
object
The result of creating a footnote.
1 property
NamedStylesSuggestionState
object
The suggestion state of a NamedStyles message.
1 property
RichLink
object
A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event).
6 properties
RgbColor
object
An RGB color.
3 properties
EmbeddedObjectSuggestionState
object
A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested v…
11 properties
Background
object
Represents the background of a document.
1 property
Range
object
Specifies a contiguous range of text.
3 properties
InsertInlineImageResponse
object
The result of inserting an inline image.
1 property
UpdateTextStyleRequest
object
Update the styling of text.
3 properties
LinkedContentReferenceSuggestionState
object
A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new sug…
1 property
InlineObject
object
An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
5 properties
EmbeddedDrawingPropertiesSuggestionState
object
A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new…
PinTableHeaderRowsRequest
object
Updates the number of pinned table header rows in a table.
2 properties
SizeSuggestionState
object
A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value.
2 properties
PositionedObjectPositioningSuggestionState
object
A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a ne…
3 properties
SectionBreak
object
A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new…
3 properties
NamedRange
object
A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so the…
3 properties
DeleteFooterRequest
object
Deletes a Footer from the document.
1 property
NamedStyleSuggestionState
object
A suggestion state of a NamedStyle message.
3 properties
TextRun
object
A ParagraphElement that represents a run of text that all has the same styling.
5 properties
TableCellStyleSuggestionState
object
A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested v…
12 properties
SuggestedBullet
object
A suggested change to a Bullet.
2 properties
Footer
object
A document footer.
2 properties
SuggestedPositionedObjectProperties
object
A suggested change to PositionedObjectProperties.
2 properties
Request
object
A single update to apply to a document.
33 properties
MergeTableCellsRequest
object
Merges cells in a Table.
1 property
CreateHeaderRequest
object
Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle.…
2 properties
Response
object
A single response from an update.
7 properties
Link
object
A reference to another portion of a document or an external URL resource.
3 properties
UpdateDocumentStyleRequest
object
Updates the DocumentStyle.
2 properties
DeleteContentRangeRequest
object
Deletes content from the document.
1 property
WriteControl
object
Provides control over how write requests are executed.
2 properties
CreateFooterResponse
object
The result of creating a footer.
1 property
NamedRanges
object
A collection of all the NamedRanges in the document that share a given name.
2 properties
SectionStyle
object
The styling that applies to a section.
18 properties
ReplaceNamedRangeContentRequest
object
Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple…
3 properties
BatchUpdateDocumentResponse
object
Response message from a BatchUpdateDocument request.
3 properties
Location
object
A particular location in the document.
2 properties
SectionColumnProperties
object
Properties that apply to a section's column.
2 properties
Color
object
A solid color.
1 property
ReplaceImageRequest
object
Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs…
3 properties
BackgroundSuggestionState
object
A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new sugge…
1 property
SuggestedTableCellStyle
object
A suggested change to a TableCellStyle.
2 properties
ListPropertiesSuggestionState
object
A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested v…
1 property
LinkedContentReference
object
A reference to the external linked source content.
1 property
ColumnBreak
object
A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column.
4 properties
Body
object
The document body. The body typically contains the full document contents except for headers, footers, and footnotes.
1 property
DocumentStyle
object
The style of the document.
18 properties
RichLinkProperties
object
Properties specific to a RichLink.
3 properties
SuggestedTableRowStyle
object
A suggested change to a TableRowStyle.
2 properties
Footnote
object
A document footnote.
2 properties
Shading
object
The shading of a paragraph.
1 property
InsertInlineImageRequest
object
Inserts an InlineObject containing an image at the given location.
4 properties
SuggestedParagraphStyle
object
A suggested change to a ParagraphStyle.
2 properties
CreateFooterRequest
object
Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle.…
2 properties
PositionedObjectPropertiesSuggestionState
object
A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new…
2 properties
DeleteParagraphBulletsRequest
object
Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent t…
1 property
CreateHeaderResponse
object
The result of creating a header.
1 property
Bullet
object
Describes the bullet of a paragraph.
3 properties
InlineObjectProperties
object
Properties of an InlineObject.
1 property
UpdateTableColumnPropertiesRequest
object
Updates the TableColumnProperties of columns in a table.
4 properties
Size
object
A width and height.
2 properties
TextStyleSuggestionState
object
A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value.
11 properties
CropProperties
object
The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the inte…
5 properties
InsertPageBreakRequest
object
Inserts a page break followed by a newline at the specified location.
2 properties
TableRange
object
A table range represents a reference to a subset of a table. It's important to note that the cells specified by a table range do not necessarily form a rectang…
3 properties
UnmergeTableCellsRequest
object
Unmerges cells in a Table.
1 property
SubstringMatchCriteria
object
A criteria that matches a specific string of text in the document.
2 properties
Dimension
object
A magnitude in a single direction in the specified units.
2 properties
TableRowStyleSuggestionState
object
A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested va…
1 property
UpdateSectionStyleRequest
object
Updates the SectionStyle.
3 properties
NamedStyles
object
The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles.
1 property
CropPropertiesSuggestionState
object
A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested v…
5 properties
TableStyle
object
Styles that apply to a table.
1 property
ParagraphElement
object
A ParagraphElement describes content within a Paragraph.
12 properties
ObjectReferences
object
A collection of object IDs.
1 property
TableOfContents
object
A StructuralElement representing a table of contents.
3 properties
Equation
object
A ParagraphElement representing an equation.
2 properties
InsertTableRowRequest
object
Inserts an empty row into a table.
2 properties
Table
object
A StructuralElement representing a table.
6 properties
FootnoteReference
object
A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote.
6 properties
Document
object
A Google Docs document.
16 properties
ReplaceAllTextResponse
object
The result of replacing text.
1 property
SheetsChartReference
object
A reference to a linked chart embedded from Google Sheets.
2 properties
SuggestedTextStyle
object
A suggested change to a TextStyle.
2 properties
ParagraphStyleSuggestionState
object
A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested v…
21 properties
PositionedObjectPositioning
object
The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to.
3 properties
PersonProperties
object
Properties specific to a linked Person.
2 properties
DeleteTableColumnRequest
object
Deletes a column from a table.
1 property
WeightedFontFamily
object
Represents a font family and weight of text.
2 properties
DeletePositionedObjectRequest
object
Deletes a PositionedObject from the document.
1 property
DeleteHeaderRequest
object
Deletes a Header from the document.
1 property
TabStop
object
A tab stop within a paragraph.
2 properties
ListProperties
object
The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list.
1 property
NestingLevelSuggestionState
object
A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested val…
8 properties
EmbeddedObject
object
An embedded object in the document.
11 properties
ShadingSuggestionState
object
A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested va…
1 property
CreateParagraphBulletsRequest
object
Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in…
2 properties
OptionalColor
object
A color that can either be fully opaque or fully transparent.
1 property
SuggestedListProperties
object
A suggested change to ListProperties.
2 properties
BatchUpdateDocumentRequest
object
Request message for BatchUpdateDocument.
2 properties
TableRow
object
The contents and style of a row in a Table.
7 properties
TableRowStyle
object
Styles that apply to a table row.
3 properties
UpdateTableCellStyleRequest
object
Updates the style of a range of table cells.
4 properties
UpdateTableRowStyleRequest
object
Updates the TableRowStyle of rows in a table.
4 properties
EmbeddedObjectBorderSuggestionState
object
A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new sugge…
4 properties
SuggestedInlineObjectProperties
object
A suggested change to InlineObjectProperties.
2 properties
HorizontalRule
object
A ParagraphElement representing a horizontal line.
4 properties
InsertTableRequest
object
Inserts a table at the specified location. A newline character will be inserted before the inserted table.
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Google 12
Other APIs Google publishes across the network.
Google Cloud API Gateway
Google Maps API
Google Aggregate Places API
Google Places Insights API
Google Street View Imagery API
Google Elevation API
Google Routes API
Google Geocoding API
Google Geolocation API
Google Address Validation API
Google Time Zone API
Google Air Quality API
#Documents
Where this information came from
This is an independent, third-party profile of Google Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.