תיבות דו-שיח וסרגלי צד במסמכים של Google Workspace

בסקריפטים שמקושרים ל-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 כדי ליצור תיבת דו-שיח מותאמת אישית שמאפשרת למשתמשים לבחור קבצים קיימים או להעלות קבצים חדשים, ולאחר מכן להעביר את הבחירה הזו בחזרה לסקריפט שלכם לצורך שימוש נוסף.

הערה: כדי להשתמש ב-Google Picker, פרויקט הסקריפט צריך להשתמש בפרויקט רגיל ב-Google Cloud.

כדי להפעיל את Picker ולקבל מפתח API:

1. יש לוודא שפרויקט הסקריפט משתמש בפרויקט סטנדרטי של GCP.
2. מפעילים את Google Picker API בפרויקט ב-Google Cloud.
3. בזמן שהפרויקט ב-Google Cloud עדיין פתוח, בוחרים באפשרות APIs & Services ואז לוחצים על Credentials.
4. לוחצים על Create credentials > API key. הפעולה הזו יוצרת את המפתח, אבל צריך לערוך אותו כדי להוסיף למפתח גם הגבלות על אפליקציות וגם הגבלת API.
5. בתיבת הדו-שיח של מפתח API לוחצים על Close.
6. לצד מפתח ה-API שיצרתם, לוחצים על סמל האפשרויות הנוספות > עריכת מפתח API.

7. בקטע Application restrictions, מבצעים את השלבים הבאים:

   1. בוחרים באפשרות גורמים מפנים מסוג HTTP (אתרי אינטרנט).
   2. בקטע הגבלות גישה לאתרים, לוחצים על הוספת פריט.
   3. לוחצים על מקור ההפניה (referrer) ומזינים *.google.com.
   4. צריך להוסיף עוד פריט ולהזין את *.googleusercontent.com בתור הגורם המפנה.
   5. לוחצים על סיום.

8. בקטע API restrictions, מבצעים את השלבים הבאים:

   1. בוחרים באפשרות Restrict key.

   2. בקטע Select APIs, בוחרים באפשרות Google Picker API ולוחצים על OK.

      הערה: Google Picker API מופיע רק אם הפעלתם אותו, כי ברשימה מופיעים רק ממשקי API שהופעלו לפרויקט ב-Cloud.

9. בקטע API key, לוחצים על 'העתקה ללוח' .

10. בחלק התחתון של המסך, לוחצים על שמירה.

הדוגמה הבאה מפעילה את ScriptApp.getOAuthToken() כדי להעביר את אסימון הגישה מסוג OAuth 2.0 של המשתמש ל- Picker. השיטה הזו מונעת מ- Picker להציג תיבת דו-שיח של הרשאה משלו, אבל היא אפשרית רק אם היקף OAuth שנדרש ב- Picker זמין ב-Apps Script. אחרת, קוד ה- Picker שלכם יצטרך להצהיר על היקפי ה-OAuth שלו, כפי שמוצג בדוגמה הזו של hello world

צריך להפעיל את הפקודה setOrigin(google.script.host.origin) כשיוצרים את PickerBuilder.

code.gs

picker/code.gs

הצגת הקוד ב-GitHub

/**
 * Creates a custom menu in Google Sheets when the spreadsheet opens.
 */
