Class google.script.url (Client-side API)
Stay organized with collections
Save and categorize content based on your preferences.
google.script.url is an asynchronous client-side JavaScript
API that can query URLs to obtain the current URL parameters and fragment.
This API supports the google.script.history
API. It can only be used in the context of a web app that uses
IFRAME.
It is not intended for use with sidebars and dialogs in an add-on or
container-script context. For more information, see the
guide to using browser
history in web apps.
Methods
| Method | Return type | Brief description |
getLocation(function) |
void |
Gets a URL location object and passes it to the specified callback
function. |
Detailed documentation
getLocation(function)
Gets a URL location object and passes it to the specified callback
function (as the only argument).
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
Parameters
| Name | Type | Description |
function | Function | a client-side
callback function to run, using the
location object as the only argument.
|
Location object
The 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
| Fields |
location.hash |
The string value of URL fragment after the # character,
or an empty string if no URL fragment is present
headingAnchor
|
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"}
|
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"]}
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 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*** ** * ** ***"]]
