Chip
עם סמל ותווית טקסט. אפשר להשבית את הצ'יפ לפי הצורך.
זמין באפליקציות של Google Chat. בתצוגה המקדימה למפתחים של תוספים ל-Google Workspace.
const chip = CardService.newChip() .setLabel('Open Link') .setOpenLink(CardService.newOpenLink().setUrl( 'https://www.google.com'));
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
set | Chip | הגדרת הטקסט החלופי של הצ'יפ לצורכי נגישות. |
set | Chip | הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. |
set | Chip | הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. |
set | Chip | הגדרה של מצב השבב (מופעל או מושבת). |
set | Chip | הגדרת הסמל שישמש כצ'יפ. |
set | Chip | הגדרת השם של הצ'יפ. |
set | Chip | הגדרת פעולה שתתבצע כשלוחצים על האובייקט. |
set | Chip | הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. |
set | Chip | הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. |
מסמכים מפורטים
set Alt Text(altText)
הגדרת הטקסט החלופי של הצ'יפ לצורכי נגישות. אם לא מגדירים את השדה, ברירת המחדל היא הטקסט שמוצג על הצ'יפ.
פרמטרים
שם | סוג | תיאור |
---|---|---|
alt | String | הטקסט החלופי שרוצים להקצות לצ'יפ הזה. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set Authorization Action(action)
הגדרת פעולת הרשאה שפותחת כתובת URL לתהליך ההרשאה כשמקישים על האובייקט. כתובת ה-URL תיפתח בחלון חדש. כשהמשתמש מסיים את תהליך ההרשאה וחוזר לאפליקציה, התוסף נטען מחדש.
אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
// ... const action = CardService.newAuthorizationAction().setAuthorizationUrl('url'); CardService.newTextButton().setText('Authorize').setAuthorizationAction(action);
פרמטרים
שם | סוג | תיאור |
---|---|---|
action | Authorization | האובייקט שמציין את פעולת ההרשאה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set Compose Action(action, composedEmailType)
הגדרת פעולה שמכינה טיוטת אימייל כשלוחצים על האובייקט. אפשר להגדיר לאובייקט UI רק את אחת מהאפשרויות הבאות: set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Compose
שמוגדר באמצעות Compose
.
// ... 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 | האובייקט שמציין את פעולת הכתיבה שתתבצע כשמקישים על הרכיב הזה. |
composed | Composed | ערך enum שמציין אם טיוטת ההודעה שנוצרה היא טיוטה עצמאית או טיוטת תשובה. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set Disabled(disabled)
הגדרה של מצב השבב (מופעל או מושבת). צ'יפ מושבת מופיע באפור ואי אפשר ללחוץ עליו.
const chip = CardService.newChip().setLabel('bug Report').setDisabled(true);
פרמטרים
שם | סוג | תיאור |
---|---|---|
disabled | Boolean | המצב המושבת. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set Icon(icon)
set Label(label)
הגדרת השם של הצ'יפ. חובה.
const chip = CardService.newChip().setLabel('bug Report');
פרמטרים
שם | סוג | תיאור |
---|---|---|
label | String | הטקסט שיוצג. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set On Click Action(action)
הגדרת פעולה שתתבצע כשלוחצים על האובייקט. אפשר להגדיר לאובייקט בממשק המשתמש רק את הערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
.
// ... 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 | הפעולה שתתבצע כשלוחצים על האלמנט הזה. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set On Click Open Link Action(action)
הגדרת פעולה שפותחת כתובת URL בכרטיסייה כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשצריך ליצור את כתובת ה-URL או כשצריך לבצע פעולות אחרות בנוסף ליצירת האובייקט Open
. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
הפרמטר Action
חייב לציין פונקציית קריאה חוזרת שמחזירה אובייקט Action
שמוגדר באמצעות Action
.
// ... 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 | האובייקט שמציין את הפעולה של פתיח הקישור שתתבצע כשמקישים על הרכיב הזה. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.
set Open Link(openLink)
הגדרת כתובת URL שתפתח כשלוחצים על האובייקט. משתמשים בפונקציה הזו כשכתובת ה-URL כבר ידועה וצריך רק לפתוח אותה. אפשר להגדיר לאובייקט בממשק המשתמש רק את אחד מהערכים set
, set
, set
, set
או set
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
open | Open | אובייקט Open שמתאר את כתובת ה-URL שרוצים לפתוח. |
חזרה
Chip
– האובייקט הזה, לצורך קישור.