Class Document

Document

Un documento que contiene uno o más objetos Tab, cada uno de los cuales contiene texto enriquecido y elementos como tablas y listas.

Los documentos se pueden abrir o crear con DocumentApp. 

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

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

Los métodos de la clase Document que acceden directamente al contenido de texto y lo modifican operan en la pestaña activa (en secuencias de comandos vinculadas a un documento en particular) o en la primera pestaña (si no hay una activa disponible). Las secuencias de comandos que dependen de estos métodos (por ejemplo, getBody()) se pueden migrar para admitir pestañas con getTabs() y, luego, Tab.asDocumentTab().

Métodos

MétodoTipo de datos que se muestraDescripción breve
addBookmark(position)BookmarkAgrega un Bookmark en el Position determinado a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa.
addEditor(emailAddress)DocumentAgrega el usuario especificado a la lista de editores de Document.
addEditor(user)DocumentAgrega el usuario especificado a la lista de editores de Document.
addEditors(emailAddresses)DocumentAgrega el array de usuarios determinado a la lista de editores de Document.
addFooter()FooterSectionAgrega una sección de pie de página, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa.
addHeader()HeaderSectionAgrega una sección de encabezado, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa.
addNamedRange(name, range)NamedRangeAgrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior, en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, en la pestaña activa.
addViewer(emailAddress)DocumentAgrega al usuario determinado a la lista de usuarios de Document.
addViewer(user)DocumentAgrega al usuario determinado a la lista de usuarios de Document.
addViewers(emailAddresses)DocumentAgrega el array de usuarios determinado a la lista de usuarios de Document.
getActiveTab()TabObtiene el Tab activo del usuario en el documento.
getAs(contentType)BlobRecupera el contenido actual de Document como un blob del tipo especificado.
getBlob()BlobRecupera el contenido actual de Document como un blob.
getBody()BodyRecupera el Body de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, el DocumentBodySection de la pestaña activa.
getBookmark(id)BookmarkObtiene el Bookmark con el ID determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
getBookmarks()Bookmark[]Obtiene todos los objetos Bookmark en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
getCursor()PositionObtiene el cursor del usuario en la pestaña activa.
getEditors()User[]Obtiene la lista de editores de este Document.
getFooter()FooterSectionRecupera la sección del pie de página de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la sección del pie de página de la pestaña activa.
getFootnotes()Footnote[]Recupera todos los elementos Footnote del cuerpo de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, del cuerpo de la pestaña activa.
getHeader()HeaderSectionRecupera la sección de encabezado de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la sección de encabezado de la pestaña activa.
getId()StringRecupera el identificador único del documento.
getLanguage()StringObtiene el código de idioma del documento.
getName()StringRecupera el título del documento.
getNamedRangeById(id)NamedRangeObtiene el NamedRange con el ID determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
getNamedRanges()NamedRange[]Obtiene todos los objetos NamedRange en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
getNamedRanges(name)NamedRange[]Obtiene todos los objetos NamedRange con el nombre determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
getSelection()RangeObtiene la selección del usuario en la pestaña activa.
getSupportedLanguageCodes()String[]Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.
getTab(tabId)TabObtiene el Tab con el ID especificado.
getTabs()Tab[]Obtiene todos los Tab no anidados que forman parte del documento.
getUrl()StringRecupera la URL para acceder al documento actual.
getViewers()User[]Obtiene la lista de usuarios y comentaristas de este Document.
newPosition(element, offset)PositionCrea un Position nuevo, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
newRange()RangeBuilderCrea un compilador que se usa para construir objetos Range a partir de elementos de pestañas en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa.
removeEditor(emailAddress)DocumentQuita al usuario determinado de la lista de editores de Document.
removeEditor(user)DocumentQuita al usuario determinado de la lista de editores de Document.
removeViewer(emailAddress)DocumentQuita al usuario determinado de la lista de usuarios y comentaristas de Document.
removeViewer(user)DocumentQuita al usuario determinado de la lista de usuarios y comentaristas de Document.
saveAndClose()voidGuarda el Document actual.
setActiveTab(tabId)voidEstablece el Tab seleccionado del usuario en el documento actual en la pestaña con el ID especificado.
setCursor(position)DocumentEstablece el cursor del usuario, dado un Position.
setLanguage(languageCode)DocumentEstablece el código de idioma del documento.
setName(name)DocumentEstablece el título del documento.
setSelection(range)DocumentEstablece la selección del usuario en la pestaña activa, según un Range.

Documentación detallada

