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 paramètres d'URL actuels et le fragment. Cette API est compatible avec l'API google.script.history. 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 des barres latérales et des boîtes de dialogue dans un module complémentaire ou dans un contexte de script de conteneur. Pour en savoir plus, consultez le guide d'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 de localisation 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, en utilisant l'objet location comme seul argument.

Objet de localisation

Le tableau suivant présente des exemples d'éléments d'emplacement 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 si aucun fragment d'URL n'est présent

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 ayant 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"]}