Classe google.script.url (API do lado do cliente)
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
google.script.url
é um JavaScript assíncrono do lado do cliente.
API que pode consultar URLs para receber os parâmetros e o fragmento de URL atuais.
Esta API oferece suporte aos google.script.history
API. Ele só pode ser usado no contexto de um aplicativo da Web que usa
IFRAME
Não se destina ao uso com barras laterais e caixas de diálogo em um complemento ou
container-script. Para mais informações, consulte a
guia para usar o navegador
em apps da Web.
Métodos
Método | Tipo de retorno | Breve descrição |
getLocation(function) |
void |
Recebe um objeto de local do URL e o transmite para o retorno de chamada especificado
função. |
Documentação detalhada
getLocation(function)
Recebe um objeto de local do URL e o transmite para a chamada de retorno especificada.
(como o único argumento).
Index.html
google.script.url.getLocation(function(location) {
console.log(location.parameters);
console.log(location.hash);
});
Parâmetros
Nome | Tipo | Descrição |
function | Function | do lado do cliente
função de callback seja executada, usando a função
location object como o único argumento.
|
Objeto de local
A tabela a seguir mostra exemplos dos elementos de localização que seriam especificados se o
o seguinte URL foi consultado:
http://www.example.com?n=1&name=alice&n=2#headingAnchor
Campos |
location.hash |
O valor da string do fragmento de URL após o caractere # .
ou uma string vazia se nenhum fragmento de URL estiver presente
headingAnchor
|
location.parameter |
Objeto de pares de chave-valor que corresponde à solicitação de URL.
parâmetros. Somente o primeiro valor será retornado para parâmetros
com vários valores. Se não houver parâmetros,
ser um objeto vazio.
{"name": "alice", "n": "1"}
|
location.parameters |
Um objeto semelhante a location.parameter , mas com
uma matriz de valores para cada chave. Se não houver parâmetros,
ser um objeto vazio.
{"name": ["alice"], "n": ["1", "2"]}
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 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*** ** * ** ***"]]