Base Service

Camadas

Esse serviço fornece acesso a informações do usuário, como endereços de e-mail e nomes de usuário. Ele também controla registros de script e caixas de diálogo em aplicativos do Google Workspace.

Classes

Nome	Breve descrição
Blob	Um objeto de troca de dados para serviços do Apps Script.
BlobSource	Interface para objetos que podem exportar dados como um Blob.
Browser	Essa classe fornece acesso a caixas de diálogo específicas das Planilhas Google.
Button	Um tipo enumerado que representa botões de diálogo localizados e predeterminados retornados por um alert ou PromptResponse.getSelectedButton() para indicar em qual botão em uma caixa de diálogo o usuário clicou.
ButtonSet	Um tipo enumerado que representa conjuntos localizados predefinidos de um ou mais botões de caixa de diálogo que podem ser adicionados a um alert ou a um prompt.
ColorType	Tipos de cores
Logger	Essa classe permite que o desenvolvedor grave no registro de execução e no Google Cloud Logging se o script estiver associado a um projeto padrão do Cloud.
Menu	Um menu personalizado em uma instância da interface do usuário de um app do Google.
MimeType	Uma enumeração que fornece acesso a declarações de tipo MIME sem digitar as strings explicitamente.
Month	Um tipo enumerado que representa os meses do ano.
PromptResponse	Uma resposta a uma caixa de diálogo prompt exibida no ambiente da interface do usuário de um app do Google.
RgbColor	Uma cor definida por canais de cor vermelho, verde e azul.
Session	A classe Session oferece acesso às informações da sessão, como o endereço de e-mail do usuário (em algumas circunstâncias) e a configuração de idioma.
Ui	Uma instância do ambiente de interface do usuário de um app Google que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais.
User	Representação de um usuário, adequada para programação.
Weekday	Um tipo enumerado que representa os dias da semana.
console	Essa classe permite que o desenvolvedor grave no registro de execução e no Google Cloud Logging se o script estiver associado a um projeto padrão do Cloud.

Blob

Métodos

Método	Tipo de retorno	Breve descrição
copyBlob()	Blob	Retorna uma cópia desse blob.
getAs(contentType)	Blob	Retorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()	Byte[]	Consegue os dados armazenados neste blob.
getContentType()	String	Recebe o tipo de conteúdo dos bytes neste blob.
getDataAsString()	String	Recebe os dados desse blob como uma string com codificação UTF-8.
getDataAsString(charset)	String	Consegue os dados desse blob como uma string com a codificação especificada.
getName()	String	Extrai o nome desse blob.
isGoogleType()	Boolean	Retorna se o blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).
setBytes(data)	Blob	Define os dados armazenados neste blob.
setContentType(contentType)	Blob	Define o tipo de conteúdo dos bytes neste blob.
setContentTypeFromExtension()	Blob	Define o tipo de conteúdo dos bytes neste blob com base na extensão do arquivo.
setDataFromString(string)	Blob	Define os dados desse blob de uma string com codificação UTF-8.
setDataFromString(string, charset)	Blob	Define os dados desse blob de uma string com a codificação especificada.
setName(name)	Blob	Define o nome do blob.

BlobSource

Métodos

Método	Tipo de retorno	Breve descrição
getAs(contentType)	Blob	Retorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()	Blob	Retorne os dados dentro deste objeto como um blob.

Browser

Propriedades

Propriedade	Tipo	Descrição
Buttons	ButtonSet

Métodos

Método	Tipo de retorno	Breve descrição
inputBox(prompt)	String	Mostra uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(prompt, buttons)	String	Mostra uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(title, prompt, buttons)	String	Mostra uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
msgBox(prompt)	String	Mostra uma caixa de diálogo com a mensagem e um botão "OK" no navegador do usuário.
msgBox(prompt, buttons)	String	Mostra uma caixa de diálogo com a mensagem e os botões especificados no navegador do usuário.
msgBox(title, prompt, buttons)	String	Mostra uma caixa de diálogo com o título, a mensagem e os botões especificados no navegador do usuário.

