Class Page

Página

Una página en un sitio de Google.

Métodos

MétodoTipo de datos que se muestraDescripción breve
addColumn(name)ColumnAgrega una columna nueva a la lista.
addHostedAttachment(blob)AttachmentAgrega un archivo adjunto a la página.
addHostedAttachment(blob, description)AttachmentAgrega un archivo adjunto a la página.
addListItem(values)ListItemAgrega un elemento a la lista.
addWebAttachment(title, description, url)AttachmentAgrega un archivo adjunto web a la página.
createAnnouncement(title, html)PageCrea anuncios para esta página.
createAnnouncement(title, html, asDraft)PageCrea anuncios para esta página.
createAnnouncementsPage(title, name, html)PageCrea una nueva página de anuncios.
createFileCabinetPage(title, name, html)PageCrea una nueva página de gabinete de archivos.
createListPage(title, name, html, columnNames)PageCrea una nueva página de lista.
createPageFromTemplate(title, name, template)PageCrea una página nueva a partir de una plantilla.
createWebPage(title, name, html)PageCrea una nueva página web.
deletePage()voidBorra esta página.
getAllDescendants()Page[]Obtiene un arreglo de páginas descendientes (directas e indirectas), hasta un límite de 200 páginas.
getAllDescendants(options)Page[]Obtiene un arreglo de páginas descendientes con argumentos avanzados opcionales.
getAnnouncements()Page[]Obtén los anuncios de esta página.
getAnnouncements(optOptions)Page[]Obtén los anuncios de esta página.
getAttachments()Attachment[]Obtén los archivos adjuntos de esta página.
getAttachments(optOptions)Attachment[]Obtén los archivos adjuntos de esta página.
getAuthors()String[]Recibir los correos electrónicos de los autores de la página
getChildByName(name)PageObtiene una página secundaria en particular.
getChildren()Page[]Obtiene un arreglo de páginas secundarias, hasta un límite de 200 páginas.
getChildren(options)Page[]Obtiene una matriz de páginas secundarias, con argumentos avanzados opcionales.
getColumns()Column[]Obtén las columnas de la lista.
getDatePublished()DateMuestra la fecha en que se publicó esta página por primera vez.
getHtmlContent()StringObtén el contenido HTML de la página.
getIsDraft()BooleanMuestra si la página está en modo borrador.
getLastEdited()DateMuestra la fecha de la última modificación, que incluye solo las ediciones de contenido.
getLastUpdated()DateMuestra la fecha de la última actualización, que incluye cambios que no son de contenido, como mudanzas.
getListItems()ListItem[]Obtén los elementos de la lista.
getListItems(optOptions)ListItem[]Obtén los elementos de la lista.
getName()StringMuestra el nombre de la página.
getPageType()PageTypeMuestra el tipo de esta página como una enumeración de SitesApp.PageType.
getParent()PageMuestra el elemento superior de esta página.
getTextContent()StringMuestra el contenido de la página de texto sin formato.
getTitle()StringMuestra el título de la página.
getUrl()StringObtén la URL de la página.
isDeleted()BooleanMuestra si se borró una página.
isTemplate()BooleanMuestra si esta página es una plantilla copiable.
publishAsTemplate(name)PagePublica esta página como una plantilla que se pueda copiar.
search(query)Page[]Obtiene un arreglo de páginas descendientes que coinciden con una búsqueda, hasta un límite de 200 páginas.
search(query, options)Page[]Obtiene un arreglo de páginas descendientes que coinciden con una consulta de búsqueda, con argumentos avanzados opcionales.
setHtmlContent(html)PageEstablece el contenido HTML de la página.
setIsDraft(draft)PageEstablece si la página está en modo de borrador.
setName(name)PageEstablece el nombre de esta página.
setParent(parent)PageEstablece el elemento superior de esta página.
setTitle(title)PageEstablece el título de la página.

Documentación detallada

addColumn(name)

Agrega una columna nueva a la lista. Solo es válido para las páginas de lista.

var site = SitesApp.getSite("example.com", "mysite");

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var columns = page.addColumn("new-column");

Parámetros

NombreTipoDescripción
nameStringel nombre de la columna nueva

Volver

Column: La columna recién creada

Arroja

Error: Para las páginas que no son listas.

Autorización

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

  • https://sites.google.com/feeds

