Esta página foi traduzida pela API Cloud Translation.

Class DocumentApp

O serviço de documentos cria e abre Documents que podem ser editados.

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

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

Propriedades

Propriedade	Tipo	Descrição
`Attribute`	`Attribute`	A enumeração `Attribute`.
`ElementType`	`ElementType`	A enumeração `ElementType`.
`FontFamily`	`FontFamily`	A enumeração `FontFamily`.
`GlyphType`	`GlyphType`	A enumeração `GlyphType`.
`HorizontalAlignment`	`HorizontalAlignment`	A enumeração `HorizontalAlignment`.
`ParagraphHeading`	`ParagraphHeading`	A enumeração `ParagraphHeading`.
`PositionedLayout`	`PositionedLayout`	A enumeração `PositionedLayout`.
`TextAlignment`	`TextAlignment`	A enumeração `TextAlignment`.
`VerticalAlignment`	`VerticalAlignment`	A enumeração `VerticalAlignment`.

Métodos

Método	Tipo de retorno	Breve descrição
`create(name)`	`Document`	Cria e retorna um novo documento.
`getActiveDocument()`	`Document`	Retorna o documento ao qual o script está vinculado ao contêiner.
`getUi()`	`Ui`	Retorna uma instância do ambiente de interface do usuário do documento que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais.
`openById(id)`	`Document`	Retorna o documento com o ID especificado.
`openByUrl(url)`	`Document`	Abre 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

Nome	Tipo	Descrição
`name`	`String`	do novo nome do documento

Retorno

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 ao qual o script está vinculado ao contêiner. Para interagir com o documento ao qual o script não está vinculado ao contêiner, use openById(id) ou openByUrl(url).

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

Retorno

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 de interface do usuário do documento que permite ao script adicionar recursos como menus, caixas de diálogo e barras laterais. Um script só pode interagir com a IU da instância atual de um documento aberto e somente se o script estiver vinculado ao documento. Para saber mais, 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();
}

Retorno

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 documento, use getActiveDocument().

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

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	o ID do documento a ser aberto

Retorno

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 ao documento, use getActiveDocument().

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

Parâmetros

Nome	Tipo	Descrição
`url`	`String`	o URL do documento a ser aberto

Retorno

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