Google ドキュメント API の概要

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

アプリケーションを Docs API と統合して、ユーザーとシステム提供データの両方から洗練されたドキュメントを作成できます。ドキュメント 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。セグメント内の要素のインデックスは、そのセグメントの先頭を基準とします。

候補

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