function onOpen() {
  try {
    SpreadsheetApp.getUi().createMenu('Picker')
        .addItem('Start', 'showPicker')
        .addToUi();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Displays an HTML-service dialog in Google Sheets that contains client-side
 * JavaScript code for the Google Picker API.
 */
function showPicker() {
  try {
    const html = HtmlService.createHtmlOutputFromFile('dialog.html')
        .setWidth(600)
        .setHeight(425)
        .setSandboxMode(HtmlService.SandboxMode.IFRAME);
    SpreadsheetApp.getUi().showModalDialog(html, 'Select a file');
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

/**
 * Gets the user's OAuth 2.0 access token so that it can be passed to Picker.
 * This technique keeps Picker from needing to show its own authorization
 * dialog, but is only possible if the OAuth scope that Picker needs is
 * available in Apps Script. In this case, the function includes an unused call
 * to a DriveApp method to ensure that Apps Script requests access to all files
 * in the user's Drive.
 *
 * @return {string} The user's OAuth 2.0 access token.
 */
function getOAuthToken() {
  try {
    DriveApp.getRootFolder();
    return ScriptApp.getOAuthToken();
  } catch (e) {
    // TODO (Developer) - Handle exception
    console.log('Failed with error: %s', e.error);
  }
}

dialog.html

picker/dialog.html

הצגת הקוד ב-GitHub

<!DOCTYPE html>
<html>
<head>
  <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons.css">
  <script>
    // IMPORTANT: Replace the value for DEVELOPER_KEY with the API key obtained
    // from the Google Developers Console.
    var DEVELOPER_KEY = 'ABC123 ... ';
    var DIALOG_DIMENSIONS = {width: 600, height: 425};
    var pickerApiLoaded = false;

    /**
     * Loads the Google Picker API.
     */
    function onApiLoad() {
      gapi.load('picker', {'callback': function() {
        pickerApiLoaded = true;
      }});
     }

    /**
     * Gets the user's OAuth 2.0 access token from the server-side script so that
     * it can be passed to Picker. This technique keeps Picker from needing to
     * show its own authorization dialog, but is only possible if the OAuth scope
     * that Picker needs is available in Apps Script. Otherwise, your Picker code
     * will need to declare its own OAuth scopes.
     */
    function getOAuthToken() {
      google.script.run.withSuccessHandler(createPicker)
          .withFailureHandler(showError).getOAuthToken();
    }

    /**
     * Creates a Picker that can access the user's spreadsheets. This function
     * uses advanced options to hide the Picker's left navigation panel and
     * default title bar.
     *
     * @param {string} token An OAuth 2.0 access token that lets Picker access the
     *     file type specified in the addView call.
     */
    function createPicker(token) {
      if (pickerApiLoaded && token) {
        var picker = new google.picker.PickerBuilder()
            // Instruct Picker to display only spreadsheets in Drive. For other
            // views, see https://developers.google.com/picker/docs/#otherviews
            .addView(google.picker.ViewId.SPREADSHEETS)
            // Hide the navigation panel so that Picker fills more of the dialog.
            .enableFeature(google.picker.Feature.NAV_HIDDEN)
            // Hide the title bar since an Apps Script dialog already has a title.
            .hideTitleBar()
            .setOAuthToken(token)
            .setDeveloperKey(DEVELOPER_KEY)
            .setCallback(pickerCallback)
            .setOrigin(google.script.host.origin)
            // Instruct Picker to fill the dialog, minus 2 pixels for the border.
            .setSize(DIALOG_DIMENSIONS.width - 2,
                DIALOG_DIMENSIONS.height - 2)
            .build();
        picker.setVisible(true);
      } else {
        showError('Unable to load the file picker.');
      }
    }

    /**
     * A callback function that extracts the chosen document's metadata from the
     * response object. For details on the response object, see
     * https://developers.google.com/picker/docs/result
     *
     * @param {object} data The response object.
     */
    function pickerCallback(data) {
      var action = data[google.picker.Response.ACTION];
      if (action == google.picker.Action.PICKED) {
        var doc = data[google.picker.Response.DOCUMENTS][0];
        var id = doc[google.picker.Document.ID];
        var url = doc[google.picker.Document.URL];
        var title = doc[google.picker.Document.NAME];
        document.getElementById('result').innerHTML =
            '<b>You chose:</b><br>Name: <a href="' + url + '">' + title +
            '</a><br>ID: ' + id;
      } else if (action == google.picker.Action.CANCEL) {
        document.getElementById('result').innerHTML = 'Picker canceled.';
      }
    }

    /**
     * Displays an error message within the #result element.
     *
     * @param {string} message The error message to display.
     */
    function showError(message) {
      document.getElementById('result').innerHTML = 'Error: ' + message;
    }
  </script>
</head>
<body>
  <div>
    <button onclick="getOAuthToken()">Select a file</button>
    <p id="result"></p>
  </div>
  <script src="https://apis.google.com/js/api.js?onload=onApiLoad"></script>
</body>
</html>