このガイドでは、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 メソッドは、作成されたドキュメントのインスタンスを返します。このインスタンスから documentId を読み取ることができます。documentId の詳細については、ドキュメント ID をご覧ください。
バッチ アップデート
documents.batchUpdate メソッドは、request オブジェクトのリストを受け取ります。各オブジェクトは、実行するリクエストを 1 つ指定します。たとえば、段落の書式を設定してインライン画像を追加します。各リクエストは適用前に検証され、リクエストはバッチ リクエストに出現する順序で処理されます。
バッチ アップデートのすべてのリクエストはアトミックに適用されます。つまり、いずれかのリクエストが有効でない場合、更新全体が失敗し、（依存する可能性のある）変更はいずれも適用されません。
一部の documents.batchUpdate メソッドは、適用されたリクエストに関する情報を含むレスポンスを返します。これらのメソッドは、response オブジェクトのリストを含むレスポンスの本文を返します。他のリクエストでは、情報を返したり空の応答を表示したりする必要はありません。レスポンス リスト内のオブジェクトは、対応するリクエストと同じインデックス順序を占有します。
バッチ リクエストの一般的なパターンは次のようになります。
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Docs API 呼び出しをバッチ処理する方法の詳細については、バッチ リクエストのベスト プラクティスをご覧ください。また、リクエストとレスポンスのタイプについては、documents.batchUpdate リファレンス ドキュメントをご覧ください。
バッチ アップデート オペレーション
バッチ アップデート リクエストにはさまざまな種類があります。ここでは、リクエスト タイプをカテゴリに分類して説明します。