Esta página foi traduzida pela API Cloud Translation.

Class Document

Um documento que contém um ou mais objetos Tab, cada um deles com texto e elementos avançados, como tabelas e listas.

Os documentos podem ser abertos ou criados usando DocumentApp.

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

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

Os métodos na classe Document que acessam e modificam diretamente o conteúdo de texto operam na guia ativa (em scripts vinculados a um documento específico) ou na primeira guia (se uma ativa não estiver disponível). Os scripts que dependem desses métodos (por exemplo, getBody()) podem ser migrados para oferecer suporte a guias usando getTabs() e, em seguida, Tab.asDocumentTab().

Métodos

Método	Tipo de retorno	Breve descrição
`addBookmark(position)`	`Bookmark`	Adiciona uma `Bookmark` na `Position` especificada à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
`addEditor(emailAddress)`	`Document`	Adiciona o usuário à lista de editores do `Document`.
`addEditor(user)`	`Document`	Adiciona o usuário à lista de editores do `Document`.
`addEditors(emailAddresses)`	`Document`	Adiciona o array de usuários à lista de editores do `Document`.
`addFooter()`	`FooterSection`	Adiciona uma seção de rodapé, se não existir nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
`addHeader()`	`HeaderSection`	Adiciona uma seção de cabeçalho, se não existir nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
`addNamedRange(name, range)`	`NamedRange`	Adiciona um `NamedRange`, que é um `Range` com um nome e um ID para usar na recuperação posterior, na primeira guia ou, para scripts vinculados a um documento, na guia ativa.
`addViewer(emailAddress)`	`Document`	Adiciona o usuário à lista de espectadores do `Document`.
`addViewer(user)`	`Document`	Adiciona o usuário à lista de espectadores do `Document`.
`addViewers(emailAddresses)`	`Document`	Adiciona a matriz de usuários à lista de espectadores do `Document`.
`getActiveTab()`	`Tab`	Retorna o `Tab` ativo no momento do usuário no documento.
`getAs(contentType)`	`Blob`	Recupera o conteúdo atual de `Document` como um blob do tipo especificado.
`getBlob()`	`Blob`	Recupera o conteúdo atual de `Document` como um blob.
`getBody()`	`Body`	Recupera a `Body` da primeira guia ou, para scripts vinculados a um documento, a `DocumentBodySection` da guia ativa.
`getBookmark(id)`	`Bookmark`	Consegue o `Bookmark` com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`getBookmarks()`	`Bookmark[]`	Recebe todos os objetos `Bookmark` na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`getCursor()`	`Position`	Recebe o cursor do usuário na guia ativa.
`getEditors()`	`User[]`	Recebe a lista de editores para este `Document`.
`getFooter()`	`FooterSection`	Recupera a seção de rodapé da primeira guia ou, para scripts vinculados a um documento, a seção de rodapé da guia ativa.
`getFootnotes()`	`Footnote[]`	Recupera todos os elementos `Footnote` no corpo da primeira guia ou, para scripts vinculados a um documento, o corpo da guia ativa.
`getHeader()`	`HeaderSection`	Recupera a seção do cabeçalho da primeira guia ou, para scripts vinculados a um documento, a seção do cabeçalho da guia ativa.
`getId()`	`String`	Recupera o identificador exclusivo do documento.
`getLanguage()`	`String`	Recebe o código de idioma do documento.
`getName()`	`String`	Recupera o título do documento.
`getNamedRangeById(id)`	`NamedRange`	Consegue o `NamedRange` com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`getNamedRanges()`	`NamedRange[]`	Recebe todos os objetos `NamedRange` na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`getNamedRanges(name)`	`NamedRange[]`	Recebe todos os objetos `NamedRange` com o nome fornecido na primeira guia ou, para scripts que são vinculados a um documento, a guia ativa.
`getSelection()`	`Range`	Recebe a seleção do usuário na guia ativa.
`getSupportedLanguageCodes()`	`String[]`	Recebe todos os códigos de idioma com suporte nos arquivos do Documentos Google.
`getTab(tabId)`	`Tab`	Recebe o `Tab` com o ID especificado.
`getTabs()`	`Tab[]`	Recebe todos os `Tab`s não aninhados que fazem parte do documento.
`getUrl()`	`String`	Recupera o URL para acessar o documento atual.
`getViewers()`	`User[]`	Mostra a lista de leitores e comentaristas desse `Document`.
`newPosition(element, offset)`	`Position`	Cria uma nova `Position`, que é uma referência a um local na guia, em relação a um elemento específico na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`newRange()`	`RangeBuilder`	Cria um builder usado para construir objetos `Range` de elementos de guia na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
`removeEditor(emailAddress)`	`Document`	Remove o usuário da lista de editores do `Document`.
`removeEditor(user)`	`Document`	Remove o usuário da lista de editores do `Document`.
`removeViewer(emailAddress)`	`Document`	Remove o usuário da lista de espectadores e comentaristas do `Document`.
`removeViewer(user)`	`Document`	Remove o usuário da lista de espectadores e comentaristas do `Document`.
`saveAndClose()`	`void`	Salva o `Document` atual.
`setActiveTab(tabId)`	`void`	Define a `Tab` selecionada do usuário no documento atual para a guia com o ID especificado.
`setCursor(position)`	`Document`	Define o cursor do usuário, considerando um `Position`.
`setLanguage(languageCode)`	`Document`	Define o código de idioma do documento.
`setName(name)`	`Document`	Define o título do documento.
`setSelection(range)`	`Document`	Define a seleção do usuário na guia ativa, considerando um `Range`.

