Class DocumentApp

DocumentApp

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

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

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

プロパティ

プロパティタイプ説明
AttributeAttributeAttribute 列挙値。
ElementTypeElementTypeElementType 列挙値。
FontFamilyFontFamilyFontFamily 列挙値。
GlyphTypeGlyphTypeGlyphType 列挙値。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 列挙値。
ParagraphHeadingParagraphHeadingParagraphHeading 列挙値。
PositionedLayoutPositionedLayoutPositionedLayout 列挙値。
TextAlignmentTextAlignmentTextAlignment 列挙値。
VerticalAlignmentVerticalAlignmentVerticalAlignment 列挙値。

メソッド

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

詳細なドキュメント

create(name)

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

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

パラメータ

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

戻る

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

承認

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

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

getActiveDocument()

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

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

戻る

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

承認

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

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

getUi()

スクリプトによる追加を許可するドキュメントのユーザー インターフェース環境のインスタンスを返します。 メニュー、ダイアログ、サイドバーなどの 機能を作成できますスクリプトがやり取りできるのは、 スクリプトがドキュメントにバインドされている場合にのみ、開いているドキュメントの現在のインスタンスが表示されます。詳しくは、 メニュー、ダイアログ、サイドバーのガイドを参照してください。 

// 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.
var doc = DocumentApp.openById('DOCUMENT_ID');

パラメータ

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

戻る

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

承認

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

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

openByUrl(url)

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

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

パラメータ

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

戻る

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

承認

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

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