Klasse google.script.url (Clientseitiges API)

google.script.url ist eine asynchrone clientseitige JavaScript API, die URLs abfragen kann, um die aktuellen URL-Parameter und das Fragment zu erhalten. Diese API unterstützt die google.script.history API. Sie kann nur im Kontext einer Webanwendung verwendet werden, die IFRAME verwendet. Sie ist nicht für die Verwendung mit Seitenleisten und Dialogfeldern in einem Add-on- oder Container-Script-Kontext vorgesehen. Weitere Informationen findest du im Leitfaden zur Verwendung des Browserverlaufs in Web-Apps.

Methoden

MethodeRückgabetypKurzbeschreibung
getLocation(function) void Ruft ein URL-Standortobjekt ab und übergibt es an die angegebene Callback-Funktion.

Detaillierte Dokumentation

getLocation(function)

Ruft ein URL-Standortobjekt ab und übergibt es an die angegebene Callback-Funktion (als einziges Argument).

Index.html

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

Parameter

NameTypBeschreibung
functionFunctioneine clientseitige Callback-Funktion, die ausgeführt werden soll, wobei das Standortobjekt als einziges Argument verwendet wird.

Standortobjekt

Die folgende Tabelle enthält Beispiele für Standortelemente, die angegeben werden, wenn die folgende URL abgefragt wird: http://www.example.com?n=1&name=alice&n=2#headingAnchor
Felder
location.hash

Stringwert des URL-Fragments nach dem Zeichen # oder ein leerer String, wenn kein URL-Fragment vorhanden ist

headingAnchor
location.parameter

Ein Objekt mit Schlüssel/Wert-Paaren, die den URL-Anfrageparametern entsprechen. Bei Parametern mit mehreren Werten wird nur der erste Wert zurückgegeben. Wenn keine Parameter vorhanden sind, ist dies ein leeres Objekt.

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

Ein Objekt ähnlich wie location.parameter, aber mit einem Array von Werten für jeden Schlüssel. Wenn keine Parameter vorhanden sind, ist dies ein leeres Objekt.

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