Skip to main content
Google Workspace
  • Google Workspace
Home Apps Script All products
  • Google Workspace apps
  • Admin console
  • Cloud Search
  • Gmail
  • Google Calendar
  • Google Chat
  • Google Classroom
  • Google Docs
  • Google Drive
  •  
  • Google Forms
  • Google Keep
  • Google Meet
  • Google Sheets
  • Google Sites
  • Google Slides
  • Google Tasks
  • Google Vault
  • Extend, automate & share
  • Add-ons
  • Apps Script
  • Chat apps
  • Drive apps
  • Marketplace
Resources
  • Tools
  • Admin console
  • Apps Script dashboard
  • Google Cloud console
  • APIs Explorer
  • Card Builder
  • Training & support
  • How to get started
  • Codelabs
  • Developer support
  • Updates
  • Release notes
  • Developer Previews
  • YouTube
  • Newsletter
  • X (Twitter)
  • Blog
/
  • English
  • Deutsch
  • Español
  • Español – América Latina
  • Français
  • Indonesia
  • Italiano
  • Polski
  • Português – Brasil
  • Tiếng Việt
  • Türkçe
  • Русский
  • עברית
  • العربيّة
  • فارسی
  • हिंदी
  • বাংলা
  • ภาษาไทย
  • 中文 – 简体
  • 中文 – 繁體
  • 日本語
  • 한국어
Sign in
  • Apps Script
