Overview

Classes

  • Google_Service_Docs
  • Google_Service_Docs_AutoText
  • Google_Service_Docs_Background
  • Google_Service_Docs_BackgroundSuggestionState
  • Google_Service_Docs_BatchUpdateDocumentRequest
  • Google_Service_Docs_BatchUpdateDocumentResponse
  • Google_Service_Docs_Body
  • Google_Service_Docs_Bullet
  • Google_Service_Docs_BulletSuggestionState
  • Google_Service_Docs_Color
  • Google_Service_Docs_ColumnBreak
  • Google_Service_Docs_CreateFooterRequest
  • Google_Service_Docs_CreateFooterResponse
  • Google_Service_Docs_CreateFootnoteRequest
  • Google_Service_Docs_CreateFootnoteResponse
  • Google_Service_Docs_CreateHeaderRequest
  • Google_Service_Docs_CreateHeaderResponse
  • Google_Service_Docs_CreateNamedRangeRequest
  • Google_Service_Docs_CreateNamedRangeResponse
  • Google_Service_Docs_CreateParagraphBulletsRequest
  • Google_Service_Docs_CropProperties
  • Google_Service_Docs_CropPropertiesSuggestionState
  • Google_Service_Docs_DeleteContentRangeRequest
  • Google_Service_Docs_DeleteFooterRequest
  • Google_Service_Docs_DeleteHeaderRequest
  • Google_Service_Docs_DeleteNamedRangeRequest
  • Google_Service_Docs_DeleteParagraphBulletsRequest
  • Google_Service_Docs_DeletePositionedObjectRequest
  • Google_Service_Docs_DeleteTableColumnRequest
  • Google_Service_Docs_DeleteTableRowRequest
  • Google_Service_Docs_Dimension
  • Google_Service_Docs_DocsList
  • Google_Service_Docs_Document
  • Google_Service_Docs_Documents_Resource
  • Google_Service_Docs_DocumentStyle
  • Google_Service_Docs_DocumentStyleSuggestionState
  • Google_Service_Docs_EmbeddedDrawingProperties
  • Google_Service_Docs_EmbeddedDrawingPropertiesSuggestionState
  • Google_Service_Docs_EmbeddedObject
  • Google_Service_Docs_EmbeddedObjectBorder
  • Google_Service_Docs_EmbeddedObjectBorderSuggestionState
  • Google_Service_Docs_EmbeddedObjectSuggestionState
  • Google_Service_Docs_EndOfSegmentLocation
  • Google_Service_Docs_Equation
  • Google_Service_Docs_Footer
  • Google_Service_Docs_Footnote
  • Google_Service_Docs_FootnoteReference
  • Google_Service_Docs_Header
  • Google_Service_Docs_HorizontalRule
  • Google_Service_Docs_ImageProperties
  • Google_Service_Docs_ImagePropertiesSuggestionState
  • Google_Service_Docs_InlineObject
  • Google_Service_Docs_InlineObjectElement
  • Google_Service_Docs_InlineObjectProperties
  • Google_Service_Docs_InlineObjectPropertiesSuggestionState
  • Google_Service_Docs_InsertInlineImageRequest
  • Google_Service_Docs_InsertInlineImageResponse
  • Google_Service_Docs_InsertInlineSheetsChartResponse
  • Google_Service_Docs_InsertPageBreakRequest
  • Google_Service_Docs_InsertSectionBreakRequest
  • Google_Service_Docs_InsertTableColumnRequest
  • Google_Service_Docs_InsertTableRequest
  • Google_Service_Docs_InsertTableRowRequest
  • Google_Service_Docs_InsertTextRequest
  • Google_Service_Docs_Link
  • Google_Service_Docs_LinkedContentReference
  • Google_Service_Docs_LinkedContentReferenceSuggestionState
  • Google_Service_Docs_ListProperties
  • Google_Service_Docs_ListPropertiesSuggestionState
  • Google_Service_Docs_Location
  • Google_Service_Docs_MergeTableCellsRequest
  • Google_Service_Docs_NamedRange
  • Google_Service_Docs_NamedRanges
  • Google_Service_Docs_NamedStyle
  • Google_Service_Docs_NamedStyles
  • Google_Service_Docs_NamedStylesSuggestionState
  • Google_Service_Docs_NamedStyleSuggestionState
  • Google_Service_Docs_NestingLevel
  • Google_Service_Docs_NestingLevelSuggestionState
  • Google_Service_Docs_ObjectReferences
  • Google_Service_Docs_OptionalColor
  • Google_Service_Docs_PageBreak
  • Google_Service_Docs_Paragraph
  • Google_Service_Docs_ParagraphBorder
  • Google_Service_Docs_ParagraphElement
  • Google_Service_Docs_ParagraphStyle
  • Google_Service_Docs_ParagraphStyleSuggestionState
  • Google_Service_Docs_PositionedObject
  • Google_Service_Docs_PositionedObjectPositioning
  • Google_Service_Docs_PositionedObjectPositioningSuggestionState
  • Google_Service_Docs_PositionedObjectProperties
  • Google_Service_Docs_PositionedObjectPropertiesSuggestionState
  • Google_Service_Docs_Range
  • Google_Service_Docs_ReplaceAllTextRequest
  • Google_Service_Docs_ReplaceAllTextResponse
  • Google_Service_Docs_ReplaceImageRequest
  • Google_Service_Docs_ReplaceNamedRangeContentRequest
  • Google_Service_Docs_Request
  • Google_Service_Docs_Response
  • Google_Service_Docs_RgbColor
  • Google_Service_Docs_SectionBreak
  • Google_Service_Docs_SectionColumnProperties
  • Google_Service_Docs_SectionStyle
  • Google_Service_Docs_Shading
  • Google_Service_Docs_ShadingSuggestionState
  • Google_Service_Docs_SheetsChartReference
  • Google_Service_Docs_SheetsChartReferenceSuggestionState
  • Google_Service_Docs_Size
  • Google_Service_Docs_SizeSuggestionState
  • Google_Service_Docs_StructuralElement
  • Google_Service_Docs_SubstringMatchCriteria
  • Google_Service_Docs_SuggestedBullet
  • Google_Service_Docs_SuggestedDocumentStyle
  • Google_Service_Docs_SuggestedInlineObjectProperties
  • Google_Service_Docs_SuggestedListProperties
  • Google_Service_Docs_SuggestedNamedStyles
  • Google_Service_Docs_SuggestedParagraphStyle
  • Google_Service_Docs_SuggestedPositionedObjectProperties
  • Google_Service_Docs_SuggestedTableCellStyle
  • Google_Service_Docs_SuggestedTableRowStyle
  • Google_Service_Docs_SuggestedTextStyle
  • Google_Service_Docs_Table
  • Google_Service_Docs_TableCell
  • Google_Service_Docs_TableCellBorder
  • Google_Service_Docs_TableCellLocation
  • Google_Service_Docs_TableCellStyle
  • Google_Service_Docs_TableCellStyleSuggestionState
  • Google_Service_Docs_TableColumnProperties
  • Google_Service_Docs_TableOfContents
  • Google_Service_Docs_TableRange
  • Google_Service_Docs_TableRow
  • Google_Service_Docs_TableRowStyle
  • Google_Service_Docs_TableRowStyleSuggestionState
  • Google_Service_Docs_TableStyle
  • Google_Service_Docs_TabStop
  • Google_Service_Docs_TextRun
  • Google_Service_Docs_TextStyle
  • Google_Service_Docs_TextStyleSuggestionState
  • Google_Service_Docs_UnmergeTableCellsRequest
  • Google_Service_Docs_UpdateDocumentStyleRequest
  • Google_Service_Docs_UpdateParagraphStyleRequest
  • Google_Service_Docs_UpdateSectionStyleRequest
  • Google_Service_Docs_UpdateTableCellStyleRequest
  • Google_Service_Docs_UpdateTableColumnPropertiesRequest
  • Google_Service_Docs_UpdateTableRowStyleRequest
  • Google_Service_Docs_UpdateTextStyleRequest
  • Google_Service_Docs_WeightedFontFamily
  • Google_Service_Docs_WriteControl
  • Overview
  • Class
  • Tree

