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 os registros de scripts e as caixas de diálogo nos apps do Google Workspace.

Aulas

NomeBreve descrição
BlobUm objeto de troca de dados para serviços do Apps Script.
BlobSourceInterface para objetos que podem exportar dados como um Blob.
BrowserEsta classe fornece acesso a caixas de diálogo específicas do Planilhas Google.
ButtonUm tipo enumerado que representa botões de caixas de diálogo predeterminados e localizados retornados por um alert ou PromptResponse.getSelectedButton() para indicar em qual botão em uma caixa de diálogo o usuário clicou.
ButtonSetUm tipo enumerado que representa conjuntos predeterminados e localizados de um ou mais botões de caixa de diálogo que podem ser adicionados a um alert ou um prompt.
ColorTypeOs tipos de cores
LoggerEssa classe permite que o desenvolvedor grave texto nos registros de depuração.
MenuUm menu personalizado em uma instância da interface do usuário de um Google app.
MimeTypeUma enumeração que fornece acesso a declarações do tipo MIME sem digitar as strings explicitamente.
MonthUm enum que representa os meses do ano.
PromptResponseUma resposta a uma caixa de diálogo prompt exibida no ambiente da interface do usuário de um Google app.
RgbColorUma cor definida por canais de cores vermelho, verde e azul.
SessionA classe Session fornece 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.
UiUma instância do ambiente da interface do usuário para um Google app que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais.
UserRepresentação de um usuário, adequada para script.
WeekdayUm enum que representa os dias da semana.
consoleEssa classe permite que o desenvolvedor grave registros no serviço Cloud Logging do Google Cloud Platform.

Blob

Métodos

MétodoTipo de retornoBreve descrição
copyBlob()BlobRetorna uma cópia desse blob.
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBytes()Byte[]Recebe os dados armazenados neste blob.
getContentType()StringExtrai o tipo de conteúdo dos bytes neste blob.
getDataAsString()StringRecebe os dados desse blob como uma String com codificação UTF-8.
getDataAsString(charset)StringRecebe os dados desse blob como uma string com a codificação especificada.
getName()StringRecebe o nome desse blob.
isGoogleType()BooleanRetorna indicando se o blob é um arquivo do Google Workspace (Planilhas, Documentos etc.).
setBytes(data)BlobDefine os dados armazenados neste blob.
setContentType(contentType)BlobDefine o tipo de conteúdo dos bytes neste blob.
setContentTypeFromExtension()BlobDefine o tipo de conteúdo dos bytes nesse blob com base na extensão do arquivo.
setDataFromString(string)BlobDefine os dados desse blob de uma string com codificação UTF-8.
setDataFromString(string, charset)BlobDefine os dados desse blob de uma string com a codificação especificada.
setName(name)BlobDefine o nome desse blob.

BlobSource

Métodos

MétodoTipo de retornoBreve descrição
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.

Browser

Propriedades

PropriedadeTipoDescrição
ButtonsButtonSet

Métodos

MétodoTipo de retornoBreve descrição
inputBox(prompt)StringAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(prompt, buttons)StringAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
inputBox(title, prompt, buttons)StringAbre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
msgBox(prompt)StringExibe uma caixa de diálogo com a mensagem fornecida e um botão "OK" no navegador do usuário.
msgBox(prompt, buttons)StringAbre uma caixa de diálogo com a mensagem e os botões especificados no navegador do usuário.
msgBox(title, prompt, buttons)StringAbre uma caixa de diálogo com o título, a mensagem e os botões especificados no navegador do usuário.

Button

Propriedades

PropriedadeTipoDescrição
CLOSEEnumO botão padrão "Fechar" exibido na barra de título de todas as caixas de diálogo.
OKEnumUm botão "OK", indicando que uma operação deve continuar.
CANCELEnumUm botão "Cancelar", indicando que uma operação não deve continuar.
YESEnumUm botão "Sim", indicando uma resposta positiva a uma pergunta.
NOEnumUm botão "Não", indicando uma resposta negativa a uma pergunta.

ButtonSet

Propriedades

PropriedadeTipoDescrição
OKEnumUm único botão "OK", indicando uma mensagem informativa que só pode ser dispensada.
OK_CANCELEnumUm botão "OK" e um "Cancel", que permitem ao usuário prosseguir ou interromper uma operação.
YES_NOEnumUm botão "Sim" e um botão "Não", permitindo que o usuário responda a uma pergunta sim/não.
YES_NO_CANCELEnumUm botão "Sim", um "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

PropriedadeTipoDescrição
UNSUPPORTEDEnumUm tipo de cor que não é compatível.
RGBEnumUma cor definida por canais de cores vermelho, verde e azul.
THEMEEnumUma cor que se refere a uma entrada no esquema de cores do tema.

Logger

Métodos

