Class HtmlService

HtmlService

Dienst zum Zurückgeben von HTML- und anderen Textinhalten aus einem Script.

Aus Sicherheitsgründen können Scripts keine Inhalte direkt an einen Browser zurückgeben. Stattdessen müssen sie den HTML-Code so bereinigen, dass keine schädlichen Aktionen ausgeführt werden können. Weitere Informationen zu den Einschränkungen bei der Rückgabe finden Sie in der Beschreibung von HtmlOutput.

Attribute

AttributTypBeschreibung
SandboxModeSandboxModeEin Enum, das die Sandbox-Modi darstellt, die für clientseitige HtmlService-Scripts verwendet werden können.
XFrameOptionsModeXFrameOptionsModeEin Enum, das die X-Frame-Options-Modi darstellt, die für clientseitige HtmlService-Scripts verwendet werden können.

Methoden

MethodeRückgabetypKurzbeschreibung
createHtmlOutput()HtmlOutputErstellt ein neues HtmlOutput-Objekt, das vom Script zurückgegeben werden kann.
createHtmlOutput(blob)HtmlOutputErstellt ein neues HtmlOutput-Objekt aus einer BlobSource-Ressource.
createHtmlOutput(html)HtmlOutputErstellt ein neues HtmlOutput-Objekt, das vom Script zurückgegeben werden kann.
createHtmlOutputFromFile(filename)HtmlOutputErstellt ein neues HtmlOutput-Objekt aus einer Datei im Code-Editor.
createTemplate(blob)HtmlTemplateErstellt ein neues HtmlTemplate-Objekt aus einer BlobSource-Ressource.
createTemplate(html)HtmlTemplateErstellt ein neues HtmlTemplate-Objekt, das vom Script zurückgegeben werden kann.
createTemplateFromFile(filename)HtmlTemplateErstellt ein neues HtmlTemplate-Objekt aus einer Datei im Code-Editor.
getUserAgent()StringRuft den User-Agent-String für den aktuellen Browser ab.

Detaillierte Dokumentation

createHtmlOutput()

Erstellt ein neues HtmlOutput-Objekt, das vom Script zurückgegeben werden kann. 

const output = HtmlService.createHtmlOutput();

Rückflug

HtmlOutput – das neue HtmlOutput-Objekt

createHtmlOutput(blob)

Erstellt ein neues HtmlOutput-Objekt aus einer BlobSource-Ressource. 

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

Parameter

NameTypBeschreibung
blobBlobSourcedas Objekt, aus dem HTML-Code abgerufen werden soll

Rückflug

HtmlOutput – das neue HtmlOutput-Objekt

Löst

Error – wenn der Blob keinen HTML-Code enthält oder der HTML-Code fehlerhaft ist

createHtmlOutput(html)

Erstellt ein neues HtmlOutput-Objekt, das vom Script zurückgegeben werden kann. 

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

Parameter

NameTypBeschreibung
htmlStringdie zu liefernden Inhalte

Rückflug

HtmlOutput – das neue HtmlOutput-Objekt

Löst

Error – wenn das HTML fehlerhaft ist

createHtmlOutputFromFile(filename)

Erstellt ein neues HtmlOutput-Objekt aus einer Datei im Code-Editor. 

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

Parameter

NameTypBeschreibung
filenameStringden Namen der zu verwendenden Datei

Rückflug

HtmlOutput – das neue HtmlOutput-Objekt

Löst

Error – wenn die Datei nicht gefunden wurde oder der darin enthaltene HTML-Code fehlerhaft ist

createTemplate(blob)

Erstellt ein neues HtmlTemplate-Objekt aus einer BlobSource-Ressource. 

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

Parameter

NameTypBeschreibung
blobBlobSourceDas Objekt, aus dem HTML-Code abgerufen werden soll.

Rückflug

HtmlTemplate – das neue HtmlTemplate-Objekt

Löst

Error – wenn das Blob kein HTML enthält

createTemplate(html)

Erstellt ein neues HtmlTemplate-Objekt, das vom Script zurückgegeben werden kann. 

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

Parameter

NameTypBeschreibung
htmlStringden Inhalt der Vorlage

Rückflug

HtmlTemplate – das neue HtmlTemplate-Objekt

createTemplateFromFile(filename)

Erstellt ein neues HtmlTemplate-Objekt aus einer Datei im Code-Editor. 

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

Parameter

NameTypBeschreibung
filenameStringden Namen der zu verwendenden Datei

Rückflug

HtmlTemplate – das neue HtmlTemplate-Objekt

Löst

Error, wenn die Datei nicht gefunden wurde

getUserAgent()

Ruft den User-Agent-String für den aktuellen Browser ab. Gibt bei den meisten Scriptausführungen null zurück, wenn die Funktion nicht in der doGet()- oder doPost()-Funktion einer Webanwendung verwendet wird.

Rückflug

String – der User-Agent-String