Class HtmlOutput

הוספת מטא תג לדף. מטא תגים שמופיעים ישירות בקובץ HTML של Apps Script מוזנחים. מותר להשתמש רק בתגי המטא הבאים:

<meta name="apple-mobile-web-app-capable" cont>e<nt="..."/
meta name="google-site-ver>i<fication" content="..."/
meta name>=<"mobile-web-app-capable" >content="..."/
meta name="viewport" content="..."/

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

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

// Log &<q>uot;bHello, w<or><l>d!/bpHello again, w<or>ld./p"
const output = HtmlService.createHt<m>lOutput('<bH>ello, world!/b'<)>;
output.append(<9;>pHello again, world./p');
Logger.log(output.getContent());

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

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

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

ראה גם

• appendUntrusted(addedContent)

מוסיף תוכן חדש לתוכן של HtmlOutput, תוך שימוש בבריחה מהקשר.

השיטה הזו מבצעת escape לתוכן בצורה נכונה על סמך המצב הנוכחי של HtmlOutput, כך שהתוצאה היא מחרוזת בטוחה ללא תגי עיצוב או תופעות לוואי. מומלץ להשתמש בשיטה הזו במקום בשיטה append בכל פעם שמוסיפים תוכן ממקור לא מהימן, כמו ממשתמש, כדי למנוע באג של סקריפטינג חוצה אתרים (XSS), שבו תוכן או תגי עיצוב שמוסיפים גורמים להפעלת קוד לא צפויה.

// Log &<q>uot;bHello, w<or>&ld!/&blt;pgt;Hello again, w&orld.&lt;/pgt;"
const output = HtmlService.createHt<m>lOutput('<bH>ello, world!/b');
output<.>appendUntrusted(<9;>pHello again, world./p');
Logger.log(output.getContent());

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

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

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

ראה גם

• append(addedContent)

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

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
const template = output.asTemplate();

חזרה

HtmlTemplate — הגרסה החדשה של HtmlTemplate.

ניקוי התוכן הנוכחי.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.clear();

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

החזרת הנתונים בתוך האובייקט הזה כ-Blob שהומר לסוג התוכן שצוין. בשיטה הזו, הסיומת המתאימה מתווספת לשם הקובץ – לדוגמה, 'myfile.pdf'. עם זאת, המערכת מניחה שחלק משם הקובץ שאחרי הנקודה האחרונה (אם יש כזו) הוא סיומת קיימת שצריך להחליף. לכן, השם ShoppingList.12.25.2014 הופך ל-ShoppingList.12.25.pdf.

כדי לראות את המכסות היומיות להמרות, אפשר לעיין במאמר בנושא מכסות לשירותי Google. יכול להיות שדומיינים חדשים ב-Google Workspace יהיו כפופים באופן זמני למכסות מחמירות יותר.

פרמטרים

חזרה

‫Blob — הנתונים כ-blob.

החזרת הנתונים בתוך האובייקט הזה כ-blob.

חזרה

‫Blob — הנתונים כ-blob.

הפונקציה מחזירה את התוכן של ה-HtmlOutput הזה.

// Log &<q>uot;bHello, w<or>ld!/b"
const output = HtmlService.createHt<m>lOutput('<bH>ello, world!/b');
Logger.log(output.getContent());

חזרה

‫String — התוכן שמוצג.

מחזירה את כתובת ה-URL של תג קישור לסמל אתר שנוסף לדף על ידי קריאה ל-setFaviconUrl(iconUrl). תגי קישור של סמלי אתרים שמוכללים ישירות בקובץ HTML של Apps Script מוזנחים.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setFaviconUrl('http://www.example.com/image.png');
Logger.log(output.getFaviconUrl());

חזרה

‫String — כתובת ה-URL של תמונת סמל האתר.

מחזירה את הגובה ההתחלתי של תיבת הדו-שיח המותאמת אישית ב-Google Docs, ב-Sheets או ב-Forms. אם HtmlOutput פורסם כאפליקציית אינטרנט, השיטה הזו מחזירה null. כדי לשנות את הגודל של תיבת דו-שיח שכבר פתוחה, קוראים ל- google.script.host.setHeight(height) בקוד בצד הלקוח.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setHeight(200);
Logger.log(output.getHeight());

חזרה

‫Integer – הגובה, בפיקסלים.

מחזירה מערך של אובייקטים שמייצגים מטא תגים שנוספו לדף על ידי קריאה ל-addMetaTag(name, content). מטא תגים שמופיעים ישירות בקובץ HTML של Apps Script מוזנחים.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.addMetaTag('viewport', 'width=device-width, initial-scale=1');

const tags = output.getMetaT<ags();
Logger.log(
    '>meta name="%s" content="%s"/',
    tags[0].getName(),
    tags[0].getContent(),
);

חזרה

‫HtmlOutputMetaTag[] — מערך של אובייקטים שמייצגים מטא תגים שנוספו לדף על ידי קריאה ל-addMetaTag(name, content).

מחזירה את הכותרת של דף הפלט. הערה: המערכת מתעלמת מרכיב ה-HTML ‏ <title>.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
Logger.log(output.getTitle());

חזרה

‫String — כותרת הדף.

מחזירה את הרוחב ההתחלתי של תיבת הדו-שיח המותאמת אישית ב-Google Docs, ב-Sheets או ב-Forms. אם HtmlOutput פורסם כאפליקציית אינטרנט, השיטה הזו מחזירה null. כדי לשנות את הגודל של תיבת דו-שיח שכבר פתוחה, קוראים ל- google.script.host.setWidth(width) בקוד בצד הלקוח.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setWidth(200);
Logger.log(output.getWidth());

חזרה

‫Integer – הרוחב בפיקסלים.

מגדיר את התוכן של HtmlOutput.

const output = HtmlService.createHtmlOutput();
output.setContent(&<#>39;bHello, wo<rl>d!/b');

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

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

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

מוסיף לדף תג קישור לסמל אתר. המערכת מתעלמת מתגי קישור לסמל אתר שמופיעים ישירות בקובץ HTML של Apps Script.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setFaviconUrl('http://www.example.com/image.png');

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

מגדיר את הגובה ההתחלתי של תיבת הדו-שיח המותאמת אישית ב-Google Docs‏, Sheets או Forms. אם HtmlOutput מתפרסם כאפליקציית אינטרנט, לשיטה הזו אין השפעה. כדי לשנות את הגודל של תיבת דו-שיח שכבר פתוחה, קוראים ל- google.script.host.setHeight(height) בקוד בצד הלקוח.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setHeight(200);

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

לשיטה הזו אין יותר השפעה – בעבר היא הגדירה את sandbox mode שמשמש לסקריפטים מצד הלקוח. כדי להגן על המשתמשים מפני קוד HTML או JavaScript זדוניים, קוד בצד הלקוח שמוצג משירות HTML מופעל בארגז חול מאובטח שמטיל הגבלות על הקוד. במקור, השיטה הזו אפשרה לכותבי סקריפטים לבחור בין גרסאות שונות של ארגז החול, אבל עכשיו כל הסקריפטים משתמשים במצב IFRAME, בלי קשר למצב ארגז החול שמוגדר. מידע נוסף זמין במדריך בנושא הגבלות בשירות HTML.

מצב IFRAME מטיל הרבה פחות הגבלות מאשר מצבי ארגז החול האחרים, והוא פועל הכי מהר, אבל הוא לא פועל בכלל בדפדפנים ישנים מסוימים, כולל Internet Explorer 9. אפשר לקרוא את מצב ארגז החול בסקריפט בצד הלקוח על ידי בדיקה של google.script.sandbox.mode. שימו לב שהמאפיין הזה מחזיר את המצב בפועל בלקוח, שיכול להיות שונה מהמצב שהתבקש בשרת אם המצב שהתבקש לא אפשרי בדפדפן של המשתמש.

<!-- Read the sandbox mode (in a client-side script). -->
<script>
  alert(google.script.sandbox.mode);
</script>

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

מגדיר את הכותרת של דף הפלט. באפליקציות אינטרנט, זהו שם הדף כולו, וב-HtmlOutput שמוצג ב-Google Sheets, זהו שם תיבת הדו-שיח.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setTitle('My First Page');

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

המאפיין הזה מגדיר את הרוחב הראשוני של תיבת דו-שיח מותאמת אישית ב-Google Docs, ב-Sheets או ב-Forms. אם HtmlOutput מתפרסם כאפליקציית אינטרנט, לשיטה הזו אין השפעה. כדי לשנות את הגודל של תיבת דו-שיח שכבר פתוחה, קוראים ל- google.script.host.setWidth(width) בקוד בצד הלקוח.

const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setWidth(200);

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.

הגדרת המצב של הכותרת X-Frame-Options בדף, ששולטת במניעת הונאת קליקים.

ההגדרה XFrameOptionsMode.ALLOWALL מאפשרת לכל אתר להוסיף את הדף ל-iframe, ולכן המפתח צריך להטמיע הגנה משלו מפני הונאת קליקים.

אם סקריפט לא מגדיר מצב X-Frame-Options, ‏ Apps Script משתמש במצב XFrameOptionsMode.DEFAULT כברירת מחדל.

// Serve HTML with no X-Frame-Options header (in Apps Script server-side code).
const output = HtmlService.createHtmlOutput(&<#>39;bHello, wo<rl>d!/b');
output.setXFrameOptionsMode(HtmlService.XFrameOptionsMode.ALLOWALL);

פרמטרים

חזרה

‫HtmlOutput — הפלט הזה, לשרשור.