addHostedAttachment(blob)

Agrega un archivo adjunto a la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Create a new blob and attach it. Many useful functions also return
// blobs file uploads, URLFetch
var blob = Utilities.newBlob("Here is some data", "text/plain", "data.txt");

// Note that the filename must be unique or this call will fail
page.addHostedAttachment(blob);

Parámetros

NombreTipoDescripción
blobBlobSourcelos datos del adjunto

Volver

Attachment: el adjunto recién creado

Autorización

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

  • https://sites.google.com/feeds

addHostedAttachment(blob, description)

Agrega un archivo adjunto a la página. Esta versión de la función permite una descripción.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Create a new blob and attach it. Many useful: functions also return
// blobs file uploads, URLFetch
var blob = Utilities.newBlob("Here is some data", "text/plain", "data.txt");

// Note that the filename must be unique or this call will fail
page.addHostedAttachment(blob, "Some newly created data");

Parámetros

NombreTipoDescripción
blobBlobSourcelos datos del adjunto
descriptionStringuna descripción del archivo adjunto

Volver

Attachment: el adjunto recién creado

Autorización

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

  • https://sites.google.com/feeds

addListItem(values)

Agrega un elemento a la lista. Solo es válido para las páginas de lista.

var site = SitesApp.getSite("example.com", "mysite");

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
// Returns only one item
page.addListItem([ "John", "Smith", "123 Main St"]);

Parámetros

NombreTipoDescripción
valuesString[]los valores de cada columna

Volver

ListItem: El ListItem recién creado

Autorización

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

  • https://sites.google.com/feeds

addWebAttachment(title, description, url)

Agrega un archivo adjunto web a la página. Solo es válido para las páginas del gabinete de archivos.

Los archivos adjuntos en la Web son vínculos, en realidad no están alojados en Google Sites.

var site = SitesApp.getSite("example.com", "mysite");
// fetch the child - this must be a File Cabinet page
// to programmatically check this, do a comparison:
//    if(page.getPageType() == SitesApp.PageType.FILE_CABINET_PAGE)
var page = site.getChildByName("files");
page.addWebAttachment("Google Robots file",
                      "This is Google's robots.txt file",
                      "http://www.google.com/robots.txt");

Parámetros

NombreTipoDescripción
titleStringel título del archivo adjunto
descriptionStringuna descripción del archivo adjunto
urlStringla URL del archivo adjunto

Volver

Attachment: el adjunto recién creado

Autorización

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

  • https://sites.google.com/feeds

createAnnouncement(title, html)

Crea anuncios para esta página. Solo es válido para las páginas de anuncios.

var site = SitesApp.getSite("example.com", "mysite");

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
page.createAnnouncement("Breaking news!", "<h1>Apps Script rocks!</h1>");

Parámetros

NombreTipoDescripción
titleStringel título de la página
htmlStringel contenido de la página

Volver

Page: los anuncios creados recientemente

Arroja

Error: para páginas que no son páginas de anuncios.

Autorización

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

  • https://sites.google.com/feeds

createAnnouncement(title, html, asDraft)

Crea anuncios para esta página. Solo es válido para las páginas de anuncios.

var site = SitesApp.getSite("example.com", "mysite");

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
page.createAnnouncement("Breaking news!",
                        "<h1>Apps Script rocks!</h1>",
                        true);

Parámetros

NombreTipoDescripción
titleStringel título de la página
htmlStringel contenido de la página
asDraftBooleansi deseas que el anuncio sea un borrador

Volver

Page: los anuncios creados recientemente

Arroja

Error: para páginas que no son páginas de anuncios.

Autorización

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

  • https://sites.google.com/feeds

createAnnouncementsPage(title, name, html)

Crea una nueva página de anuncios. Ten en cuenta que un sitio principal o una página no puede tener más de 500 páginas secundarias.

// This method can be called from both a Site instance
// as well as a Page instance
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

Parámetros

NombreTipoDescripción
titleStringel título de la página
nameStringel nombre de la página
htmlStringel contenido de la página

Volver

Page: El Page recién creado

Autorización

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

  • https://sites.google.com/feeds

createFileCabinetPage(title, name, html)

Crea una nueva página de gabinete de archivos. Ten en cuenta que un sitio principal o una página no pueden tener más de 500 páginas secundarias.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createFileCabinetPage("New File Cabinet",
                           "new-file-cabinet",
                           "<h1>Your HTML here</h1>");

