Class DocumentApp

DocumentApp

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

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

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

Propiedades

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

Métodos

Método	Tipo de datos que se devuelve	Descripción breve
create(name)	Document	Crea y muestra un documento nuevo.
getActiveDocument()	Document	Muestra el documento al que está vinculada la secuencia de comandos.
getUi()	Ui	Muestra una instancia del entorno de la interfaz de usuario del documento que permite que la secuencia de comandos agregue 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.
const doc = DocumentApp.create('Document Name');

Parámetros

Nombre	Tipo	Descripción
name	String	El nombre del documento nuevo.

Volver

Document : La instancia del documento nuevo.

Autorización

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

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

---

getActiveDocument()

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

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

Volver

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

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

---

getUi()

Muestra una instancia del entorno de la interfaz de usuario del documento que permite que la secuencia de comandos agregue 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 de 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 : 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 documento, usa getActiveDocument() en su lugar.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

Parámetros

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

Volver

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

• 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 documento, usa getActiveDocument() en su lugar.

// Open a document by URL.
const 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 : 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 permisos:

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