Класс google.script.url (клиентский API)
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
google.script.url
— это асинхронный клиентский API JavaScript, который может запрашивать URL-адреса для получения текущих параметров и фрагмента URL-адреса. Этот API поддерживает API google.script.history
. Его можно использовать только в контексте веб-приложения, использующего IFRAME
. Он не предназначен для использования с боковыми панелями и диалоговыми окнами в контексте надстройки или сценария контейнера. Дополнительные сведения см. в руководстве по использованию истории браузера в веб-приложениях .
Методы
Метод | Тип возврата | Краткое описание |
---|
getLocation(function) | void | Получает объект местоположения URL-адреса и передает его указанной функции обратного вызова. |
Подробная документация
getLocation(function)
Получает объект местоположения URL-адреса и передает его указанной функции обратного вызова (в качестве единственного аргумента).
Индекс.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
Параметры
Имя | Тип | Описание |
---|
function | Function | функция обратного вызова на стороне клиента для запуска, используя объект местоположения в качестве единственного аргумента. |
Объект местоположения
В следующей таблице показаны примеры элементов местоположения, которые будут указаны, если был запрошен следующий 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 "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-24 UTC.
[null,null,["Последнее обновление: 2025-07-24 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*** ** * ** ***"]]