page.createFileCabinetPage("New File Cabinet",
                             "new-file-cabinet-child",
                             "<h1>Your HTML here</h1>");

Parámetros

NombreTipoDescripción
titleStringel título de la página
nameStringel nombre de la página
htmlStringel contenido de la página

Volver

Page: La nueva Page

Autorización

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

  • https://sites.google.com/feeds

createListPage(title, name, html, columnNames)

Crea una nueva página de lista. Tenga en cuenta que un sitio principal o una página no pueden tener más de 500 páginas secundarias.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createListPage("New List Page",
                    "new-list-page",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

page.createListPage("New List Page",
                    "new-list-page-child",
                    "<h1>Your List Page HTML here</h1>",
                    [ "col1", "col2" ]);

Parámetros

NombreTipoDescripción
titleStringel título de la página
nameStringel nombre de la página
htmlStringel contenido de la página
columnNamesString[]los nombres de columna utilizados para la lista

Volver

Page: La nueva Page

Autorización

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

  • https://sites.google.com/feeds

createPageFromTemplate(title, name, template)

Crea una página nueva a partir de una plantilla. Ten en cuenta que un sitio principal o una página no puede tener más de 500 páginas secundarias.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var template = site.getTemplates()[0];

// If an invalid template is passed, this will throw an "Invalid Argument" error.
site.createPageFromTemplate("ClonedPage", "cloned-page", template);

Parámetros

NombreTipoDescripción
titleStringel título de la página
nameStringel nombre de la página
templatePagela página de la plantilla

Volver

Page: El Page recién creado

Autorización

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

  • https://sites.google.com/feeds

createWebPage(title, name, html)

Crea una nueva página web. Tenga en cuenta que un sitio principal o una página no pueden tener más de 500 páginas secundarias.

// This method can be called from either a site or a page.
var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

site.createAnnouncementsPage("New Announcement",
                             "new-announcement",
                             "<h1>Your announcement goes here</h1>");

page.createAnnouncementsPage("New Announcement",
                             "new-announcement-child",
                             "<h1>Your announcement goes here</h1>");

Parámetros

NombreTipoDescripción
titleStringel título de la página
nameStringel nombre de la página
htmlStringel contenido de la página

Volver

Page: La nueva Page

Autorización

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

  • https://sites.google.com/feeds

deletePage()

Borra esta página.

var site = SitesApp.getSite("example.com", "mysite");

// Delete ALL the pages!
var pages = site.getAllDescendants();
for(var i in pages) {
  pages[i].deletePage();
}

Autorización

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

  • https://sites.google.com/feeds

getAllDescendants()

Obtiene un arreglo de páginas descendientes (directas e indirectas), hasta un límite de 200 páginas.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getAllDescendants();

Volver

Page[]: Es un array de páginas secundarias directas e indirectas.

Autorización

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

  • https://sites.google.com/feeds

getAllDescendants(options)

Obtiene un arreglo de páginas descendientes con argumentos avanzados opcionales.

var site = SitesApp.getSite("example.com", "mysite");
var descendants = site.getAllDescendants({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in descendants) {
  Logger.log(descendants[i].getName());
}

Parámetros

NombreTipoDescripción
optionsObjectCampos de objetos de JavaScript definidos en la sección Argumentos avanzados a continuación

Parámetros avanzados

NombreTipoDescripción
typePageType[]solo obtener páginas de este tipo
startIntegercomienza los resultados aquí
maxIntegerla cantidad máxima de resultados (200 predeterminados)
includeDraftsBooleansi se deben incluir páginas en borrador (valor predeterminado: falso)
includeDeletedBooleansi se deben incluir páginas eliminadas (falso predeterminado)
searchStringmostrar solo páginas que coincidan con esta consulta

Volver

Page[]: Es un array de páginas secundarias indirectas y directas del tipo 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://sites.google.com/feeds

getAnnouncements()

Obtén los anuncios de esta página. Solo es válido para las páginas de anuncios.

var site = SitesApp.getSite("example.com", "mysite");

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
var announcements = page.getAnnouncements();

for(var i in announcements) {
  Logger.log(announcements[i].getHtmlContent());
}

Volver

Page[]: Es un arreglo de anuncios.

Arroja

Error: para páginas que no son páginas de anuncios.

Autorización

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

  • https://sites.google.com/feeds

getAnnouncements(optOptions)

Obtén los anuncios de esta página. Solo es válido para las páginas de anuncios.

var site = SitesApp.getSite("example.com", "mysite");

// This snippet will only work with announcement pages - this is different
// from a page that is an annoucement (individual announcements). To check
// if this method can be called:
//    if(page.getPageType() == SitesApp.PageType.ANNOUNCEMENTS_PAGE))
var page = site.getChildByName("news");
var announcements = page.getAnnouncements({ start: 0,
                                            max: 20,
                                            includeDrafts: false,
                                            includeDeleted: false,
                                            search: "Breaking" });

for(var i in announcements) {
  Logger.log(announcements[i].getHtmlContent());
}

Parámetros

NombreTipoDescripción
optOptionsObjectUn objeto JavaScript que contiene parámetros avanzados

Parámetros avanzados

NombreTipoDescripción
startIntegerel índice de inicio de los resultados
maxIntegerla cantidad máxima de resultados que se mostrarán, que es un valor predeterminado de 200 como máximo
includeDraftsBooleansi se deben incluir páginas en borrador (valor predeterminado: falso)
includeDeletedBooleansi se deben incluir páginas eliminadas (falso predeterminado)
searchStringmostrar solo páginas que coincidan con esta consulta

Volver

Page[]: Es un arreglo de anuncios.

Arroja

Error: para páginas que no son páginas de anuncios.

Autorización

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

  • https://sites.google.com/feeds

getAttachments()

Obtén los archivos adjuntos de esta página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

var attachments = page.getAttachments();
for(var i in attachments) {
  Logger.log(attachments[i].getTitle());
}

Volver

Attachment[]: Es un arreglo de adjuntos.

Autorización

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

  • https://sites.google.com/feeds

getAttachments(optOptions)

Obtén los archivos adjuntos de esta página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// This returns only one attachment
var attachments = page.getAttachments({ start: 0, max: 1});
for(var i in attachments) {
  Logger.log(attachments[i].getTitle());
}

Parámetros

NombreTipoDescripción
optOptionsObjectun objeto JavaScript que contiene parámetros opcionales

Parámetros avanzados

NombreTipoDescripción
startIntegerel primer índice para comenzar a mostrar archivos adjuntos
maxIntegerla cantidad máxima de resultados que se mostrarán, que es un valor predeterminado de 200 como máximo

Volver

Attachment[]: Es un arreglo de adjuntos.

Autorización

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

  • https://sites.google.com/feeds

getAuthors()

Recibir los correos electrónicos de los autores de la página

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
var authors = page.getAuthors();

for(var i in authors) {
  Logger.log(authors[i]);
}

Volver

String[]: un arreglo de direcciones de correo electrónico del autor

Autorización

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

  • https://sites.google.com/feeds

getChildByName(name)

Obtiene una página secundaria en particular.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildByName("childPage");

Parámetros

NombreTipoDescripción
nameStringel nombre de la página secundaria

Volver

Page: la página secundaria

Autorización

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

  • https://sites.google.com/feeds

getChildren()

Obtiene un arreglo de páginas secundarias, hasta un límite de 200 páginas.

var site = SitesApp.getSite("example.com", "mysite");
var pages = site.getChildren();

Volver

Page[]: Es un array de páginas secundarias directas.

Autorización

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

  • https://sites.google.com/feeds

getChildren(options)

Obtiene una matriz de páginas secundarias, con argumentos avanzados opcionales.

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

Parámetros

NombreTipoDescripción
optionsObjectCampos de objetos de JavaScript definidos en la sección Argumentos avanzados a continuación

Parámetros avanzados

NombreTipoDescripción
typePageType[]solo obtener páginas de este tipo
startIntegercomienza los resultados aquí
maxIntegerla cantidad máxima de resultados (200 predeterminados)
includeDraftsBooleansi se deben incluir páginas en borrador (valor predeterminado: falso)
includeDeletedBooleansi se deben incluir páginas eliminadas (falso predeterminado)
searchStringmostrar solo páginas que coincidan con esta consulta

Volver

Page[]: Es un arreglo de páginas secundarias directas del tipo 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://sites.google.com/feeds

getColumns()

Obtén las columnas de la lista. Solo es válido para las páginas de lista.

var site = SitesApp.getSite("example.com", "mysite");

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var columns = page.getColumns();

for(var i in columns) {
  Logger.log(columns[i].getName());
}

Volver

Column[]: Es un arreglo de instancias de Column.

Arroja

Error: Para las páginas que no son listas.

Autorización

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

  • https://sites.google.com/feeds

getDatePublished()

Muestra la fecha en que se publicó esta página por primera vez.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was published " + page.getDatePublished());

Volver

Date: Es la fecha de publicación original.

Autorización

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

  • https://sites.google.com/feeds

getHtmlContent()

Obtén el contenido HTML de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getHtmlContent());

Volver

String: Es el contenido HTML.

Autorización

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

  • https://sites.google.com/feeds

getIsDraft()

Muestra si la página está en modo borrador. Solo es válido para los anuncios.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

Logger.log("Is this Announcement Page a draft?", page.getIsDraft());

Volver

Boolean: Si la página está en modo de borrador

Autorización

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

  • https://sites.google.com/feeds

getLastEdited()

Muestra la fecha de la última modificación, que incluye solo las ediciones de contenido.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was last updated " + page.getLastEdited());

Volver

Date: La fecha de la última actualización de la página, incluidas las ediciones de contenido

Autorización

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

  • https://sites.google.com/feeds

getLastUpdated()

Muestra la fecha de la última actualización, que incluye cambios que no son de contenido, como mudanzas.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " was last updated " + page.getLastUpdated());

