פעולות ביומן

אובייקטים של Action מאפשרים לכם ליצור התנהגות אינטראקטיבית בתוספים של Google Workspace. הם מגדירים מה קורה כשמשתמש יוצר אינטראקציה עם ווידג'ט (לדוגמה, לחצן) בממשק המשתמש של התוסף.

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

לדוגמה, נניח שאתם רוצים ליצור לחצן שייבנה ומציג כרטיס חדש כשלוחצים עליו. לשם כך, צריך ליצור ווידג'ט חדש של לחצן ולהשתמש בפונקציה setOnClickAction(action) של handler של לחצנים כדי להגדיר Action בניית כרטיסים. ב-Action שהגדרתם מצוינת פונקציית קריאה חוזרת ל-Apps Script, שפועלת אחרי שלוחצים על הלחצן. במקרה כזה, צריך להטמיע את פונקציית הקריאה החוזרת כדי לבנות את הכרטיס הרצוי ולהחזיר אובייקט ActionResponse. אובייקט התשובה מורה לתוסף להציג את הכרטיס שיצרה פונקציית הקריאה החוזרת.

בדף הזה מתוארות פעולות בווידג'ט שהן ספציפיות ליומן, שאפשר לכלול בתוסף.

אינטראקציות ביומן

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

בוצע ניסיון לפעולה	פונקציית הקריאה החוזרת אמורה לחזור
איך מוסיפים משתתפים?	CalendarEventActionResponse
הגדרת הנתונים של שיחת הוועידה	CalendarEventActionResponse
הוספת קבצים מצורפים	CalendarEventActionResponse

כדי להשתמש בפעולות הווידג'ט ובאובייקטים של התגובה האלה, כל התנאים הבאים צריכים להתקיים:

• הפעולה הזאת מתבצעת בזמן שלמשתמש יש אירוע ביומן פתוח.
• שדה המניפסט addOns.calendar.currentEventAccess של התוסף מוגדר כ-WRITE או כ-READ_WRITE.
• התוסף כולל את https://www.googleapis.com/auth/calendar.addons.current.event.write ההיקף של יומן Google.

בנוסף, שינויים שמבוצעים על ידי פונקציית הקריאה החוזרת (callback) של הפעולה לא נשמרים עד שהמשתמש ישמור את האירוע ביומן.

הוספת משתתפים עם פונקציית קריאה חוזרת

בדוגמה הבאה תוכלו לראות איך יוצרים לחצן להוספת משתתף ספציפי לאירוע שאתם עורכים ביומן Google:

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens an event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttendeesButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attendees and disable the button if not.
    if (!e.calendar.capabilities.canAddAttendees) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attendees to the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttendeesButtonClicked (e) {
    return CardService.newCalendarEventActionResponseBuilder()
        .addAttendees(["[e-mail]", "[e-mail]"])
        .build();
  }

הגדרת הנתונים של שיחת הוועידה באמצעות פונקציית קריאה חוזרת

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

בדוגמה הבאה אפשר לראות איך יוצרים לחצן שמגדיר את הנתונים של שיחת הוועידה לאירוע שעורכים:

  /**
   * Build a simple card with a button that sends a notification.
   * This function is called as part of the eventOpenTrigger that builds
   * a UI when the user opens a Calendar event.
   *
   * @param e The event object passed to eventOpenTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onSaveConferenceOptionsButtonClicked')
        .setParameters(
          {'phone': "1555123467", 'adminEmail': "[e-mail]"});
    var button = CardService.newTextButton()
        .setText('Add new attendee')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can set
    // conference data and disable the button if not.
    if (!e.calendar.capabilities.canSetConferenceData) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Sets conference data for the
   * Calendar event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onSaveConferenceOptionsButtonClicked(e) {
    var parameters = e.commonEventObject.parameters;

    // Create an entry point and a conference parameter.
    var phoneEntryPoint = ConferenceDataService.newEntryPoint()
      .setEntryPointType(ConferenceDataService.EntryPointType.PHONE)
      .setUri('tel:' + parameters['phone']);

    var adminEmailParameter = ConferenceDataService.newConferenceParameter()
        .setKey('adminEmail')
        .setValue(parameters['adminEmail']);

    // Create a conference data object to set to this Calendar event.
    var conferenceData = ConferenceDataService.newConferenceDataBuilder()
        .addEntryPoint(phoneEntryPoint)
        .addConferenceParameter(adminEmailParameter)
        .setConferenceSolutionId('myWebScheduledMeeting')
        .build();

    return CardService.newCalendarEventActionResponseBuilder()
        .setConferenceData(conferenceData)
        .build();
  }

הוספת קבצים מצורפים עם פונקציית קריאה חוזרת

הדוגמה הבאה מראה איך ליצור לחצן שמוסיף קובץ מצורף לאירוע ביומן Google שמתבצע עריכה:

  /**
   * Build a simple card with a button that creates a new attachment.
   * This function is called as part of the eventAttachmentTrigger that
   * builds a UI when the user goes through the add-attachments flow.
   *
   * @param e The event object passed to eventAttachmentTrigger function.
   * @return {Card}
   */
  function buildSimpleCard(e) {
    var buttonAction = CardService.newAction()
        .setFunctionName('onAddAttachmentButtonClicked');
    var button = CardService.newTextButton()
        .setText('Add a custom attachment')
        .setOnClickAction(buttonAction);

    // Check the event object to determine if the user can add
    // attachments and disable the button if not.
    if (!e.calendar.capabilities.canAddAttachments) {
      button.setDisabled(true);
    }

    // ...continue creating card sections and widgets, then create a Card
    // object to add them to. Return the built Card object.
  }

  /**
   * Callback function for a button action. Adds attachments to the Calendar
   * event being edited.
   *
   * @param {Object} e The action event object.
   * @return {CalendarEventActionResponse}
   */
  function onAddAttachmentButtonClicked(e) {
    return CardService.newCalendarEventActionResponseBuilder()
             .addAttachments([
               CardService.newAttachment()
                 .setResourceUrl("https://example.com/test")
                 .setTitle("Custom attachment")
                 .setMimeType("text/html")
                 .setIconUrl("https://example.com/test.png")
             ])
        .build();
  }

הגדרת סמל הקובץ המצורף

סמל הקובץ המצורף חייב להתארח בתשתית של Google. לפרטים נוספים, ראו הוספת סמלים של קבצים מצורפים.