Permite que las secuencias de comandos creen tokens de estado que se pueden usar en APIs de devolución de llamada (como flujos de OAuth).
// Reusable function to generate a callback URL, assuming the script has been // published as a web app (necessary to obtain the URL programmatically). If the // script has not been published as a web app, set `var url` in the first line // to the URL of your script project (which cannot be obtained // programmatically). function getCallbackURL(callbackFunction) { let url = ScriptApp.getService().getUrl(); // Ends in /exec (for a web app) url = `${ url.slice(0, -4)}usercallback?state=`; // Change /exec to /usercallback const stateToken = ScriptApp.newStateToken() .withMethod(callbackFunction) .withTimeout(120) .createToken(); return url + stateToken; }
Métodos
Método | Tipo de datos que se muestra | Descripción breve |
---|---|---|
create | String | Construye una representación de cadena encriptada del token de estado. |
with | State | Agrega un argumento al token. |
with | State | Establece una función de devolución de llamada. |
with | State | Establece la duración (en segundos) durante la cual el token es válido. |
Documentación detallada
create Token()
Construye una representación de cadena encriptada del token de estado.
const stateToken = ScriptApp.newStateToken().createToken();
Volver
String
: Es una cadena encriptada que representa el token.
with Argument(name, value)
Agrega un argumento al token. Se puede llamar a este método varias veces.
const stateToken = ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
name | String | el nombre del argumento |
value | String | el valor del argumento |
Volver
State
: Es el compilador de tokens de estado para encadenar.
with Method(method)
Establece una función de devolución de llamada. El valor predeterminado es una función llamada callback()
.
const stateToken = ScriptApp.newStateToken().withMethod('myCallback').createToken();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
method | String | Es el nombre de la función de devolución de llamada, representada como una cadena sin paréntesis ni argumentos. Puedes usar funciones de las bibliotecas incluidas, como
Library.libFunction1 . |
Volver
State
: Es el compilador de tokens de estado para encadenar.
with Timeout(seconds)
Establece la duración (en segundos) durante la cual el token es válido. El valor predeterminado es de 60 segundos y la duración máxima es de 3,600 segundos (1 hora).
const stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();
Parámetros
Nombre | Tipo | Descripción |
---|---|---|
seconds | Integer | la duración durante la cual el token es válido (el valor máximo es 3600 ) |
Volver
State
: Es el compilador de tokens de estado para encadenar.