Class HtmlService

HtmlService

שירות להחזרת HTML ותוכן טקסט אחר מסקריפט.

מטעמי אבטחה, סקריפטים לא יכולים להחזיר תוכן ישירות לדפדפן. במקום זאת, הם צריכים לבצע סניטציה של ה-HTML כדי שלא יוכל לבצע פעולות זדוניות. בתיאור של HtmlOutput מפורטות המגבלות שחלות על הנתונים שניתן להחזיר.

מאפיינים

נכססוגתיאור
SandboxModeSandboxModeסוג enum שמייצג את מצבי ארגז החול שאפשר להשתמש בהם בסקריפטים HtmlServiceמצד הלקוח.
XFrameOptionsModeXFrameOptionsModeסוג enum שמייצג את X-Frame-Options המצבים שבהם אפשר להשתמש בסקריפטים של HtmlService הצפנה מצד הלקוח.

Methods

שיטהסוג הערך שמוחזרתיאור קצר
createHtmlOutput()HtmlOutputיוצרת אובייקט HtmlOutput חדש שאפשר להחזיר מהסקריפט.
createHtmlOutput(blob)HtmlOutputיוצרת אובייקט HtmlOutput חדש ממקור BlobSource.
createHtmlOutput(html)HtmlOutputיוצרת אובייקט HtmlOutput חדש שאפשר להחזיר מהסקריפט.
createHtmlOutputFromFile(filename)HtmlOutputיוצרת אובייקט HtmlOutput חדש מקובץ בכלי לעריכת קוד.
createTemplate(blob)HtmlTemplateיוצרת אובייקט HtmlTemplate חדש ממקור BlobSource.
createTemplate(html)HtmlTemplateיוצרת אובייקט HtmlTemplate חדש שאפשר להחזיר מהסקריפט.
createTemplateFromFile(filename)HtmlTemplateיוצרת אובייקט HtmlTemplate חדש מקובץ בכלי לעריכת קוד.
getUserAgent()Stringמקבלת את המחרוזת של סוכן המשתמש בדפדפן הנוכחי.

תיעוד מפורט

createHtmlOutput()

יוצרת אובייקט HtmlOutput חדש שאפשר להחזיר מהסקריפט. 

const output = HtmlService.createHtmlOutput();

חזרה

‫HtmlOutput — אובייקט HtmlOutput חדש

createHtmlOutput(blob)

יוצרת אובייקט HtmlOutput חדש ממקור BlobSource. 

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

פרמטרים

שםסוגתיאור
blobBlobSourceהאובייקט שממנו רוצים לחלץ HTML

חזרה

‫HtmlOutput – אובייקט HtmlOutput חדש

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם ה-blob לא מכיל HTML או שה-HTML פגום

createHtmlOutput(html)

יוצרת אובייקט HtmlOutput חדש שאפשר להחזיר מהסקריפט. 

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

פרמטרים

שםסוגתיאור
htmlStringהתוכן שיוצג

חזרה

‫HtmlOutput — אובייקט HtmlOutput חדש

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם ה-HTML פגום

createHtmlOutputFromFile(filename)

יוצרת אובייקט HtmlOutput חדש מקובץ בכלי לעריכת קוד. 

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

פרמטרים

שםסוגתיאור
filenameStringשם הקובץ שבו רוצים להשתמש

חזרה

‫HtmlOutput – אובייקט HtmlOutput חדש

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם הקובץ לא נמצא או שקובץ ה-HTML שבו פגום

createTemplate(blob)

יוצרת אובייקט HtmlTemplate חדש ממקור BlobSource. 

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

פרמטרים

שםסוגתיאור
blobBlobSourceהאובייקט שממנו רוצים לקבל HTML.

חזרה

‫HtmlTemplate – אובייקט HtmlTemplate חדש

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם ה-blob לא מכיל HTML

createTemplate(html)

יוצרת אובייקט HtmlTemplate חדש שאפשר להחזיר מהסקריפט. 

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

פרמטרים

שםסוגתיאור
htmlStringהתוכן של התבנית

חזרה

‫HtmlTemplate – אובייקט HtmlTemplate חדש

createTemplateFromFile(filename)

יוצרת אובייקט HtmlTemplate חדש מקובץ בכלי לעריכת קוד. 

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

פרמטרים

שםסוגתיאור
filenameStringשם הקובץ שבו רוצים להשתמש

חזרה

‫HtmlTemplate – אובייקט HtmlTemplate חדש

מקפיצה את הודעות השגיאה (Throws)

‫Error – אם הקובץ לא נמצא

getUserAgent()

מקבלת את המחרוזת של סוכן המשתמש בדפדפן הנוכחי. הפונקציה מחזירה null ברוב ההרצות של סקריפטים, אם היא לא נמצאת בפונקציה doGet() או doPost() של אפליקציית אינטרנט.

חזרה

‫String – מחרוזת סוכן המשתמש