Clase google.script.url (API del cliente)
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
google.script.url
es un JavaScript asíncrono del lado del cliente
La API puede consultar las URLs para obtener los parámetros y el fragmento de URL actuales.
Esta API admite el método google.script.history
en la API de Cloud. Solo se puede usar en el contexto de una aplicación web que use
IFRAME
No está diseñado para usarse con barras laterales y diálogos en un complemento o
contexto de secuencia de comandos del contenedor. Para obtener más información, consulta la
guía para usar el navegador
en apps web.
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
getLocation(function) |
void |
Obtiene un objeto de ubicación de URL y lo pasa a la devolución de llamada especificada.
. |
Documentación detallada
getLocation(function)
Obtiene un objeto de ubicación de URL y lo pasa a la devolución de llamada especificada.
(como único argumento).
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
Parámetros
Nombre | Tipo | Descripción |
function | Function | del cliente
función de devolución de llamada que se ejecute
location object como único argumento.
|
Objeto Location
En la siguiente tabla, se muestran ejemplos de los elementos de ubicación que se especificarían si el elemento
se consultó la siguiente URL:
http://www.example.com?n=1&name=alice&n=2#headingAnchor
Campos |
location.hash |
El valor de cadena del fragmento de URL después del carácter #
o una cadena vacía si no hay ningún fragmento de URL
headingAnchor
|
location.parameter |
Un objeto de pares clave-valor que corresponden a la solicitud de URL
parámetros. Solo se mostrará el primer valor de los parámetros
que tienen múltiples valores. Si no hay parámetros presentes,
ser un objeto vacío.
{"name": "alice", "n": "1"}
|
location.parameters |
Un objeto similar a location.parameter , pero con
un array de valores para cada clave. Si no hay parámetros presentes,
ser un objeto vacío.
{"name": ["alice"], "n": ["1", "2"]}
|
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-26 (UTC)
[null,null,["Última actualización: 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*** ** * ** ***"]]