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 de contenu à un navigateur. À la place, ils doivent nettoyer le code HTML afin qu'il ne puisse pas effectuer d'actions malveillantes. Consultez la description de HtmlOutput pour connaître les limites que cela implique sur ce qui peut être renvoyé.

Propriétés

PropriétéTypeDescription
SandboxModeSandboxModeÉnumération représentant les modes de bac à sable pouvant être utilisés pour les scripts HtmlService côté client.
XFrameOptionsModeXFrameOptionsModeÉnumération représentant les modes X-Frame-Options pouvant être utilisés pour les scripts HtmlService côté client.

Méthodes

MéthodeType renvoyéBrève description
createHtmlOutput()HtmlOutputCrée un objet HtmlOutput qui peut être renvoyé à partir du script.
createHtmlOutput(blob)HtmlOutputCrée un objet HtmlOutput à partir d'une ressource BlobSource.
createHtmlOutput(html)HtmlOutputCrée un objet HtmlOutput qui peut être renvoyé à partir du script.
createHtmlOutputFromFile(filename)HtmlOutputCrée un objet HtmlOutput à partir d'un fichier de l'éditeur de code.
createTemplate(blob)HtmlTemplateCrée un objet HtmlTemplate à partir d'une ressource BlobSource.
createTemplate(html)HtmlTemplateCrée un objet HtmlTemplate qui peut être renvoyé à partir du script.
createTemplateFromFile(filename)HtmlTemplateCrée un objet HtmlTemplate à partir d'un fichier de l'éditeur de code.
getUserAgent()StringRécupère la chaîne du user-agent pour le navigateur actuel.

Documentation détaillée

createHtmlOutput()

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

var output = HtmlService.createHtmlOutput();

Renvois

HtmlOutput : nouvel objet HTMLOutput


createHtmlOutput(blob)

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

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

Paramètres

NomTypeDescription
blobBlobSourcel'objet pour extraire le code HTML

Renvois

HtmlOutput : nouvel objet HtmlOutput

Génère

Error : si l'objet 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.

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

Paramètres

NomTypeDescription
htmlStringle contenu à diffuser

Renvois

HtmlOutput : nouvel objet HTMLOutput

Génère

Error : si le format du code HTML est incorrect


createHtmlOutputFromFile(filename)

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

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

Paramètres

NomTypeDescription
filenameStringle nom du fichier à utiliser

Renvois

HtmlOutput : 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) {
  var template = HtmlService.createTemplate(blob);
  return output;
}

Paramètres

NomTypeDescription
blobBlobSourceObjet dont extrait le code HTML.

Renvois

HtmlTemplate : 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.

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

Paramètres

NomTypeDescription
htmlStringle contenu du modèle

Renvois

HtmlTemplate : nouvel objet HtmlTemplate


createTemplateFromFile(filename)

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

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

Paramètres

NomTypeDescription
filenameStringle nom du fichier à utiliser

Renvois

HtmlTemplate : nouvel objet HtmlTemplate

Génère

Error : si le fichier est introuvable


getUserAgent()

Récupère la chaîne du user-agent pour le navigateur actuel. Renvoie null pour la plupart des exécutions de script s'il n'est pas utilisé dans la fonction doGet() ou doPost() d'une application Web.

Renvois

String : chaîne user-agent