Esta página foi traduzida pela API Cloud Translation.

Base Service

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

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`	Esta classe fornece acesso a caixas de diálogo específicas do Planilhas Google.
`Button`	Um 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.
`ButtonSet`	Um 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`.
`ColorType`	Os tipos de cores
`Logger`	Essa classe permite que o desenvolvedor grave texto nos registros de depuração.
`Menu`	Um menu personalizado em uma instância da interface do usuário de um Google app.
`MimeType`	Uma enumeração que fornece acesso a declarações do tipo MIME sem digitar as strings explicitamente.
`Month`	Um enum 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 Google app.
`RgbColor`	Uma cor definida por canais de cores vermelho, verde e azul.
`Session`	A 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.
`Ui`	Uma 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.
`User`	Representação de um usuário, adequada para script.
`Weekday`	Um enum que representa os dias da semana.
`console`	Essa classe permite que o desenvolvedor grave registros no serviço Cloud Logging do Google Cloud Platform.

`Blob`

Métodos

Método	Tipo de retorno	Breve descrição
`copyBlob()`	`Blob`	Retorna uma cópia desse blob.
`getAs(contentType)`	`Blob`	Retorne 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()`	`String`	Extrai 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`	Recebe os dados desse blob como uma string com a codificação especificada.
`getName()`	`String`	Recebe o nome desse blob.
`isGoogleType()`	`Boolean`	Retorna indicando 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 nesse 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 desse blob.

`BlobSource`

Métodos

Método	Tipo de retorno	Breve descrição
`getAs(contentType)`	`Blob`	Retorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
`getBlob()`	`Blob`	Retorne os dados dentro desse 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`	Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
`inputBox(prompt, buttons)`	`String`	Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
`inputBox(title, prompt, buttons)`	`String`	Abre uma caixa de diálogo com uma caixa de entrada de texto no navegador do usuário.
`msgBox(prompt)`	`String`	Exibe uma caixa de diálogo com a mensagem fornecida e um botão "OK" no navegador do usuário.
`msgBox(prompt, buttons)`	`String`	Abre uma caixa de diálogo com a mensagem e os botões especificados no navegador do usuário.
`msgBox(title, prompt, buttons)`	`String`	Abre 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 padrão "Fechar" exibido na barra de título de todas as caixas de diálogo.
`OK`	`Enum`	Um botão "OK", indicando que uma operação deve continuar.
`CANCEL`	`Enum`	Um botão "Cancelar", indicando que uma operação não deve continuar.
`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 "Cancel", que permitem ao usuário prosseguir ou interromper 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 sim/não.
`YES_NO_CANCEL`	`Enum`	Um 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