Button

Propriedades

Propriedade	Tipo	Descrição
CLOSE	Enum	O botão de fechar padrão exibido na barra de título de cada caixa de diálogo.
OK	Enum	Um botão "OK", indicando que uma operação precisa ser realizada.
CANCEL	Enum	Um botão "Cancelar", indicando que uma operação não deve ser realizada.
YES	Enum	Um botão "Sim", indicando uma resposta positiva a uma pergunta.
NO	Enum	Um botão "Não", indicando uma resposta negativa a uma pergunta.

ButtonSet

Propriedades

Propriedade	Tipo	Descrição
OK	Enum	Um único botão "OK", indicando uma mensagem informativa que só pode ser dispensada.
OK_CANCEL	Enum	Um botão "OK" e um botão "Cancelar", permitindo que o usuário prossiga ou interrompa uma operação.
YES_NO	Enum	Um botão "Sim" e um botão "Não", permitindo que o usuário responda a uma pergunta do tipo sim/não.
YES_NO_CANCEL	Enum	Um botão "Sim", um botão "Não" e um botão "Cancelar", permitindo que o usuário responda a uma pergunta sim/não ou interrompa uma operação.

ColorType

Propriedades

Propriedade	Tipo	Descrição
UNSUPPORTED	Enum	Um tipo de cor que não é aceito.
RGB	Enum	Uma cor definida por canais de cor vermelho, verde e azul.
THEME	Enum	Uma cor que se refere a uma entrada no esquema de cores do tema.

Logger

Métodos

Método	Tipo de retorno	Breve descrição
clear()	void	Limpa o registro.
getLog()	String	Retorna uma lista completa de mensagens no registro atual.
log(data)	Logger	Grava os dados no registro.
log(format, values)	Logger	Grava uma string formatada no console de registro usando o formato e os valores fornecidos.

Menu

Métodos

Método	Tipo de retorno	Breve descrição
addItem(caption, functionName)	Menu	Adiciona um item ao menu.
addSeparator()	Menu	Adiciona um separador visual ao menu.
addSubMenu(menu)	Menu	Adiciona um submenu ao menu.
addToUi()	void	Insere o menu na instância da interface do usuário do editor.

MimeType

Propriedades