Volver

Date: La fecha de la última actualización de la página con cambios no relacionados con el contenido

Autorización

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

  • https://sites.google.com/feeds

getListItems()

Obtén los elementos de la lista. Solo es válido para las páginas de lista.

var site = SitesApp.getSite("example.com", "mysite");

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
var items = page.getListItems();

for(var i in items) {
  Logger.log(items[i].getValueByName("Status"));
}

Volver

ListItem[]: Es un arreglo de instancias de ListItem.

Arroja

Error: Para las páginas que no son listas.

Autorización

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

  • https://sites.google.com/feeds

getListItems(optOptions)

Obtén los elementos de la lista. Solo es válido para las páginas de lista.

var site = SitesApp.getSite("example.com", "mysite");

var page = site.getChildByName("listpage");
// Only valid on List pages. Check for the type like so:
//     if(page.getPageType() == SitesApp.PageType.LIST_PAGE))
// Returns only one item
var items = page.getListItems({ start:0, max: 1 });

for(var i in items) {
  Logger.log(items[i].getValueByName("Status"));
}

Parámetros

NombreTipoDescripción
optOptionsObjectUn objeto JavaScript de parámetros opcionales

Parámetros avanzados

NombreTipoDescripción
startIntegerel primer índice desde el que comenzar
maxIntegerla cantidad máxima de resultados que se mostrarán, que es un valor predeterminado de 200 como máximo