Documentação detalhada

`addBookmark(position)`

Adiciona uma Bookmark na Position especificada à primeira guia ou, para scripts vinculados a um documento, à guia ativa. Para adicionar um marcador a qualquer guia, use o método DocumentTab.addBookmark(position).

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Parâmetros

Nome	Tipo	Descrição
`position`	`Position`	A posição do novo marcador de página.

Retornar

Bookmark: o novo favorito.

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

`addEditor(emailAddress)`

Adiciona o usuário à lista de editores do Document. Se o usuário já estava na lista de espectadores, esse método promove o usuário para fora da lista de espectadores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retornar

Document: Document para encadeamento.

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

`addEditor(user)`

Adiciona o usuário à lista de editores do Document. Se o usuário já estava na lista de espectadores, esse método promove o usuário para fora da lista de espectadores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

Document: Document para encadeamento.

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

`addEditors(emailAddresses)`

Adiciona o array de usuários à lista de editores do Document. Se algum dos usuários já estiver na lista de espectadores, esse método vai promover a saída deles da lista de espectadores.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Document: Document para encadeamento.

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

`addFooter()`

Adiciona uma seção de rodapé, se não existir nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa. Para adicionar uma seção de rodapé a qualquer guia, use o método DocumentTab.addFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Retornar

FooterSection: o rodapé da guia.

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

`addHeader()`

Adiciona uma seção de cabeçalho, se não existir nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa. Para adicionar uma seção de cabeçalho a qualquer guia, use o método DocumentTab.addHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Retornar

HeaderSection: o cabeçalho da guia.

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

`addNamedRange(name, range)`

Adiciona um NamedRange, que é um Range com um nome e um ID para usar na recuperação posterior, na primeira guia ou, para scripts vinculados a um documento, na guia ativa. Para adicionar um NamedRange em qualquer guia, use o método DocumentTab.addNamedRange(name, range). Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos no documento, como um ID em HTML. Depois de adicionar um NamedRange a um documento, não é possível modificá-lo, apenas removê-lo.

Qualquer script que acesse o documento pode acessar um NamedRange. Para evitar conflitos inesperados entre scripts, considere prefixar os nomes de intervalos com uma string exclusiva.

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do intervalo, que não precisa ser exclusivo. Os nomes de intervalos precisam ter de 1 a 256 caracteres.
`range`	`Range`	O intervalo de elementos a serem associados ao nome. O intervalo pode ser a seleção ativa, um resultado da pesquisa ou construído manualmente com `newRange()`.

Retornar

NamedRange: o NamedRange.

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

