Class DocumentApp

DocumentApp

ドキュメント サービスは、編集可能な Documents を作成して開きます。

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

プロパティ

プロパティ	タイプ	説明
Attribute	Attribute	Attribute 列挙型。
ElementType	ElementType	ElementType 列挙型。
FontFamily	FontFamily	FontFamily 列挙型。
GlyphType	GlyphType	GlyphType 列挙型。
HorizontalAlignment	HorizontalAlignment	HorizontalAlignment 列挙型。
ParagraphHeading	ParagraphHeading	ParagraphHeading 列挙型。
PositionedLayout	PositionedLayout	PositionedLayout 列挙型。
TextAlignment	TextAlignment	TextAlignment 列挙型。
VerticalAlignment	VerticalAlignment	VerticalAlignment 列挙型。

メソッド

メソッド	戻り値の型	概要
create(name)	Document	新しいドキュメントを作成して返します。
getActiveDocument()	Document	スクリプトがコンテナにバインドされているドキュメントを返します。
getUi()	Ui	ドキュメントのユーザー インターフェース環境のインスタンスを返します。これにより、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。
openById(id)	Document	指定された ID のドキュメントを返します。
openByUrl(url)	Document	指定された URL のドキュメントを開いて返します。

詳細なドキュメント

create(name)

新しいドキュメントを作成して返します。

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

パラメータ

名前	型	説明
name	String	新しいドキュメントの名前。

戻る

Document - 新しいドキュメント インスタンス。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/documents

---

getActiveDocument()

スクリプトがコンテナにバインドされているドキュメントを返します。スクリプトがコンテナにバインドされていないドキュメントを操作するには、代わりに openById(id) または openByUrl(url) を使用します。

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

戻る

Document - ドキュメント インスタンス

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getUi()

ドキュメントのユーザー インターフェース環境のインスタンスを返します。これにより、スクリプトでメニュー、ダイアログ、サイドバーなどの機能を追加できます。スクリプトは、開いているドキュメントの現在のインスタンスの UI のみを操作できます。ただし、スクリプトがドキュメントにバインドされている場合に限られます。詳しくは、メニューとダイアログとサイドバーのガイドをご覧ください。

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

戻る

Ui - このドキュメントのユーザー インターフェース環境のインスタンス

---

openById(id)

指定された ID のドキュメントを返します。スクリプトがドキュメントにコンテナバインドされている場合は、代わりに getActiveDocument() を使用します。

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

パラメータ

名前	型	説明
id	String	開くドキュメントの ID。

戻る

Document - ドキュメント インスタンス。

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/documents

---

openByUrl(url)

指定された URL のドキュメントを開いて返します。スクリプトがドキュメントにコンテナ バインドされている場合は、代わりに getActiveDocument() を使用します。

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

パラメータ

名前	型	説明
url	String	開くドキュメントの URL

戻る

Document - ドキュメント インスタンス

承認

このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。

• https://www.googleapis.com/auth/documents