מחלקה של google.script.url (ממשק API בצד הלקוח)
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
google.script.url
הוא JavaScript אסינכרוני בצד הלקוח
ממשק API שיכול לשלוח שאילתות על כתובות URL כדי לקבל את הפרמטרים והמקטע הנוכחיים של כתובת האתר.
ה-API הזה תומך ב-google.script.history
API. ניתן להשתמש בה רק בהקשר של אפליקציית אינטרנט שמשתמשת
IFRAME
היא לא מיועדת לשימוש עם סרגלי צד ותיבות דו-שיח בתוסף, או
הקשר לסקריפט קונטיינר. מידע נוסף זמין במאמר
מדריך לשימוש בדפדפן
ההיסטוריה באפליקציות אינטרנט.
שיטות
שיטה | סוג הערך המוחזר | תיאור קצר |
getLocation(function) |
void |
הפונקציה מקבלת אובייקט מיקום של כתובת URL ומעבירה אותו לקריאה החוזרת (callback) שצוינה
מותאמת אישית. |
מסמכי תיעוד מפורטים
getLocation(function)
הפונקציה מקבלת אובייקט של מיקום כתובת URL ומעבירה אותו לקריאה חוזרת (callback) שצוין
פונקציה (כארגומנט היחיד).
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
פרמטרים
שם | סוג | תיאור |
function | Function | בצד הלקוח
להפעיל את פונקציית הקריאה החוזרת, באמצעות
location object בתור הארגומנט היחיד.
|
אובייקט מיקום
הטבלה הבאה מציגה דוגמאות לרכיבי המיקום שיצוינו אם
נעשתה שאילתה לגבי כתובת ה-URL הבאה:
http://www.example.com?n=1&name=alice&n=2#headingAnchor
שדות |
location.hash |
ערך המחרוזת של מקטע כתובת URL אחרי התו # ,
או מחרוזת ריקה אם לא קיים שבר של כתובת URL
headingAnchor
|
location.parameter |
אובייקט של צמדי מפתח/ערך שתואמים לבקשה לכתובת ה-URL
. רק הערך הראשון יוחזר לפרמטרים
שיש להם כמה ערכים. אם לא קיימים פרמטרים, הפעולה
להיות אובייקט ריק.
{"name": "alice", "n": "1"}
|
location.parameters |
אובייקט שדומה ל-location.parameter , אבל עם
מערך של ערכים לכל מפתח. אם לא קיימים פרמטרים,
להיות אובייקט ריק.
{"name": ["alice"], "n": ["1", "2"]}
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-26 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-26 (שעון UTC)."],[[["\u003cp\u003e\u003ccode\u003egoogle.script.url\u003c/code\u003e is a client-side JavaScript API for querying URLs to get parameters and fragments within web apps.\u003c/p\u003e\n"],["\u003cp\u003eThis API works with \u003ccode\u003egoogle.script.history\u003c/code\u003e and requires the use of \u003ccode\u003eIFRAME\u003c/code\u003e in your web app.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetLocation()\u003c/code\u003e method retrieves a URL location object containing parameters and hash information, passing it to a callback function.\u003c/p\u003e\n"],["\u003cp\u003eThe location object provides access to URL components like hash, individual parameters, and all parameter values.\u003c/p\u003e\n"]]],[],null,["# Class google.script.url (Client-side API)\n\n`google.script.url` is an asynchronous client-side JavaScript\nAPI that can query URLs to obtain the current URL parameters and fragment.\nThis API supports the [`google.script.history`](/apps-script/guides/html/reference/history)\nAPI. It can only be used in the context of a web app that uses\n[`IFRAME`](/apps-script/reference/html/sandbox-mode#properties).\nIt is not intended for use with sidebars and dialogs in an add-on or\ncontainer-script context. For more information, see the\n[guide to using browser\nhistory in web apps](/apps-script/guides/web#web_apps_and_browser_history). \n\n### Methods\n\n| Method | Return type | Brief description |\n|-------------------------------------------------|-------------|------------------------------------------------------------------------------|\n| [getLocation(function)](#getLocation(Function)) | `void` | Gets a URL location object and passes it to the specified callback function. |\n\nDetailed documentation\n----------------------\n\n### `getLocation(function)`\n\nGets a [URL location object](#locationObject) and passes it to the specified callback\nfunction (as the only argument). \n\n### Index.html\n\n```html\ngoogle.script.url.getLocation(function(location) {\n console.log(location.parameters);\n console.log(location.hash);\n});\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|------------|------------|------------------------------------------------------------------------------------------------------------|\n| `function` | `Function` | a client-side callback function to run, using the [location object](#locationObject) as the only argument. |\n\n#### Location object\n\nThe following table shows examples of the location elements that would be specified if the following URL was queried: `http://www.example.com?n=1&name=alice&n=2#headingAnchor`\n\n| Fields ||\n|-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `location.hash` | The string value of URL fragment after the `#` character, or an empty string if no URL fragment is present ``` headingAnchor ``` |\n| `location.parameter` | An object of key/value pairs that correspond to the URL request parameters. Only the first value will be returned for parameters that have multiple values. If no parameters are present, this will be an empty object. ``` {\"name\": \"alice\", \"n\": \"1\"} ``` |\n| `location.parameters` | An object similar to `location.parameter`, but with an array of values for each key. If no parameters are present, this will be an empty object. ``` {\"name\": [\"alice\"], \"n\": [\"1\", \"2\"]} ``` |\n\n*** ** * ** ***"]]