בדיקת תוסף לעריכה
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
מומלץ לבדוק היטב את התוספים לפני הפרסום שלהם, כדי לוודא שהם פועלים כמצופה. באמצעות Apps Script אפשר לבדוק תוספים לעורך שנמצאים בפיתוח בקבצים ספציפיים של Google Docs, Sheets, Forms או Slides. אפשר להשתמש באפשרות הזו כדי:
- מוודאים שתוסף שנכתב בסקריפט עצמאי פועל כמצופה כשמחילים אותו על גיליון, מסמך, מצגת או טופס.
- מוודאים שתהליך התקנת התוסף פועל כמצופה, במיוחד במצבים שונים של מחזור החיים של ההרשאה (מותקן, מופעל או שניהם).
- מוודאים שהתוסף פועל כמצופה כשמבצעים פעולות במסמך מסוים ובתוכן שלו.
- לבדוק ולהשוות בין הגרסה הנוכחית לבין הגרסה הקודמת של התוסף.
יצירת פריסה לבדיקה
פריסת בדיקה היא שילוב של תוסף ומסמך בדיקה.
אחרי שפיתחתם גרסה של סקריפט ואתם רוצים לבדוק אותה כתוסף, עליכם לפעול לפי השלבים הבאים:
- אם עדיין אין לכם, יוצרים גיליון אלקטרוני, מסמך, מצגת או טופס כדי לבדוק את התוסף.
- פותחים את פרויקט הסקריפט שמכיל את התוסף.
- לוחצים על פריסה > בדיקת הפריסות.
- לצד בחירת סוג, לוחצים על 'הפעלת סוגי פריסה' settings
ובוחרים באפשרות תוסף של עורך.
- לוחצים על Create new test (יצירת בדיקה חדשה) או על Add test (הוספת בדיקה).
- בוחרים גרסה של קוד או בוחרים באפשרות Latest Code (הקוד העדכני ביותר).
- בקטע Config, בוחרים את מצב ההרשאה הראשוני לבדיקה.
- בקטע מסמך לבדיקה, לוחצים על לא נבחר מסמך. בוחרים את הקובץ ב-Sheets, ב-Docs, ב-Slides או ב-Forms שבו רוצים להשתמש כדי לבדוק את התוסף, ולוחצים על הוספה.
- לוחצים על שמירת המבחן.
כל פריסות הבדיקה השמורות מופיעות בתיבת הדו-שיח Test deployments. כך תוכלו לחזור לאותה פריסה לבדיקה מאוחר יותר.
הרצת פריסה לבדיקה
אם יש לכם פריסה אחת או יותר של בדיקה שנשמרה, תוכלו להריץ אחת מהן באופן הבא:
- פותחים את פרויקט הסקריפט שמכיל את התוסף.
- לוחצים על פריסה > בדיקת הפריסות.
- בקטע Saved Tests, בוחרים בלחצן הבחירה לצד פריסת הבדיקה השמורה שרוצים להריץ ולוחצים על Execute.
מסמך הבדיקה ייפתח בכרטיסייה חדשה. התוסף נמצא במצב ההרשאה שצוין בפריסה לבדיקה. כדי לוודא שהתוסף פועל כמצופה, אפשר לבצע אינטראקציה עם התפריט ורכיבי ממשק המשתמש שלו.
פרטי הבדיקה
יש כמה דברים שכדאי לזכור כשבודקים תוספים ל-Editor בדרך הזו:
- אי אפשר להשתמש בטריגרים שניתן להתקין במהלך הבדיקה. אי אפשר לבדוק פונקציונליות שמבוססת על טריגרים שניתן להתקין.
- כשמריצים פריסה לבדיקה שמוגדרת לבדיקה עם הקוד העדכני ביותר, אפשר לראות את השינויים שנשמרו בסקריפט של התוסף על ידי רענון מסמך הבדיקה.
- למסמך הבדיקה יש כתובת URL שאפשר לשתף עם עורכי מסמך הבדיקה המקורי. כך תוכלו לשתף פעולה בקלות רבה יותר עם אחרים בזמן הבדיקה והפיתוח.
- אם התוסף משתמש בשירות המאפיינים, המאפיינים נשמרים ויישארו זמינים בפעם הבאה שתפעילו את פריסת הבדיקה.
- בנוסף, לכל פריסה של בדיקה שמשתמשת באותה שילוב של תוסף ומסמך בדיקה יש גישה לאותו מידע על הנכס. לדוגמה, אם יוצרים שתי פריסות לבדיקה, המאפיינים שנשמרו במהלך הפעלת הפריסה הראשונה יהיו זמינים במהלך הפעלת הפריסה השנייה, ולהפך, אבל רק אם בפריסות נעשה שימוש באותו סקריפט ובאותו מסמך בדיקה.
- אם מריצים פריסה לבדיקה, יכול להיות שתופיע בקשה לאישור אם לא הפעילתם את הסקריפט בעבר. חשוב לזכור שאישור סקריפט במהלך בדיקה מאשר אותו גם מחוץ לבדיקה.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2024-12-22 (שעון UTC).
[null,null,["עדכון אחרון: 2024-12-22 (שעון UTC)."],[[["\u003cp\u003eApps Script allows developers to test editor add-ons directly within Google Docs, Sheets, Slides, or Forms to verify functionality and installation flow.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create test deployments to specify add-on versions, authorization states, and associated documents for controlled testing environments.\u003c/p\u003e\n"],["\u003cp\u003eSaved test deployments can be executed repeatedly, enabling developers to iterate on their add-ons and observe changes in real-time within the test document.\u003c/p\u003e\n"],["\u003cp\u003eWhile offering valuable testing capabilities, test deployments have limitations such as not supporting installable triggers and shared property persistence across deployments using the same add-on and document.\u003c/p\u003e\n"],["\u003cp\u003eTest deployments provide a shareable URL for collaborative testing and may require authorization for the script, both within and outside the testing environment.\u003c/p\u003e\n"]]],["To test add-ons in development, create a test deployment linking a script version to a specific Google Docs, Sheets, Forms, or Slides file. Select the add-on's authorization state and save the test. Run saved tests by selecting them in the \"Test deployments\" dialog and clicking \"Execute.\" During testing, changes to the script can be viewed by refreshing the test document; the test document URL is shareable for collaboration. Any properties created are also persisted across multiple test deployments.\n"],null,["# Test an Editor add-on\n\nAdd-ons should be tested thoroughly prior to publishing to ensure they\nbehave as intended. Apps Script lets you test\n[Editor add-ons](/workspace/add-ons/concepts/types#editor_add-ons)\nin development on specific Google Docs Sheets, Forms, or Slides files. This\ncan be used to:\n\n- Verify that an add-on written in a standalone script functions as intended when applied to a sheet, doc, presentation, or form.\n- Verify that the add-on installation flow works as intended, particularly for different initial [authorization lifecycle states](/workspace/add-ons/concepts/editor-auth-lifecycle#the_complete_lifecycle) ([installed, enabled, or both](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)).\n- Verify that the add-on functions as intended when acting on a particular document and its contents.\n- Test and compare the current and previous versions of the add-on.\n\nCreate a test deployment\n------------------------\n\nA test deployment is the combination of an add-on and a test document.\nOnce you have a script version developed and would like to test it as an add-on,\nfollow these steps:\n\n1. If you don't have one already, create a spreadsheet, document, presentation, or form to test the add-on with.\n2. Open the script project containing your add-on.\n3. Click **Deploy** \\\u003e **Test deployments**.\n4. Next to **Select type** , click Enable deployment types settings and select **Editor add-on**.\n5. Click **Create new test** or **Add test**.\n6. Choose a code version or select **Latest Code**.\n7. In the **Config** section, select the initial [authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled) for the test.\n8. Under **Test document** , click **No document selected** . Select the Sheets, Docs, Slides, or Forms file you want to use to test the add-on and click **Insert**.\n9. Click **Save test**.\n\nAll saved test deployments appear in the **Test deployments** dialog. This lets\nyou revisit the same test deployment later on.\n\nRun a test deployment\n---------------------\n\nIf you have one or more saved test deployments, you can run one of them by\nfollowing these steps:\n\n1. Open the script project containing your add-on.\n2. Click **Deploy** \\\u003e **Test deployments**.\n3. Under **Saved Tests** , select the radio button next to the saved test deployment you want to run and click **Execute**.\n\nThe test document opens in a new tab. The add-on is in the\n[authorization state](/workspace/add-ons/concepts/editor-auth-lifecycle#installed_versus_enabled)\nspecified in the test deployment. You can verify that the add-on functions as\nintended by interacting with its menu and UI elements.\n\n### Testing details\n\nThere are a number of things to keep in mind while testing Editor add-ons\nthis way:\n\n- [Installable triggers](/workspace/add-ons/concepts/editor-triggers#installable_triggers_in_add-ons) aren't supported when testing. Functionality that depends on installable triggers is not testable.\n- While running a test deployment that's set to test with the latest code, you can see changes saved to the add-on script by refreshing the test document.\n- The test document has a URL that you can share with editors of the original test document. This way, you can more easily collaborate with others while testing and developing.\n- If your add-on uses the [Properties service](/apps-script/reference/properties/properties-service), properties persist and remain available the next time the test deployment is run.\n- In addition, any test deployment that uses the same combination of add-on and test document has access to the same property information. For example, if you create two test deployments, the properties saved while running the first are available while running the second and vice versa, but only if the deployments use the same script and test document.\n- If you run a test deployment, you might be prompted for authorization if you have not run the script before. Be aware that authorizing a script while testing also authorizes the script outside of testing."]]