今日からGoogleドキュメントで使えるGASのコード一覧

本記事では、Google Apps ScriptでGoogleドキュメントに対して使うことができるDocumentAppという処理の一覧表を用意しました。Googleの公式ドキュメントは英語なので、分かりづらいところもありますので、みなさんがそこで挫折しないように日本語で内容が把握できるようにします。

まだすべてのメソッドで日本語での使い方が解説できているわけではありませんが、最終的にはすべての使い方を日本語で解説するページを用意していきます。
日本語化されている記事の見分け方は、簡単な説明列で日本語が記載されているものについては日本語記事が用意できています。メソッド名をクリックすることで対象の記事を閲覧することができます。
日本語の記事が出来上がっていないメソッドについてはGoogleから提供されている公式ドキュメント（英語）へのリンクとなっています。

DocumentAppの概要

DocumentAppとは、Google Apps ScriptでGoogleドキュメントに対する操作を行うコードですが、DocumentAppに用意されているメソッドでは、次のような操作を行うことができます。

• ドキュメントファイルの作成
• アクセス権限の編集
• ドキュメントファイルの修正

クラス名一覧

※クリックすると対象場所にジャンプします

インターフェイス

列挙型一覧

※クリックすると対象場所にジャンプします

クラス別メソッド名一覧

Class Body

Bodyクラスはドキュメントボディを制御するクラスで、ドキュメントボディはListItem、Paragraph、Table、TableOfContentsによって構成されています。ドキュメント構造についての詳しい情報は、ドキュメント構造（未実装）をご確認下さい。

概ねヘッダー、フッター等を除くドキュメントの内容がドキュメントボディ部分となります。

Class Body

Class Bookmark

Class ContainerElement

Class DocumentApp

Class Equation

Class EquationFunction

Class EquationFunctionArgumentSeparator

Class EquationSymbol

Class FooterSection

Class Footnote

Class FootnoteSection

Class HeaderSection

Class HorizontalRule

Class InlineDrawing

Class InlineImage

Class ListItem

Class NamedRange

Class PageBreak

Class Paragraph

Class Position

Class PositionedImage

Class Range

Class RangeBuilder

Class Table

Class TableCell

Class TableOfContents

Class TableRow

Class Text

Class UnsupportedElement

列挙型名一覧

列挙型のメソッドを利用するときには、基本的には『DocumentApp.列挙型名.プロパティ名』の形で利用します。例えば、VerticalAlignmentのBOTTOMを設定したい場合は、『DocumentApp.VerticalAlignment.BOTTOM』という形で記述します。

Enoms Attribute

Enoms ElementType

ElementTypeはドキュメントの構成要素の種類を設定したり、構成要素を比較したりする場合に使用します。

function sampleCodeForGetAllCalendars() {
  var firstChild = DocumentApp.getActiveDocument().getBody().getChild(0);
  if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
    //本文セクションの1つ目の子要素が段落に設定されている場合は、要素をH1見出しに設定する処理
    firstChild.asParagraph().setHeading(DocumentApp.ParagraphHeading.HEADING1);
  }
}

Enoms FontFamily（非推奨）

FontFamilyはフォントの種類を設定します。 現在は非推奨です。

Enoms GlyphType

GlyphTypeは箇条書き設定を設定します。

Enoms HorizontalAlignment

HorizontalAlignmentは水平方向の文字配置を設定します。

Enoms ParagraphHeading

ParagraphHeadingは段落見出しを設定します。

Enoms PositionedLayout

PositionedLayoutは画像の配置方法を設定します。

Enoms TextAlignment

TextAlignmentは文字配置を設定します。

Enoms VerticalAlignment

VerticalAlignmentは垂直方向の文字配置を設定します。