このガイドでは、Google Docs API を構成する主なメソッド、ドキュメントへのアクセス方法、ドキュメント作成時のワークフローなどのコンセプトについて説明します。
API メソッド
documents リソースには、Docs API の呼び出しに使用するメソッドが用意されています。次のメソッドを使用すると、ドキュメントの作成、読み取り、更新を行うことができます。
documents.createメソッドを使用してドキュメントを作成します。documents.getメソッドを使用して、指定されたドキュメントの内容を取得します。documents.batchUpdateメソッドを使用して、指定したドキュメントに対して一連の更新をアトミックに実行します。
documents.get メソッドと documents.batchUpdate メソッドでは、ターゲット ドキュメントを指定するパラメータとして documentId が必要です。documents.create メソッドは、作成されたドキュメントのインスタンスを返します。このインスタンスから documentId を読み取ることができます。Docs API のリクエストとレスポンスの方法の詳細については、リクエストとレスポンスをご覧ください。
ドキュメント ID
documentId はドキュメントの一意の識別子で、ドキュメントの URL から取得できます。文字、数字、一部の特殊文字を含む特定の文字列です。ドキュメント名が変更されても、ドキュメント ID は安定しています。
https://docs.google.com/document/d/DOCUMENT_ID/edit
次の正規表現を使用して、Google ドキュメントの URL から documentId を抽出できます。
/document/d/([a-zA-Z0-9-_]+)
Google ドライブ API をご存知の場合は、documentId は files リソースの id に対応します。
Google ドライブのドキュメントの管理
ドキュメント ファイルは、クラウドベースのストレージ サービスである Google ドライブに保存されます。Docs API には独自のスタンドアロン メソッドがありますが、ユーザーのドキュメント ファイルを操作するには、Google Drive API メソッドも使用する必要があることがよくあります。たとえば、ドキュメント ファイルをコピーするには、Drive API の files.copy メソッドを使用します。詳細については、既存のドキュメントをコピーするをご覧ください。
デフォルトでは、Docs API を使用すると、新しいドキュメントはドライブのユーザーのルートフォルダに保存されます。ファイルをドライブ フォルダに保存するオプションがあります。詳細については、Google ドライブ フォルダを操作するをご覧ください。
ドキュメント ファイルを操作する
ユーザーのマイドライブからドキュメントを取得するには、多くの場合、まずドライブの files.list メソッドを使用してファイルの ID を取得する必要があります。パラメータを指定せずにメソッドを呼び出すと、ユーザーのすべてのファイルとフォルダのリスト（ID を含む）が返されます。
ドキュメントの MIME タイプは、データ型と形式を示します。ドキュメントの MIME タイプの形式は application/vnd.google-apps.document です。MIME タイプのリストについては、Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。
マイドライブ内のドキュメント ファイルのみを MIME タイプで検索するには、次のクエリ文字列フィルタを追加します。
q: mimeType = 'application/vnd.google-apps.document'
クエリ文字列フィルタの詳細については、ファイルとフォルダを検索するをご覧ください。
documentId がわかったら、documents.get メソッドを使用して、指定されたドキュメントの完全なインスタンスを取得します。詳細については、リクエストとレスポンスをご覧ください。
Google Workspace ドキュメントのバイト コンテンツをエクスポートするには、エクスポートするファイルの documentId と正しいエクスポート MIME タイプを指定して、ドライブの files.export メソッドを使用します。詳細については、Google Workspace ドキュメントのコンテンツをエクスポートするをご覧ください。
Get メソッドと List メソッドを比較する
次の表に、ドライブとドキュメントのメソッドの違いと、各メソッドで返されるデータを示します。
| 演算子 | 説明 | 用途 |
|---|---|---|
drive.files.get |
ID でファイルのメタデータを取得します。files リソースのインスタンスを返します。 |
特定のファイルのメタデータを取得します。 |
drive.files.list |
ユーザーのファイルを取得します。ファイルのリストを返します。 | どのファイルを変更する必要があるかわからない場合は、ユーザーファイルのリストを取得します。 |
docs.documents.get |
指定されたドキュメントの最新バージョン（すべての書式とテキストを含む）を取得します。documents リソースのインスタンスを返します。 |
特定のドキュメント ID のドキュメントを取得します。 |
ドキュメント作成ワークフロー
新しいドキュメントの作成と入力は簡単です。既存のコンテンツを気にする必要がなく、ドキュメントの状態を変更できる共同編集者もいないためです。概念的には、次のシーケンス図に示すように動作します。
図 1 では、documents リソースを操作するユーザーの情報フローは次のようになります。
- アプリがウェブサーバーで
documents.createメソッドを呼び出します。 - ウェブサーバーは、作成されたドキュメントのインスタンスを
documentsリソースとして含む HTTP レスポンスを送信します。 - 必要に応じて、アプリは
documents.batchUpdateメソッドを呼び出して、一連の編集リクエストをアトミックに実行し、ドキュメントにデータを入力します。 - ウェブサーバーが HTTP レスポンスを送信します。
documents.batchUpdateメソッドの中には、適用されたリクエストに関する情報を含むレスポンス本文を返すものもあれば、空のレスポンスを返すものもあります。
ドキュメント更新ワークフロー
既存のドキュメントの更新はより複雑です。ドキュメントを更新する意味のある呼び出しを行うには、現在の状態（構成要素、要素内のコンテンツ、ドキュメント内の要素の順序）を把握しておく必要があります。次のシーケンス図は、この仕組みを示しています。
図 2 では、documents リソースを操作するユーザーの情報フローは次のようになります。
- アプリが、検索するファイルの
documentIdを指定して、ウェブサーバーでdocuments.getメソッドを呼び出します。 - ウェブサーバーは、指定されたドキュメントのインスタンスを
documentsリソースとして含む HTTP レスポンスを送信します。返される JSON には、ドキュメントのコンテンツ、書式設定、その他の機能が含まれています。 - アプリは JSON を解析し、ユーザーが更新するコンテンツや形式を決定できるようにします。
- アプリは
documents.batchUpdateメソッドを呼び出して、一連の編集リクエストをアトミックに実行し、ドキュメントを更新します。 - ウェブサーバーが HTTP レスポンスを送信します。
documents.batchUpdateメソッドの中には、適用されたリクエストに関する情報を含むレスポンス本文を返すものもあれば、空のレスポンスを返すものもあります。
この図では、他の共同編集者による同時更新が同じドキュメントで行われるワークフローは考慮されていません。詳細については、ベスト プラクティスのセクションのコラボレーションを計画するをご覧ください。