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

Index

コンテンツ本文内のほとんどの要素には、startIndex プロパティと endIndex プロパティがあります。要素を囲むセグメントの先頭を基準とする要素の開始と終了のオフセットを示します。

インライン画像

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

名前付き範囲

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

Segment

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

候補

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