Class Google_Service_Docs_Documents_Resource

The "documents" collection of methods. Typical usage is:

 $docsService = new Google_Service_Docs(...);
 $documents = $docsService->documents;
Google_Service_Resource
Extended by Google_Service_Docs_Documents_Resource
Located at Docs.php
Methods summary
public Google_Service_Docs_BatchUpdateDocumentResponse
# batchUpdate( string $documentId, Google_Service_Docs_BatchUpdateDocumentRequest $postBody, array $optParams = array() )

Applies one or more updates to the document.

Applies one or more updates to the document.

Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied.

Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests.

For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order.

Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically. (documents.batchUpdate)

Parameters

$documentId
The ID of the document to update.
$postBody
$optParams
Optional parameters.

Returns

Google_Service_Docs_BatchUpdateDocumentResponse
Google_Service_Docs_BatchUpdateDocumentResponse
public Google_Service_Docs_Document
# create( Google_Service_Docs_Document $postBody, array $optParams = array() )

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored.

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored.

Returns the created document. (documents.create)

Parameters

$postBody
$optParams
Optional parameters.

Returns

Google_Service_Docs_Document
Google_Service_Docs_Document
public Google_Service_Docs_Document
# get( string $documentId, array $optParams = array() )

Gets the latest version of the specified document. (documents.get)

Gets the latest version of the specified document. (documents.get)

Parameters

$documentId
The ID of the document to retrieve.
$optParams
Optional parameters.

Returns

Google_Service_Docs_Document
Google_Service_Docs_Document

Opt_param

string suggestionsViewMode The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
© 2020 Google Inc.
Google Docs API documentation generated by ApiGen 2.8.0