Class Document

Agrega un Bookmark en la Position determinada.

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

Volver

Bookmark: 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 alcances:

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

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

Parámetros

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 alcances:

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

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

Parámetros

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 alcances:

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

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 los promociona fuera de ella.

Parámetros

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 alcances:

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

Agrega una sección de pie de página del documento, si no existe.

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

Volver

FooterSection: El pie de página del documento.

Autorización

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

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

Agrega una sección de encabezado de documento, si no existe ninguna.

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

Volver

HeaderSection: Es el encabezado del documento.

Autorización

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

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

Agrega un NamedRange, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior. 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. En cambio, los ID son únicos dentro del documento, como un ID en HTML. Después de agregar una NamedRange a un documento, no puedes modificarla; solo puedes quitarla.

Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar una string única al prefijo de nombres de rangos.

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

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 alcances:

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

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

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 alcances:

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

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

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 alcances:

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

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 tiene efecto en ellos.

Parámetros

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 alcances:

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

Recupera el contenido Document actual 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('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

Volver

Blob: Es el documento actual como un BLOB.

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

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

Recupera el Body del documento activo.

Los documentos pueden contener diferentes tipos de secciones (p.ej., HeaderSection y FooterSection). La sección activa para un documento es Body.

Los métodos de elementos de Document delegan al elemento 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('abc123456');

// Gets the document 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 del documento activo.

Autorización

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

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

Obtiene el Bookmark con el ID determinado. Este método muestra null si no existe Bookmark.

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

Volver

Bookmark: Es el Bookmark con el ID determinado o null si no existe un Bookmark.

Autorización

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

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

Obtiene todos los objetos Bookmark del 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);

Volver

Bookmark[]: Es un array de los objetos Bookmark del documento.

Autorización

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

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

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

Volver

Position: Es una representación del cursor del usuario, o null si el usuario no tiene un cursor colocado en el documento 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 alcances:

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

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 alcances:

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

Recupera la sección de pie de página del documento, si existe.

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

Volver

FooterSection: El pie de página del documento.

Autorización

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

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

Recupera todos los elementos Footnote en el cuerpo del documento.

Las llamadas a getFootnotes generan una iteración de los elementos del documento. En el caso de documentos grandes, evita realizar 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('abc123456');

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

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

Volver

Footnote[]: Es el pie de página del documento.

Autorización

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

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

Recupera la sección de encabezado del documento, si existe.

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

Volver

HeaderSection: Es el encabezado del documento.

Autorización

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

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

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

Volver

String: 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 alcances:

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

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

Volver

String: 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 alcances:

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

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 alcances:

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

Obtiene el NamedRange con el ID determinado. Este método muestra null si no existe tal NamedRange. 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. En cambio, los ID son únicos dentro del documento, como un ID en HTML.

Parámetros

Volver

NamedRange: Es el NamedRange con el ID determinado o null si no existe tal rango.

Autorización

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

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

Obtiene todos los objetos NamedRange del documento.

Se puede acceder a NamedRange mediante cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar una string única al prefijo de nombres de rangos.

Volver

NamedRange[]: Es un array de los objetos NamedRange del documento 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 alcances:

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

Obtiene todos los objetos NamedRange del documento con el nombre determinado. Los nombres no son necesariamente únicos. Es posible que varios rangos diferentes en el mismo documento compartan el mismo nombre, al igual que una clase en HTML. En cambio, los ID son únicos dentro del documento, como un ID en HTML.

Se puede acceder a NamedRange mediante cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar una string única al prefijo de nombres de rangos.

Parámetros

Volver

NamedRange[]: Es un array de los objetos NamedRange del documento 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 alcances:

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

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

Volver

Range: Es una representación de la selección del usuario, o null si el usuario no tiene nada seleccionado en el documento, 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 alcances:

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

Obtiene todos los códigos de idioma que se admiten en 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 alcances:

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

Recupera la URL para acceder al documento actual.

var 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 alcances:

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

Obtiene la lista de usuarios y comentaristas de esta Document.

Volver

User[]: Es un array de usuarios con permiso para ver o comentar.

Autorización

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

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

Crea un objeto Position nuevo, que es una referencia a una ubicación en el documento, en relación con un elemento específico. El cursor del usuario se representa como un Position, entre otros 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

Volver

Position: 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 alcances:

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

Crea un compilador que se usa para construir objetos Range a partir de elementos del 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());

Volver

RangeBuilder: 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 alcances:

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

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 se comparte Document 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 usuarios.

Parámetros

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 alcances:

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

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 se comparte Document 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 usuarios.

Parámetros

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 alcances:

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

Quita al usuario determinado de la lista de lectores y comentaristas de Document. Este método no tiene efecto si el usuario es editor, no lector ni comentarista. 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 se comparte Document 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

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 alcances:

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

Quita al usuario determinado de la lista de lectores y comentaristas de Document. Este método no tiene efecto si el usuario es un editor, no un lector. 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 se comparte Document 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

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 alcances:

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

Guarda el Document actual. Hace que se quiten 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() a fin de volver a abrir un documento determinado para editarlo.

Autorización

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

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

Establece el cursor del usuario en el documento activo en función de un Position. Una secuencia de comandos solo puede acceder al cursor del usuario que ejecuta la secuencia de comandos y solo si la secuencia está vinculada al 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

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 alcances:

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

Establece el código de idioma del documento. Es el idioma que se muestra en el Archivo > Idioma 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

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 alcances:

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

Establece el título del documento.

Parámetros

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 alcances:

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

Establece la selección del usuario en el documento activo en función de un Range. Una secuencia de comandos solo puede acceder a la selección del usuario que ejecuta la secuencia de comandos y solo si la secuencia está vinculada al 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

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 alcances:

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