addBookmark(position)

Agrega un Bookmark en el Position determinado a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa. Para agregar un favorito a cualquier pestaña, usa el 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

NombreTipoDescripción
positionPositionEs la posición del favorito nuevo.

Volver

Bookmark: Es el nuevo favorito.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addEditor(emailAddress)

Agrega el usuario especificado a la lista de editores de Document. Si el usuario ya estaba en la lista de usuarios, este método lo quita de la lista.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que quieres agregar.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addEditor(user)

Agrega el usuario especificado a la lista de editores de Document. Si el usuario ya estaba en la lista de usuarios, este método lo quita de la lista.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addEditors(emailAddresses)

Agrega el array de usuarios determinado a la lista de editores de Document. Si alguno de los usuarios ya estaba en la lista de usuarios, este método lo quita de la lista.

Parámetros

NombreTipoDescripción
emailAddressesString[]Es un array de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addFooter()

Agrega una sección de pie de página, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa. Para agregar una sección de pie de página a cualquier pestaña, usa el 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');

Volver

FooterSection: Es el pie de página de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addHeader()

Agrega una sección de encabezado, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, a la pestaña activa. Para agregar una sección de encabezado a cualquier pestaña, usa el 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');

Volver

HeaderSection: Es el encabezado de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addNamedRange(name, range)

Agrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior, en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, en la pestaña activa. Para agregar un NamedRange en cualquier pestaña, usa el método DocumentTab.addNamedRange(name, range). Los nombres no son necesariamente únicos; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro del documento, como un ID en HTML. Una vez que agregues un NamedRange a un documento, no podrás modificarlo, solo quitarlo.

Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange. Para evitar conflictos imprevistos entre las secuencias de comandos, considera anteponer a los nombres de los rangos una cadena única. 

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

NombreTipoDescripción
nameStringEs el nombre del rango, que no tiene que ser único. Los nombres de los rangos deben tener entre 1 y 256 caracteres.
rangeRangeEs el rango de elementos que se asociarán con el nombre. El rango puede ser la selección activa, un resultado de la búsqueda o puede construirse manualmente con newRange().

Volver

NamedRange: Es el NamedRange.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addViewer(emailAddress)

Agrega al usuario determinado a la lista de usuarios de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que quieres agregar.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addViewer(user)

Agrega al usuario determinado a la lista de usuarios de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se agregará.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

addViewers(emailAddresses)

Agrega el array de usuarios determinado a la lista de usuarios de Document. Si alguno de los usuarios ya estaba en la lista de editores, este método no tendrá efecto para ellos.

Parámetros

NombreTipoDescripción
emailAddressesString[]Es un array de direcciones de correo electrónico de los usuarios que se agregarán.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getActiveTab()

