Class Image

הוספה של פעולת האירוע שאפשר לבצע בווידג'ט.

פרמטרים

חזרה

‫Widget – האובייקט, לשרשור.

ההגדרה הזו קובעת את הטקסט החלופי של התמונה לצורכי נגישות. חובה.

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

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

אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

// ...

const action = CardService.newAuthorizationAction().setAuthorizationUrl('url');
CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

הגדרת פעולה שיוצרת טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט ComposeActionResponse שהוגדר באמצעות ComposeActionResponseBuilder.setGmailDraft(draft).

// ...

const action = CardService.newAction().setFunctionName('composeEmailCallback');
CardService.newTextButton()
    .setText('Compose Email')
    .setComposeAction(action, CardService.ComposedEmailType.REPLY_AS_DRAFT);

// ...

function composeEmailCallback(e) {
  const thread = GmailApp.getThreadById(e.threadId);
  const draft = thread.createDraftReply('This is a reply');
  return CardService.newComposeActionResponseBuilder()
      .setGmailDraft(draft)
      .build();
}

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

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

פרמטרים

חזרה

‫Widget – האובייקט הזה, לשרשור.

מגדיר את התמונה לשימוש על ידי ציון כתובת ה-URL או מחרוזת הנתונים שלה. חובה.

כתובת ה-URL שציינתם יכולה להיות כתובת URL שנגישה לכולם או מחרוזת תמונה מקודדת ב-Base64. כדי לקבל את המחרוזת הזו, אפשר להשתמש בקוד הבא כדי ליצור מחרוזת תמונה מקודדת מתמונה ב-Google Drive, ואז לאחסן את המחרוזת לשימוש מאוחר יותר באמצעות setImageUrl(url). השיטה הזו מונעת את הצורך של התוסף שלכם לגשת לכתובת URL של תמונה שזמינה לציבור:

// The following assumes you have the image to use in Google Drive and have its
// ID.
const imageBytes = DriveApp.getFileById('123abc').getBlob().getBytes();
const encodedImageURL =
    `data:image/jpeg;base64,${Utilities.base64Encode(imageBytes)}`;

// You can store encodeImageURL and use it as a parameter to
// Image.setImageUrl(url).

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

הגדרת פעולה שמופעלת כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse.

// ...

const action = CardService.newAction().setFunctionName('notificationCallback');
CardService.newTextButton()
    .setText('Create notification')
    .setOnClickAction(action);

// ...

function notificationCallback() {
  return CardService.newActionResponseBuilder()
      .setNotification(
          CardService.newNotification().setText('Some info to display to user'),
          )
      .build();
}

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט OpenLink. אפשר להגדיר לאובייקט בממשק המשתמש רק אחד מהערכים setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

הפרמטר Action צריך לציין פונקציית קריאה חוזרת שמחזירה אובייקט ActionResponse שהוגדר באמצעות ActionResponseBuilder.setOpenLink(openLink).

// ...

const action = CardService.newAction().setFunctionName('openLinkCallback');
CardService.newTextButton()
    .setText('Open Link')
    .setOnClickOpenLinkAction(action);

// ...

function openLinkCallback() {
  return CardService.newActionResponseBuilder()
      .setOpenLink(CardService.newOpenLink().setUrl('https://www.google.com'))
      .build();
}

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

הגדרה של כתובת URL שתיפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק אחת מהאפשרויות הבאות: setOpenLink(openLink),‏ setOnClickAction(action),‏ setOnClickOpenLinkAction(action),‏ setAuthorizationAction(action) או setComposeAction(action, composedEmailType).

פרמטרים

חזרה

‫Image – האובייקט הזה, לשרשור.

הגדרה של רמת החשיפה של הווידג'ט. ערך ברירת המחדל הוא `VISIBLE`.

פרמטרים

חזרה

‫Widget – האובייקט, לשרשור.