בסקריפטים שמקושרים ל-Google Docs, ל-Sheets או ל-Forms אפשר להציג כמה סוגים של רכיבי ממשק משתמש — התראות והנחיות מוכנות מראש, וגם תיבות דו-שיח וסרגלי צד שמכילים דפי שירות HTML מותאמים אישית. בדרך כלל, האלמנטים האלה נפתחים מאפשרויות בתפריט. (שימו לב שב-Google Forms, רכיבי ממשק משתמש גלויים רק למשתמש שפותח את הטופס כדי לשנות אותו, ולא למשתמש שפותח את הטופס כדי להשיב).
תיבות דו-שיח של התראות
התראה היא תיבת דו-שיח מוכנה מראש שנפתחת בכלי לעריכת מסמכים ב-Google Docs , Sheets , Slides או Forms. יוצגו בו הודעה ולחצן OK. הכותרת ולחצנים חלופיים הם אופציונליים. הפעולה הזו דומה לקריאה ל-window.alert()
ב-JavaScript בצד הלקוח בדפדפן אינטרנט.
התראות משעות את הסקריפט בצד השרת בזמן שתיבת הדו-שיח פתוחה. הסקריפט ימשיך אחרי שהמשתמש סוגר את תיבת הדו-שיח, אבל חיבורי JDBC לא נשמרים לאורך כל ההשעיה.
כפי שאפשר לראות בדוגמה הבאה, ב-Google Docs, ב-Forms, ב-Slides וב-Sheets נעשה שימוש בשיטה Ui.alert()
, שזמינה בשלוש גרסאות שונות. כדי לשנות את לחצן "OK" שמוגדר כברירת מחדל, מעבירים ערך מ-enum Ui.ButtonSet
כארגומנט buttons
. כדי להעריך על איזה לחצן המשתמש לחץ, משווים את הערך המוחזר של alert()
ל-enum של Ui.Button
.
function onOpen() {
SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
.createMenu('Custom Menu')
.addItem('Show alert', 'showAlert')
.addToUi();
}
function showAlert() {
var ui = SpreadsheetApp.getUi(); // Same variations.
var result = ui.alert(
'Please confirm',
'Are you sure you want to continue?',
ui.ButtonSet.YES_NO);
// Process the user's response.
if (result == ui.Button.YES) {
// User clicked "Yes".
ui.alert('Confirmation received.');
} else {
// User clicked "No" or X in the title bar.
ui.alert('Permission denied.');
}
}
תיבות דו-שיח של ההנחיות
הנחיה היא תיבת דו-שיח מוכנה מראש שנפתחת בכלי עריכה של Google Docs , Sheets , Slides או Forms. מוצגים בו הודעה, שדה להזנת טקסט ולחצן "OK" (אישור). כותרת ולחצנים חלופיים הם אופציונליים. הפעולה הזו דומה לקריאה ל-window.prompt()
ב-JavaScript בצד הלקוח בדפדפן אינטרנט.
ההנחיות משעות את הסקריפט בצד השרת כשתיבת הדו-שיח פתוחה. הסקריפט ימשיך אחרי שהמשתמש סוגר את תיבת הדו-שיח, אבל חיבורי JDBC לא נשמרים לאורך כל ההשעיה.
כפי שאפשר לראות בדוגמה הבאה, ב-Google Docs Forms, Slides ו-Sheets נעשה שימוש בשיטה Ui.prompt()
,
הזמינה בשלוש גרסאות שונות. כדי לשנות את לחצן "OK" שמוגדר כברירת מחדל, צריך להעביר ערך מה-enum Ui.ButtonSet
כארגומנט buttons
. כדי להעריך את תגובת המשתמש, אוספים את הערך המוחזר של prompt()
ואז קוראים לפונקציה PromptResponse.getResponseText()
כדי לאחזר את הקלט של המשתמש ולהשוות בין הערך המוחזר של PromptResponse.getSelectedButton()
ל-enum Ui.Button
.
function onOpen() {
SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp.
.createMenu('Custom Menu')
.addItem('Show prompt', 'showPrompt')
.addToUi();
}
function showPrompt() {
var ui = SpreadsheetApp.getUi(); // Same variations.
var result = ui.prompt(
'Let\'s get to know each other!',
'Please enter your name:',
ui.ButtonSet.OK_CANCEL);
// Process the user's response.
var button = result.getSelectedButton();
var text = result.getResponseText();
if (button == ui.Button.OK) {
// User clicked "OK".
ui.alert('Your name is ' + text + '.');
} else if (button == ui.Button.CANCEL) {
// User clicked "Cancel".
ui.alert('I didn\'t get your name.');
} else if (button == ui.Button.CLOSE) {
// User clicked X in the title bar.
ui.alert('You closed the dialog.');
}
}
תיבות דו-שיח בהתאמה אישית
תיבת דו-שיח בהתאמה אישית יכולה להציג ממשק משתמש של שירות HTML בעורך Google Docs , Sheets , Slides או Forms.
תיבות דו-שיח בהתאמה אישית לא משעות את הסקריפט בצד השרת בזמן שתיבת הדו-שיח פתוחה.
הרכיב בצד הלקוח יכול לבצע קריאות אסינכרוניות לסקריפט בצד השרת באמצעות ה-API google.script
לממשקים של שירות HTML.
תיבת הדו-שיח יכולה לסגור את עצמה על ידי קריאה ל-google.script.host.close()
בצד הלקוח של ממשק שירות HTML. תיבת הדו-שיח לא יכולה להיות סגורה בממשקים אחרים, אלא רק על ידי המשתמש או עצמו.
כפי שמוצג בדוגמה שלמטה, הקבצים ב-Google Docs, ב-Forms, ב-Slides וב-Sheets משתמשים בשיטה Ui.showModalDialog()
כדי לפתוח את תיבת הדו-שיח.
Code.gs
function onOpen() { SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .createMenu('Custom Menu') .addItem('Show dialog', 'showDialog') .addToUi(); } function showDialog() { var html = HtmlService.createHtmlOutputFromFile('Page') .setWidth(400) .setHeight(300); SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .showModalDialog(html, 'My custom dialog'); }
Page.html
Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />
סרגלי צד בהתאמה אישית
סרגל צד יכול להציג ממשק משתמש של שירות HTML בתוך עורך של Google Docs, Forms, Slides ו-Sheets.
סרגלי צד לא משעים את הסקריפט בצד השרת כשתיבת הדו-שיח פתוחה. הרכיב בצד הלקוח יכול לבצע קריאות אסינכרוניות לסקריפט בצד השרת באמצעות ה-API google.script
לממשקים של שירות HTML.
סרגל הצד יכול לסגור את עצמו על ידי קריאה ל-google.script.host.close()
בצד הלקוח בממשק שירות HTML. אי אפשר לסגור את סרגל הצד בממשקים אחרים, אלא רק על ידי המשתמש או עצמו.
כמו בדוגמה הבאה, ב-Google Docs , ב-Forms, ב-Slides וב-Sheets נעשה שימוש בשיטה Ui.showSidebar()
כדי לפתוח את סרגל הצד.
Code.gs
function onOpen() { SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .createMenu('Custom Menu') .addItem('Show sidebar', 'showSidebar') .addToUi(); } function showSidebar() { var html = HtmlService.createHtmlOutputFromFile('Page') .setTitle('My custom sidebar'); SpreadsheetApp.getUi() // Or DocumentApp or SlidesApp or FormApp. .showSidebar(html); }
Page.html
Hello, world! <input type="button" value="Close" onclick="google.script.host.close()" />
תיבות דו-שיח לפתיחת קבצים
Google Picker היא תיבת דו-שיח מסוג 'פתיחת קבצים' למידע שמאוחסן בשרתי Google, כולל Google Drive, 'חיפוש תמונות Google', Google Video Search ועוד.
כפי שמוצג בדוגמה הבאה, אפשר להשתמש ב-JavaScript API של Picker בצד הלקוח בשירות HTML כדי ליצור תיבת דו-שיח מותאמת אישית שמאפשרת למשתמשים לבחור קבצים קיימים או להעלות קבצים חדשים, ולאחר מכן להעביר את הבחירה הזו בחזרה לסקריפט שלכם לצורך שימוש נוסף.
כדי להפעיל את Picker ולקבל מפתח API:
- יש לוודא שפרויקט הסקריפט משתמש בפרויקט סטנדרטי של GCP.
- מפעילים את Google Picker API בפרויקט ב-Google Cloud.
- בזמן שהפרויקט ב-Google Cloud עדיין פתוח, בוחרים באפשרות APIs & Services ואז לוחצים על Credentials.
- לוחצים על Create credentials > API key. הפעולה הזו יוצרת את המפתח, אבל צריך לערוך אותו כדי להוסיף למפתח גם הגבלות על אפליקציות וגם הגבלת API.
- בתיבת הדו-שיח של מפתח API לוחצים על Close.
- לצד מפתח ה-API שיצרתם, לוחצים על סמל האפשרויות הנוספות > עריכת מפתח API.
בקטע Application restrictions, מבצעים את השלבים הבאים:
- בוחרים באפשרות גורמים מפנים מסוג HTTP (אתרי אינטרנט).
- בקטע הגבלות גישה לאתרים, לוחצים על הוספת פריט.
- לוחצים על מקור ההפניה (referrer) ומזינים
*.google.com
. - צריך להוסיף עוד פריט ולהזין את
*.googleusercontent.com
בתור הגורם המפנה. - לוחצים על סיום.
בקטע API restrictions, מבצעים את השלבים הבאים:
- בוחרים באפשרות Restrict key.
בקטע Select APIs, בוחרים באפשרות Google Picker API ולוחצים על OK.
הערה: Google Picker API מופיע רק אם הפעלתם אותו, כי ברשימה מופיעים רק ממשקי API שהופעלו לפרויקט ב-Cloud.
בקטע API key, לוחצים על 'העתקה ללוח' .
בחלק התחתון של המסך, לוחצים על שמירה.