Class HtmlService

HtmlService

Service permettant de renvoyer du contenu HTML et d'autres contenus textuels à partir d'un script.

Pour des raisons de sécurité, les scripts ne peuvent pas renvoyer directement du contenu à un navigateur. Au lieu de cela, ils doivent assainir le code HTML pour qu'il ne puisse pas effectuer d'actions malveillantes. Consultez la description de HtmlOutput pour connaître les limites que cela implique sur les éléments pouvant être renvoyés.

Propriétés

Propriété	Type	Description
SandboxMode	SandboxMode	Énumération représentant les modes bac à sable pouvant être utilisés pour les scripts HtmlService côté client.
XFrameOptionsMode	XFrameOptionsMode	Énumération représentant les modes X-Frame-Options pouvant être utilisés pour les scripts HtmlService côté client.

Méthodes

Méthode	Type renvoyé	Brève description
createHtmlOutput()	HtmlOutput	Crée un objet HtmlOutput qui peut être renvoyé à partir du script.
createHtmlOutput(blob)	HtmlOutput	Crée un objet HtmlOutput à partir d'une ressource BlobSource.
createHtmlOutput(html)	HtmlOutput	Crée un objet HtmlOutput qui peut être renvoyé à partir du script.
createHtmlOutputFromFile(filename)	HtmlOutput	Crée un objet HtmlOutput à partir d'un fichier dans l'éditeur de code.
createTemplate(blob)	HtmlTemplate	Crée un objet HtmlTemplate à partir d'une ressource BlobSource.
createTemplate(html)	HtmlTemplate	Crée un objet HtmlTemplate qui peut être renvoyé à partir du script.
createTemplateFromFile(filename)	HtmlTemplate	Crée un objet HtmlTemplate à partir d'un fichier dans l'éditeur de code.
getUserAgent()	String	Obtient la chaîne user-agent du navigateur actuel.

Documentation détaillée

createHtmlOutput()

Crée un objet HtmlOutput qui peut être renvoyé à partir du script.

const output = HtmlService.createHtmlOutput();

Renvois

HtmlOutput : le nouvel objet HtmlOutput

---

createHtmlOutput(blob)

Crée un objet HtmlOutput à partir d'une ressource BlobSource.

function createFromBlob(blob) {
  const output = HtmlService.createHtmlOutput(blob);
  return output;
}

Paramètres

Nom	Type	Description
blob	BlobSource	Objet à partir duquel obtenir le code HTML

Renvois

HtmlOutput : le nouvel objet HtmlOutput

Génère

Error : si le blob ne contient pas de code HTML ou si le code HTML est incorrect

---

createHtmlOutput(html)

Crée un objet HtmlOutput qui peut être renvoyé à partir du script.

const output = HtmlService.createHtmlOutput('<b>Hello world!</b>');

Paramètres

Nom	Type	Description
html	String	le contenu à diffuser ;

Renvois

HtmlOutput : le nouvel objet HtmlOutput

Génère

Error : si le code HTML est mal formé

---

createHtmlOutputFromFile(filename)

Crée un objet HtmlOutput à partir d'un fichier dans l'éditeur de code.

const output = HtmlService.createHtmlOutputFromFile('myPage');

Paramètres

Nom	Type	Description
filename	String	Nom du fichier à utiliser

Renvois

HtmlOutput : le nouvel objet HtmlOutput

Génère

Error : si le fichier est introuvable ou si le code HTML qu'il contient est incorrect

---

createTemplate(blob)

Crée un objet HtmlTemplate à partir d'une ressource BlobSource.

function createFromBlob(blob) {
  const template = HtmlService.createTemplate(blob);
  const output = template.evaluate();
  return output;
}

Paramètres

Nom	Type	Description
blob	BlobSource	Objet à partir duquel obtenir le code HTML.

Renvois

HtmlTemplate : le nouvel objet HtmlTemplate

Génère

Error : si le blob ne contient pas de code HTML

---

createTemplate(html)

Crée un objet HtmlTemplate qui peut être renvoyé à partir du script.

const template = HtmlService.createTemplate(
    '<b>The time is &lt;?= new Date() ?&gt;</b>',
);

Paramètres

Nom	Type	Description
html	String	le contenu du modèle.

Renvois

HtmlTemplate : le nouvel objet HtmlTemplate

---

createTemplateFromFile(filename)

Crée un objet HtmlTemplate à partir d'un fichier dans l'éditeur de code.

const template = HtmlService.createTemplateFromFile('myTemplate');

Paramètres

Nom	Type	Description
filename	String	Nom du fichier à utiliser

Renvois

HtmlTemplate : le nouvel objet HtmlTemplate

Génère

Error : si le fichier est introuvable

---

getUserAgent()

Obtient la chaîne user-agent du navigateur actuel. Renvoie null pour la plupart des exécutions de script si elle n'est pas utilisée dans la fonction doGet() ou doPost() d'une application Web.

Renvois

String : chaîne user-agent