MétodoTipo de retornoBreve descrição
clear()voidLimpa o registro.
getLog()StringRetorna uma lista completa de mensagens no registro atual.
log(data)LoggerGrava a string no console de geração de registros.
log(format, values)LoggerGrava uma string formatada no console de geração de registros, usando o formato e os valores fornecidos.

Métodos

MétodoTipo de retornoBreve descrição
addItem(caption, functionName)MenuAdiciona um item ao menu.
addSeparator()MenuAdiciona um separador visual ao menu.
addSubMenu(menu)MenuAdiciona um submenu ao menu.
addToUi()voidInsere o menu na instância da interface do usuário do editor.

MimeType

Propriedades

PropriedadeTipoDescrição
GOOGLE_APPS_SCRIPTEnumRepresentação do tipo MIME para um projeto do Google Apps Script.
GOOGLE_DRAWINGSEnumRepresentação do tipo MIME para um arquivo do Desenhos Google.
GOOGLE_DOCSEnumRepresentação do tipo MIME para um arquivo do Documentos Google.
GOOGLE_FORMSEnumRepresentação do tipo MIME para um arquivo do Formulários Google.
GOOGLE_SHEETSEnumRepresentação do tipo MIME para um arquivo das Planilhas Google.
GOOGLE_SITESEnumRepresentação do tipo MIME para um arquivo do Google Sites.
GOOGLE_SLIDESEnumRepresentação do tipo MIME de um arquivo das Apresentações Google.
FOLDEREnumRepresentação do tipo MIME para uma pasta do Google Drive.
SHORTCUTEnumRepresentação do tipo MIME para um atalho do Google Drive.
BMPEnumRepresentação do tipo MIME para um arquivo de imagem BMP (normalmente .bmp).
GIFEnumRepresentação do tipo MIME para um arquivo de imagem GIF (normalmente .gif).
JPEGEnumRepresentação do tipo MIME para um arquivo de imagem JPEG (normalmente .jpg).
PNGEnumRepresentação do tipo MIME para um arquivo de imagem PNG (geralmente .png).
SVGEnumRepresentação do tipo MIME para um arquivo de imagem SVG (normalmente .svg).
PDFEnumRepresentação do tipo MIME para um arquivo PDF (normalmente .pdf).
CSSEnumRepresentação do tipo MIME para um arquivo de texto CSS (normalmente .css).
CSVEnumRepresentação do tipo MIME para um arquivo de texto CSV (normalmente .csv).
HTMLEnumRepresentação do tipo MIME para um arquivo de texto HTML (normalmente .html).
JAVASCRIPTEnumRepresentação do tipo MIME para um arquivo de texto JavaScript (normalmente .js).
PLAIN_TEXTEnumRepresentação do tipo MIME para um arquivo de texto simples (normalmente .txt).
RTFEnumRepresentação do tipo MIME para um arquivo rich text (normalmente .rtf).
OPENDOCUMENT_GRAPHICSEnumRepresentação do tipo MIME para um arquivo gráfico OpenDocument (normalmente .odg).
OPENDOCUMENT_PRESENTATIONEnumRepresentação do tipo MIME para um arquivo de apresentação OpenDocument (normalmente .odp).
OPENDOCUMENT_SPREADSHEETEnumRepresentação do tipo MIME para um arquivo de planilha OpenDocument (normalmente .ods).
OPENDOCUMENT_TEXTEnumRepresentação do tipo MIME para um arquivo de processamento de texto OpenDocument (normalmente .odt).
MICROSOFT_EXCELEnumRepresentação do tipo MIME para um arquivo de planilha do Microsoft Excel (normalmente .xlsx).
MICROSOFT_EXCEL_LEGACYEnumRepresentação do tipo MIME para um arquivo legado do Microsoft Excel (geralmente .xls).
MICROSOFT_POWERPOINTEnumRepresentação do tipo MIME para um arquivo de apresentação do Microsoft PowerPoint (geralmente .pptx).
MICROSOFT_POWERPOINT_LEGACYEnumRepresentação do tipo MIME para um arquivo legado do Microsoft PowerPoint (geralmente .ppt).
MICROSOFT_WORDEnumRepresentação de tipo MIME para um arquivo de documento do Microsoft Word (normalmente .docx).
MICROSOFT_WORD_LEGACYEnumRepresentação do tipo MIME para um arquivo legado do Microsoft Word (normalmente .doc).
ZIPEnumRepresentação do tipo MIME para um arquivo ZIP (geralmente .zip).

Month

Propriedades

PropriedadeTipoDescrição
JANUARYEnumJaneiro (mês 1).
FEBRUARYEnumFevereiro (mês 2).
MARCHEnumMarço (mês 3).
APRILEnumAbril (mês 4).
MAYEnumMaio (mês 5).
JUNEEnumJunho (mês 6).
JULYEnumJulho (mês 7).
AUGUSTEnumAgosto (mês 8).
SEPTEMBEREnumSetembro (mês 9).
OCTOBEREnumOutubro (mês 10).
NOVEMBEREnumNovembro (mês 11).
DECEMBEREnumDezembro (mês 12).

