פריט תפריט שניתן ללחוץ עליו, שמתווסף לתפריט בכותרת הכרטיס.
const action = CardService.newAction(); // Finish building the action... const cardAction = CardService.newCardAction().setText('Card action').setOnClickAction(action);
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
setAuthorizationAction(action) | CardAction | הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. |
setComposeAction(action, composedEmailType) | CardAction | הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. |
setOnClickAction(action) | CardAction | הגדרת פעולה שתתבצע כשלוחצים על האובייקט. |
setOnClickOpenLinkAction(action) | CardAction | הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
setOpenLink(openLink) | CardAction | הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. |
setText(text) | CardAction | הגדרת טקסט התפריט של הפעולה הזו. |
מסמכים מפורטים
setAuthorizationAction(action)
הגדרת פעולת הרשאה שפותחת כתובת 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);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | AuthorizationAction | האובייקט שמציין את פעולת ההרשאה שתתבצע כשמקישים על האלמנט הזה. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.
setComposeAction(action, composedEmailType)
הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחת מהאפשרויות הבאות: 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את פעולת הכתיבה שתתבצע כשלוחצים על הרכיב הזה. |
composedEmailType | ComposedEmailType | ערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.
setOnClickAction(action)
הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | הפעולה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.
setOnClickOpenLinkAction(action)
הגדרת פעולה שפותחת כתובת 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(); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Action | האובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.
setOpenLink(openLink)
הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים setOpenLink(openLink)
, setOnClickAction(action)
, setOnClickOpenLinkAction(action)
, setAuthorizationAction(action)
או setComposeAction(action, composedEmailType)
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
openLink | OpenLink | אובייקט OpenLink שמתאר את כתובת ה-URL שרוצים לפתוח. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.
setText(text)
הגדרת טקסט התפריט של הפעולה הזו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | הטקסט של פריט התפריט. |
חזרה
CardAction
– האובייקט הזה, לצורך קישור.