Class DocumentApp

DocumentApp

El servicio de documentos crea y abre Documents, que se puede editar.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

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

Propiedades

Propiedad	Tipo	Descripción
Attribute	Attribute	La enumeración Attribute.
ElementType	ElementType	La enumeración ElementType.
FontFamily	FontFamily	La enumeración FontFamily.
GlyphType	GlyphType	La enumeración GlyphType.
HorizontalAlignment	HorizontalAlignment	La enumeración HorizontalAlignment.
ParagraphHeading	ParagraphHeading	La enumeración ParagraphHeading.
PositionedLayout	PositionedLayout	La enumeración PositionedLayout.
TextAlignment	TextAlignment	La enumeración TextAlignment.
VerticalAlignment	VerticalAlignment	La enumeración VerticalAlignment.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
create(name)	Document	Crea y muestra un documento nuevo.
getActiveDocument()	Document	Muestra el documento al que está vinculada el contenedor de la secuencia de comandos.
getUi()	Ui	Muestra una instancia del entorno de interfaz de usuario del documento que permite a la secuencia de comandos agregar funciones como menús, diálogos y barras laterales.
openById(id)	Document	Muestra el documento con el ID especificado.
openByUrl(url)	Document	Abre y muestra el documento con la URL especificada.

Documentación detallada

create(name)

Crea y muestra un documento nuevo.

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

Parámetros

Nombre	Tipo	Descripción
name	String	el nombre del nuevo documento

Volver

Document: Es la instancia de documento nueva.

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

---

getActiveDocument()

Muestra el documento al que está vinculada el contenedor de la secuencia de comandos. Para interactuar con el documento al que la secuencia de comandos no está vinculada con el contenedor, usa openById(id) o openByUrl(url) en su lugar.

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

Volver

Document: Es la instancia 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

---

getUi()

Muestra una instancia del entorno de interfaz de usuario del documento que permite a la secuencia de comandos agregar funciones como menús, diálogos y barras laterales. Una secuencia de comandos solo puede interactuar con la IU de la instancia actual de un documento abierto y solo si la secuencia de comandos está vinculada al documento. Para obtener más información, consulta las guías sobre menús y diálogos y barras laterales.

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Volver

Ui: Es una instancia del entorno de la interfaz de usuario de este documento.

---

openById(id)

Muestra el documento con el ID especificado. Si la secuencia de comandos está vinculada al contenedor con el documento, usa getActiveDocument() en su lugar.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

Parámetros

Nombre	Tipo	Descripción
id	String	el ID del documento que se abrirá

Volver

Document: Es la instancia 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

---

openByUrl(url)

Abre y muestra el documento con la URL especificada. Si la secuencia de comandos está vinculada al contenedor con el documento, usa getActiveDocument() en su lugar.

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

Parámetros

Nombre	Tipo	Descripción
url	String	la URL del documento que se abrirá

Volver

Document: Es la instancia 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