Propriedade	Tipo	Descrição
`UNSUPPORTED`	`Enum`	Um tipo de cor que não é compatível.
`RGB`	`Enum`	Uma cor definida por canais de cores 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 a string no console de geração de registros.
`log(format, values)`	`Logger`	Grava uma string formatada no console de geração de registros, 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 para um arquivo do Desenhos Google.
`GOOGLE_DOCS`	`Enum`	Representação do tipo MIME para um arquivo do Documentos Google.
`GOOGLE_FORMS`	`Enum`	Representação do tipo MIME para um arquivo do Formulários Google.
`GOOGLE_SHEETS`	`Enum`	Representação do tipo MIME para um arquivo das Planilhas Google.
`GOOGLE_SITES`	`Enum`	Representação do tipo MIME para um arquivo do Google Sites.
`GOOGLE_SLIDES`	`Enum`	Representação do tipo MIME de um arquivo das Apresentações Google.
`FOLDER`	`Enum`	Representação do tipo MIME para uma pasta do Google Drive.
`SHORTCUT`	`Enum`	Representação do tipo MIME para um atalho do Google Drive.
`BMP`	`Enum`	Representação do tipo MIME para um arquivo de imagem BMP (normalmente .bmp).
`GIF`	`Enum`	Representação do tipo MIME para um arquivo de imagem GIF (normalmente .gif).
`JPEG`	`Enum`	Representação do tipo MIME para um arquivo de imagem JPEG (normalmente .jpg).
`PNG`	`Enum`	Representação do tipo MIME para um arquivo de imagem PNG (geralmente .png).
`SVG`	`Enum`	Representação do tipo MIME para um arquivo de imagem SVG (normalmente .svg).
`PDF`	`Enum`	Representação do tipo MIME para um arquivo PDF (normalmente .pdf).
`CSS`	`Enum`	Representação do tipo MIME para um arquivo de texto CSS (normalmente .css).
`CSV`	`Enum`	Representação do tipo MIME para um arquivo de texto CSV (normalmente .csv).
`HTML`	`Enum`	Representação do tipo MIME para um arquivo de texto HTML (normalmente .html).
`JAVASCRIPT`	`Enum`	Representação do tipo MIME para um arquivo de texto JavaScript (normalmente .js).
`PLAIN_TEXT`	`Enum`	Representação do tipo MIME para um arquivo de texto simples (normalmente .txt).
`RTF`	`Enum`	Representação do tipo MIME para um arquivo rich text (normalmente .rtf).
`OPENDOCUMENT_GRAPHICS`	`Enum`	Representação do tipo MIME para um arquivo gráfico OpenDocument (normalmente .odg).
`OPENDOCUMENT_PRESENTATION`	`Enum`	Representação do tipo MIME para um arquivo de apresentação OpenDocument (normalmente .odp).
`OPENDOCUMENT_SPREADSHEET`	`Enum`	Representação do tipo MIME para um arquivo de planilha OpenDocument (normalmente .ods).
`OPENDOCUMENT_TEXT`	`Enum`	Representação do tipo MIME para um arquivo de processamento de texto OpenDocument (normalmente .odt).
`MICROSOFT_EXCEL`	`Enum`	Representação do tipo MIME para um arquivo de planilha do Microsoft Excel (normalmente .xlsx).
`MICROSOFT_EXCEL_LEGACY`	`Enum`	Representação do tipo MIME para um arquivo legado do Microsoft Excel (geralmente .xls).
`MICROSOFT_POWERPOINT`	`Enum`	Representação do tipo MIME para um arquivo de apresentação do Microsoft PowerPoint (geralmente .pptx).
`MICROSOFT_POWERPOINT_LEGACY`	`Enum`	Representação do tipo MIME para um arquivo legado do Microsoft PowerPoint (geralmente .ppt).
`MICROSOFT_WORD`	`Enum`	Representação de tipo MIME para um arquivo de documento do Microsoft Word (normalmente .docx).
`MICROSOFT_WORD_LEGACY`	`Enum`	Representação do tipo MIME para um arquivo legado do Microsoft Word (normalmente .doc).
`ZIP`	`Enum`	Representação do tipo MIME para um arquivo ZIP (geralmente .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 (mês 5).
`JUNE`	`Enum`	Junho (mês 6).
`JULY`	`Enum`	Julho (mês 7).
`AUGUST`	`Enum`	Agosto (mês 8).
`SEPTEMBER`	`Enum`	Setembro (mês 9).
`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`	Extrai o texto que o usuário digitou no campo de entrada da caixa de diálogo.
`getSelectedButton()`	`Button`	Extrai 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 sete caracteres (#rrggbb) no estilo CSS ou uma string hexadecimal de nove caracteres (#aarrggbb).
`getBlue()`	`Integer`	O canal azul dessa cor, como um número de 0 a 255.
`getColorType()`	`ColorType`	Define 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`	Recebe 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 sob a autoridade de quem o script está sendo executado.
`getScriptTimeZone()`	`String`	Extrai o fuso horário do script.
`getTemporaryActiveUserKey()`	`String`	Recebe uma chave temporária que é exclusiva do usuário ativo, mas não revela a identidade do usuário.

`Ui`

Propriedades

Propriedade	Tipo	Descrição
`Button`	`Button`	Um 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.
`ButtonSet`	`ButtonSet`	Um 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étodo	Tipo de retorno	Breve descrição
`alert(prompt)`	`Button`	Abre uma caixa de diálogo no editor do usuário com a mensagem fornecida 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 fornecidos.
`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 fornecida 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 no lado do cliente.

`User`

Métodos

Método	Tipo de retorno	Breve descrição
`getEmail()`	`String`	Extrai 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`	na sexta-feira.
`SATURDAY`	`Enum`	sábado.

`console`

Métodos

Método	Tipo de retorno	Breve descrição
`error()`	`void`	Envia uma mensagem em branco no nível ERRO para o Stackdriver Logging.
`error(formatOrObject, values)`	`void`	Envia uma mensagem de nível ERRO 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 do DEBUG para o Stackdriver Logging.
`log(formatOrObject, values)`	`void`	Envia uma mensagem de nível DEBUG para o Stackdriver Logging.
`time(label)`	`void`	Inicia um timer que pode ser usado para monitorar a duração de uma operação.
`timeEnd(label)`	`void`	Interrompe um timer que foi iniciado anteriormente chamando `console.time()`.
`warn()`	`void`	Envia uma mensagem em branco de nível WARNING para o Stackdriver Logging.
`warn(formatOrObject, values)`	`void`	Envia uma mensagem de nível WARNING para o Stackdriver Logging.