`addViewer(emailAddress)`

Adiciona o usuário à lista de espectadores do Document. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser adicionado.

Retornar

Document: Document para encadeamento.

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

`addViewer(user)`

Adiciona o usuário à lista de espectadores do Document. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser adicionado.

Retornar

Document: Document para encadeamento.

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

`addViewers(emailAddresses)`

Adiciona a matriz de usuários à lista de espectadores do Document. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para eles.

Parâmetros

Nome	Tipo	Descrição
`emailAddresses`	`String[]`	Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retornar

Document: Document para encadeamento.

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

`getActiveTab()`

Retorna o Tab ativo no momento do usuário no documento. Um script só pode acessar a guia ativa do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

Retornar

Tab: o Tab ativo do usuário ou null se o script não estiver vinculado ao 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

`getAs(contentType)`

Recupera o conteúdo atual de Document como um blob do tipo especificado.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Parâmetros

Nome	Tipo	Descrição
`contentType`	`String`	O tipo MIME para a conversão. `'application/pdf'` e `'text/markdown'` são aceitos.

Retornar

Blob: o documento atual como um blob.

`getBlob()`

Recupera o conteúdo atual de Document como um blob.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

Retornar

Blob: o documento atual como um blob.

`getBody()`

Recupera a Body da primeira guia ou, para scripts vinculados a um documento, a DocumentBodySection da guia ativa. Para acessar o DocumentBodySection de qualquer guia, use o método DocumentTab.getBody().

As guias podem conter diferentes tipos de seções (por exemplo, HeaderSection, FooterSection). A seção ativa de uma guia é a Body.

Os métodos de elemento em Document são delegados para o Body ativo.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Retornar

Body: a seção do corpo da guia.

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

`getBookmark(id)`

Consegue o Bookmark com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para acessar um marcador em qualquer guia, use o método DocumentTab.getBookmark(id). Esse método retorna null se nenhum Bookmark existir na guia.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID do `Bookmark`.

Retornar

Bookmark: o Bookmark com o ID fornecido ou null se nenhum Bookmark existir na guia.

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

`getBookmarks()`

Recebe todos os objetos Bookmark na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para receber todos os favoritos em qualquer guia, use o método DocumentTab.getBookmarks().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Retornar

Bookmark[]: uma matriz dos objetos Bookmark na guia.

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

`getCursor()`

Recebe o cursor do usuário na guia ativa. Um script só pode acessar o cursor do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Retornar

Position: uma representação do cursor do usuário ou null se o usuário não tiver um cursor colocado na guia ou se o script não estiver vinculado ao 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

`getEditors()`

Recebe a lista de editores para este Document.

Retornar

User[]: uma matriz de usuários com permissão de edição.

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

`getFooter()`

Recupera a seção de rodapé da primeira guia ou, para scripts vinculados a um documento, a seção de rodapé da guia ativa. Para acessar a seção de rodapé de qualquer guia, use o método DocumentTab.getFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Retornar

FooterSection: o rodapé da guia.

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

`getFootnotes()`

Recupera todos os elementos Footnote no corpo da primeira guia ou, para scripts vinculados a um documento, o corpo da guia ativa. Para receber todas as notas de rodapé em qualquer guia, use o método DocumentTab.getFootnotes().

As chamadas para getFootnotes causam uma iteração nos elementos da guia. Para guias grandes, evite chamadas desnecessárias para esse método.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Retornar

Footnote[]: as notas de rodapé da guia.

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

`getHeader()`

Recupera a seção do cabeçalho da primeira guia ou, para scripts vinculados a um documento, a seção do cabeçalho da guia ativa. Para acessar a seção de cabeçalho de qualquer guia, use o método DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Retornar

HeaderSection: o cabeçalho da guia.

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

`getId()`

Recupera o identificador exclusivo do documento. O ID do documento é usado com DocumentApp.openById() para abrir uma instância específica do documento.

Retornar

String: o ID 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

`getLanguage()`

Recebe o código de idioma do documento. Esse é o idioma mostrado em File > Language do editor de documentos, que pode não ser o idioma real do documento.

