Class Document

Document

Um documento com rich text e elementos como tabelas e listas.

É possível abrir ou criar documentos usando DocumentApp.

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

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

Métodos

MétodoTipo de retornoBreve descrição
addBookmark(position)BookmarkAdiciona um Bookmark no Position especificado.
addEditor(emailAddress)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditor(user)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditors(emailAddresses)DocumentAdiciona a matriz de usuários especificada à lista de editores do Document.
addFooter()FooterSectionAdiciona uma seção de rodapé do documento, se não houver nenhuma.
addHeader()HeaderSectionAdiciona uma seção de cabeçalho do documento, se não houver nenhuma.
addNamedRange(name, range)NamedRangeAdiciona um NamedRange, que é um Range que tem um nome e um ID para serem recuperados posteriormente.
addViewer(emailAddress)DocumentAdiciona o usuário especificado à lista de leitores do Document.
addViewer(user)DocumentAdiciona o usuário especificado à lista de leitores do Document.
addViewers(emailAddresses)DocumentAdiciona a matriz de usuários especificada à lista de leitores para o Document.
getAs(contentType)BlobRecupera o conteúdo atual de Document como um blob do tipo especificado.
getBlob()BlobRecupera o conteúdo atual do Document como um blob.
getBody()BodyRecupera o Body do documento ativo.
getBookmark(id)BookmarkRecebe o Bookmark com o ID fornecido.
getBookmarks()Bookmark[]Recebe todos os objetos Bookmark no documento.
getCursor()PositionExtrai o cursor do usuário no documento ativo.
getEditors()User[]Recebe a lista de editores deste Document.
getFooter()FooterSectionRecupera a seção de rodapé do documento, se houver.
getFootnotes()Footnote[]Recupera todos os elementos Footnote no corpo do documento.
getHeader()HeaderSectionRecupera a seção de cabeçalho do documento, se existir.
getId()StringRecupera o identificador exclusivo do documento.
getLanguage()StringExtrai o código de idioma do documento.
getName()StringRecupera o título do documento.
getNamedRangeById(id)NamedRangeRecebe o NamedRange com o ID fornecido.
getNamedRanges()NamedRange[]Recebe todos os objetos NamedRange no documento.
getNamedRanges(name)NamedRange[]Recebe todos os objetos NamedRange no documento com o nome indicado.
getSelection()RangeExtrai a seleção do usuário no documento ativo.
getSupportedLanguageCodes()String[]Extrai todos os códigos de idioma compatíveis com os arquivos do Documentos Google.
getUrl()StringRecupera o URL para acessar o documento atual.
getViewers()User[]Recebe a lista de leitores e comentadores deste Document.
newPosition(element, offset)PositionCria um novo Position, que é uma referência a um local no documento, relativo a um elemento específico.
newRange()RangeBuilderCria um builder usado para criar objetos Range com base em elementos do documento.
removeEditor(emailAddress)DocumentRemove o usuário especificado da lista de editores do Document.
removeEditor(user)DocumentRemove o usuário especificado da lista de editores do Document.
removeViewer(emailAddress)DocumentRemove o usuário especificado da lista de leitores e comentadores do Document.
removeViewer(user)DocumentRemove o usuário especificado da lista de leitores e comentadores do Document.
saveAndClose()voidSalva o Document atual.
setCursor(position)DocumentDefine o cursor do usuário no documento ativo, dado um Position.
setLanguage(languageCode)DocumentDefine o código de idioma do documento.
setName(name)DocumentDefine o título do documento.
setSelection(range)DocumentDefine a seleção do usuário no documento ativo, considerando um Range.

Documentação detalhada

addBookmark(position)

Adiciona um 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

NomeTipoDescrição
positionPositionA posição do novo favorito.

Retorno

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 especificado à lista de editores do Document. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser adicionado.

Retorno

Document: este 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 especificado à lista de editores do Document. Se o usuário já estiver na lista de espectadores, esse método o removerá da lista.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retorno

Document: este 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 a matriz de usuários especificada à lista de editores do Document. Se algum dos usuários já estiver na lista de espectadores, esse método o removerá da lista de espectadores.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

Document: este 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é do documento, se não houver 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');

Retorno

FooterSection: o rodapé 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

addHeader()

Adiciona uma seção de cabeçalho do documento, se não houver 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');

Retorno

HeaderSection: o cabeçalho 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

addNamedRange(name, range)

Adiciona um NamedRange, que é um Range que tem um nome e um ID para serem recuperados posteriormente. Os nomes não são necessariamente únicos. Vários intervalos diferentes no mesmo documento podem ter o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos dentro do documento, como um ID em HTML. Depois de adicionar um NamedRange a um documento, não será possível modificar, apenas removê-lo.

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

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

NomeTipoDescrição
nameStringO nome do intervalo, que não precisa ser exclusivo. Os nomes de intervalos precisam ter entre 1 e 256 caracteres.
rangeRangeO 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().

Retorno

NamedRange — A 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 especificado à lista de leitores do Document. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser adicionado.

Retorno

Document: este 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 especificado à lista de leitores do Document. Se o usuário já estiver na lista de editores, esse método não terá efeito.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser adicionado.

Retorno

Document: este 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 especificada à lista de leitores para o Document. Se algum dos usuários já estiver na lista de editores, esse método não terá efeito para ele.

Parâmetros

