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

סקריפטים שמקושרים ל-Google Docs, ב-Sheets או ב-Forms יכולים להופיע כמה סוגים של רכיבי ממשק משתמש — התראות והנחיות מוכנות מראש, וגם תיבות דו-שיח וסרגלי צד שמכילים הדפים של שירות HTML. בדרך כלל, הרכיבים האלה נפתחים מאפשרויות בתפריט. (שימו לב שב-Google Forms, רכיבי ממשק משתמש גלויים רק לעורך שפותח את הטופס כדי לשנות אותו, ולא למשתמש שפותחים את הטופס כדי להשיב).

תיבות דו-שיח של התראות

התראה היא תיבת דו-שיח מוכנה מראש שנפתחת בתוך מסמך של Google Docs, Sheets, עורך Slides או Forms. תוצג הודעה עם הכיתוב 'אישור' לחצן; כותרת ו לחצנים חלופיים הם אופציונליים. היא דומה לשיחות window.alert() ב-JavaScript בצד הלקוח בתוך דפדפן אינטרנט.

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

כפי שמוצג בדוגמה שלמטה, Google Docs, Forms, Slides ו-Sheets ב-Sheets משתמשים בשיטה Ui.alert(), זמין בשלוש וריאציות. כדי לשנות את ברירת המחדל "OK" (אישור) לחצן, להעביר מהערך Ui.ButtonSet של טיפוסים בני מנייה (enum) כארגומנט buttons. כדי להעריך על איזה לחצן המשתמש לחץ, משווים הערך המוחזר של alert() Ui.Button enum.

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

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

כפי שאפשר לראות בדוגמה הבאה, ב-Google Docs שהוספתם ל-Forms, Slides ו-Sheets נעשה שימוש בשיטה Ui.prompt(), שזמין בשלוש וריאציות. כדי לשנות את ברירת המחדל "OK" (אישור) לחצן, להעביר ערך מ-Ui.ButtonSet 'טיפוסים בני מנייה (enum)' כארגומנט buttons. כדי לבדוק את תגובת המשתמש, תיעוד הערך המוחזר של prompt() ואז הקריאה PromptResponse.getResponseText() כדי לאחזר את הקלט של המשתמש, ולהשוות את הערך המוחזר PromptResponse.getSelectedButton() למספר 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.

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

סרגלי צד לא משעים את הסקריפט בצד השרת כשתיבת הדו-שיח פתוחה. הרכיב בצד הלקוח יכול לבצע קריאות אסינכרוניות לסקריפט בצד השרת באמצעות google.script API לממשקים של שירות 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 חיפוש ועוד.

כמו בדוגמה למטה, אפשר להשתמש ב-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 שהופעלו עבור הענן פרויקט.

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

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

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

חובה להתקשר 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>