Volver

ListItem[]: Es un arreglo de instancias de ListItem.

Arroja

Error: Para las páginas que no son listas.

Autorización

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

  • https://sites.google.com/feeds

getName()

Muestra el nombre de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName());

Volver

String: Es el nombre de esta página.

Autorización

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

  • https://sites.google.com/feeds

getPageType()

Muestra el tipo de esta página como una enumeración de SitesApp.PageType.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
var pageType = page.getPageType();
if(pageType == SitesApp.PageType.WEB_PAGE) {
   Logger.log(page.getName() + " is a Web Page");
}

Volver

PageType: Es una enumeración PageType que indica si se trata de una página web, de lista, de anuncios o de gabinete de archivos.

Autorización

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

  • https://sites.google.com/feeds

getParent()

Muestra el elemento superior de esta página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " parent: " + page.getParent().getName());

Volver

Page: Es la página principal de esta página.

Autorización

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

  • https://sites.google.com/feeds

getTextContent()

Muestra el contenido de la página de texto sin formato.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getName() + " content: " + page.getTextContent());

Volver

String: Es el contenido de texto sin formato de la página.

Autorización

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

  • https://sites.google.com/feeds

getTitle()

Muestra el título de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getTitle());

Volver

String: Es el título de esta página.

Autorización

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

  • https://sites.google.com/feeds

getUrl()

Obtén la URL de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
Logger.log(page.getUrl());

Volver

