Class StateTokenBuilder

StateTokenBuilder

스크립트에서 콜백 API (예: 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;
}

메서드

메서드반환 유형간략한 설명
createToken()String상태 토큰의 암호화된 문자열 표현을 생성합니다.
withArgument(name, value)StateTokenBuilder토큰에 인수를 추가합니다.
withMethod(method)StateTokenBuilder콜백 함수를 설정합니다.
withTimeout(seconds)StateTokenBuilder토큰이 유효한 기간 (초)을 설정합니다.

자세한 문서

createToken()

상태 토큰의 암호화된 문자열 표현을 생성합니다. 

const stateToken = ScriptApp.newStateToken().createToken();

리턴

String — 토큰을 나타내는 암호화된 문자열입니다.

withArgument(name, value)

토큰에 인수를 추가합니다. 이 메서드는 여러 번 호출할 수 있습니다. 

const stateToken =
    ScriptApp.newStateToken().withArgument('myField', 'myValue').createToken();

매개변수

이름유형설명
nameString인수의 이름입니다.
valueString인수의 값입니다.

리턴

StateTokenBuilder — 체이닝을 위한 상태 토큰 빌더입니다.

withMethod(method)

콜백 함수를 설정합니다. 기본값은 callback()이라는 함수입니다. 

const stateToken =
    ScriptApp.newStateToken().withMethod('myCallback').createToken();

매개변수

이름유형설명
methodString괄호나 인수 없이 문자열로 표현되는 콜백 함수의 이름입니다. Library.libFunction1과 같이 포함된 라이브러리의 함수를 사용할 수 있습니다.

리턴

StateTokenBuilder — 체이닝을 위한 상태 토큰 빌더입니다.

withTimeout(seconds)

토큰이 유효한 기간 (초)을 설정합니다. 기본값은 60초이며 최대 기간은 3,600초 (1시간)입니다. 

const stateToken = ScriptApp.newStateToken().withTimeout(60).createToken();

매개변수

이름유형설명
secondsInteger토큰이 유효한 기간입니다. 최댓값은 3600입니다.

리턴

StateTokenBuilder — 체이닝을 위한 상태 토큰 빌더입니다.