Obtiene el Tab activo del usuario en el documento. Una secuencia de comandos solo puede acceder a la pestaña activa del usuario que la ejecuta y solo si está vinculada al 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()}`);

Volver

Tab: Es el Tab activo del usuario o null si la secuencia de comandos no está vinculada al documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getAs(contentType)

Recupera el contenido actual de Document como un blob del 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

NombreTipoDescripción
contentTypeStringEs el tipo de MIME al que se debe realizar la conversión. Se admiten 'application/pdf' y 'text/markdown'.

Volver

Blob: Es el documento actual como un blob.

getBlob()

Recupera el contenido actual de Document como un 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());

Volver

Blob: Es el documento actual como un blob.

getBody()

Recupera el Body de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, el DocumentBodySection de la pestaña activa. Para obtener el DocumentBodySection de cualquier pestaña, usa el método DocumentTab.getBody().

Las pestañas pueden contener diferentes tipos de secciones (por ejemplo, HeaderSection, FooterSection). La sección activa de una pestaña es Body.

Los métodos de elementos en Document delegan al Body activo. 

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

Volver

Body: Es la sección del cuerpo de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getBookmark(id)

Obtiene el Bookmark con el ID determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para obtener un favorito en cualquier pestaña, usa el método DocumentTab.getBookmark(id). Este método muestra null si no existe tal Bookmark en la pestaña. 

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

NombreTipoDescripción
idStringEl ID de Bookmark.

Volver

Bookmark: Es el Bookmark con el ID determinado o null si no existe tal Bookmark en la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getBookmarks()

Obtiene todos los objetos Bookmark en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para obtener todos los favoritos de cualquier pestaña, usa el 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);

Volver

Bookmark[]: Es un array de los objetos Bookmark de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getCursor()

Obtiene el cursor del usuario en la pestaña activa. Una secuencia de comandos solo puede acceder al cursor del usuario que la ejecuta y solo si está vinculada al 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.');
}

Volver

Position: Es una representación del cursor del usuario o null si el usuario no tiene un cursor en la pestaña o si la secuencia de comandos no está vinculada al documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getEditors()

Obtiene la lista de editores de este Document.

Volver

User[]: Es un array de usuarios con permiso de edición.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getFooter()

Recupera la sección del pie de página de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la sección del pie de página de la pestaña activa. Para obtener la sección del pie de página de cualquier pestaña, usa el 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());

Volver

FooterSection: Es el pie de página de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getFootnotes()

Recupera todos los elementos Footnote del cuerpo de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, del cuerpo de la pestaña activa. Para obtener todas las notas al pie en cualquier pestaña, usa el método DocumentTab.getFootnotes().

Las llamadas a getFootnotes provocan una iteración sobre los elementos de la pestaña. En el caso de las pestañas grandes, evita las llamadas innecesarias a este 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());

Volver

Footnote[]: Son las notas al pie de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getHeader()

Recupera la sección de encabezado de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la sección de encabezado de la pestaña activa. Para obtener la sección de encabezado de cualquier pestaña, usa el 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());

Volver

HeaderSection: Es el encabezado de la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getId()

Recupera el identificador único del documento. El ID de documento se usa con DocumentApp.openById() para abrir una instancia de documento específica.

Volver

String: Es el ID del documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getLanguage()

Obtiene el código de idioma del documento. Es el idioma que se muestra en File > Language del editor de documentos, que puede no ser el idioma real que contiene el documento.

Volver

String: Es el idioma del documento o null si no está definido.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getName()

Recupera el título del documento.

Volver

String: Es el título del documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getNamedRangeById(id)

Obtiene el NamedRange con el ID determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para obtener el NamedRange con el ID determinado en cualquier pestaña, usa el método DocumentTab.getNamedRangeById(id). Este método muestra null si no existe ese NamedRange en la pestaña. Los nombres no son necesariamente únicos, incluso entre pestañas. Varios rangos diferentes en la misma pestaña pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Parámetros

NombreTipoDescripción
idStringEl ID del rango, que es único dentro de la pestaña

Volver

NamedRange: Es el NamedRange con el ID determinado o null si no existe ese rango en la pestaña.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getNamedRanges()

Obtiene todos los objetos NamedRange en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para obtener todos los objetos NamedRange en cualquier pestaña, usa el método DocumentTab.getNamedRanges().

Cualquier secuencia de comandos que acceda a la pestaña puede acceder a un NamedRange. Para evitar conflictos imprevistos entre secuencias de comandos, considera anteponer un prefijo a los nombres de los rangos con una cadena única.

Volver

NamedRange[]: Es un array de los objetos NamedRange de la pestaña, que puede incluir varios rangos con el mismo nombre.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getNamedRanges(name)

Obtiene todos los objetos NamedRange con el nombre determinado en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para obtener todos los objetos NamedRange en cualquier pestaña, usa el método DocumentTab.getNamedRanges(name). Los nombres no son necesariamente únicos, incluso entre pestañas. Varios rangos diferentes en la misma pestaña pueden compartir el mismo nombre, al igual que una clase en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange. Para evitar conflictos imprevistos entre secuencias de comandos, considera anteponer un prefijo a los nombres de los rangos con una cadena única.

Parámetros

NombreTipoDescripción
nameStringEs el nombre del rango, que no es necesariamente único.

Volver

NamedRange[]: Es un array de los objetos NamedRange en la pestaña con el nombre determinado.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getSelection()

Obtiene la selección del usuario en la pestaña activa. Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta y solo si está vinculada al 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.');
}

Volver

Range: Es una representación de la selección del usuario o null si el usuario no tiene nada seleccionado en la pestaña, si solo se selecciona el final de un párrafo, si solo se selecciona el final de un párrafo y una línea nueva, o si la secuencia de comandos no está vinculada al documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getSupportedLanguageCodes()

Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.

Volver

String[]: Es un array de códigos de idioma.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getTab(tabId)

Obtiene el Tab con el ID especificado. Este método muestra null si no existe ese Tab. Puede acceder a las pestañas en cualquier nivel de anidación.

Parámetros

NombreTipoDescripción
tabIdStringEs el ID de la pestaña que se obtendrá.

Volver

Tab: Es el Tab con el ID especificado o null si no existe ese Tab.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getTabs()

Obtiene todos los Tab no anidados que forman parte del documento.

Las pestañas pueden contener pestañas secundarias, una pestaña anidada dentro de otra. Se puede acceder a las pestañas secundarias con Tab.getChildTabs().

Volver

Tab[]: Es la lista de todos los Tab que forman parte del documento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getUrl()

Recupera la URL para acceder al documento actual. 

const doc = DocumentApp.getActiveDocument();

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

Volver

String: Es la URL para acceder al documento actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

getViewers()

Obtiene la lista de usuarios y comentaristas de este Document.

Volver

User[]: Es un array de usuarios con permiso de vista o comentario.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

newPosition(element, offset)

Crea un Position nuevo, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para crear un Position en relación con una ubicación en cualquier pestaña, usa el método DocumentTab.newPosition(element, offset). El cursor del usuario se representa como un Position, entre otros 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

NombreTipoDescripción
elementElementEl elemento que debe contener el nuevo Position; debe ser un elemento Text o un elemento contenedor, como Paragraph.
offsetIntegerPara los elementos Text, la cantidad de caracteres antes de Position; para otros elementos, la cantidad de elementos secundarios antes de Position dentro del mismo elemento contenedor.

Volver

Position: Es el nuevo Position.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

newRange()

Crea un compilador que se usa para construir objetos Range a partir de elementos de pestañas en la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, la pestaña activa. Para crear un compilador que se use para construir objetos DocumentRange a partir de elementos de pestañas en cualquier pestaña, usa el 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());

Volver

RangeBuilder: Es el nuevo compilador.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

removeEditor(emailAddress)

Quita al usuario determinado de la lista de editores de Document. Este método no impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si Document se encuentra en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de usuarios con permiso de lectura.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que quieres quitar.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

removeEditor(user)

Quita al usuario determinado de la lista de editores de Document. Este método no impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si Document se encuentra en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de usuarios con permiso de lectura.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

removeViewer(emailAddress)

Quita al usuario determinado de la lista de usuarios y comentaristas de Document. Este método no tiene efecto si el usuario es editor, no un usuario que mira o comenta. Este método tampoco bloquea a los usuarios para que accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si Document está en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
emailAddressStringEs la dirección de correo electrónico del usuario que quieres quitar.

Volver

Document: Este Document para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

removeViewer(user)

Quita al usuario determinado de la lista de usuarios y comentaristas de Document. Este método no tiene efecto si el usuario es un editor, no un usuario. Este método tampoco impide que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si Document se comparte con todo el dominio del usuario o si Document se encuentra en una unidad compartida a la que el usuario puede acceder.

En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.

Parámetros

NombreTipoDescripción
userUserEs una representación del usuario que se quitará.

Volver

Document: Este Document para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

saveAndClose()

Guarda el Document actual. Hace que se borren y apliquen las actualizaciones pendientes.

El método saveAndClose() se invoca automáticamente al final de la ejecución de la secuencia de comandos para cada Document editable abierta.

No se puede editar un Document cerrado. Usa DocumentApp.openById() para volver a abrir un documento determinado y editarlo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setActiveTab(tabId)

Establece el Tab seleccionado del usuario en el documento actual en la pestaña con el 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

NombreTipoDescripción
tabIdStringEs el ID de la pestaña que se establecerá como activa.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setCursor(position)

Establece el cursor del usuario, dado un Position. Una secuencia de comandos solo puede acceder al cursor del usuario que la ejecuta y solo si está vinculada al documento.

Proporcionar un Position desde un Tab inactivo cambia la pestaña activa del usuario. 

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

NombreTipoDescripción
positionPositionLa nueva ubicación del cursor.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setLanguage(languageCode)

Establece el código de idioma del documento. Es el idioma que se muestra en File > Language del editor de documentos, que puede no ser el idioma real que contiene el documento. Usa getSupportedLanguageCodes() para obtener todos los códigos de idioma válidos.

Parámetros

NombreTipoDescripción
languageCodeStringEs el código de idioma.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setName(name)

Establece el título del documento.

Parámetros

NombreTipoDescripción
nameStringEs el título del documento nuevo.

Volver

Document: Es el documento actual.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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

setSelection(range)

Establece la selección del usuario en la pestaña activa, según un Range. Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta y solo si está vinculada al 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

NombreTipoDescripción
rangeRangeEs el nuevo rango de elementos que se deben seleccionar.

Volver

Document: Este Document, para encadenar.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes ámbitos:

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