Propriedade	Tipo	Descrição
GOOGLE_APPS_SCRIPT	Enum	Representação do tipo MIME para um projeto do Google Apps Script.
GOOGLE_DRAWINGS	Enum	Representação do tipo MIME de um arquivo do Google Desenhos.
GOOGLE_DOCS	Enum	Representação do tipo MIME de um arquivo do Documentos Google.
GOOGLE_FORMS	Enum	Representação do tipo MIME de um arquivo do Google Forms.
GOOGLE_SHEETS	Enum	Representação do tipo MIME de um arquivo das Planilhas Google.
GOOGLE_SITES	Enum	Representação do tipo MIME de um arquivo do Google Sites.
GOOGLE_SLIDES	Enum	Representação do tipo MIME de um arquivo do Apresentações Google.
FOLDER	Enum	Representação do tipo MIME de uma pasta do Google Drive.
SHORTCUT	Enum	Representação do tipo MIME de um atalho do Google Drive.
BMP	Enum	Representação do tipo MIME de um arquivo de imagem BMP (normalmente .bmp).
GIF	Enum	Representação do tipo MIME de um arquivo de imagem GIF (normalmente .gif).
JPEG	Enum	Representação do tipo MIME de um arquivo de imagem JPEG (normalmente .jpg).
PNG	Enum	Representação do tipo MIME de um arquivo de imagem PNG (normalmente .png).
SVG	Enum	Representação do tipo MIME de um arquivo de imagem SVG (normalmente .svg).
PDF	Enum	Representação do tipo MIME de um arquivo PDF (geralmente .pdf).
CSS	Enum	Representação do tipo MIME de um arquivo de texto CSS (normalmente .css).
CSV	Enum	Representação do tipo MIME de um arquivo de texto CSV (geralmente .csv).
HTML	Enum	Representação do tipo MIME de um arquivo de texto HTML (normalmente .html).
JAVASCRIPT	Enum	Representação do tipo MIME de um arquivo de texto JavaScript (normalmente .js).
PLAIN_TEXT	Enum	Representação do tipo MIME de um arquivo de texto simples (normalmente .txt).
RTF	Enum	Representação do tipo MIME de um arquivo de texto enriquecido (normalmente .rtf).
OPENDOCUMENT_GRAPHICS	Enum	Representação do tipo MIME de um arquivo de gráficos OpenDocument (normalmente .odg).
OPENDOCUMENT_PRESENTATION	Enum	Representação do tipo MIME de um arquivo de apresentação do OpenDocument (normalmente .odp).
OPENDOCUMENT_SPREADSHEET	Enum	Representação do tipo MIME de um arquivo de planilha OpenDocument (normalmente .ods).
OPENDOCUMENT_TEXT	Enum	Representação do tipo MIME de um arquivo de processamento de texto do OpenDocument (normalmente .odt).
MICROSOFT_EXCEL	Enum	Representação do tipo MIME de um arquivo de planilha do Microsoft Excel (normalmente .xlsx).
MICROSOFT_EXCEL_LEGACY	Enum	Representação do tipo MIME de um arquivo legado do Microsoft Excel (normalmente .xls).
MICROSOFT_POWERPOINT	Enum	Representação do tipo MIME de um arquivo de apresentação do Microsoft PowerPoint (normalmente .pptx).
MICROSOFT_POWERPOINT_LEGACY	Enum	Representação do tipo MIME de um arquivo legado do Microsoft PowerPoint (normalmente .ppt).
MICROSOFT_WORD	Enum	Representação do tipo MIME de um arquivo de documento do Microsoft Word (normalmente .docx).
MICROSOFT_WORD_LEGACY	Enum	Representação do tipo MIME de um arquivo legado do Microsoft Word (normalmente .doc).
ZIP	Enum	Representação do tipo MIME de um arquivo ZIP (normalmente .zip).

Month

Propriedades

Propriedade	Tipo	Descrição
JANUARY	Enum	Janeiro (mês 1).
FEBRUARY	Enum	Fevereiro (mês 2).
MARCH	Enum	Março (mês 3).
APRIL	Enum	Abril (mês 4).
MAY	Enum	Maio (5º mês).
JUNE	Enum	Junho (mês 6).
JULY	Enum	Julho (mês 7).
AUGUST	Enum	Agosto (mês 8).
SEPTEMBER	Enum	Setembro (9º mês).
OCTOBER	Enum	Outubro (mês 10).
NOVEMBER	Enum	Novembro (mês 11).
DECEMBER	Enum	Dezembro (mês 12).

PromptResponse

Métodos

Método	Tipo de retorno	Breve descrição
getResponseText()	String	Recebe o texto que o usuário digitou no campo de entrada da caixa de diálogo.
getSelectedButton()	Button	Recebe o botão em que o usuário clicou para dispensar a caixa de diálogo.

RgbColor

Métodos

