Class DocumentApp

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
DocumentApp

O serviço Document cria e abre Documents que pode ser editado.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Propriedades

PropriedadeTipoDescrição
AttributeAttributeA enumeração Attribute.
ElementTypeElementTypeA enumeração ElementType.
FontFamilyFontFamilyA enumeração FontFamily.
GlyphTypeGlyphTypeA enumeração GlyphType.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
ParagraphHeadingParagraphHeadingA enumeração ParagraphHeading.
PositionedLayoutPositionedLayoutA enumeração PositionedLayout.
TextAlignmentTextAlignmentA enumeração TextAlignment.
VerticalAlignmentVerticalAlignmentA enumeração VerticalAlignment.

Métodos

MétodoTipo de retornoBreve descrição
create(name)DocumentCria e retorna um novo documento.
getActiveDocument()DocumentRetorna o documento em que o script é vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente da interface do usuário do documento que permite que o script adicione recursos, como menus, caixas de diálogo e barras laterais.
openById(id)DocumentRetorna o documento com o ID especificado.
openByUrl(url)DocumentAbre e retorna o documento com o URL especificado.

Documentação detalhada

create(name)

Cria e retorna um novo documento.

// Create and open a new document.
var doc = DocumentApp.create('Document Name');

Parâmetros

NomeTipoDescrição
nameStringo nome do novo documento;

Retornar

Document: a nova instância do documento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents

getActiveDocument()

Retorna o documento em que o script é vinculado ao contêiner. Para interagir com o documento a que o script não está vinculado por contêiner, use openById(id) ou openByUrl(url).

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

Retornar

Document: a instância do documento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getUi()

Retorna uma instância do ambiente da interface do usuário do documento que permite que o script adicione recursos, como menus, caixas de diálogo e barras laterais. Um script só pode interagir com a IU para a instância atual de um documento aberto e somente se o script estiver vinculado ao documento. Para mais informações, consulte os guias sobre menus e caixas de diálogo e barras laterais.

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Retornar

Ui: uma instância do ambiente da interface do usuário deste documento


openById(id)

Retorna o documento com o ID especificado. Se o script estiver vinculado ao contêiner do documento, use getActiveDocument().

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

Parâmetros

NomeTipoDescrição
idStringID do documento a ser aberto

Retornar

Document: a instância do documento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents

openByUrl(url)

Abre e retorna o documento com o URL especificado. Se o script estiver vinculado ao contêiner do documento, use getActiveDocument().

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

Parâmetros

NomeTipoDescrição
urlStringo URL do documento a ser aberto

Retornar

Document: a instância do documento

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/documents