Se usó la API de Cloud Translation para traducir esta página.

Class 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.
var doc = DocumentApp.openById("<my-id>");

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

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

Métodos

Método	Tipo de datos que se muestra	Descripción breve
`addBookmark(position)`	`Bookmark`	Agrega un `Bookmark` en la `Position` especificada a la primera pestaña o, para las secuencias de comandos que son vinculado a un documento, la pestaña activa.
`addEditor(emailAddress)`	`Document`	Agrega el usuario determinado a la lista de editores de `Document`.
`addEditor(user)`	`Document`	Agrega el usuario determinado a la lista de editores de `Document`.
`addEditors(emailAddresses)`	`Document`	Agrega el array determinado de usuarios a la lista de editores de `Document`.
`addFooter()`	`FooterSection`	Agrega una sección de pie de página, si no existe ninguna, 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()`	`HeaderSection`	Agrega una sección de encabezado, si no existe ninguna, 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)`	`NamedRange`	Agrega un `NamedRange`, que es un `Range` que tiene un nombre y un ID para usar en la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, en la pestaña activa.
`addViewer(emailAddress)`	`Document`	Agrega el usuario específico a la lista de lectores de `Document`.
`addViewer(user)`	`Document`	Agrega el usuario específico a la lista de lectores de `Document`.
`addViewers(emailAddresses)`	`Document`	Agrega el array determinado de usuarios a la lista de visualizadores de `Document`.
`getActiveTab()`	`Tab`	Obtiene el objeto `Tab` del usuario activo en el documento.
`getAs(contentType)`	`Blob`	Recupera el contenido `Document` actual como un BLOB del tipo especificado.
`getBlob()`	`Blob`	Recupera el contenido `Document` actual como un BLOB.
`getBody()`	`Body`	Recupera el `Body` de la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, el `DocumentBodySection` de la pestaña activa.
`getBookmark(id)`	`Bookmark`	Obtiene el `Bookmark` con el ID dado en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en 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, en la pestaña activa.
`getCursor()`	`Position`	Permite obtener el cursor del usuario en la pestaña activa.
`getEditors()`	`User[]`	Obtiene la lista de editores de este `Document`.
`getFooter()`	`FooterSection`	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, el pie de página de la pestaña activa sección.
`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, el cuerpo de la pestaña activa.
`getHeader()`	`HeaderSection`	Recupera la sección del encabezado de la primera pestaña o, en el caso de las secuencias de comandos que están vinculadas a un documento, el encabezado de la pestaña activa sección.
`getId()`	`String`	Recupera el identificador único del documento.
`getLanguage()`	`String`	Obtiene el código de idioma del documento.
`getName()`	`String`	Recupera el título del documento.
`getNamedRangeById(id)`	`NamedRange`	Obtiene el `NamedRange` con el ID dado en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en 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, en la pestaña activa.
`getNamedRanges(name)`	`NamedRange[]`	Obtiene todos los objetos `NamedRange` con el nombre determinado en la primera pestaña o, para las secuencias de comandos que están vinculados a un documento, la pestaña activa.
`getSelection()`	`Range`	Obtiene la selección del usuario en la pestaña activa.
`getSupportedLanguageCodes()`	`String[]`	Obtiene todos los códigos de idioma compatibles con los archivos de Documentos de Google.
`getTab(tabId)`	`Tab`	Obtiene el `Tab` con el ID especificado.
`getTabs()`	`Tab[]`	Obtiene todos los elementos `Tab` no anidados que forman parte del documento.
`getUrl()`	`String`	Recupera la URL para acceder al documento actual.
`getViewers()`	`User[]`	Obtiene la lista de lectores y comentaristas de este `Document`.
`newPosition(element, offset)`	`Position`	Crea un nuevo elemento `Position`, que es una referencia a una ubicación en la pestaña, en relación con una elemento específico 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.
`newRange()`	`RangeBuilder`	Crea un compilador que se usa para construir objetos `Range` a partir de elementos de pestaña en primera pestaña o, para secuencias de comandos que están vinculadas a una documento, la pestaña activa.
`removeEditor(emailAddress)`	`Document`	Quita al usuario determinado de la lista de editores de `Document`.
`removeEditor(user)`	`Document`	Quita al usuario determinado de la lista de editores de `Document`.
`removeViewer(emailAddress)`	`Document`	Quita al usuario específico de la lista de lectores y comentaristas de `Document`.
`removeViewer(user)`	`Document`	Quita al usuario específico de la lista de lectores y comentaristas de `Document`.
`saveAndClose()`	`void`	Guarda el `Document` actual.
`setActiveTab(tabId)`	`void`	Establece el `Tab` seleccionado del usuario en el documento actual en la pestaña con el ID especificado.
`setCursor(position)`	`Document`	Establece el cursor del usuario, según un objeto `Position`.
`setLanguage(languageCode)`	`Document`	Establece el código de idioma del documento.
`setName(name)`	`Document`	Establece el título del documento.
`setSelection(range)`	`Document`	Establece la selección del usuario en la pestaña activa, según un elemento `Range`.

Documentación detallada

`addBookmark(position)`

Agrega un Bookmark en la Position especificada a la primera pestaña o, para las secuencias de comandos que son vinculado a un documento, la pestaña activa. Para agregar un agrega a favoritos 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(DOCUMENT_ID);

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

Nombre	Tipo	Descripción
`position`	`Position`	La posición del nuevo marcador.

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

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

`addEditor(emailAddress)`

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

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se agregará.

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

`addEditor(user)`

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

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Es una representación del usuario que se agregará.

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

`addEditors(emailAddresses)`

Agrega el array determinado de usuarios a la lista de editores de Document. Si alguno de los usuarios ya estaban en la lista de usuarios; este método los hace desaparecer de la lista de usuarios.

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Un array de direcciones de correo electrónico de los usuarios que se agregarán.

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

`addFooter()`

Agrega una sección de pie de página, si no existe ninguna, 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. Cómo agregar un 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(DOCUMENT_ID);

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

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

`addHeader()`

Agrega una sección de encabezado, si no existe ninguna, 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. Cómo agregar un 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(DOCUMENT_ID);

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

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 primera pestaña o, en el caso de las secuencias de comandos 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 un mismo documento pueden tener el mismo nombre como una clase en HTML. Por el contrario, los IDs son únicos dentro del documento, como un ID en HTML. Después de agregar un NamedRange a un documento, no puedes modificarlo, sino que solo puedes quitarlo.

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

// Creates a named range that includes every table in the active tab.
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]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	El nombre del rango, que no tiene por qué ser único. los nombres de los rangos deben ser entre 1 y 256 caracteres.
`range`	`Range`	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 construido 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 alcances:

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

`addViewer(emailAddress)`

Agrega el usuario específico a la lista de lectores de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se agregará.

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

`addViewer(user)`

Agrega el usuario específico a la lista de lectores de Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Es una representación del usuario que se agregará.

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

`addViewers(emailAddresses)`

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

Parámetros

Nombre	Tipo	Descripción
`emailAddresses`	`String[]`	Un array de direcciones de correo electrónico de los usuarios que se agregarán.

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

`getActiveTab()`

Obtiene el objeto Tab del usuario activo en el documento. Una secuencia de comandos solo puede acceder a la activa del usuario que ejecuta la secuencia de comandos y solo si esta 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: El Tab del usuario activo actualmente, o null si la secuencia de comandos no está vinculada a el 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

`getAs(contentType)`

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

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

Nombre	Tipo	Descripción
`contentType`	`String`	El tipo de MIME en el que se convertirá; Se admiten `'application/pdf'` y `'text/markdown'`.

Volver

Blob: Es el documento actual como un BLOB.

`getBlob()`

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

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

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

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

`getBookmark(id)`

Obtiene el Bookmark con el ID dado en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en 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(DOCUMENT_ID);

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

Nombre	Tipo	Descripción
`id`	`String`	Es el ID de `Bookmark`.

Volver

Bookmark: El Bookmark con el ID proporcionado o null si no existe tal Bookmark existe dentro 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 alcances:

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, en la pestaña activa. Para obtener favoritos en 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(DOCUMENT_ID);

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

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

`getCursor()`

Permite obtener el cursor del usuario en la pestaña activa. Una secuencia de comandos solo puede acceder al cursor del usuario que esté ejecutando la secuencia de comandos, y solo si esta 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 elemento. el 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 alcances:

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

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, el pie de página de la pestaña activa sección. 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(DOCUMENT_ID);

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

Volver

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

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, el cuerpo de la pestaña activa. Para obtener todas las notas al pie de 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 las pestañas grandes, evita 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(DOCUMENT_ID);

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

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

`getHeader()`

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

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

Volver

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

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

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

`getLanguage()`

Obtiene el código de idioma del documento. Este es el idioma que aparece en la opción Archivo del editor de documentos > Idioma, 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 alcances:

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

`getName()`

Recupera el título del documento.

Volver

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

`getNamedRangeById(id)`

Obtiene el NamedRange con el ID dado en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en la pestaña activa. Para obtener la NamedRange por el ID determinado en cualquier pestaña, usa DocumentTab.getNamedRangeById(id). . Este método muestra null si no existe tal NamedRange en la pestaña. Nombres no son necesariamente únicos, ni siquiera entre pestañas; varios intervalos diferentes en la misma pestaña tengan el mismo nombre, como una clase en HTML. Por el contrario, los IDs son únicos dentro de la pestaña, como un ID en HTML.

Parámetros

Nombre	Tipo	Descripción
`id`	`String`	El ID del rango, que es único dentro de la pestaña.

Volver

NamedRange: el NamedRange con el ID proporcionado, o null si no existe tal 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 alcances:

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, en la pestaña activa. Para obtener NamedRange de cualquier pestaña, usa el método DocumentTab.getNamedRanges().

Se puede acceder a un NamedRange con cualquier secuencia de comandos que acceda a la pestaña. Para evitar conflictos no deseados entre secuencias de comandos, considera colocar 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 posiblemente incluya 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

`getNamedRanges(name)`

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

Se puede acceder a un NamedRange con cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre secuencias de comandos, considera colocar un prefijo a los nombres de los rangos con una cadena única.

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	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 alcances:

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 ejecute la secuencia de comandos, y solo si esta 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. cualquier elemento seleccionado en la pestaña, si solo está seleccionado el final de un párrafo, si solo 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

`getSupportedLanguageCodes()`

Obtiene todos los códigos de idioma compatibles con los archivos de Documentos de Google.

Volver

String[]: Indica 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

`getTab(tabId)`

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

Parámetros

Nombre	Tipo	Descripción
`tabId`	`String`	El ID de la pestaña que se obtendrá.

Volver

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

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

`getTabs()`

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

Las pestañas pueden contener pestañas secundarias, una pestaña anidada dentro de otra pestaña. Se puede acceder a las pestañas secundarias usando 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 alcances:

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

`getUrl()`

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

`getViewers()`

Obtiene la lista de lectores y comentaristas de este Document.

Volver

User[]: Es un conjunto 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

`newPosition(element, offset)`

Crea un nuevo elemento Position, que es una referencia a una ubicación en la pestaña, en relación con una elemento específico 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 crear un Position en relación con una ubicación en cualquier pestaña, usa DocumentTab.newPosition(element, offset). . El cursor del usuario se representa como una 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.
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

Nombre	Tipo	Descripción
`element`	`Element`	El elemento que debe contener el `Position` nuevo; este debe ser un elemento `Text` o un elemento contenedor, como `Paragraph`.
`offset`	`Integer`	Para 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 de 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 alcances:

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ña en primera pestaña o, para secuencias de comandos que están vinculadas a una documento, la pestaña activa. A fin de crear un compilador para construir objetos DocumentRange desde los elementos de las pestañas de 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.
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: Es el compilador nuevo.

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

`removeEditor(emailAddress)`

Quita al usuario determinado de la lista de editores de Document. Este método no impedir que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen Acceso general (por ejemplo, si el Document se comparte con todo el dominio, 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 lectores.

Parámetros

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico 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 alcances:

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

`removeEditor(user)`

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

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	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 alcances:

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

`removeViewer(emailAddress)`

Quita al usuario específico de la lista de lectores y comentaristas de Document. Esta no tiene efecto si el usuario es editor, no visualizador ni comentarista. Este método también no impida que los usuarios accedan a Document si pertenecen a una clase de usuarios que tener acceso general (por ejemplo, si el Document se comparte con la cuenta de usuario todo el dominio 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

Nombre	Tipo	Descripción
`emailAddress`	`String`	La dirección de correo electrónico del usuario que se quitará.

Volver

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

`removeViewer(user)`

Quita al usuario específico de la lista de lectores y comentaristas de Document. Esta no tiene efecto si el usuario es editor y no visualizador. Este método tampoco bloquea que los usuarios accedan a Document si pertenecen a una clase de usuarios que tienen permisos generales (por ejemplo, si Document se comparte con todo el dominio del usuario) Si Document está en una unidad compartida a la que el usuario pueda acceder.

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

Parámetros

Nombre	Tipo	Descripción
`user`	`User`	Una representación del usuario que se quitará.

Volver

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

`saveAndClose()`

Guarda el Document actual. Hace que las actualizaciones pendientes se vacían y se apliquen.

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

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

Parámetros

Nombre	Tipo	Descripción
`tabId`	`String`	El ID de la pestaña que se configurará como activa.

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

`setCursor(position)`

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

Si se proporciona un Position de un Tab inactivo, se cambia la pestaña activa del usuario.

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

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

Parámetros

Nombre	Tipo	Descripción
`position`	`Position`	La nueva ubicación del cursor.

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

`setLanguage(languageCode)`

Establece el código de idioma del documento. Este es el idioma que aparece en la opción Archivo del editor de documentos > Idioma, 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

Nombre	Tipo	Descripción
`languageCode`	`String`	El código de idioma.

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

`setName(name)`

Establece el título del documento.

Parámetros

Nombre	Tipo	Descripción
`name`	`String`	Es el título del nuevo documento.

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

`setSelection(range)`

Establece la selección del usuario en la pestaña activa, según un elemento Range. Una secuencia de comandos solo puede acceder a la selección del usuario que ejecuta la secuencia de comandos solo si esta está vinculada al documento

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

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

Parámetros

Nombre	Tipo	Descripción
`range`	`Range`	El nuevo rango de elementos para seleccionar.

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