Classe google.script.url (API côté client)

google.script.url est une API JavaScript côté client asynchrone qui peut interroger des URL pour obtenir les fragments et les paramètres d'URL actuels. Cette API est compatible avec l'API google.script.history. Elle ne peut être utilisée que dans le contexte d'une application Web qui utilise IFRAME. Elle n'est pas conçue pour être utilisée avec des barres latérales et des boîtes de dialogue dans un contexte de module complémentaire ou de script de conteneur. Pour plus d'informations, consultez le guide sur l'utilisation de l'historique du navigateur dans les applications Web.

Méthodes

MéthodeType renvoyéBrève description
getLocation(function) void Récupère un objet d'emplacement d'URL et le transmet à la fonction de rappel spécifiée.

Documentation détaillée

getLocation(function)

Récupère un objet d'emplacement d'URL et le transmet à la fonction de rappel spécifiée (comme seul argument).

Index.html

google.script.url.getLocation(function(location) {
  console.log(location.parameters);
  console.log(location.hash);
});

Paramètres

NomTypeDescription
functionFunctionUne fonction de rappel côté client à exécuter, l'objet de localisation étant le seul argument.

Objet de position

Le tableau suivant présente des exemples d'éléments de lieu qui seraient spécifiés si l'URL suivante était 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 chaîne vide en l'absence de fragment d'URL

headingAnchor
location.parameter

Objet de paires clé/valeur correspondant aux paramètres de requête d'URL. Seule la première valeur est renvoyée pour les paramètres comportant plusieurs valeurs. Si aucun paramètre n'est présent, l'objet sera vide.

{"name": "alice", "n": "1"}
location.parameters

Objet semblable à location.parameter, mais avec un tableau de valeurs pour chaque clé. Si aucun paramètre n'est présent, l'objet sera vide.

{"name": ["alice"], "n": ["1", "2"]}