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. Au lieu de cela, 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 concernant les éléments pouvant être renvoyés.

Propriétés

PropriétéTypeDescription
SandboxModeSandboxModeEnumération représentant les modes de bac à sable pouvant être utilisés pour les scripts HtmlService côté client.
XFrameOptionsModeXFrameOptionsModeEnumé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 pouvant être renvoyé à partir du script.
createHtmlOutput(blob)HtmlOutputCrée un objet HtmlOutput à partir d'une ressource BlobSource.
createHtmlOutput(html)HtmlOutputCrée un objet HtmlOutput pouvant être renvoyé à partir du script.
createHtmlOutputFromFile(filename)HtmlOutputCrée un objet HtmlOutput à partir d'un fichier dans l'éditeur de code.
createTemplate(blob)HtmlTemplateCrée un objet HtmlTemplate à partir d'une ressource BlobSource.
createTemplate(html)HtmlTemplateCrée un objet HtmlTemplate pouvant être renvoyé à partir du script.
createTemplateFromFile(filename)HtmlTemplateCrée un objet HtmlTemplate à partir d'un fichier dans l'éditeur de code.
getUserAgent()StringObtient la chaîne user-agent du navigateur actuel.

Documentation détaillée

createHtmlOutput()

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

const output = HtmlService.createHtmlOutput();

Renvois

HtmlOutput : 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

NomTypeDescription
blobBlobSourcel'objet à partir duquel extraire le code HTML ;

Renvois

HtmlOutput : 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 pouvant être renvoyé à partir du script. 

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

Paramètres

NomTypeDescription
htmlStringle contenu à diffuser ;

Renvois

HtmlOutput : nouvel objet HtmlOutput

Génère

Error : si le code HTML n'est pas correctement formaté

createHtmlOutputFromFile(filename)

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

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

Paramètres

NomTypeDescription
filenameStringNom du fichier à utiliser

Renvois

HtmlOutput : nouvel objet HtmlOutput

Génère

Error : si le fichier n'a pas été trouvé 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

NomTypeDescription
blobBlobSourceObjet à partir duquel extraire 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 pouvant être renvoyé à partir du script. 

const 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 dans l'éditeur de code. 

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

Paramètres

NomTypeDescription
filenameStringNom du fichier à utiliser

Renvois

HtmlTemplate : 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 s'il n'est pas utilisé dans la fonction doGet() ou doPost() d'une application Web.

Renvois

String : chaîne user-agent