Google ドキュメント API の概要

Google Docs API を使用すると、Google ドキュメントでドキュメントを作成、変更できます。

アプリケーションは Docs API と統合して、ユーザーとシステムから提供されるデータの両方から洗練されたドキュメントを作成できます。Docs API を使用すると、次のことができます。

  • 処理の自動化
  • ドキュメントを一括で作成する
  • ドキュメントの書式設定
  • 請求書または契約書を生成する
  • オブジェクトの特定の属性を取得する

Docs API で使用される一般的な用語を以下に示します。

ドキュメント ID

ドキュメントの一意の識別子。ドキュメントを参照する文字、数字、特殊文字を含む特定の文字列で、ドキュメントの URL から取得できます。ドキュメント ID は、ドキュメント名が変更されても変更されません。ID を確認する方法について詳しくは、ドキュメント ID をご覧ください。

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

ドキュメントを構成する構造。ドキュメントの最上位要素には、Body、DocumentStyle、List があります。

Google Workspace のドキュメント

Google Workspace アプリケーション（Google ドキュメントなど）が作成するファイル。Docs の MIME タイプ形式は application/vnd.google-apps.document です。MIME タイプの一覧については、 Google Workspace と Google ドライブでサポートされている MIME タイプをご覧ください。

Index

コンテンツ本文内のほとんどの要素には、startIndex プロパティと endIndex プロパティがあります。これらは、要素の開始と終了のオフセットを、要素を囲むセグメントの開始からの相対値で示します。

インライン画像

ドキュメント内のテキストの流れに表示される画像。添付ファイルではありません。

名前付き範囲

連続したテキストの範囲。NamedRange は、同じ namedRangeId を持つ範囲のコレクションです。名前付き範囲を使用すると、ドキュメントの一部を任意のユーザー定義ラベルに関連付けることができるため、後でプログラムで内容を読み取ったり編集したりできます。ドキュメントには同じ名前の複数の名前付き範囲を含めることができますが、各名前付き範囲には一意の ID があります。

Segment

構造要素またはコンテンツ 要素を含む Body、Header、Footer、Footnote。セグメント内の要素のインデックスは、そのセグメントの開始を基準としています。

候補

ドキュメントの元のテキストを変更せずに、変更を提案することができます。提案内容をオーナーが承認すると、元のテキストが置き換えられます。