Es 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 Document.
// Open a document by ID. let doc = DocumentApp.openById('<my-id>'); // Create and open a document. doc = DocumentApp.create('Document Title');
Los métodos de la clase Document que acceden directamente al contenido de texto y lo modifican operan en la pestaña activa (en secuencias de comandos vinculadas a un documento específico) o en la primera pestaña (si no hay una activa disponible). Las secuencias de comandos que dependen de estos métodos (por ejemplo, get) se pueden migrar para que admitan pestañas con get y, luego, Tab.asDocumentTab().
Métodos
| Método | Tipo de datos que se muestra | Descripción breve |
|---|---|---|
add | Bookmark | Agrega un Bookmark en el Position determinado a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa. |
add | Document | Agrega el usuario especificado a la lista de editores del Document. |
add | Document | Agrega el usuario especificado a la lista de editores del Document. |
add | Document | Agrega el array de usuarios proporcionado a la lista de editores del Document. |
add | Footer | Agrega una sección de pie de página, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa. |
add | Header | Agrega una sección de encabezado, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa. |
add | Named | Agrega un Named, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior, en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en la pestaña activa. |
add | Document | Agrega el usuario determinado a la lista de usuarios que pueden ver el Document. |
add | Document | Agrega el usuario determinado a la lista de usuarios que pueden ver el Document. |
add | Document | Agrega el array de usuarios proporcionado a la lista de usuarios que pueden ver el Document. |
get | Tab | Obtiene el Tab activo del usuario en el documento. |
get | Blob | Recupera el contenido actual de Document como un BLOB del tipo especificado. |
get | Blob | Recupera el contenido actual de Document como un BLOB. |
get | Body | Recupera el Body de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, el Document de la pestaña activa. |
get | Bookmark|null | Obtiene el objeto Bookmark con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. |
get | Bookmark[] | Obtiene todos los objetos Bookmark de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. |
get | Position|null | Obtiene el cursor del usuario en la pestaña activa. |
get | User[] | Obtiene la lista de editores de este Document. |
get | Footer | Recupera la sección de pie de página de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la sección de pie de página de la pestaña activa. |
get | Footnote[]|null | Recupera todos los elementos Footnote del cuerpo de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, del cuerpo de la pestaña activa. |
get | Header | Recupera la sección de encabezado de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la sección de encabezado de la pestaña activa. |
get | String | Recupera el identificador único del documento. |
get | String | Obtiene el código de idioma del documento. |
get | String | Recupera el título del documento. |
get | Named | Obtiene el objeto Named con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. |
get | Named | Obtiene todos los objetos Named de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. |
get | Named | Obtiene todos los objetos Named con el nombre determinado en la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. |
get | Range|null | Obtiene la selección del usuario en la pestaña activa. |
get | String[] | Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google. |
get | Tab | Obtiene el Tab con el ID especificado. |
get | Tab[] | Obtiene todos los Tab no anidados que forman parte del documento. |
get | String | Recupera la URL para acceder al documento actual. |
get | User[] | Obtiene la lista de lectores y comentaristas de este Document. |
new | Position | Crea un nuevo Position, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. |
new | Range | Crea un compilador que se usa para construir objetos Range a partir de elementos de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. |
remove | Document | Quita al usuario especificado de la lista de editores del Document. |
remove | Document | Quita al usuario especificado de la lista de editores del Document. |
remove | Document | Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document. |
remove | Document | Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document. |
save | void | Guarda el Document actual. |
set | void | Establece el Tab seleccionado por el usuario en el documento actual en la pestaña con el ID especificado. |
set | Document | Establece el cursor del usuario, dado un Position. |
set | Document | Establece el código de idioma del documento. |
set | Document | Establece el título del documento. |
set | Document | Establece la selección del usuario en la pestaña activa, dado un Range. |
Documentación detallada
add Bookmark(position)
Agrega un Bookmark en el Position determinado a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa. Para agregar un marcador a cualquier pestaña, usa el método Document.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the active or first tab's body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId());
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
position | Position | Posición del nuevo favorito. |
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
add Editor(emailAddress)
Agrega el usuario especificado a la lista de editores del Document. Si el usuario ya estaba en la lista de usuarios, este método lo promueve fuera de ella.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String | Es 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
add Editor(user)
Agrega el usuario especificado a la lista de editores del Document. Si el usuario ya estaba en la lista de usuarios, este método lo promueve fuera de ella.
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
add Editors(emailAddresses)
Agrega el array de usuarios proporcionado a la lista de editores del Document. Si alguno de los usuarios ya estaba en la lista de usuarios con acceso, este método los quita de ella.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String[] | Es 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
add Header()
Agrega una sección de encabezado, si no existe, a la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, a la pestaña activa. Para agregar una sección de encabezado a cualquier pestaña, usa el método Document.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Adds a header to the document's active or first tab. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Volver
Header: 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
add Named Range(name, range)
Agrega un Named, que es un Range que tiene un nombre y un ID para usar en la recuperación posterior, en la primera pestaña o, para las secuencias de comandos que están vinculadas a un documento, en la pestaña activa. Para agregar un Named en cualquier pestaña, usa el método Document. Los nombres no son necesariamente únicos; varios rangos diferentes en el mismo documento pueden compartir el mismo nombre, de forma similar a una clase en HTML. En cambio, los IDs son únicos dentro del documento, como un ID en HTML.
Después de agregar un Named a un documento, no podrás modificarlo, solo quitarlo.
Cualquier secuencia de comandos que acceda al documento puede acceder a un objeto Named. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.
// Creates a named range that includes every table in the active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
name | String | Nombre del rango, que no necesita ser único; los nombres de los rangos deben tener entre 1 y 256 caracteres. |
range | Range | Es 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 se puede construir manualmente con new. |
Volver
Named: Es el Named.
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
add Viewer(emailAddress)
Agrega el usuario determinado a la lista de usuarios que pueden ver el Document. Si el usuario ya estaba en la lista de editores, este método no tiene efecto.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String | Es 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
add Viewer(user)
Agrega el usuario determinado a la lista de usuarios que pueden ver el 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
add Viewers(emailAddresses)
Agrega el array de usuarios proporcionado a la lista de usuarios que pueden ver el Document. Si alguno de los usuarios ya estaba en la lista de editores, este método no tendrá efecto en ellos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String[] | Es 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
get Active Tab()
Obtiene el Tab activo del usuario en el documento. Una secuencia de comandos solo puede acceder a la pestaña activa del usuario que la ejecuta, y solo si está vinculada al documento.
// Display a dialog box that shows the title of the tab that the // user is currently viewing. const tab = DocumentApp.getActiveDocument().getActiveTab(); DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);
Volver
Tab: Es el objeto Tab activo del usuario o null si la secuencia de comandos no está vinculada al documento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get As(contentType)
Recupera el contenido actual de Document como un BLOB del tipo especificado.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
content | String | Tipo de MIME al que se convertirá el archivo. Se admiten 'application/pdf' y 'text/markdown'. |
Volver
Blob: Es el documento actual como un blob.
get 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('123abc'); // Retrieves the current document's contents as a blob and logs it to the // console. console.log(doc.getBlob().getContentType());
Volver
Blob: Es el documento actual como un blob.
get Body()
Recupera el Body de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, el Document de la pestaña activa. Para obtener el Document de cualquier pestaña, usa el método Document.
Las pestañas pueden contener diferentes tipos de secciones (por ejemplo, Header, Footer). La sección activa de una pestaña es la Body.
Los métodos de elementos en Document delegan en el Body activo.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the active or first tab's body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Volver
Body: Es la sección del cuerpo de la pestaña.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Bookmark(id)
Obtiene el objeto Bookmark con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. Para obtener un marcador en cualquier pestaña, usa el método Document. Este método devuelve null si no existe tal Bookmark dentro de la pestaña.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the bookmark by its ID in the document's active or first tab. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the // console. otherwise, logs 'No bookmark exists with the given ID.' to the // console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | String | Es el ID de Bookmark. |
Volver
Bookmark|null: El Bookmark con el ID determinado o null si no existe tal Bookmark 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
get Bookmarks()
Obtiene todos los objetos Bookmark de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. Para obtener todos los marcadores de cualquier pestaña, usa el método Document.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('123abc'); // Gets all of the bookmarks in the document's active or first tab. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the tab to the console. console.log(bookmarks.length);
Volver
Bookmark[]: Es un array de los objetos Bookmark 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
get Cursor()
Obtiene el cursor del usuario en la pestaña activa. Una secuencia de comandos solo puede acceder al cursor del usuario que la ejecuta, y solo si la secuencia de comandos está vinculada al documento.
// Insert some text at the cursor position and make it bold. const cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns // null, the cursor's containing element doesn't allow insertions, so show the // user an error message. const element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Volver
Position|null: Es una representación del cursor del usuario o null si el usuario no tiene un cursor colocado 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
get Editors()
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
get Footnotes()
Recupera todos los elementos Footnote del cuerpo de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, del cuerpo de la pestaña activa. Para obtener todas las notas al pie de cualquier pestaña, usa el método Document.
Las llamadas a get provocan una iteración sobre los elementos de la pestaña. En el caso de las pestañas grandes, evita las llamadas innecesarias a este método.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Volver
Footnote[]|null: 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
get Header()
Recupera la sección de encabezado de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la sección de encabezado de la pestaña activa. Para obtener la sección de encabezado de cualquier pestaña, usa el método Document.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the text of the active or first tab's header and logs it to the console. console.log(doc.getHeader().getText());
Volver
Header: 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
get Id()
Recupera el identificador único del documento. El ID del documento se usa con Document 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
get Language()
Obtiene el código de idioma del documento. Este es el idioma que se muestra en Archivo > Idioma del editor de documentos, que puede no ser el idioma real que contiene el documento.
Volver
String: Es el idioma del documento o null si no se define.
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
get Name()
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
get Named Range By Id(id)
Obtiene el objeto Named con el ID determinado en la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. Para obtener el objeto Named con el ID determinado en cualquier pestaña, usa el método Document. Este método devuelve null si no existe tal Named en la pestaña. Los nombres no son necesariamente únicos, ni siquiera entre pestañas; varios rangos diferentes en la misma pestaña pueden compartir el mismo nombre, de forma similar a una clase en HTML. En cambio, los IDs son únicos dentro de la pestaña, como un ID en HTML.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
id | String | ID del rango, que es único dentro de la hoja. |
Volver
Named: El Named con el ID determinado 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
get Named Ranges()
Obtiene todos los objetos Named de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. Para obtener todos los objetos Named en cualquier pestaña, usa el método Document.
Se puede acceder a un objeto Named desde cualquier secuencia de comandos que acceda a la pestaña. Para evitar conflictos no deseados entre las secuencias de comandos, considera agregar un prefijo a los nombres de los rangos con una cadena única.
Volver
Named: Es un array de los objetos Named en la pestaña, que posiblemente incluye 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
get Named Ranges(name)
Obtiene todos los objetos Named con el nombre determinado en la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. Para obtener todos los objetos Named en cualquier pestaña, usa el método Document. Los nombres no son necesariamente únicos, ni siquiera entre las pestañas; varios rangos diferentes en la misma pestaña pueden compartir el mismo nombre, de forma similar a una clase en HTML. En cambio, los IDs son únicos dentro de la pestaña, como un ID en HTML.
Se puede acceder a un Named desde cualquier secuencia de comandos que acceda al documento. Para evitar conflictos no deseados entre las 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 | Nombre del rango, que no necesariamente es único. |
Volver
Named: Es un array de los objetos Named 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
get Selection()
Obtiene la selección del usuario en la pestaña activa. Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta, y solo si está vinculada al documento.
// Display a dialog box that tells the user how many elements are included in // the selection. const selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { const elements = selection.getRangeElements(); DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Volver
Range|null: Es una representación de la selección del usuario o null si el usuario no seleccionó nada en la pestaña, si solo se seleccionó el final de un párrafo, si solo se seleccionó 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
get Supported Language Codes()
Obtiene todos los códigos de idioma que se admiten en los archivos de Documentos de Google.
Volver
String[]: Es un array de códigos de idioma.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Tab(tabId)
Obtiene el Tab con el ID especificado. Este método devuelve null si no existe tal Tab. Puede acceder a las pestañas en cualquier nivel de anidación.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
tab | String | 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
get Tabs()
Obtiene todos los Tab no anidados que forman parte del documento.
Las pestañas pueden contener pestañas secundarias, es decir, una pestaña anidada dentro de otra. Se puede acceder a las pestañas secundarias con Tab.getChildTabs().
Volver
Tab[]: Es la lista de todos los Tab que forman parte del documento.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Url()
Recupera la URL para acceder al documento actual.
const doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());
Volver
String: Es la URL para acceder al documento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Viewers()
Obtiene la lista de lectores y comentaristas de este 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
new Position(element, offset)
Crea un nuevo Position, que es una referencia a una ubicación en la pestaña, en relación con un elemento específico de la primera pestaña o, para las secuencias de comandos vinculadas a un documento, la pestaña activa. Para crear un Position relativo a una ubicación en cualquier pestaña, usa el método Document. El cursor del usuario se representa como un Position, entre otros usos.
// Append a paragraph to the active tab, then place the user's cursor after the // first word of the new paragraph. const doc = DocumentApp.getActiveDocument(); const paragraph = doc.getBody().appendParagraph('My new paragraph.'); const position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
element | Element | El elemento que debe contener el nuevo Position; debe ser un elemento Text o un elemento contenedor como Paragraph. |
offset | Integer | Para los elementos Text, la cantidad de caracteres antes del Position; para otros elementos, la cantidad de elementos secundarios antes del Position dentro del mismo elemento contenedor. |
Volver
Position: Es el nuevo Position.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
new Range()
Crea un compilador que se usa para construir objetos Range a partir de elementos de la primera pestaña o, en el caso de las secuencias de comandos vinculadas a un documento, la pestaña activa. Para crear un compilador que se use para construir objetos Document a partir de elementos de pestañas en cualquier pestaña, usa el método Document.
// Change the user's selection to a range that includes every table in the // active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Volver
Range: Es el nuevo compilador.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Editor(emailAddress)
Quita al usuario especificado de la lista de editores del Document. Este método no impide que los usuarios accedan al Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el 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 visualizadores.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String | Es 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
remove Editor(user)
Quita al usuario especificado de la lista de editores del Document. Este método no impide que los usuarios accedan al Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el 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 visualizadores.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
user | User | Es 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
remove Viewer(emailAddress)
Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document. Este método no tiene efecto si el usuario es editor, no visualizador ni comentarista. Este método tampoco impide que los usuarios accedan al Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Document se comparte con todo el dominio del usuario o si el Document se encuentra en una unidad compartida a la que el usuario puede acceder.
En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
email | String | Es la dirección de correo electrónico del usuario que se quitará. |
Volver
Document: Es 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
remove Viewer(user)
Quita al usuario determinado de la lista de usuarios que pueden ver y comentar el Document. Este método no tiene efecto si el usuario es editor y no visualizador. Este método tampoco impide que los usuarios accedan al Document si pertenecen a una clase de usuarios que tienen acceso general, por ejemplo, si el Document se comparte con todo el dominio del usuario o si el Document se encuentra en una unidad compartida a la que el usuario puede acceder.
En el caso de los archivos de Drive, también se quita al usuario de la lista de editores.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
user | User | Es una representación del usuario que se quitará. |
Volver
Document: Es 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
save And Close()
Guarda el Document actual. Hace que se vacíen y apliquen las actualizaciones pendientes.
El método save 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 Document para volver a abrir un documento determinado y editarlo.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Active Tab(tabId)
Establece el Tab seleccionado por el usuario en el documento actual en la pestaña con el ID especificado.
const doc = DocumentApp.getActiveDocument(); // Sets the user's selected tab by its ID. // TODO(developer): Replace the ID with your own. const tab = doc.setActiveTab('123abc');
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
tab | String | ID de la pestaña que se establecerá como activa. |
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Cursor(position)
Establece el cursor del usuario, dado un Position. Una secuencia de comandos solo puede acceder al cursor del usuario que la ejecuta, y solo si la secuencia de comandos está vinculada al documento.
Si se proporciona un Position desde un Tab inactivo, se cambia la pestaña activa del usuario.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the // new paragraph. const paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); const position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
position | Position | Es 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
set Language(languageCode)
Establece el código de idioma del documento. Este es el idioma que se muestra en Archivo > Idioma del editor de documentos, que puede no ser el idioma real que contiene el documento. Usa get para obtener todos los códigos de idioma válidos.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
language | String | Es 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
set Name(name)
Establece el título del documento.
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
name | String | Es el título del documento nuevo. |
Volver
Document: Es el documento actual.
Autorización
Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Selection(range)
Establece la selección del usuario en la pestaña activa, dado un Range. Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta, y solo si está vinculada al documento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the // document. const rangeBuilder = documentTab.newRange(); const tables = documentTab.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parámetros
| Nombre | Tipo | Descripción |
|---|---|---|
range | Range | Es el nuevo rango de elementos que se seleccionará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