Cette page a été traduite par l'API Cloud Translation.

Class HtmlService

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

Pour des raisons de sécurité, les scripts ne peuvent pas renvoyer directement du contenu à un navigateur. À la place, ils doivent nettoyer le code HTML afin qu’il ne puisse pas effectuer d’actions malveillantes. Voir la description de HtmlOutput pour les limites que cela implique quant à ce qui peut être renvoyé.

Propriétés

Propriété	Type	Description
`SandboxMode`	`SandboxMode`	Énumération représentant les modes bac à sable pouvant être utilisés pour `HtmlService` côté client les scripts.
`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é par le 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é par le script.
`createHtmlOutputFromFile(filename)`	`HtmlOutput`	Crée un objet `HtmlOutput` à partir d'un fichier de 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é par le script.
`createTemplateFromFile(filename)`	`HtmlTemplate`	Crée un objet `HtmlTemplate` à partir d'un fichier de l'éditeur de code.
`getUserAgent()`	`String`	Ré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é par le 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

Nom	Type	Description
`blob`	`BlobSource`	l'objet à extraire du code HTML

Renvois

HtmlOutput : nouvel objet HtmlOutput

Génère

Error : si l'objet blob ne contient pas de code HTML ou si le format HTML est incorrect

`createHtmlOutput(html)`

Crée un objet HtmlOutput qui peut être renvoyé par le script.

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

Paramètres

Nom	Type	Description
`html`	`String`	le 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

Nom	Type	Description
`filename`	`String`	le 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

Nom	Type	Description
`blob`	`BlobSource`	Objet dont le code HTML doit être extrait.

Renvois

HtmlTemplate : nouvel objet HtmlTemplate

Génère

Error : si l'objet blob ne contient pas de code HTML

`createTemplate(html)`

Crée un objet HtmlTemplate qui peut être renvoyé par le script.

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

Nom	Type	Description
`filename`	`String`	le 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 scripts s'ils ne sont pas utilisés dans la fonction doGet() ou doPost() d'une application Web.

Renvois

String : chaîne du user-agent