Class DocumentApp

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.
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

PropiedadTipoDescripción
AttributeAttributeLa enumeración Attribute.
ElementTypeElementTypeLa enumeración ElementType.
FontFamilyFontFamilyLa enumeración FontFamily.
GlyphTypeGlyphTypeLa enumeración GlyphType.
HorizontalAlignmentHorizontalAlignmentLa enumeración HorizontalAlignment.
ParagraphHeadingParagraphHeadingLa enumeración ParagraphHeading.
PositionedLayoutPositionedLayoutLa enumeración PositionedLayout.
TextAlignmentTextAlignmentLa enumeración TextAlignment.
VerticalAlignmentVerticalAlignmentLa enumeración VerticalAlignment.

Métodos

MétodoTipo de datos que se muestraDescripción breve
create(name)DocumentCrea y muestra un documento nuevo.
getActiveDocument()DocumentMuestra el documento al que está vinculada el contenedor de la secuencia de comandos.
getUi()UiMuestra 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)DocumentMuestra el documento con el ID especificado.
openByUrl(url)DocumentAbre 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

NombreTipoDescripción
nameStringel 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

NombreTipoDescripción
idStringel 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

NombreTipoDescripción
urlStringla 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