PromptResponse

Métodos

MétodoTipo de retornoBreve descrição
getResponseText()StringExtrai o texto que o usuário digitou no campo de entrada da caixa de diálogo.
getSelectedButton()ButtonExtrai o botão em que o usuário clicou para dispensar a caixa de diálogo.

RgbColor

Métodos

MétodoTipo de retornoBreve descrição
asHexString()StringRetorna a cor como uma string hexadecimal de sete caracteres (#rrggbb) no estilo CSS ou uma string hexadecimal de nove caracteres (#aarrggbb).
getBlue()IntegerO canal azul dessa cor, como um número de 0 a 255.
getColorType()ColorTypeDefine o tipo dessa cor.
getGreen()IntegerO canal verde dessa cor, como um número de 0 a 255.
getRed()IntegerO canal vermelho dessa cor, como um número de 0 a 255.

Session

Métodos

MétodoTipo de retornoBreve descrição
getActiveUser()UserRecebe informações sobre o usuário atual.
getActiveUserLocale()StringRecebe a configuração de idioma do usuário atual como uma string. Por exemplo, en para inglês.
getEffectiveUser()UserRecebe informações sobre o usuário sob a autoridade de quem o script está sendo executado.
getScriptTimeZone()StringExtrai o fuso horário do script.
getTemporaryActiveUserKey()StringRecebe uma chave temporária que é exclusiva do usuário ativo, mas não revela a identidade do usuário.

Ui

Propriedades

PropriedadeTipoDescrição
ButtonButtonUm tipo enumerado que representa botões de caixas de diálogo predeterminados e localizados retornados por um alerta ou PromptResponse.getSelectedButton() para indicar em qual botão em uma caixa de diálogo o usuário clicou.
ButtonSetButtonSetUm tipo enumerado que representa conjuntos predeterminados e localizados de um ou mais botões de caixa de diálogo que podem ser adicionados a um alerta ou um comando.

Métodos

MétodoTipo de retornoBreve descrição
alert(prompt)ButtonAbre uma caixa de diálogo no editor do usuário com a mensagem fornecida e um botão "OK".
alert(prompt, buttons)ButtonAbre uma caixa de diálogo no editor do usuário com a mensagem e o conjunto de botões fornecidos.
alert(title, prompt, buttons)ButtonAbre uma caixa de diálogo no editor do usuário com o título, a mensagem e o conjunto de botões fornecidos.
createAddonMenu()MenuCria um builder que pode ser usado para inserir um submenu no menu "Extensões" do editor.
createMenu(caption)MenuCria um builder que pode ser usado para adicionar um menu à interface do usuário do editor.
prompt(prompt)PromptResponseAbre uma caixa de diálogo de entrada no editor do usuário com a mensagem fornecida e um botão "OK".
prompt(prompt, buttons)PromptResponseAbre 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)PromptResponseAbre 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)voidAbre uma caixa de diálogo modal no editor do usuário com conteúdo personalizado do lado do cliente.
showModelessDialog(userInterface, title)voidAbre uma caixa de diálogo sem modo no editor do usuário com conteúdo personalizado do lado do cliente.
showSidebar(userInterface)voidAbre uma barra lateral no editor do usuário com conteúdo personalizado no lado do cliente.

User

Métodos

MétodoTipo de retornoBreve descrição
getEmail()StringExtrai o endereço de e-mail do usuário, se disponível.

Weekday

Propriedades

PropriedadeTipoDescrição
SUNDAYEnumdomingo.
MONDAYEnumsegunda-feira.
TUESDAYEnumterça-feira.
WEDNESDAYEnumquarta-feira.
THURSDAYEnumquinta-feira.
FRIDAYEnumna sexta-feira.
SATURDAYEnumsábado.

console

Métodos

MétodoTipo de retornoBreve descrição
error()voidEnvia uma mensagem em branco no nível ERRO para o Stackdriver Logging.
error(formatOrObject, values)voidEnvia uma mensagem de nível ERRO para o Stackdriver Logging.
info()voidEnvia uma mensagem de nível INFO em branco para o Stackdriver Logging.
info(formatOrObject, values)voidEnvia uma mensagem de nível INFO para o Stackdriver Logging.
log()voidEnvia uma mensagem em branco no nível do DEBUG para o Stackdriver Logging.
log(formatOrObject, values)voidEnvia uma mensagem de nível DEBUG para o Stackdriver Logging.
time(label)voidInicia um timer que pode ser usado para monitorar a duração de uma operação.
timeEnd(label)voidInterrompe um timer que foi iniciado anteriormente chamando console.time().
warn()voidEnvia uma mensagem em branco de nível WARNING para o Stackdriver Logging.
warn(formatOrObject, values)voidEnvia uma mensagem de nível WARNING para o Stackdriver Logging.