קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
פעולות אוניברסליות הן רכיבים של פריטי תפריט שמאפשרים למשתמש לפתוח דף אינטרנט חדש, להציג כרטיסי ממשק משתמש חדשים או להריץ פונקציה ספציפית של Apps Script כשבוחרים בהן. הפעולות הכלליות דומות מאוד לפעולות בכרטיס, מלבד העובדה שהן תמיד ממוקמות בכל כרטיס בתוסף, ללא קשר להקשר הנוכחי של התוסף.
שימוש בפעולות אוניברסליות מאפשר לוודא שלמשתמש תמיד תהיה גישה לפונקציונליות מסוימת, ללא קשר לחלק בתוסף שבו הוא יוצר אינטראקציה. ריכזנו כאן כמה תרחישים לדוגמה לפעולות אוניברסליות:
פתיחת דף אינטרנט של הגדרות (או הצגת כרטיס הגדרות).
הצגת מידע לעזרה למשתמש.
מתחילים תהליך עבודה חדש, כמו 'הוספת לקוח חדש'.
הצגת כרטיס שמאפשר למשתמש לשלוח משוב על התוסף.
בכל פעם שיש לכם פעולה שלא תלויה בהקשר הנוכחי, כדאי להפוך אותה לפעולה אוניברסלית.
שימוש בפעולות אוניברסליות
פעולות אוניברסליות מוגדרות במניפסט של הפרויקט של התוסף. אחרי שמגדירים פעולה אוניברסלית, היא תמיד זמינה למשתמשים בתוסף. אם המשתמש מציג כרטיס, קבוצת הפעולות האוניברסליות שהגדרתם תמיד מופיעה בתפריט הכרטיס, אחרי כל פעולת הכרטיס שהגדרתם לכרטיס הזה. הפעולות האוניברסליות מופיעות בתפריטי הכרטיסים באותו הסדר שבו הן מוגדרות במניפסט של התוסף.
הגדרת פעולות אוניברסליות
מגדירים פעולות אוניברסליות במניפסט של התוסף. פרטים נוספים זמינים במאמר מניפסטים.
לכל פעולה, מציינים את הטקסט שצריך להופיע בתפריט של אותה פעולה. לאחר מכן תוכלו לציין שדה openLink כדי לציין שהפעולה צריכה לפתוח ישירות דף אינטרנט בכרטיסייה חדשה. לחלופין, אפשר לציין שדה runFunction שמציין פונקציית קריאה חוזרת של Apps Script שתתבצע כשבוחרים בפעולה האוניברסלית.
כשמשתמשים ב-runFunction, פונקציית הקריאה החוזרת שצוינה בדרך כלל מבצעת אחת מהפעולות הבאות:
הפונקציה יוצרת כרטיסי ממשק משתמש להצגה מיידית על ידי החזרת אובייקט UniversalActionResponse שנוצר.
הפונקציה פותחת כתובת URL, אולי אחרי ביצוע משימות אחרות, על ידי החזרת אובייקט UniversalActionResponse מובנה.
ביצוע משימות ברקע שלא גורמות למעבר לכרטיס חדש או לפתיחת כתובת URL.
במקרה כזה, פונקציית הקריאה החוזרת לא מחזירה דבר.
כשפונקציית ה-callback נקראת, מועבר אליה אובייקט אירוע שמכיל מידע על הכרטיס הפתוח ועל ההקשר של התוסף.
דוגמה
קטע הקוד הבא מציג קטע מניפסט לדוגמה של תוסף ל-Google Workspace שמשתמש בפעולות אוניברסליות תוך הרחבת Gmail. הקוד מגדיר במפורש היקף מטא-נתונים כדי שהתוסף יוכל לקבוע מי שלח את ההודעה הפתוחה.
הפונקציה Open contact URL מפעילה פונקציה שמחליטה איזו כתובת URL לפתוח, ואז פותחת אותה בכרטיסייה חדשה באמצעות אובייקט OpenLink. הקוד יוצר את כתובת ה-URL באמצעות כתובת האימייל של השולח.
Open settings מפעיל את הפונקציה createSettingsCards() שמוגדרת בפרויקט הסקריפט של התוסף. הפונקציה הזו מחזירה אובייקט UniversalActionResponse תקין שמכיל קבוצת כרטיסים עם הגדרות של התוסף ומידע נוסף.
אחרי שהפונקציה מסיימת ליצור את האובייקט הזה, רשימת הכרטיסים מוצגת בממשק המשתמש (ראו החזרת מספר כרטיסים).
הפעלת סנכרון ברקע מפעילה את הפונקציה runBackgroundSync() שמוגדרת בפרויקט הסקריפט של התוסף. הפונקציה הזו לא יוצרת כרטיסים, אלא מבצעת משימות אחרות ברקע שלא משנות את ממשק המשתמש. מכיוון שהפונקציה לא מחזירה UniversalActionResponse, ממשק המשתמש לא מציג כרטיס חדש כשהפונקציה מסתיימת. במקום זאת, בממשק המשתמש מוצג סמל טעינה בזמן שהפונקציה פועלת.
דוגמה לאופן יצירת הפונקציות openContactURL(), createSettingsResponse() ו-runBackgroundSync():
/***OpenacontactURL.*@param{Object}eaneventobject*@return{UniversalActionResponse}*/functionopenContactURL(e){//ActivatetemporaryGmailscopes,inthiscasesothatthe//openmessagemetadatacanberead.varaccessToken=e.gmail.accessToken;GmailApp.setCurrentMessageAccessToken(accessToken);//BuildURLtoopenbasedonabaseURLandthesender's email.//ThisURLmustbeincludedintheopenLinkUrlPrefixeswhitelist.varmessageId=e.gmail.messageId;varmessage=GmailApp.getMessageById(messageId);varsender=message.getFrom();varurl="https://www.example.com/urlbase/"+sender;returnCardService.newUniversalActionResponseBuilder().setOpenLink(CardService.newOpenLink().setUrl(url)).build();}/***Createacollectionofcardstocontroltheadd-onsettingsand*presentotherinformation.Thesecardsaredisplayedinalistwhen*theuserselectstheassociated"Open settings"universalaction.**@param{Object}eaneventobject*@return{UniversalActionResponse}*/functioncreateSettingsResponse(e){returnCardService.newUniversalActionResponseBuilder().displayAddOnCards([createSettingCard(),createAboutCard()]).build();}/***Createandreturnabuiltsettingscard.*@return{Card}*/functioncreateSettingCard(){returnCardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('Settings')).addSection(CardService.newCardSection().addWidget(CardService.newSelectionInput().setType(CardService.SelectionInputType.CHECK_BOX).addItem("Ask before deleting contact","contact",false).addItem("Ask before deleting cache","cache",false).addItem("Preserve contact ID after deletion","contactId",false))//...continueaddingwidgetsorothersectionshere...).build();//Don't forget to build the card!}/***Createandreturnabuilt'About'informationalcard.*@return{Card}*/functioncreateAboutCard(){returnCardService.newCardBuilder().setHeader(CardService.newCardHeader().setTitle('About')).addSection(CardService.newCardSection().addWidget(CardService.newTextParagraph().setText('This add-on manages contact information. For more '+'details see the <a href="https://www.example.com/help">'+'help page</a>.'))//...addotherinformationwidgetsorsectionshere...).build();//Don't forget to build the card!}/***Runbackgroundtasks,noneofwhichshouldaltertheUI.*Alsorecordsthetimeofsyncinthescriptproperties.**@param{Object}eaneventobject*/functionrunBackgroundSync(e){varprops=PropertiesService.getUserProperties();props.setProperty("syncTime",newDate().toString());syncWithContacts();//Notshown.updateCache();//Notshown.validate();//Notshown.//noreturnvaluetellstheUItokeepshowingthecurrentcard.}
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2024-12-22 (שעון UTC)."],[[["\u003cp\u003eUniversal actions are menu items that provide consistent access to specific functions like opening web pages, displaying UI cards, or running Apps Script functions, appearing on every card within a Google Workspace add-on.\u003c/p\u003e\n"],["\u003cp\u003eThese actions are defined in the add-on's manifest file and can be configured to either open a link directly or execute a specified Apps Script function when selected.\u003c/p\u003e\n"],["\u003cp\u003eWhen a universal action triggers a function, it can build and display UI cards, open a URL, or perform background tasks without altering the user interface.\u003c/p\u003e\n"],["\u003cp\u003eUniversal actions are beneficial for providing users with essential functionalities, like settings, help, or initiating workflows, regardless of their current location within the add-on.\u003c/p\u003e\n"]]],["Universal actions are menu items in add-ons that provide consistent functionality across all cards. Configured in the add-on's manifest, they allow users to open a web page, display UI cards, or run Apps Script functions. Each action is defined with menu text and either an `openLink` for web pages or a `runFunction` for script execution. The callback function in `runFunction` can build UI cards, open URLs, or run background tasks, all within a 30-second time limit.\n"],null,["# Universal actions are menu item elements that allow a user to open a new\nweb page, display new UI cards, or run a specific Apps Script function when\nselected. In operation they are very similar to\n[card actions](/workspace/add-ons/concepts/widgets#user_interaction_widgets),\nexcept that universal actions are always placed on every card in your add-on,\nregardless of the current add-on context.\n\nBy using universal actions, you can make sure the user always has access to\ncertain functionality, regardless of which part of your add-on they interact\nwith. Here are some example use cases for universal actions:\n\n- Open a settings web page (or display a settings card).\n- Show help information to the user.\n- Start a new workflow, such as 'Add new customer'.\n- Display a card that lets a user send feedback about the add-on.\n\nWhenever you have an action that does not depend on the current context,\nyou should consider making it a universal action.\n\nUsing universal actions\n-----------------------\n\nUniversal actions are configured in your add-on's project\n[manifest](/workspace/add-ons/concepts/workspace-manifests). Once you've configured a\nuniversal action, it is always available to users of your add-on. If the user\nis viewing a card, the set of universal actions you've defined always appears\nin the card menu, after any\n[card actions](/workspace/add-ons/concepts/widgets#user_interaction_widgets)\nyou've defined for that card. Universal actions appear in the card menus in the\nsame order in which they are defined in the add-on's manifest.\n\nConfiguring universal actions\n-----------------------------\n\nYou configure universal actions in your add-on's manifest; see\n[Manifests](/workspace/add-ons/concepts/workspace-manifests#manifest_structure_for_gmail_add-ons)\nfor more details.\n\nFor each action, you specify the text that should appear in the menu for that\naction. You can then specify an `openLink` field indicating that the action\nshould directly open a web page in a new tab. Alternatively, you can specify\na `runFunction` field that specifies an Apps Script callback function to\nexecute when the universal action is selected.\n\nWhen `runFunction` is used, the callback function specified usually does one\nof the following:\n\n- Builds UI cards to display immediately by returning a built [`UniversalActionResponse`](/apps-script/reference/card-service/universal-action-response) object.\n- Opens a URL, perhaps after doing other tasks, by returning a built `UniversalActionResponse` object.\n- Conducts background tasks that do not switch to a new card or open a URL. In this case the callback function returns nothing.\n\nWhen called, the callback function is passed an\n[event object](/workspace/add-ons/concepts/actions#action_event_objects)\ncontaining information about the open card and add-on context.\n| **Warning:** To keep the add-ons responsive, the [Card service](/apps-script/reference/card-service/card-service) limits universal action callback functions to a maximum of 30 seconds of execution time. If the execution takes longer than that, your add-on UI may not update its display properly.\n\nExample\n-------\n\nThe following code snippet shows an example manifest excerpt for a\nGoogle Workspace add-on that uses universal actions\nwhile extending Gmail. The code explicitly sets a metadata scope so that the\nadd-on can determine who sent the open message. \n\n \"oauthScopes\": [\n \"https://www.googleapis.com/auth/gmail.addons.current.message.metadata\"\n ],\n \"addOns\": {\n \"common\": {\n \"name\": \"Universal Actions Only Addon\",\n \"logoUrl\": \"https://www.example.com/hosted/images/2x/my-icon.png\",\n \"openLinkUrlPrefixes\": [\n \"https://www.google.com\",\n \"https://www.example.com/urlbase\"\n ],\n \"universalActions\": [{\n \"label\": \"Open google.com\",\n \"openLink\": \"https://www.google.com\"\n }, {\n \"label\": \"Open contact URL\",\n \"runFunction\": \"openContactURL\"\n }, {\n \"label\": \"Open settings\",\n \"runFunction\": \"createSettingsResponse\"\n }, {\n \"label\": \"Run background sync\",\n \"runFunction\": \"runBackgroundSync\"\n }],\n ...\n },\n \"gmail\": {\n \"contextualTriggers\": [\n {\n \"unconditional\": {},\n \"onTriggerFunction\": \"getContextualAddOn\"\n }\n ]\n },\n ...\n },\n ...\n\nThe three universal actions defined in preceding example do the following:\n\n- *Open google.com* opens \u003chttps://www.google.com\u003e in a new tab.\n- *Open contact URL* runs a function that determines what URL to open and then opens it in a new tab using an [`OpenLink`](/apps-script/reference/card-service/open-link) object. The code builds the URL using the sender's email address.\n- *Open settings* runs the `createSettingsCards()` function defined in the add-on script project. This function returns a valid [`UniversalActionResponse`](/apps-script/reference/card-service/universal-action-response) object containing a set of cards with add-on setting and other information. After the function finishes building this object, the UI displays the list of cards (see [Returning multiple cards](/workspace/add-ons/how-tos/navigation#returning_multiple_cards)).\n- *Run background sync* runs the `runBackgroundSync()` function defined in the add-on script project. This function does not build cards; instead it performs some other background tasks that do not change the UI. Since the function doesn't return a [`UniversalActionResponse`](/apps-script/reference/card-service/universal-action-response), the UI does not display a new card when the function finishes. Instead the UI displays a loading indicator spinner while the function is running.\n\nHere is an example of how you might construct the `openContactURL()`,\n`createSettingsResponse()`, and `runBackgroundSync()` functions: \n\n /**\n * Open a contact URL.\n * @param {Object} e an event object\n * @return {UniversalActionResponse}\n */\n function openContactURL(e) {\n // Activate temporary Gmail scopes, in this case so that the\n // open message metadata can be read.\n var accessToken = e.gmail.accessToken;\n GmailApp.setCurrentMessageAccessToken(accessToken);\n\n // Build URL to open based on a base URL and the sender's email.\n // This URL must be included in the openLinkUrlPrefixes whitelist.\n var messageId = e.gmail.messageId;\n var message = GmailApp.getMessageById(messageId);\n var sender = message.getFrom();\n var url = \"https://www.example.com/urlbase/\" + sender;\n return CardService.newUniversalActionResponseBuilder()\n .setOpenLink(CardService.newOpenLink()\n .setUrl(url))\n .build();\n }\n\n /**\n * Create a collection of cards to control the add-on settings and\n * present other information. These cards are displayed in a list when\n * the user selects the associated \"Open settings\" universal action.\n *\n * @param {Object} e an event object\n * @return {UniversalActionResponse}\n */\n function createSettingsResponse(e) {\n return CardService.newUniversalActionResponseBuilder()\n .displayAddOnCards(\n [createSettingCard(), createAboutCard()])\n .build();\n }\n\n /**\n * Create and return a built settings card.\n * @return {Card}\n */\n function createSettingCard() {\n return CardService.newCardBuilder()\n .setHeader(CardService.newCardHeader().setTitle('Settings'))\n .addSection(CardService.newCardSection()\n .addWidget(CardService.newSelectionInput()\n .setType(CardService.SelectionInputType.CHECK_BOX)\n .addItem(\"Ask before deleting contact\", \"contact\", false)\n .addItem(\"Ask before deleting cache\", \"cache\", false)\n .addItem(\"Preserve contact ID after deletion\", \"contactId\", false))\n // ... continue adding widgets or other sections here ...\n ).build(); // Don't forget to build the card!\n }\n\n /**\n * Create and return a built 'About' informational card.\n * @return {Card}\n */\n function createAboutCard() {\n return CardService.newCardBuilder()\n .setHeader(CardService.newCardHeader().setTitle('About'))\n .addSection(CardService.newCardSection()\n .addWidget(CardService.newTextParagraph()\n .setText('This add-on manages contact information. For more '\n + 'details see the \u003ca href=\"https://www.example.com/help\"\u003e'\n + 'help page\u003c/a\u003e.'))\n // ... add other information widgets or sections here ...\n ).build(); // Don't forget to build the card!\n }\n\n /**\n * Run background tasks, none of which should alter the UI.\n * Also records the time of sync in the script properties.\n *\n * @param {Object} e an event object\n */\n function runBackgroundSync(e) {\n var props = PropertiesService.getUserProperties();\n props.setProperty(\"syncTime\", new Date().toString());\n\n syncWithContacts(); // Not shown.\n updateCache(); // Not shown.\n validate(); // Not shown.\n\n // no return value tells the UI to keep showing the current card.\n }"]]