Retornar

String: o idioma do documento ou null, se não for definido.

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

`getName()`

Recupera o título do documento.

Retornar

String: o título 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

`getNamedRangeById(id)`

Consegue o NamedRange com o ID fornecido na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para receber o NamedRange com o ID fornecido em qualquer guia, use o método DocumentTab.getNamedRangeById(id). Esse método retorna null se nenhum NamedRange existir na guia. Os nomes não são necessariamente exclusivos, mesmo entre guias. Vários intervalos diferentes na mesma guia podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos na guia, como um ID em HTML.

Parâmetros

Nome	Tipo	Descrição
`id`	`String`	O ID do intervalo, que é exclusivo na guia.

Retornar

NamedRange: o NamedRange com o ID fornecido ou null se esse intervalo não existir na guia.

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

`getNamedRanges()`

Recebe todos os objetos NamedRange na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para receber todos os objetos NamedRange em qualquer guia, use o método DocumentTab.getNamedRanges().

Uma NamedRange pode ser acessada por qualquer script que acesse a guia. Para evitar conflitos indesejados entre scripts, considere prefixar os nomes de intervalos com uma string exclusiva.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia, possivelmente incluindo vários intervalos com o mesmo nome.

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

`getNamedRanges(name)`

Recebe todos os objetos NamedRange com o nome fornecido na primeira guia ou, para scripts que são vinculados a um documento, a guia ativa. Para receber todos os objetos NamedRange em qualquer guia, use o método DocumentTab.getNamedRanges(name). Os nomes não são necessariamente exclusivos, mesmo entre guias. Vários intervalos diferentes na mesma guia podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos na guia, como um ID em HTML.

Um NamedRange pode ser acessado por qualquer script que acesse o documento. Para evitar conflitos indesejados entre scripts, considere prefixar os nomes de intervalos com uma string exclusiva.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O nome do intervalo, que não é necessariamente exclusivo.

Retornar

NamedRange[]: uma matriz dos objetos NamedRange na guia com o nome fornecido.

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

`getSelection()`

Recebe a seleção do usuário na guia ativa. Um script só pode acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado ao documento.

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Retornar

Range: uma representação da seleção do usuário ou null se o usuário não tiver nada selecionado na guia, se apenas o final de um parágrafo estiver selecionado, se apenas o final de um parágrafo e uma nova linha estiverem selecionados ou se o script não estiver vinculado ao 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

`getSupportedLanguageCodes()`

Recebe todos os códigos de idioma com suporte nos arquivos do Documentos Google.

Retornar

String[]: uma matriz de códigos de idioma.

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

`getTab(tabId)`

Recebe o Tab com o ID especificado. Esse método retorna null se não houver um Tab. Podem acessar guias em qualquer nível de aninhamento.

Parâmetros

Nome	Tipo	Descrição
`tabId`	`String`	O ID da guia a ser recebida.

Retornar

Tab: o Tab com o ID especificado ou null se nenhum Tab existir.

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

`getTabs()`

Recebe todos os Tabs não aninhados que fazem parte do documento.

As guias podem conter guias filhas, uma guia aninhada em outra. As guias filhas podem ser acessadas usando Tab.getChildTabs().

Retornar

Tab[]: a lista de todos os Tabs que fazem parte 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

`getUrl()`

Recupera o URL para acessar o documento atual.

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

Retornar

String: o URL para acessar o documento atual.

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

`getViewers()`

Mostra a lista de leitores e comentaristas desse Document.

Retornar

User[]: uma matriz de usuários com permissão de visualização ou comentário.

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

`newPosition(element, offset)`

Cria uma nova Position, que é uma referência a um local na guia, em relação a um elemento específico na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para criar um Position relativo a um local em qualquer guia, use o método DocumentTab.newPosition(element, offset). O cursor do usuário é representado como um Position, entre outros usos.

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

Nome	Tipo	Descrição
`element`	`Element`	O elemento que precisa conter o novo `Position`. Ele precisa ser um `Text` ou um elemento de contêiner, como `Paragraph`.
`offset`	`Integer`	Para elementos `Text`, o número de caracteres antes do `Position`. Para outros elementos, o número de elementos filhos antes do `Position` no mesmo elemento do contêiner.

