このガイドでは、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.get メソッドを使用して公開されたドキュメントを取得することはできません。公開されたドキュメントは、異なる URL 形式を使用し、個別の公開 documentId を持ちます。公開 documentId を documents.get メソッドで使用しようとすると、404 HTTP ステータス コード レスポンスが返されます。
同様に、Drive API の files.copy メソッドを使用して公開済みドキュメントをコピーすることはできません。
公開されたドキュメントを取得またはコピーするには、元の documentId を使用する必要があります。公開された URL から元の documentId を抽出する方法はありません。
詳しくは以下をご覧ください。
バッチ アップデート
documents.batchUpdate メソッドは、request オブジェクトのリストを受け取ります。各オブジェクトは、実行する単一のリクエストを指定します。たとえば、段落の書式を設定してから、インライン画像を追加します。各リクエストは適用前に検証され、バッチ リクエストに表示される順序で処理されます。
バッチ アップデート内のすべてのリクエストはアトミックに適用されます。つまり、リクエストが無効な場合、更新全体が失敗し、依存関係のある変更は適用されません。
一部の documents.batchUpdate メソッドは、適用されたリクエストに関する情報を含むレスポンスを提供します。これらのメソッドは、response オブジェクトのリストを含むレスポンス本文を返します。他のリクエストでは、情報を返す必要はなく、空の返信が表示されます。レスポンス リスト内のオブジェクトは、対応するリクエストと同じインデックス順序になります。
一括リクエストを行う一般的なパターンは次のようになります。
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Docs API 呼び出しをバッチ処理する方法の詳細については、バッチ リクエストのベスト プラクティスをご覧ください。リクエストとレスポンスのタイプについては、documents.batchUpdate リファレンス ドキュメントをご覧ください。
バッチ アップデート オペレーション
バッチ アップデート リクエストにはさまざまな種類があります。以下に、さまざまなカテゴリに分類されたリクエスト タイプの内訳を示します。