Método	Tipo de retorno	Breve descrição
asHexString()	String	Retorna a cor como uma string hexadecimal de 7 caracteres no estilo CSS (#rrggbb) ou uma string hexadecimal de 9 caracteres (#aarrggbb).
getBlue()	Integer	O canal azul dessa cor, como um número de 0 a 255.
getColorType()	ColorType	Receba o tipo dessa cor.
getGreen()	Integer	O canal verde dessa cor, como um número de 0 a 255.
getRed()	Integer	O canal vermelho dessa cor, como um número de 0 a 255.

Session

Métodos

Método	Tipo de retorno	Breve descrição
getActiveUser()	User	Recebe informações sobre o usuário atual.
getActiveUserLocale()	String	Extrai a configuração de idioma do usuário atual como uma string, por exemplo, en para inglês.
getEffectiveUser()	User	Recebe informações sobre o usuário com autoridade para executar o script.
getScriptTimeZone()	String	Recebe o fuso horário do script.
getTemporaryActiveUserKey()	String	Recebe uma chave temporária exclusiva para o usuário ativo, mas que não revela a identidade dele.

Ui

Propriedades

Propriedade	Tipo	Descrição
Button	Button	Um tipo enumerado que representa botões de diálogo localizados e predeterminados retornados por um alert ou PromptResponse.getSelectedButton() para indicar em qual botão em uma caixa de diálogo o usuário clicou.
ButtonSet	ButtonSet	Um tipo enumerado que representa conjuntos localizados e predefinidos de um ou mais botões de caixa de diálogo que podem ser adicionados a um alerta ou a um prompt.

Métodos

Método	Tipo de retorno	Breve descrição
alert(prompt)	Button	Abre uma caixa de diálogo no editor do usuário com a mensagem e um botão "OK".
alert(prompt, buttons)	Button	Abre uma caixa de diálogo no editor do usuário com a mensagem e o conjunto de botões fornecidos.
alert(title, prompt, buttons)	Button	Abre uma caixa de diálogo no editor do usuário com o título, a mensagem e o conjunto de botões especificados.
createAddonMenu()	Menu	Cria um builder que pode ser usado para inserir um submenu no menu "Extensões" do editor.
createMenu(caption)	Menu	Cria um builder que pode ser usado para adicionar um menu à interface do usuário do editor.
prompt(prompt)	PromptResponse	Abre uma caixa de diálogo de entrada no editor do usuário com a mensagem especificada e um botão "OK".
prompt(prompt, buttons)	PromptResponse	Abre uma caixa de diálogo de entrada no editor do usuário com a mensagem e o conjunto de botões fornecidos.
prompt(title, prompt, buttons)	PromptResponse	Abre uma caixa de diálogo de entrada no editor do usuário com o título, a mensagem e o conjunto de botões fornecidos.
showModalDialog(userInterface, title)	void	Abre uma caixa de diálogo modal no editor do usuário com conteúdo personalizado do lado do cliente.
showModelessDialog(userInterface, title)	void	Abre uma caixa de diálogo sem modo no editor do usuário com conteúdo personalizado do lado do cliente.
showSidebar(userInterface)	void	Abre uma barra lateral no editor do usuário com conteúdo personalizado do lado do cliente.

User

Métodos

Método	Tipo de retorno	Breve descrição
getEmail()	String	Retorna o endereço de e-mail do usuário, se disponível.

Weekday

Propriedades

Propriedade	Tipo	Descrição
SUNDAY	Enum	Domingo.
MONDAY	Enum	Segunda-feira.
TUESDAY	Enum	Terça-feira.
WEDNESDAY	Enum	Quarta-feira.
THURSDAY	Enum	quinta-feira.
FRIDAY	Enum	Sexta-feira.
SATURDAY	Enum	sábado.

console

Métodos

Método	Tipo de retorno	Breve descrição
error()	void	Envia uma mensagem em branco de nível de ERRO para o Stackdriver Logging.
error(formatOrObject, values)	void	Envia uma mensagem de nível ERROR para o Stackdriver Logging.
info()	void	Envia uma mensagem de nível INFO em branco para o Stackdriver Logging.
info(formatOrObject, values)	void	Envia uma mensagem de nível INFO para o Stackdriver Logging.
log()	void	Envia uma mensagem em branco no nível DEBUG para o Stackdriver Logging.
log(formatOrObject, values)	void	Gera uma mensagem de nível DEBUG para o Stackdriver Logging.
time(label)	void	Inicia um cronômetro que pode ser usado para acompanhar o tempo de uma operação.
timeEnd(label)	void	Parar um timer que foi iniciado anteriormente chamando console.time().
warn()	void	Envia uma mensagem em branco de nível de ALERTA para o Stackdriver Logging.
warn(formatOrObject, values)	void	Envia uma mensagem de nível WARNING para o Stackdriver Logging.