リクエストとレスポンス

このガイドでは、Terraform を構成する主なリクエストとレスポンスのメソッドについて説明します。 Google Docs API と、ドキュメントを一括更新する方法。

Google Docs API を呼び出すには、HTTP リクエストまたはメソッド 言語固有のクライアント ライブラリで呼び出す必要があります。 これらはほぼ同じです。

Google Docs API は HTTP レスポンスを返します。通常、レスポンスには結果が含まれます。 渡されます。クライアント ライブラリを使用してリクエストを行う場合、 レスポンスは言語固有の方法で返されます。

リクエストのメソッド

Docs API は、次のメソッドをサポートしています。

  • documents.create: 作成 空白の Google ドキュメントです
  • documents.get: 完全なインスタンスを返します。返された JSON を解析できます。 ドキュメントの内容、書式設定、その他の機能を抽出します。
  • documents.batchUpdate: ドキュメントにアトミックに適用する編集リクエストのリストを送信する。 結果のリストを返します。

documents.get メソッドと documents.batchUpdate メソッドには documentId が必要です。 引数としてターゲット ドキュメントを指定します。documents.create メソッド 作成されたドキュメントのインスタンスを返します。このインスタンスから、 documentIddocumentId の詳細については、ドキュメント ID

バッチ アップデート

documents.batchUpdate メソッドは request 個のオブジェクト(それぞれ 1 個) 実行する単一のリクエストを指定します。たとえば、段落の書式を設定し、 追加します。各リクエストは適用前に検証され、 リクエストは、バッチ リクエストに出現する順序で処理されます。

バッチ アップデートのすべてのリクエストはアトミックに適用されます。つまり、API の呼び出しに 有効でない場合、更新全体が失敗し、 適用される。

一部の documents.batchUpdate メソッドは、以下の情報を含むレスポンスを提供します。 表示されます。これらのメソッドは、 本文 response のリストを含む 説明します。他のリクエストでは、情報を返す必要はなく、空の文字列を 返信できます。レスポンス リスト内のオブジェクトは、 対応するリクエストです。

バッチ リクエストの一般的なパターンは次のようになります。

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

詳しくは、バッチ リクエストのベスト プラクティスをご覧ください。 バッチ処理を行う方法と documents.batchUpdate リクエスト タイプとレスポンス タイプに関するリファレンス ドキュメント。

バッチ アップデート オペレーション

バッチ アップデート リクエストにはさまざまな種類があります。こちらが リクエスト タイプは、 あります。

オブジェクト 追加 / 挿入 更新 / 置換 削除
テキスト InsertTextRequest ReplaceAllTextRequest
スタイル CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
名前付き範囲 CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
画像 InsertInlineImageRequest ReplaceImageRequest
テーブル InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
ページ オブジェクト(ヘッダーフッターを含む) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest