Google Apps Script Cheat Sheet
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

 
View only
 
 
ABCDEFGHIJKLMNOPQRSTUVWXY
1
CategoryComponentDescription
2
CalendarThis service allows a script to access and modify the user's Google Calendar, including additional calendars that the user is subscribed to.
3
Class CalendarAppAllows a script to read and update the user's Google Calendar. This class provides direct access to the user's default calendar, as well as the ability to retrieve additional calendars that the user owns or is subscribed to.
4
Class CalendarRepresents a calendar that the user owns or is subscribed to.
5
Class CalendarEventRepresents a single calendar event.
6
Class CalendarEventSeriesRepresents a series of events (a recurring event).
7
Class EventGuestRepresents a guest of an event.
8
Class EventRecurrenceRepresents the recurrence settings for an event series.
9
Class RecurrenceRuleRepresents a recurrence rule for an event series.
Note that this class also behaves like the EventRecurrence that it belongs to, allowing you to chain rule creation together like so: recurrence.addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2);
Modifiers like times(times) and interval(interval) are applied to the most recently added rule.
10
Enum ColorAn enum representing the named colors available in the Calendar service.
11
Enum GuestStatusAn enum representing the statuses a guest can have for an event.
12
Enum VisibilityAn enum representing the visibility of an event.
13
14
ContactsThis service allows scripts to access and modify Google Contacts, both for individual contacts and for groups.
15
Class ContactsAppThis class allows users to access their own Google Contacts and create, remove, and update contacts listed therein.
16
Class AddressFieldAddress field in a contact.
17
Class CompanyFieldCompany field in a Contact.
18
Class ContactA Contact contains the name, address, and various contact details of a contact.
19
Class ContactGroupA ContactGroup is is a group of contacts.
20
Class CustomFieldA custom field in a Contact.
21
Class DateFieldA date field in a Contact.
22
Class EmailFieldAn email field in a Contact.
23
Class IMFieldAn instant messaging field in a Contact.
24
Class PhoneFieldA phone number field in a Contact.
25
Class UrlFieldA URL field in a Contact.
26
Enum ExtendedFieldAn enum for extended contacts fields.
27
Enum FieldAn enum for contacts fields.
28
Enum GenderAn enum for contact gender.
29
Enum PriorityAn enum for contact priority.
30
Enum SensitivityAn enum for contact sensitivity.
31
32
DocumentThis service allows scripts to create, access, and modify Google Docs files.
33
Enum AttributeAn enumeration of the element attributes.
Use attributes to compose custom styles. For example:
34
Class BodyAn element representing a document body. The Body may contain ListItem, Paragraph, Table, and TableOfContents elements. For more information on document structure, see the guide to extending Google Docs.
The Body typically contains the full document contents except for the HeaderSection, FooterSection, and any FootnoteSection elements.
35
Class BookmarkAn object representing a bookmark.
36
Class ContainerElementA generic element that may contain other elements. All elements that may contain child elements, such as Paragraph, inherit fromContainerElement.
37
Class DocumentA document, containing rich text and elements such as tables and lists.
Documents may be opened or created using DocumentApp.
38
Class DocumentAppThe document service creates and opens Documents that can be edited.
39
Interface ElementA generic element. Document contents are represented as elements. For example, ListItem, Paragraph, and Table are elements and inherit all of the methods defined by Element, such as getType().
40
Enum ElementTypeAn enumeration of all the element types.
Use the ElementType enumeration to check the type of a given element, for instance:
41
Class EquationAn element representing a mathematical expression. An Equation may contain EquationFunction, EquationSymbol, and Textelements. For more information on document structure, see the guide to extending Google Docs.
42
Class EquationFunctionAn element representing a function in a mathematical Equation. An EquationFunction may contain EquationFunction,EquationFunctionArgumentSeparator, EquationSymbol, and Text elements. For more information on document structure, see theguide to extending Google Docs.
43
Class EquationFunctionArgumentSeparator
An element representing a function separator in a mathematical Equation. An EquationFunctionArgumentSeparator cannot contain any other element. For more information on document structure, see the guide to extending Google Docs.
44
Class EquationSymbolAn element representing a symbol in a mathematical Equation. An EquationSymbol cannot contain any other element. For more information on document structure, see the guide to extending Google Docs.
45
Enum FontFamilyAn enumeration of the supported fonts.
Use the FontFamily enumeration to set the font for a range of text, element or document.
46
Class FooterSectionAn element representing a footer section. A Document typically contains at most one FooterSection. The FooterSection may containListItem, Paragraph, and Table elements. For more information on document structure, see the guide to extending Google Docs.
47
Class FootnoteAn element representing a footnote. Each Footnote is contained within a ListItem or Paragraph and has a correspondingFootnoteSection element for the footnote's contents. The Footnote itself cannot contain any other element. For more information on document structure, see the guide to extending Google Docs.
48
Class FootnoteSectionAn element representing a footnote section. A FootnoteSection contains the text that corresponds to a Footnote. The FootnoteSection may contain ListItem or Paragraph elements. For more information on document structure, see the guide to extending Google Docs.
49
Enum GlyphTypeAn enumeration of the supported glyph types.
Use the GlyphType enumeration to set the bullet type for list items.
50
Class HeaderSectionAn element representing a header section. A Document typically contains at most one HeaderSection. The HeaderSection may contain ListItem, Paragraph, and Table elements. For more information on document structure, see the guide to extending Google Docs.
51
Enum HorizontalAlignmentAn enumeration of the supported horizontal alignment types.
52
Class HorizontalRuleAn element representing an horizontal rule. A HorizontalRule can be contained within a ListItem or Paragraph, but cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs.
53
Class InlineDrawingAn element representing an embedded drawing. An InlineDrawing can be contained within a ListItem or Paragraph, unless the ListItem or Paragraph is within a FootnoteSection. An InlineDrawing cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs.
54
Class InlineImageAn element representing an embedded image. An InlineImage can be contained within a ListItem or Paragraph, unless the ListItem or Paragraph is within a FootnoteSection. An InlineImage cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs.
55
Class ListItemAn element representing a list item. A ListItem is a Paragraph that is associated with a list ID. A ListItem may contain Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, and Text elements. For more information on document structure, see the guide to extending Google Docs.

ListItems may not contain new-line characters. New-line characters ("\n") are converted to line-break characters ("\r").

ListItems with the same list ID belong to the same list and are numbered accordingly. The ListItems for a given list are not required to be adjacent in the document or even have the same parent element. Two items belonging to the same list may exist anywhere in the document while maintaining consecutive numbering, as the following example illustrates:
56
Class NamedRangeA Range that has a name and ID to allow later retrieval. Names are not necessarily unique; several different ranges in the same document may share the same name, much like a class in HTML. By contrast, IDs are unique within the document, like an ID in HTML. Once a NamedRange has been added to a document, it cannot be modified, only removed.

A NamedRange can be accessed by any script that accesses the document. To avoid unintended conflicts between scripts, consider prefixing range names with a unique string.
57
Class PageBreakAn element representing a page break. A PageBreak can be contained within a ListItem or Paragraph, unless the ListItem or Paragraph is within a Table, HeaderSection, FooterSection, or FootnoteSection. A PageBreak cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs.
58
Class ParagraphAn element representing a paragraph. A Paragraph may contain Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, and Text elements. For more information on document structure, see the guide to extending Google Docs.

Paragraphs may not contain new-line characters. New-line characters ("\n") are converted to line-break characters ("\r").
59
Enum ParagraphHeadingAn enumeration of the standard paragraph headings.
60
Class PositionA reference to a location in the document, relative to a specific element. The user's cursor is represented as a Position, among other uses. Scripts can only access the cursor of the user who is running the script, and only if the script is bound to the document.
61
Class RangeA range of elements in a document. The user's selection is represented as a Range, among other uses. Scripts can only access the selection of the user who is running the script, and only if the script is bound to the document.
62
Class RangeBuilderA builder used to construct RangeBuilder objects from document elements.
63
Class RangeElementA wrapper around an Element with a possible start and end offset. These offsets allow a range of characters within a Text element to be represented in search results, document selections, and named ranges.
64
Class TableAn element representing a table. A Table may only contain TableRow elements. For more information on document structure, see the guide to extending Google Docs.

When creating a Table that contains a large number of rows or cells, consider building it from a string array, as shown in the following example.
65
Class TableCellAn element representing a table cell. A TableCell is always contained within a TableRow and may contain ListItem, Paragraph, or Table elements. For more information on document structure, see the guide to extending Google Docs.
66
Class TableOfContentsAn element containing a table of contents. A TableOfContents may contain ListItem, Paragraph, and Table elements, although the contents of a TableOfContents are usually generated automatically by Google Docs. For more information on document structure, see the guide to extending Google Docs.
67
Class TableRowAn element representing a table row. A TableRow is always contained within a Table and may only contain TableCell elements. For more information on document structure, see the guide to extending Google Docs.
68
Class TextAn element representing a rich text region. All text in a Document is contained within Text elements. A Text element can be contained within an Equation, EquationFunction, ListItem, or Paragraph, but cannot itself contain any other element. For more information on document structure, see the guide to extending Google Docs.
69
Enum TextAlignmentAn enumeration of the type of text alignments.
70
Class UnsupportedElementAn element representing a region that is unknown or cannot be affected by a script, such as a page number.
71
Enum VerticalAlignmentAn enumeration of the supported vertical alignment types.
72
73
DriveThis service allows scripts to create, find, and modify files and folders in Google Drive.
74
Enum AccessAn enum representing classes of users who can access a file or folder, besides any individual users who have been explicitly given access. These properties can be accessed from DriveApp.Access.
75
Class DriveAppAllows scripts to create, find, and modify files and folders in Google Drive.
76
Class FileA file in Google Drive. Files can be accessed or created from DriveApp.
77
Class FileIteratorAn iterator that allows scripts to iterate over a potentially large collection of files. File iterators can be acccessed from DriveApp or aFolder.
78
Class FolderA folder in Google Drive. Folders can be accessed or created from DriveApp.
79
Class FolderIteratorAn object that allows scripts to iterate over a potentially large collection of folders. Folder iterators can be acccessed from DriveApp, a File, or a Folder.
80
Enum PermissionAn enum representing the permissions granted to users who can access a file or folder, besides any individual users who have been explicitly given access. These properties can be accessed from DriveApp.Permission.
81
Class UserA user associated with a file in Google Drive. Users can be accessed from File.getEditors(), Folder.getViewers(), and other methods.
82
83
FormsThis service allows scripts to create, access, and modify Google Forms.
84
Class AlignmentAn enum representing the supported types of image alignment. Alignment types can be accessed from FormApp.Alignment.
85
Class CheckboxItemA question item that allows the respondent to select one or more checkboxes, as well as an optional "other" field. Items can be accessed or created from a Form.
86
Class ChoiceA single choice associated with a type of Item that supports choices, like CheckboxItem, ListItem, orMultipleChoiceItem.
87
Class DateItemA question item that allows the respondent to indicate a date. Items can be accessed or created from a Form.
88
Class DateTimeItemA question item that allows the respondent to indicate a date and time. Items can be accessed or created from a Form.
89
Enum DestinationTypeAn enum representing the supported types of form-response destinations. All forms, including those that do not have a destination set explicitly, save a copy of responses in the form's response store. Destination types can be accessed fromFormApp.DestinationType.
90
Class DurationItemA question item that allows the respondent to indicate a length of time.
91
Class FormA form that contains overall properties (such as title, settings, and where responses are stored) and items (which includes question items like checkboxes and layout items like page breaks). Forms can be accessed or created from FormApp.
92
Class FormAppAllows a script to open existing Forms or create new ones.
93
Class FormResponseA response to the form as a whole. Form responses have three main uses: they contain the answers submitted by a respondent (see getItemResponses(), they can be used to programmatically respond to the form (see withItemResponse(response) and submit()), and they can be used as a template to create a URL for the form with pre-filled answers. Form responses can be created or accessed from a Form.
94
Class GridItemA question item, presented as a grid of columns and rows, that allows the respondent to select one choice per row from a sequence of radio buttons. Items can be accessed or created from a Form.
95
Class ImageItemA layout item that displays an image. Items can be accessed or created from a Form.
96
Class ItemA generic form item that contains properties common to all items, such as title and help text. Items can be accessed or created from a Form. To operate on type-specific properties, use getType() to check the item's ItemType, then cast the item to the appropriate class using a method like asCheckboxItem().
97
Class ItemResponseA response to one question item within a form. Item responses can be accessed from FormResponse and created from any Item that asks the respondent to answer a question.
98
Enum ItemTypeAn enum representing the supported types of form items. Item types can be accessed from FormApp.ItemType.
99
Class ListItemA question item that allows the respondent to select one choice from a drop-down list. Items can be accessed or created from aForm.
100
Class MultipleChoiceItemA question item that allows the respondent to select one choice from a list of radio buttons or an optional "other" field. Items can be accessed or created from a Form.
Loading...
 
 
 
シート1