Overview Guides Reference Samples Support
Google Workspace
  • Google Workspace
  • Home
  • Apps Script
    • Overview
    • Guides
    • Reference
    • Samples
    • Support
  • All products
    • More
  • Resources
    • More
  • Overview
  • Google Workspace services
  • Admin Console
    • Advanced services
    • Directory API
    • Enterprise License Manager API
    • Groups Migration API
    • Groups Settings API
    • Reseller API
    • Reports API
  • Calendar
    • Overview
    • CalendarApp
    • Classes
    • Calendar
    • CalendarEvent
    • CalendarEventSeries
    • EventGuest
    • EventRecurrence
    • RecurrenceRule
    • Enums
    • Color
    • EventColor
    • EventTransparency
    • EventType
    • GuestStatus
    • Visibility
    • Advanced services
    • Calendar API
  • Chat
    • Advanced services
    • Chat API
  • Docs
    • Overview
    • DocumentApp
    • Classes
    • Body
    • Bookmark
    • ContainerElement
    • Date
    • Document
    • DocumentTab
    • Equation
    • EquationFunction
    • EquationFunctionArgumentSeparator
    • EquationSymbol
    • FooterSection
    • Footnote
    • FootnoteSection
    • HeaderSection
    • HorizontalRule
    • InlineDrawing
    • InlineImage
    • ListItem
    • NamedRange
    • PageBreak
    • Paragraph
    • Person
    • Position
    • PositionedImage
    • Range
    • RangeBuilder
    • RangeElement
    • RichLink
    • Tab
    • Table
    • TableCell
    • TableOfContents
    • TableRow
    • Text
    • UnsupportedElement
    • Interfaces
    • Element
    • Enums
    • Attribute
    • ElementType
    • FontFamily
    • GlyphType
    • HorizontalAlignment
    • ParagraphHeading
    • PositionedLayout
    • TabType
    • TextAlignment
    • VerticalAlignment
    • Advanced services
    • Docs API
  • Drive
    • Overview
    • DriveApp
    • Classes
    • File
    • FileIterator
    • Folder
    • FolderIterator
    • User
    • Enums
    • Access
    • Permission
    • Advanced services
    • Drive API
    • Drive Activity API
    • Drive Labels API
  • Forms
    • Overview
    • FormApp
    • Classes
    • CheckboxGridItem
    • CheckboxGridValidation
    • CheckboxGridValidationBuilder
    • CheckboxItem
    • CheckboxValidation
    • CheckboxValidationBuilder
    • Choice
    • DateItem
    • DateTimeItem
    • DurationItem
    • Form
    • FormResponse
    • GridItem
    • GridValidation
    • GridValidationBuilder
    • ImageItem
    • ItemResponse
    • ListItem
    • MultipleChoiceItem
    • PageBreakItem
    • ParagraphTextItem
    • ParagraphTextValidation
    • ParagraphTextValidationBuilder
    • QuizFeedback
    • QuizFeedbackBuilder
    • RatingItem
    • ScaleItem
    • SectionHeaderItem
    • TextItem
    • TextValidation
    • TextValidationBuilder
    • TimeItem
    • VideoItem
    • Interfaces
    • Item
    • Enums
    • Alignment
    • DestinationType
    • FeedbackType
    • ItemType
    • PageNavigationType
    • RatingIconType
  • Gmail
    • Overview
    • GmailApp
    • Classes
    • GmailAttachment
    • GmailDraft
    • GmailLabel
    • GmailMessage
    • GmailThread
    • Advanced services
    • Gmail API
  • Sheets
    • Overview
    • SpreadsheetApp
    • Classes
    • Banding
    • BooleanCondition
    • CellImage
    • CellImageBuilder
    • Color
    • ColorBuilder
    • ConditionalFormatRule
    • ConditionalFormatRuleBuilder
    • ContainerInfo
    • DataSource for Connected Sheets
      • BigQueryDataSourceSpec
      • BigQueryDataSourceSpecBuilder
      • DataExecutionStatus
      • LookerDataSourceSpec
      • LookerDataSourceSpecBuilder
      • DataSource
      • DataSourceChart
      • DataSourceColumn
      • DataSourceFormula
      • DataSourceParameter
      • DataSourcePivotTable
      • DataSourceRefreshSchedule
      • DataSourceRefreshScheduleFrequency
      • DataSourceSheet
      • DataSourceSheetFilter
      • DataSourceSpec
      • DataSourceSpecBuilder
      • DataSourceTable
      • DataSourceTableColumn
      • DataSourceTableFilter
    • DataValidation
    • DataValidationBuilder
    • DateTimeGroupingRule
    • DeveloperMetadata
    • DeveloperMetadataFinder
    • DeveloperMetadataLocation
    • Drawing
    • EmbeddedAreaChartBuilder
    • EmbeddedBarChartBuilder
    • EmbeddedChart
    • EmbeddedChartBuilder
    • EmbeddedColumnChartBuilder
    • EmbeddedComboChartBuilder
    • EmbeddedHistogramChartBuilder
    • EmbeddedLineChartBuilder
    • EmbeddedPieChartBuilder
    • EmbeddedScatterChartBuilder
    • EmbeddedTableChartBuilder
    • Filter
    • FilterCriteria
    • FilterCriteriaBuilder
    • GradientCondition
    • Group
    • NamedRange
    • OverGridImage
    • PageProtection
    • PivotFilter
    • PivotGroup
    • PivotGroupLimit
    • PivotTable
    • PivotValue
    • Protection
    • Range
    • RangeList
    • RichTextValue
    • RichTextValueBuilder
    • Selection
    • Sheet
    • Slicer
    • SortSpec
    • Spreadsheet
    • SpreadsheetTheme
    • TextFinder
    • TextRotation
    • TextStyle
    • TextStyleBuilder
    • ThemeColor
    • Enums
    • AutoFillSeries
    • BandingTheme
    • BooleanCriteria
    • BorderStyle
    • CopyPasteType
    • DataSource for Connected Sheets
      • DataExecutionErrorCode
      • DataExecutionState
      • DataSourceParameterType
      • DataSourceRefreshScope
      • DataSourceType
    • DataValidationCriteria
    • DateTimeGroupingRuleType
    • DeveloperMetadataLocationType
    • DeveloperMetadataVisibility
    • Dimension
    • Direction
    • FrequencyType
    • GroupControlTogglePosition
    • InterpolationType
    • PivotTableSummarizeFunction
    • PivotValueDisplayType
    • ProtectionType
    • RecalculationInterval
    • RelativeDate
    • SheetType
    • SortOrder
    • TextDirection
    • TextToColumnsDelimiter
    • ThemeColorType
    • ValueType
    • WrapStrategy
    • Advanced services
    • Sheets API
  • Slides
    • Overview
    • SlidesApp
    • Classes
    • AffineTransform
    • AffineTransformBuilder
    • AutoText
    • Autofit
    • Border
    • Color
    • ColorScheme
    • ConnectionSite
    • Fill
    • Group
    • Image
    • Layout
    • Line
    • LineFill
    • Link
    • List
    • ListStyle
    • Master
    • NotesMaster
    • NotesPage
    • Page
    • PageBackground
    • PageElement
    • PageElementRange
    • PageRange
    • Paragraph
    • ParagraphStyle
    • PictureFill
    • Point
    • Presentation
    • Selection
    • Shape
    • SheetsChart
    • Slide
    • SolidFill
    • SpeakerSpotlight
    • Table
    • TableCell
    • TableCellRange
    • TableColumn
    • TableRow
    • TextRange
    • TextStyle
    • ThemeColor
    • Video
    • WordArt
    • Enums
    • AlignmentPosition
    • ArrowStyle
    • AutoTextType
    • AutofitType
    • CellMergeState
    • ContentAlignment
    • DashStyle
    • FillType
    • LineCategory
    • LineFillType
    • LineType
    • LinkType
    • ListPreset
    • PageBackgroundType
    • PageElementType
    • PageType
    • ParagraphAlignment
    • PlaceholderType
    • PredefinedLayout
    • SelectionType
    • ShapeType
    • SheetsChartEmbedType
    • SlideLinkingMode
    • SlidePosition
    • SpacingMode
    • TextBaselineOffset
    • TextDirection
    • ThemeColorType
    • VideoSourceType
    • Advanced services
    • Slides API
  • Workspace
    • Advanced services
    • Events API
  • More...
    • Classroom
      • Advanced services
      • Classroom API
    • Groups
      • Overview
      • GroupsApp
      • Classes
      • Group
      • Enums
      • Role
      • Advanced services
      • Cloud Identity Groups API
      • Migrate from Groups Service
    • People
      • Advanced services
      • People API
      • Migrate from Contacts service
      • Contacts
      • Overview
      • ContactsApp
      • Classes
      • AddressField
      • CompanyField
      • Contact
      • ContactGroup
      • CustomField
      • DateField
      • EmailField
      • IMField
      • PhoneField
      • UrlField
      • Enums
      • ExtendedField
      • Field
      • Gender
      • Priority
      • Sensitivity
    • Tasks
      • Advanced services
      • Tasks API
  • Other Google services
  • Google Analytics
    • Advanced services
    • Analytics Data API
    • Analytics Admin API
  • Google Maps
    • Overview
    • Maps
    • Classes
    • DirectionFinder
    • DirectionFinderEnums
    • ElevationSampler
    • Geocoder
    • StaticMap
    • StaticMapEnums
    • Enums
    • Avoid
    • Color
    • Format
    • MarkerSize
    • Mode
    • Type
  • Google Translate
    • Overview
    • LanguageApp
  • YouTube
    • Advanced services
    • YouTube Data API
    • YouTube Analytics API
    • YouTube Content ID API
  • More...
    • Google Ads & Merchant Center
      • AdSense
        • Advanced services
        • AdSense Management API
      • Display & Video 360
        • Advanced services
        • DV360 API
      • DoubleClick Bid Manager
        • Advanced services
        • DBM Reporting API
      • DoubleClick Campaigns
        • Advanced services
        • DCM/DFA Reporting and Trafficking API
      • Shopping Content
        • Advanced services
        • Merchant API
        • Google Content API for Shopping
    • Google Data Studio
      • Overview
      • DataStudioApp
      • Classes
      • BigQueryConfig
      • Checkbox
      • CommunityConnector
      • Config
      • DebugError
      • Field
      • Fields
      • GetAuthTypeResponse
      • GetDataResponse
      • GetSchemaResponse
      • Info
      • OptionBuilder
      • SelectMultiple
      • SelectSingle
      • SetCredentialsResponse
      • TextArea
      • TextInput
      • UserError
      • Enums
      • AggregationType
      • AuthType
      • BigQueryParameterType
      • FieldType
    • Google Tables
      • Advanced services
      • Tables API
    • Google Tag Manager
      • Advanced services
      • Tag Manager API
  • Utility services
  • API & database connections
    • BigQuery
      • Advanced services
      • BigQuery API
    • JDBC
      • Overview
      • Jdbc
      • Classes
      • JdbcArray
      • JdbcBlob
      • JdbcCallableStatement
      • JdbcClob
      • JdbcConnection
      • JdbcDatabaseMetaData
      • JdbcDate
      • JdbcParameterMetaData
      • JdbcPreparedStatement
      • JdbcRef
      • JdbcResultSet
      • JdbcResultSetMetaData
      • JdbcRowId
      • JdbcSQLXML
      • JdbcSavepoint
      • JdbcStatement
      • JdbcStruct
      • JdbcTime
      • JdbcTimestamp
    • URL Fetch
      • Overview
      • UrlFetchApp
      • Classes
      • HTTPResponse
  • Data usability & optimization
    • Optimization
      • Overview
      • LinearOptimizationService
      • Classes
      • LinearOptimizationConstraint
      • LinearOptimizationEngine
      • LinearOptimizationSolution
      • Enums
      • Status
      • VariableType
    • Utilities
      • Overview
      • Utilities
      • Enums
      • Charset
      • DigestAlgorithm
      • MacAlgorithm
      • RsaAlgorithm
    • XML
      • Overview
      • XmlService
      • Classes
      • Attribute
      • Cdata
      • Comment
      • DocType
      • Document
      • Element
      • EntityRef
      • Format
      • Namespace
      • ProcessingInstruction
      • Text
      • Interfaces
      • Content
      • Enums
      • ContentType
  • HTML & content
    • Charts
      • Overview
      • Charts
      • Classes
      • AreaChartBuilder
      • BarChartBuilder
      • Chart
      • ChartOptions
      • ColumnChartBuilder
      • DataTable
      • DataTableBuilder
      • DataViewDefinition
      • DataViewDefinitionBuilder
      • LineChartBuilder
      • NumberRangeFilterBuilder
      • PieChartBuilder
      • ScatterChartBuilder
      • StringFilterBuilder
      • TableChartBuilder
      • TextStyle
      • TextStyleBuilder
      • Interfaces
      • DataTableSource
      • Enums
      • ChartHiddenDimensionStrategy
      • ChartMergeStrategy
      • ChartType
      • ColumnType
      • CurveStyle
      • MatchType
      • Orientation
      • PickerValuesLayout
      • PointStyle
      • Position
    • Content
      • Overview
      • ContentService
      • Classes
      • TextOutput
      • Enums
      • MimeType
    • HTML
      • Overview
      • google.script.history (client-side)
      • google.script.host (client-side)
      • google.script.run (client-side)
      • google.script.url (client-side)
      • HtmlService
      • Classes
      • HtmlOutput
      • HtmlOutputMetaTag
      • HtmlTemplate
      • Enums
      • SandboxMode
      • XFrameOptionsMode
    • Mail
      • Overview
      • MailApp
  • Script execution & information
    • Base
      • Overview
      • Browser
      • Logger
      • MimeType
      • Session
      • console
      • Classes
      • Blob
      • Menu
      • PromptResponse
      • RgbColor
      • Ui
      • User
      • Interfaces
      • BlobSource
      • Enums
      • Button