ドキュメント

このガイドでは、Terraform を構成する主なメソッドなど、 ドキュメントへのアクセス方法、ドキュメントを作成する際のワークフロー ドキュメントをご覧ください

API メソッド

documents リソースは、 すべてのメソッドについて説明します。以下の方法で、 ドキュメントの作成、読み取り、更新:

  • documents.create を使用する メソッドを使用してドキュメントを作成します。
  • documents.get メソッドを使用する 指定したドキュメントのコンテンツを取得できます。
  • documents.batchUpdate を使用する メソッドを使用すると、指定したドキュメントに対して一連の更新をアトミックに実行できます。

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

ドキュメント ID

documentId はドキュメントの一意の識別子です。この値から導出できます。 取得できるからです文字、数字、メールアドレスを含む 使用しないでください。ドキュメント名が変わっても、ドキュメント ID は不変です。 できます。

https://docs.google.com/document/d/DOCUMENT_ID/edit

次の正規表現を使用して、documentId を Google ドキュメントの URL:

/document/d/([a-zA-Z0-9-_]+)

Google Drive API に精通している場合、documentId は id に対応します。 これは files リソースにあります。

Google ドライブのドキュメントの管理

ドキュメント ファイルはクラウドベースのストレージである Google ドライブに保存されます あります。Docs API には独自のスタンドアロン メソッドがありますが、 また、Google Drive API メソッドを使用してユーザーの ドキュメント ファイル。たとえば、ドキュメント ファイルをコピーするには、 Drive API の files.copy メソッドを呼び出します。詳しくは、既存の ドキュメントをご覧ください。

デフォルトでは、Docs API を使用すると、新しいドキュメントは ドライブ上のユーザーのルートフォルダです。ファイルを保存するには ドライブ フォルダに移動します。詳しくは、 Google ドライブ フォルダ。

ドキュメント ファイルを操作する

ユーザーのマイドライブからドキュメントを取得するには、多くの場合、 最初に 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 ドキュメントのバイト コンテンツを書き出すには、ドライブの files.export メソッド エクスポートするファイルの documentId と正しいエクスポート MIME type。詳しくは、エクスポートする Google Workspace ドキュメント コンテンツをご覧ください。

Get メソッドと List メソッドを比較する

次の表に、Google ドライブと および各メソッドで返されるデータがあります。

演算子 説明 用途
drive.files.get ファイルのメタデータを ID で取得します。files リソースのインスタンスを返します。 特定のファイルのメタデータを取得します。
drive.files.list ユーザーのファイルを取得します。ファイルのリストを返します。 変更する必要があるファイルが不明な場合は、ユーザー ファイルのリストを取得します。
docs.documents.get 指定したドキュメントの最新バージョン（すべての書式設定とテキストを含む）を取得します。documents リソースのインスタンスを返します。 特定のドキュメント ID のドキュメントを取得します。

ドキュメント作成ワークフロー

新しいドキュメントを作成して入力するのは簡単です。 心配する必要はなく、コンテンツに変更を加えることができる ドキュメントの状態。概念的には、この流れは次のようになります。 図:

ワークフローを作成し、 新しいドキュメントにデータを入力します。
図 1. 新しいドキュメントを作成してデータを入力するワークフロー。

図 1 では、Google Chat と通信する documents リソースには次のものがあります。 情報のフロー:

  1. アプリは documents.create メソッドがオン 作成します。
  2. ウェブサーバーが、ウェブサーバーから documents リソースとしてドキュメントを作成しました。
  3. 必要に応じて、アプリは documents.batchUpdate を呼び出します。 メソッドを使用して、ドキュメントにデータを入力する一連の編集リクエストをアトミックに実行します。 説明します
  4. ウェブサーバーが HTTP レスポンスを送信します。一部の documents.batchUpdate メソッド 適用されたリクエストに関する情報をレスポンスの本文に提供しますが、 それ以外のユーザーには空の回答が表示されます。

ドキュメント更新ワークフロー

既存のドキュメントの更新はより複雑です。意味のあるものにするには、 呼び出しを行ってドキュメントを更新する場合は、その現在の状態、つまりどのような要素が その要素に含まれるコンテンツ、要素内の要素の順序など、 できます。次のシーケンス図に、この仕組みを示します。

更新するワークフロー ドキュメントをご覧ください
図 2. ドキュメントを更新するワークフロー。

図 2 では、documents リソースを操作しているユーザーに 次のような流れになります。

  1. アプリは documents.get メソッド（ウェブの場合） 検索するファイルの documentId に置き換えます。
  2. ウェブサーバーが、ウェブサーバーから documents リソースとして指定します。返される JSON には、 書式設定などの機能を利用できます。
  3. このアプリが JSON を解析して、ユーザーはコンテンツまたは形式を決定できます。 更新されます
  4. アプリが documents.batchUpdate メソッドを呼び出して、セットをアトミックに実行する ドキュメントを更新します。
  5. ウェブサーバーが HTTP レスポンスを送信します。一部の documents.batchUpdate メソッド 適用されたリクエストに関する情報をレスポンスの本文に提供しますが、 それ以外のユーザーには空の回答が表示されます。

この図では、他のプロジェクトによって同時に更新されるワークフローは 同じドキュメントで共同編集者が作られる。詳しくは、 プラクティスのセクション コラボレーション。