Si compilas una interfaz de usuario para una secuencia de comandos, puedes publicarla como una app web. Por ejemplo, una secuencia de comandos que permite a los usuarios programar citas con miembros de un equipo de asistencia se presenta mejor como una app web para que los usuarios puedan acceder a ella directamente desde sus navegadores.
Tanto las secuencias de comandos independientes como las secuencias de comandos vinculadas a aplicaciones Google Workspace se pueden convertir en apps web, siempre que cumplan con los siguientes requisitos.
Requisitos para las apps web
Una secuencia de comandos se puede publicar como una app web si cumple con los siguientes requisitos:
- Contiene una función
doGet(e)
odoPost(e)
. - La función muestra un objeto servicio de HTML
HtmlOutput
o un objeto servicio de contenidoTextOutput
.
parámetros de solicitud
Cuando un usuario visita una app o un programa le envía una solicitud HTTP GET
, Apps Script ejecuta la función doGet(e)
. Cuando un programa envía a la app una solicitud HTTP POST
, Apps Script ejecuta doPost(e)
en su lugar. En ambos casos, el argumento e
representa un parámetro de evento que puede contener información sobre cualquier parámetro de solicitud. La estructura del objeto del evento se muestra en la siguiente tabla:
Campos | |
---|---|
e.queryString |
El valor de la parte de la cadena de consulta de la URL, o name=alice&n=1&n=2 |
e.parameter |
Un objeto de pares clave-valor que corresponden a los parámetros de la solicitud. Solo se muestra el primer valor para los parámetros que tienen varios valores. {"name": "alice", "n": "1"} |
e.parameters |
Un objeto similar a {"name": ["alice"], "n": ["1", "2"]} |
e.pathInfo |
Es la ruta de URL después de |
e.contextPath |
No se usa, siempre es la cadena vacía. |
e.contentLength |
La longitud del cuerpo de la solicitud para las solicitudes POST o 332 |
e.postData.length |
Es igual a 332 |
e.postData.type |
El tipo de MIME del cuerpo de POST text/csv |
e.postData.contents |
El texto del contenido del cuerpo de POST Alice,21 |
e.postData.name |
Siempre el valor "postData" postData |
Por ejemplo, puedes pasar parámetros como username
y age
a una URL, como se muestra a continuación:
https://script.google.com/.../exec?username=jsmith&age=21
Luego, puedes mostrar los parámetros de la siguiente manera:
function doGet(e) {
var params = JSON.stringify(e);
return ContentService.createTextOutput(params).setMimeType(ContentService.MimeType.JSON);
}
En el ejemplo anterior, doGet(e)
muestra el siguiente resultado:
{
"queryString": "username=jsmith&age=21",
"parameter": {
"username": "jsmith",
"age": "21"
},
"contextPath": "",
"parameters": {
"username": [
"jsmith"
],
"age": [
"21"
]
},
"contentLength": -1
}
Implementa una secuencia de comandos como una app web
Para implementar una secuencia de comandos como una app web, sigue estos pasos:
- En la parte superior derecha del proyecto de secuencia de comandos, haz clic en Implementar > Nueva implementación.
- Junto a "Seleccionar tipo", haz clic en Habilitar los tipos de implementación > Aplicación web.
- Ingresa la información de tu app web en los campos de la sección "Configuración de la implementación".
- Haz clic en Implementar.
Puedes compartir la URL de la app web con las personas con las que quieras que la usen, siempre que les hayas otorgado acceso.
Prueba la implementación de una app web
Para probar tu secuencia de comandos como una app web, sigue estos pasos:
- En la esquina superior derecha del proyecto de secuencia de comandos, haz clic en Implementar > Implementaciones de prueba.
- Junto a "Seleccionar tipo", haz clic en Habilitar los tipos de implementación > Aplicación web.
- En la URL de la app web, haz clic en Copiar.
Pega la URL en tu navegador y prueba la app web.
Esta URL termina en
/dev
y solo pueden acceder a ella los usuarios que tienen acceso de edición a la secuencia de comandos. Esta instancia de la app siempre ejecuta el código guardado más recientemente y solo se diseñó para realizar pruebas durante el desarrollo.
Permisos
Los permisos de una app web varían según cómo elijas ejecutarla:
- Ejecutar la app como yo: En este caso, la secuencia de comandos siempre se ejecuta como tú, el propietario de la secuencia de comandos, sin importar quién acceda a la app web.
- Ejecutar la app como usuario que accede a la app web: En este caso, la secuencia de comandos se ejecuta con la identidad del usuario activo que usa la app web. Este enfoque de permisos hace que la app web muestre el correo electrónico del propietario de la secuencia de comandos cuando el usuario autoriza el acceso.
Cómo incorporar tu app web en Google Sites
Para incorporar una app web en Google Sites, primero debes implementarla. También necesitarás la URL implementada del diálogo Deploy
.
Para incorporar una app web en una página de Sites, sigue estos pasos:
- Abre la página Sitios en la que quieres agregar la app web.
- Selecciona Insertar > Insertar URL.
- Pega la URL de la app web y, luego, haz clic en AGREGAR.
La app web aparece en un marco en la vista previa de la página. Cuando publiques la página, es posible que los usuarios de tu sitio deban autorizar la app web antes de que se ejecute de forma normal. Las apps web no autorizadas presentan mensajes de autorización al usuario.
Apps web y el historial del navegador
Puede ser conveniente que una app web de Apps Script simule una aplicación de varias páginas o una con una IU dinámica controlada a través de parámetros de URL. Para hacerlo bien, puedes definir un objeto de estado que represente la IU o la página de la app, y enviar el estado al historial del navegador a medida que el usuario navega por tu app. También puedes escuchar los eventos del historial para que tu app web muestre la IU correcta cuando el usuario navegue hacia atrás y hacia adelante con los botones del navegador. Si consultas los parámetros de URL en el momento de la carga, puedes hacer que tu app compile de forma dinámica su IU en función de esos parámetros, lo que le permite al usuario iniciar la app en un estado particular.
Apps Script proporciona dos APIs de JavaScript asíncronas del cliente para ayudar a crear apps web vinculadas al historial del navegador:
google.script.history
proporciona métodos para permitir una respuesta dinámica a los cambios en el historial del navegador. Esto incluye: enviar estados (objetos simples que puedes definir) al historial del navegador, reemplazar el estado superior en la pila de historial y configurar una función de devolución de llamada de objeto de escucha para responder a los cambios en el historial.google.script.url
proporciona los medios para recuperar los parámetros de URL y el fragmento de URL de la página actual, si están presentes.
Estas APIs de historial solo están disponibles para las apps web. No son compatibles con las barras laterales, los diálogos ni los complementos. Tampoco se recomienda usar esta funcionalidad en apps web incorporadas en Google Sites.