Classe google.script.url (API côté client)
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
google.script.url
est un code JavaScript asynchrone côté client.
API capable d'interroger des URL pour obtenir les paramètres d'URL actuels et le fragment.
Cette API est compatible avec la google.script.history
API. Il ne peut être utilisé que dans le contexte
d'une application Web qui utilise
IFRAME
Elle n'est pas destinée à être utilisée avec les barres latérales et les boîtes de dialogue d'un module complémentaire ou
conteneur-script. Pour en savoir plus, consultez les
guide d'utilisation du navigateur
dans les applications Web.
Méthodes
Méthode | Type renvoyé | Brève description |
getLocation(function) |
void |
Récupère un objet location d'URL et le transmet au rappel spécifié.
. |
Documentation détaillée
getLocation(function)
Elle récupère un objet de localisation d'URL et le transmet au rappel spécifié.
(comme seul argument).
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
Paramètres
Nom | Type | Description |
function | Function | côté client
de rappel à exécuter, à l'aide de la
location_object comme seul argument.
|
Objet Location
Le tableau suivant présente des exemples d'éléments "location" qui seraient spécifiés si le
L'URL suivante a été interrogée:
http://www.example.com?n=1&name=alice&n=2#headingAnchor
Champs |
location.hash |
Valeur de chaîne du fragment d'URL après le caractère # ,
ou une chaîne vide en l'absence de fragment d'URL
headingAnchor
|
location.parameter |
Un objet de paires clé/valeur correspondant à la requête URL
paramètres. Seule la première valeur est renvoyée pour les paramètres.
comportant plusieurs valeurs. Si aucun paramètre n'est présent,
être un objet vide.
{"name": "alice", "n": "1"}
|
location.parameters |
Un objet semblable à location.parameter , mais avec
un tableau de valeurs pour chaque clé. Si aucun paramètre n'est présent,
être un objet vide.
{"name": ["alice"], "n": ["1", "2"]}
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 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*** ** * ** ***"]]