Es un documento que 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");
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
addBookmark(position) | Bookmark | Agrega un Bookmark en el Position especificado. |
addEditor(emailAddress) | Document | Agrega el usuario determinado a la lista de editores del Document . |
addEditor(user) | Document | Agrega el usuario determinado a la lista de editores del Document . |
addEditors(emailAddresses) | Document | Agrega el array de usuarios determinado a la lista de editores del Document . |
addFooter() | FooterSection | Agrega una sección de pie de página del documento, si no existe ninguna. |
addHeader() | HeaderSection | Agrega una sección de encabezado de documento, si no existe ninguna. |
addNamedRange(name, range) | NamedRange | Agrega un NamedRange , que es un Range que tiene un nombre y un ID para usar en la recuperación posterior. |
addViewer(emailAddress) | Document | Agrega el usuario determinado a la lista de visualizadores de Document . |
addViewer(user) | Document | Agrega el usuario determinado a la lista de visualizadores de Document . |
addViewers(emailAddresses) | Document | Agrega el array de usuarios determinado a la lista de visualizadores de Document . |
getAs(contentType) | Blob | Recupera el contenido actual de Document como un BLOB del tipo especificado. |
getBlob() | Blob | Recupera el contenido actual de Document como un BLOB. |
getBody() | Body | Recupera el Body del documento activo. |
getBookmark(id) | Bookmark | Obtiene el Bookmark con el ID dado. |
getBookmarks() | Bookmark[] | Obtiene todos los objetos Bookmark del documento. |
getCursor() | Position | Obtiene el cursor del usuario en el documento activo. |
getEditors() | User[] | Obtiene la lista de editores para este Document . |
getFooter() | FooterSection | Recupera la sección del pie de página del documento, si existe. |
getFootnotes() | Footnote[] | Recupera todos los elementos Footnote del cuerpo del documento. |
getHeader() | HeaderSection | Recupera la sección del encabezado del documento, si existe. |
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. |
getNamedRanges() | NamedRange[] | Obtiene todos los objetos NamedRange del documento. |
getNamedRanges(name) | NamedRange[] | Obtiene todos los objetos NamedRange del documento con el nombre determinado. |
getSelection() | Range | Obtiene la selección del usuario en el documento activo. |
getSupportedLanguageCodes() | String[] | Obtiene todos los códigos de idioma compatibles con los archivos de Documentos de Google. |
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 Position nuevo, que es una referencia a una ubicación en el documento en relación con un elemento específico. |
newRange() | RangeBuilder | Crea un compilador que se usa para construir objetos Range a partir de elementos de documentos. |
removeEditor(emailAddress) | Document | Quita al usuario determinado de la lista de editores del Document . |
removeEditor(user) | Document | Quita al usuario determinado de la lista de editores del Document . |
removeViewer(emailAddress) | Document | Quita al usuario determinado de la lista de lectores y comentaristas del Document . |
removeViewer(user) | Document | Quita al usuario determinado de la lista de lectores y comentaristas del Document . |
saveAndClose() | void | Guarda el Document actual. |
setCursor(position) | Document | Configura el cursor del usuario en el documento activo, según un 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 el documento activo, según un Range . |
Documentación detallada
addBookmark(position)
Agrega un Bookmark
en el Position
especificado.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
position | Position | La posición del nuevo favorito. |
Devolvedor
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 del Document
. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se agregará. |
Devolvedor
Document
: Es este Document
para 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 del Document
. Si el usuario ya estaba en la lista de usuarios, este método quita al usuario de la lista.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se agregará. |
Devolvedor
Document
: Es este Document
para 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 de usuarios determinado a la lista de editores del Document
. Si alguno de los usuarios ya estaba en la lista de usuarios, este método lo quita 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. |
Devolvedor
Document
: Es este Document
para 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
addHeader()
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');
Devolvedor
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
addNamedRange(name, range)
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 IDs son únicos dentro del documento, como un ID en HTML. Después de agregar un NamedRange
a un documento, no puedes modificarlo; solo puedes quitarlo.
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 un prefijo a los nombres de los rangos con una string única.
// 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
Nombre | Tipo | Descripción |
---|---|---|
name | String | Es el nombre del rango, que no es necesario que sea único. Los nombres de rangos deben tener entre 1 y 256 caracteres. |
range | Range | El rango de elementos que se asociará con el nombre; el rango puede ser la selección activa, un resultado de búsqueda o crearse manualmente con newRange() . |
Devolvedor
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 determinado a la lista de visualizadores 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 | Es la dirección de correo electrónico del usuario que se agregará. |
Devolvedor
Document
: Es este Document
para 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 determinado a la lista de visualizadores 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á. |
Devolvedor
Document
: Es este Document
para 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 de usuarios determinado a la lista de visualizadores de Document
. Si alguno de los usuarios ya estaba en la lista de editores, este método no tiene efecto.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddresses | String[] | Un array de direcciones de correo electrónico de los usuarios que se agregarán. |
Devolvedor
Document
: Es este Document
para 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
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('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
Nombre | Tipo | Descripción |
---|---|---|
contentType | String | El tipo de MIME al que se realizará la conversión. Por el momento, solo se admite 'application/pdf' . |
Devolvedor
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('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Devolvedor
Blob
: Es el documento actual como un BLOB.
getBody()
Recupera el Body
del documento activo.
Los documentos pueden contener diferentes tipos de secciones (p.ej., HeaderSection
, FooterSection
). La sección activa de un documento es Body
.
Los métodos de elementos de Document
se 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('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Devolvedor
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
getBookmark(id)
Obtiene el Bookmark
con el ID dado. Este método muestra null
si no existe tal 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
Nombre | Tipo | Descripción |
---|---|---|
id | String | El ID de Bookmark . |
Devolvedor
Bookmark
: Es el Bookmark
con el ID dado, o null
si no existe tal 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
getBookmarks()
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);
Devolvedor
Bookmark[]
: Es un array de los objetos Bookmark
en 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
getCursor()
Obtiene el cursor del usuario en el documento activo. 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. 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.'); }
Devolvedor
Position
: Es una representación del cursor del usuario, o bien null
si el usuario no tiene un cursor 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
getEditors()
Obtiene la lista de editores para este Document
.
Devolvedor
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
getFootnotes()
Recupera todos los elementos Footnote
del cuerpo del documento.
Las llamadas a getFootnotes
generan una iteración en los elementos del documento. Para documentos 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('abc123456'); // Gets the first footnote. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Devolvedor
Footnote[]
: Son las notas al pie 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
getHeader()
Recupera la sección del 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());
Devolvedor
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
getId()
Recupera el identificador único del documento. El ID de documento se usa con DocumentApp.openById()
para abrir una instancia de documento específica.
Devolvedor
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. Es el idioma que se muestra en File > Language del editor del documento, que puede no ser el idioma real que contiene el documento.
Devolvedor
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
getName()
Recupera el título del documento.
Devolvedor
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
getNamedRangeById(id)
Obtiene el NamedRange
con el ID dado. 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
Nombre | Tipo | Descripción |
---|---|---|
id | String | el ID del rango, que es único en el documento |
Devolvedor
NamedRange
: Es el NamedRange
con el ID determinado, o bien 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
getNamedRanges()
Obtiene todos los objetos NamedRange
del documento.
Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange
. Para evitar conflictos accidentales entre secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.
Devolvedor
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
getNamedRanges(name)
Obtiene todos los objetos NamedRange
del documento con el nombre determinado. 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 IDs son únicos dentro del documento, como un ID en HTML.
Cualquier secuencia de comandos que acceda al documento puede acceder a un NamedRange
. Para evitar conflictos accidentales entre secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | el nombre del rango, que no es necesariamente único |
Devolvedor
NamedRange[]
: Es un array de los objetos NamedRange
en el 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
getSelection()
Obtiene la selección del usuario en el documento activo. 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. 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.'); }
Devolvedor
Range
: Es una representación de la selección del usuario, o null
si este no tiene ningún elemento 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
getSupportedLanguageCodes()
Obtiene todos los códigos de idioma compatibles con los archivos de Documentos de Google.
Devolvedor
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
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());
Devolvedor
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
.
Devolvedor
User[]
: Es un array de usuarios con permiso de lectura o comentarios.
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 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
Nombre | Tipo | Descripción |
---|---|---|
element | Element | el elemento que contendrá el Position nuevo; debe ser un elemento Text o un elemento contenedor como Paragraph |
offset | Integer | En el caso de los elementos Text , la cantidad de caracteres antes del Position ; en el caso de otros elementos, la cantidad de elementos secundarios antes del Position dentro del mismo elemento contenedor |
Devolvedor
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
newRange()
Crea un compilador que se usa para construir objetos Range
a partir de elementos de documentos.
// 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());
Devolvedor
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 del 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
está en una unidad compartida a la que el usuario puede acceder.
En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de lectores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se quitará. |
Devolvedor
Document
: Es este Document
para 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)
Quita al usuario determinado de la lista de editores del 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
está en una unidad compartida a la que el usuario puede acceder.
En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de lectores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se quitará. |
Devolvedor
Document
: Es este Document
para 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 determinado de la lista de lectores y comentaristas del 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 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, esta acción también quita al usuario de la lista de editores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
emailAddress | String | Es la dirección de correo electrónico del usuario que se quitará. |
Devolvedor
Document
: Es este Document
para 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 determinado de la lista de lectores y comentaristas del Document
. Este método no tiene efecto si el usuario es editor, no 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 Document
se comparte con todo el dominio del usuario o si el Document
está en una unidad compartida a la que el usuario puede acceder).
En el caso de los archivos de Drive, esta acción también quita al usuario de la lista de editores.
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
user | User | Es una representación del usuario que se quitará. |
Devolvedor
Document
: Es este Document
para 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 vacien 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 abierto.
No se puede editar un Document
cerrado. Usa DocumentApp.openById()
para volver a abrir un
documento determinado a fin de 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
setCursor(position)
Configura el cursor del usuario en el documento activo, según un Position
. Una secuencia de comandos solo puede acceder al cursor del usuario que la ejecuta, y solo si esta 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
Nombre | Tipo | Descripción |
---|---|---|
position | Position | la nueva ubicación del cursor |
Devolvedor
Document
: Este Document
, para 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. Es el idioma que se muestra en File
> Language del editor del documento, 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 | Es el código de idioma. |
Devolvedor
Document
: Es este Document
para 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 | el título del documento nuevo |
Devolvedor
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 el documento activo, 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.
// 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
Nombre | Tipo | Descripción |
---|---|---|
range | Range | el nuevo rango de elementos para seleccionar |
Devolvedor
Document
: Este Document
, para 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