Retornar

Position: o novo Position.

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

`newRange()`

Cria um builder usado para construir objetos Range de elementos de guia na primeira guia ou, para scripts vinculados a um documento, a guia ativa. Para criar um builder usado para construir objetos DocumentRange de elementos de guia em qualquer guia, use o método DocumentTab.newRange().

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Retornar

RangeBuilder: o novo builder.

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

`removeEditor(emailAddress)`

Remove o usuário da lista de editores do Document. Esse método não impede que os usuários acessem o Document se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se o Document estiver em um drive compartilhado que o usuário pode acessar.

Para arquivos do Drive, isso também remove o usuário da lista de visualizadores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

Document: Document para encadeamento.

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

`removeEditor(user)`

Para arquivos do Drive, isso também remove o usuário da lista de visualizadores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

Document: Document para encadeamento.

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

`removeViewer(emailAddress)`

Remove o usuário da lista de espectadores e comentaristas do Document. Esse método não terá efeito se o usuário for um editor, não um espectador ou comentarista. Esse método também não impede que os usuários acessem o Document se eles pertencem a uma classe de usuários que têm acesso geral. Por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se o Document estiver em um drive compartilhado que o usuário pode acessar.

Para arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`emailAddress`	`String`	O endereço de e-mail do usuário a ser removido.

Retornar

Document: Document para encadeamento.

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

`removeViewer(user)`

Remove o usuário da lista de espectadores e comentaristas do Document. Esse método não terá efeito se o usuário for um editor, não um espectador. Esse método também não impede que os usuários acessem o Document se eles pertencerem a uma classe de usuários que têm acesso geral. Por exemplo, se o Document for compartilhado com todo o domínio do usuário ou se o Document estiver em um drive compartilhado que o usuário pode acessar.

Para arquivos do Drive, isso também remove o usuário da lista de editores.

Parâmetros

Nome	Tipo	Descrição
`user`	`User`	Uma representação do usuário a ser removido.

Retornar

Document: Document para encadeamento.

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

`saveAndClose()`

Salva o Document atual. Faz com que as atualizações pendentes sejam limpas e aplicadas.

O método saveAndClose() é invocado automaticamente no final da execução do script para cada Document editável aberto.

Não é possível editar uma Document fechada. Use DocumentApp.openById() para reabrir um documento para edição.

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

`setActiveTab(tabId)`

Define a Tab selecionada do usuário no documento atual para a guia com o ID especificado.

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

Parâmetros

Nome	Tipo	Descrição
`tabId`	`String`	O ID da guia a ser definida como ativa.

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

`setCursor(position)`

Define o cursor do usuário, considerando um Position. Um script só pode acessar o cursor do usuário que está executando o script e somente se ele estiver vinculado ao documento.

Fornecer um Position de um Tab inativo muda a guia ativa do usuário.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parâmetros

Nome	Tipo	Descrição
`position`	`Position`	O novo local do cursor.

Retornar

Document: Document para encadeamento.

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

`setLanguage(languageCode)`

Define o código de idioma do documento. Esse é o idioma mostrado em File > Language do editor de documentos, que pode não ser o idioma real do documento. Use getSupportedLanguageCodes() para receber todos os códigos de idioma válidos.

Parâmetros

Nome	Tipo	Descrição
`languageCode`	`String`	O código do idioma.

Retornar

Document: Document para encadeamento.

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

`setName(name)`

Define o título do documento.

Parâmetros

Nome	Tipo	Descrição
`name`	`String`	O título do novo documento.

Retornar

Document: o documento atual.

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

`setSelection(range)`

Define a seleção do usuário na guia ativa, considerando um Range. Um script só pode acessar a seleção do usuário que está executando o script e somente se ele estiver vinculado ao documento.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parâmetros

Nome	Tipo	Descrição
`range`	`Range`	O novo intervalo de elementos a selecionar.

Retornar

Document: Document para encadeamento.

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