NomeTipoDescrição
emailAddressesString[]Uma matriz de endereços de e-mail dos usuários a serem adicionados.

Retorno

Document: este 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

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('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

NomeTipoDescrição
contentTypeStringO tipo MIME para conversão. Atualmente, apenas 'application/pdf' é compatível.

Retorno

Blob: o documento atual como um blob.


getBlob()

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

Retorno

Blob: o documento atual como um blob.


getBody()

Recupera o Body do documento ativo.

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

Os métodos do elemento no Document delegam 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('abc123456');

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

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

Retorno

Body: seção do corpo do documento ativo.

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)

Recebe o Bookmark com o ID fornecido. Esse método retornará null se essa 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

NomeTipoDescrição
idStringO ID do Bookmark.

Retorno

Bookmark: o Bookmark com o ID fornecido ou null, se essa Bookmark não 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

getBookmarks()

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);

Retorno

Bookmark[]: uma matriz dos objetos Bookmark no 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

getCursor()

Extrai o cursor do usuário no documento ativo. Um script só acessa o cursor do usuário que está executando o script e apenas se ele 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.');
}

Retorno

Position: uma representação do cursor do usuário ou null se o usuário não tiver um cursor posicionado no documento 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 deste Document.

Retorno

User[]: uma matriz de usuários com permissão 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

getFooter()

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

Retorno

FooterSection: o rodapé 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

getFootnotes()

Recupera todos os elementos Footnote no corpo do documento.

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

Retorno

Footnote[]: as notas de rodapé 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

getHeader()

Recupera a seção de cabeçalho do documento, se 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 text of the document's header and logs it to the console.
console.log(doc.getHeader().getText());

Retorno

HeaderSection: o cabeçalho 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

getId()

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

Retorno

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()

Extrai o código de idioma do documento. Esse é o idioma mostrado em Arquivo > Idioma no editor de documentos, que pode não ser o mesmo idioma que o documento.

Retorno

String: o idioma do documento, ou null, se não estiver 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.

Retorno

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)

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

Parâmetros

NomeTipoDescrição
idStringo ID do intervalo, que é exclusivo no documento

Retorno

NamedRange: o NamedRange com o ID fornecido ou null se esse intervalo não 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

getNamedRanges()

Recebe todos os objetos NamedRange no documento.

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

Retorno

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 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 no documento com o nome indicado. Os nomes não são necessariamente exclusivos. Diversos intervalos diferentes no mesmo documento podem compartilhar o mesmo nome, assim como uma classe em HTML. Por outro lado, os IDs são exclusivos dentro do documento, como um ID em HTML.

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

Parâmetros

NomeTipoDescrição
nameStringo nome do intervalo, que não é necessariamente único

Retorno

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

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()

Extrai a seleção do usuário no documento ativo. Um script só pode acessar a seleção do usuário que está executando o script e apenas se ele 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.');
}

Retorno

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

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

getSupportedLanguageCodes()

Extrai todos os códigos de idioma compatíveis com os arquivos do Documentos Google.

Retorno

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

getUrl()

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

Retorno

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()

Recebe a lista de leitores e comentadores deste Document.

Retorno

User[]: uma matriz de usuários com permissão de leitura 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 um novo Position, que é uma referência a um local no documento, relativo 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

NomeTipoDescrição
elementElemento elemento que vai conter o novo Position. Ele precisa ser um elemento Text ou um elemento de contêiner, como Paragraph
offsetIntegerpara elementos Text, o número de caracteres antes de Position. Para outros elementos, o número de elementos filhos antes de Position no mesmo elemento contêiner

Retorno

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 criar objetos Range com base em 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());

Retorno

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 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 que tenham acesso geral. Por exemplo, se 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.

Nos arquivos do Drive, essa ação também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser removido.

Retorno

Document: este 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)

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 que tenham acesso geral. Por exemplo, se 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.

Nos arquivos do Drive, essa ação também remove o usuário da lista de leitores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retorno

Document: este 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 especificado 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 impede que os usuários acessem o Document se eles pertencerem a uma classe de usuários com acesso geral. Por exemplo, se 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.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
emailAddressStringO endereço de e-mail do usuário a ser removido.

Retorno

Document: esse 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 especificado 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 visualizador. Esse método também 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 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.

Nos arquivos do Drive, essa ação também remove o usuário da lista de editores.

Parâmetros

NomeTipoDescrição
userUserUma representação do usuário a ser removido.

Retorno

Document: esse 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 removidas e aplicadas.

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

Não é possível editar um Document fechado. Use DocumentApp.openById() se quiser reabrir um determinado 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

setCursor(position)

Define o cursor do usuário no documento ativo, dado 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

NomeTipoDescrição
positionPositiona nova localização do cursor

Retorno

Document: este 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 Arquivo > Idioma no editor de documentos, que pode não ser o mesmo idioma que o documento. Use getSupportedLanguageCodes() para acessar todos os códigos de idioma válidos.

Parâmetros

NomeTipoDescrição
languageCodeStringO código do idioma.

Retorno

Document: este 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

NomeTipoDescrição
nameStringo novo título do documento

Retorno

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 no documento ativo, considerando um Range. Um script só pode acessar a seleção do usuário que está executando o script e apenas se ele 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

NomeTipoDescrição
rangeRangeo novo intervalo de elementos para selecionar

Retorno

Document: este 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