String: Es la URL de la página.

Autorización

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

  • https://sites.google.com/feeds

isDeleted()

Muestra si se borró una página.

Volver

Boolean: Indica si se borró la página.

Autorización

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

  • https://sites.google.com/feeds

isTemplate()

Muestra si esta página es una plantilla copiable.

var site = SitesApp.getSite("example.com", "mysite");
var firstTemplate = site.getTemplates()[0];
if(firstTemplate.isTemplate()) {
  Logger.log("This will always return true");
}

Volver

Boolean: Si esta página es una plantilla.

Autorización

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

  • https://sites.google.com/feeds

publishAsTemplate(name)

Publica esta página como una plantilla que se pueda copiar.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Turn this page into a publishable template
page.publishedAsTemplate("template-name");

Parámetros

NombreTipoDescripción
nameStringEl nombre de la plantilla nueva

Volver

Page: La plantilla recién publicada

Autorización

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

  • https://sites.google.com/feeds

search(query)

Obtiene un arreglo de páginas descendientes que coinciden con una búsqueda, hasta un límite de 200 páginas.

var site = SitesApp.getSite("example.com", "mysite");
var matches = site.search("targetText");

for(var i in matches) {
  Logger.log(matches[i].getName());
}

Parámetros

NombreTipoDescripción
queryStringla consulta de búsqueda de texto completa que debe coincidir

Volver

Page[]: Es un array de páginas secundarias indirectas y directas del tipo 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://sites.google.com/feeds

search(query, options)

Obtiene un arreglo de páginas descendientes que coinciden con una consulta de búsqueda, con argumentos avanzados opcionales.

var site = SitesApp.getSite("example.com", "mysite");
var childPages = site.getChildren({
  type: SitesApp.PageType.WEB_PAGE,
  start: 0,
  max: 25,
  includeDrafts: false,
  includeDeleted: true,
  search: "target"
});

for(var i in childPages) {
  Logger.log(childPages[i].getName());
}

Parámetros

NombreTipoDescripción
queryStringla consulta de búsqueda de texto completa que debe coincidir
optionsObjectCampos de objetos de JavaScript definidos en la sección Argumentos avanzados a continuación

Parámetros avanzados

NombreTipoDescripción
typePageType[]solo obtener páginas de este tipo
startIntegercomienza los resultados aquí
maxIntegerla cantidad máxima de resultados (200 predeterminados)
includeDraftsBooleansi se deben incluir páginas en borrador (valor predeterminado: falso)
includeDeletedBooleansi se deben incluir páginas eliminadas (falso predeterminado)

Volver

Page[]: Es un array de páginas secundarias indirectas y directas del tipo 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://sites.google.com/feeds

setHtmlContent(html)

Establece el contenido HTML de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setHtmlContent("<h1>New Page Content</h1>");

Parámetros

NombreTipoDescripción
htmlStringel nuevo contenido

Volver

Page: esta página para encadenar

Autorización

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

  • https://sites.google.com/feeds

setIsDraft(draft)

Establece si la página está en modo de borrador. Solo es válido para los anuncios.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];

// Take the page out of draft mode
page.setIsDraft(false);

Parámetros

NombreTipoDescripción
draftBooleanel nuevo estado

Volver

Page: esta página para encadenar

Autorización

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

  • https://sites.google.com/feeds

setName(name)

Establece el nombre de esta página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setName("new-name");

Parámetros

NombreTipoDescripción
nameStringel nombre nuevo

Volver

Page: esta página para encadenar

Autorización

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

  • https://sites.google.com/feeds

setParent(parent)

Establece el elemento superior de esta página.

var site = SitesApp.getSite("example.com", "mysite");
var child = site.getChildByName("childToBeMoved");
var parent = site.getChildByName("newParent");
child.setParent(parent);

Parámetros

NombreTipoDescripción
parentPageel nuevo padre o madre

Volver

Page: esta página para encadenar

Autorización

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

  • https://sites.google.com/feeds

setTitle(title)

Establece el título de la página.

var site = SitesApp.getSite("example.com", "mysite");
var page = site.getChildren()[0];
page.setTitle("New Title");

Parámetros

NombreTipoDescripción
titleStringel nuevo título

Volver

Page: esta página para encadenar

Autorización

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

  • https://sites.google.com/feeds

Métodos obsoletos