Class Document

Adiciona uma Bookmark no Position 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('abc123456');

// Gets the document 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

Retornar

Bookmark: o novo favorito.

Autorização

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

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

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estiver na lista de leitores, esse método o promoverá fora da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Adiciona o usuário especificado à lista de editores do Document. Se o usuário já estiver na lista de leitores, esse método o promoverá fora da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Adiciona a matriz de usuários especificada à lista de editores do Document. Se algum dos usuários já estiver na lista de leitores, esse método os promoverá fora da lista de leitores.

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Adiciona uma seção de rodapé do documento, se não existir nenhuma.

// 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('abc123456');

// Adds a footer to the document.
const footer = doc.addFooter();

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

Retornar

FooterSection: o rodapé do documento.

Autorização

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

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

Adiciona uma seção de cabeçalho do documento, se não existir nenhuma.

// 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('abc123456');

// Adds a header to the document.
const header = doc.addHeader();

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

Retornar

HeaderSection: o cabeçalho do documento.

Autorização

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

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

Adiciona um NamedRange, que é um Range que tem um nome e um código a serem usados para recuperação posterior. 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 códigos são exclusivos no documento, como um código em HTML. Depois de adicionar um NamedRange a um documento, não será possível modificá-lo, apenas removê-lo.

Qualquer script que acesse o documento pode acessar um NamedRange. Para evitar conflitos não intencionais entre scripts, prefixe nomes de intervalos com uma string exclusiva.

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

Parâmetros

Retornar

NamedRange: o NamedRange.

Autorização

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

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

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

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

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

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

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

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

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('abc123456');

// 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

Retornar

Blob: o documento atual como um blob.

Recupera o conteúdo atual do 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('abc123456');

// 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.

Recupera o Body do documento ativo.

Os documentos podem conter diferentes tipos de seções (por exemplo, HeaderSection, FooterSection). A seção ativa para um documento é a Body.

Os métodos do elemento em Document delegam aos Body ativos.

// 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('abc123456');

// Gets the document body.
const body = doc.getBody();

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

Retornar

Body: a seção de corpo do documento ativa.

Autorização

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

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

Recebe o Bookmark com o ID fornecido. Esse método retornará null se esse Bookmark não existir.

// 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('abc123456');

// Gets the bookmark by its ID.
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

Retornar

Bookmark: o Bookmark com o ID fornecido, ou null se esse Bookmark não existir.

Autorização

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

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

Recebe todos os objetos Bookmark no documento.

// 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('abc123456');

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

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

Retornar

Bookmark[]: uma matriz dos objetos Bookmark no documento.

Autorização

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

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

Obtém o cursor do usuário no documento ativo. Um script só pode acessar o cursor do usuário que está executando o script e apenas se o script estiver vinculado ao documento.

// Insert some text at the cursor position and make it bold.
var 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.
  var 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 no documento ou se o script não estiver vinculado ao documento.

Autorização

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

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

Obtém a lista de editores para este Document.

Retornar

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

Autorização

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

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

Recupera a seção de rodapé do documento, se houver.

// 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('abc123456');

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

Retornar

FooterSection: o rodapé do documento.

Autorização

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

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

Recupera todos os elementos Footnote no corpo do documento.

As chamadas para getFootnotes causam uma iteração nos elementos do documento. Para documentos 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('abc123456');

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

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

Retornar

Footnote[]: as notas de rodapé do documento.

Autorização

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

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

Recupera a seção do cabeçalho do documento, se houver.

// 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('abc123456');

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

Retornar

HeaderSection: o cabeçalho do documento.

Autorização

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

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

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

Retornar

String: o ID do documento

Autorização

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

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

Obtém o código de idioma do documento. Esse é o idioma mostrado em Arquivo > Idioma 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 estiver definido.

Autorização

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

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

Recupera o título do documento.

Retornar

String: o título do documento

Autorização

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

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

Recebe o NamedRange com o ID fornecido. Esse método retornará null se esse NamedRange não existir. Os nomes não são necessariamente exclusivos. Vários intervalos diferentes no mesmo documento podem ter o mesmo nome, bem como uma classe em HTML. Por outro lado, os códigos são exclusivos no documento, como um código em HTML.

Parâmetros

Retornar

NamedRange: o NamedRange com o ID fornecido, ou null se esse intervalo não existir

Autorização

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

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

Recebe todos os objetos NamedRange no documento.

Um NamedRange pode ser acessado por qualquer script que acessa o documento. Para evitar conflitos não intencionais entre scripts, prefixe nomes de intervalo com uma string exclusiva.

Retornar

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

Autorização

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

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

Recebe todos os objetos NamedRange no documento com o nome fornecido. 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 códigos são exclusivos no documento, como um código em HTML.

Um NamedRange pode ser acessado por qualquer script que acessa o documento. Para evitar conflitos não intencionais entre scripts, prefixe nomes de intervalo com uma string exclusiva.

Parâmetros

Retornar

NamedRange[]: uma matriz dos objetos NamedRange no documento com o nome determinado

Autorização

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

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

Obtém a seleção do usuário no documento ativo. Um script só pode acessar a seleção do usuário que o está executando e somente se o script estiver vinculado ao documento.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var 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 no documento, se apenas o final de um parágrafo for selecionado, se apenas o final de um parágrafo e uma nova linha forem selecionados ou se o script não estiver vinculado ao documento.

Autorização

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

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

Obtém todos os códigos de idioma compatíveis com os arquivos do Google Docs.

Retornar

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

Autorização

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

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

Recupera o URL para acessar o documento atual.

var 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 requerem autorização com um ou mais dos seguintes escopos:

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

Recebe a lista de leitores e comentadores deste Document.

Retornar

User[]: uma matriz de usuários com permissão para ver ou comentar.

Autorização

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

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

Cria um novo Position, que é uma referência a um local no documento, em relação a um elemento específico. O cursor do usuário é representado como um Position, entre outros usos.

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

Parâmetros

Retornar

Position: o novo Position

Autorização

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

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

Cria um builder usado para criar objetos Range a partir de elementos do documento.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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 requerem autorização com um ou mais dos seguintes escopos:

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

Remove o usuário especificado 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 com 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 ele possa acessar.

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

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Remove o usuário especificado 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 com 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 ele possa acessar.

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

Parâmetros

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Remove o usuário da lista de leitores e comentadores do Document. Esse método não terá efeito se o usuário for um editor, não um leitor ou comentarista. Esse método também não impedirá que os usuários acessem o Document se pertencerem a uma classe de usuários com 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 ele possa acessar.

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

Parâmetros

Retornar

Document: este Document para encadeamento.

Autorização

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

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

Remove o usuário da lista de leitores e comentadores do Document. Esse método não terá efeito se o usuário for um editor, não um leitor. Esse método também não impedirá que os usuários acessem o Document se pertencerem a uma classe de usuários com 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 ele possa acessar.

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

Parâmetros

Retornar

Document: este Document para encadeamento.

Autorização

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

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

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 editável.

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

Autorização

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

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

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

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

Parâmetros

Retornar

Document — este Document, para encadeamento

Autorização

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

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

Define o código de idioma do documento. Esse é o idioma mostrado em Arquivo > Idioma 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

Retornar

Document: este Document, para encadeamento.

Autorização

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

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

Define o título do documento.

Parâmetros

Retornar

Document: o documento atual

Autorização

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

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

Define a seleção do usuário no documento ativo, com base em um Range. Um script só pode acessar a seleção do usuário que o está executando e somente se o script estiver vinculado ao documento.

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

Parâmetros

Retornar

Document — este Document, para encadeamento

Autorização

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

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