OAuth (Dialogflow)를 통한 계정 연결

OAuth 연결 유형은 두 가지 업계 표준 OAuth 2.0 흐름, 즉 암시적 OAuth 2.0 흐름을 지원합니다. 승인 코드 플로우가 포함됩니다.

In the implicit code flow, Google opens your authorization endpoint in the user's browser. After successful sign in, you return a long-lived access token to Google. This access token is now included in every request sent from the Assistant to your Action.

In the authorization code flow, you need two endpoints:

• The authorization endpoint, which is responsible for presenting the sign-in UI to your users that aren't already signed in and recording consent to the requested access in the form of a short-lived authorization code.
• The token exchange endpoint, which is responsible for two types of exchanges:
  1. Exchanges an authorization code for a long-lived refresh token and a short-lived access token. This exchange happens when the user goes through the account linking flow.
  2. Exchanges a long-lived refresh token for a short-lived access token. This exchange happens when Google needs a new access token because the one it had expired.

Although the implicit code flow is simpler to implement, Google recommends that access tokens issued using the implicit flow never expire, because using token expiration with the implicit flow forces the user to link their account again. If you need token expiration for security reasons, you should strongly consider using the auth code flow instead.

Note: Please choose which OAuth2 flow you want to implement. If needed, the content of this guide reloads to adapt to your choice.

Auth code Implicit flow

OAuth 계정 연결 구현

참고: 금융 정보를 처리하기 위해 계정 연결을 구현하는 경우 작업에 추가 정책이 적용될 수 있습니다. 최대 6개의 재무 정보를 확인하기 위해 계정이 연결된 액션을 검토할 수 있습니다. 출시 일정을 계획할 때 그 시간을 고려하세요. 간단한 검토를 위해 금융 서비스 정책을 준수하는지 확인합니다. 검토를 위해 작업을 제출하기 전에 확인할 수 있습니다.

프로젝트 구성

OAuth 계정 연결을 사용하도록 프로젝트를 구성하려면 다음 단계를 따르세요.

1. Actions 콘솔을 열고 사용할 프로젝트를 선택합니다.
2. 개발 탭을 클릭하고 계정 연결을 선택합니다.
3. 계정 연결 옆의 스위치를 켭니다.
4. 계정 생성 섹션에서 아니요, 내 웹사이트에서만 계정 생성을 허용하겠습니다를 선택합니다.

5. 연결 유형에서 OAuth 및 암시적을 선택합니다.

   

6. 클라이언트 정보에서 다음을 수행합니다.

   • 내 작업에서 Google에 발급한 클라이언트 ID에 값을 할당하여 Google에서 전송하는 요청입니다. <ph type="x-smartling-placeholder"></ph>
   • 승인 및 토큰 교환 엔드포인트의 URL을 입력하세요.

를 통해 개인정보처리방침을 정의할 수 있습니다.

참고: 클라이언트 ID를 base64 인코딩으로 전송하려는 경우 문자열에서 클라이언트 구성 (선택사항) 옆에 있는 드롭다운 화살표를 클릭합니다. 그런 다음 Google에서 HTTP 기본 서비스를 통해 clientID와 보안 비밀을 전송하기 위해 인증 헤더가 필요합니다.

6. 저장을 클릭합니다.

OAuth 서버 구현

To support the OAuth 2.0 implicit flow, your service makes an authorization endpoint available by HTTPS. This endpoint is responsible for authenticating and obtaining consent from users for data access. The authorization endpoint presents a sign-in UI to your users that aren't already signed in and records consent to the requested access.

When your Action needs to call one of your service's authorized APIs, Google uses this endpoint to get permission from your users to call these APIs on their behalf.

A typical OAuth 2.0 implicit flow session initiated by Google has the following flow:

1. Google opens your authorization endpoint in the user's browser. The user signs in if not signed in already, and grants Google permission to access their data with your API if they haven't already granted permission.
2. Your service creates an access token and returns it to Google by redirecting the user's browser back to Google with the access token attached to the request.
3. Google calls your service's APIs, and attaches the access token with each request. Your service verifies that the access token grants Google authorization to access the API and then completes the API call.

Handle authorization requests

When your Action needs to perform account linking via an OAuth2 implicit flow, Google sends the user to your authorization endpoint with a request that includes the following parameters:

Authorization endpoint parameters
client_id	The client ID you assigned to Google.
redirect_uri	The URL to which you send the response to this request.
state	A bookkeeping value that is passed back to Google unchanged in the redirect URI.
response_type	The type of value to return in the response. For the OAuth 2.0 implicit flow, the response type is always token.

For example, if your authorization endpoint is available at https://myservice.example.com/auth, a request might look like:

GET https://myservice.example.com/auth?client_id=GOOGLE_CLIENT_ID&redirect_uri=REDIRECT_URI&state=STATE_STRING&response_type=token

For your authorization endpoint to handle sign-in requests, do the following steps:

1. Verify the client_id and redirect_uri values to prevent granting access to unintended or misconfigured client apps:

   • Confirm that the client_id matches the client ID you assigned to Google.
   • Confirm that the URL specified by the redirect_uri parameter has the following form:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID

     YOUR_PROJECT_ID is the ID found on the Project settings page of the Actions Console.

2. Check if the user is signed in to your service. If the user isn't signed in, complete your service's sign-in or sign-up flow.

3. Generate an access token that Google will use to access your API. The access token can be any string value, but it must uniquely represent the user and the client the token is for and must not be guessable.

4. Send an HTTP response that redirects the user's browser to the URL specified by the redirect_uri parameter. Include all of the following parameters in the URL fragment:

   • access_token: the access token you just generated
   • token_type: the string bearer
   • state: the unmodified state value from the original request The following is an example of the resulting URL:

     https://oauth-redirect.googleusercontent.com/r/YOUR_PROJECT_ID#access_token=ACCESS_TOKEN&token_type=bearer&state=STATE_STRING

Google's OAuth 2.0 redirect handler will receive the access token and confirm that the state value hasn't changed. After Google has obtained an access token for your service, Google will attach the token to subsequent calls to your Action as part of the AppRequest.

인증 흐름 시작

경고: 작업과 대화를 시작할 때 사용자에게 계정 연결 필수 메시지를 표시하지 마세요. 대신 인증되지 않은 사용자에게 게스트 플로우를 제공하여 작업의 작동 방식을 보여주고 진행에 필요한 경우에만 계정 연결을 요청하세요. 계정 연결 문제로 인해 사용자가 계속 작업을 떠나는 경우 Google에서 작업을 적극적으로 홍보하지 않으므로 작업의 사용자 트래픽이 감소할 수 있습니다.

계정 로그인 도우미 인텐트 사용 인증 흐름을 시작합니다. 다음 코드 스니펫은 Dialogflow 및 Actions SDK에서 응답을 보내 이 도우미를 사용합니다.

Dialogflow:

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Node.js

const {dialogflow, SignIn} = require('actions-on-google');
const app = dialogflow({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('Start Signin', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

드림

<ph type="x-smartling-placeholder">

</ph>

자바

@ForIntent("Start Signin")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

드림

<ph type="x-smartling-placeholder">

</ph>

JSON

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "PLACEHOLDER"
            }
          }
        ]
      },
      "userStorage": "{\"data\":{}}",
      "systemIntent": {
        "intent": "actions.intent.SIGN_IN",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
          "optContext": "To get your account details"
        }
      }
    }
  },
  "outputContexts": [
    {
      "name": "/contexts/_actions_on_google",
      "lifespanCount": 99,
      "parameters": {
        "data": "{}"
      }
    }
  ]
}

Actions SDK:

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph>

Node.js

const {actionssdk, SignIn} = require('actions-on-google');
const app = actionssdk({
  // REPLACE THE PLACEHOLDER WITH THE CLIENT_ID OF YOUR ACTIONS PROJECT
  clientId: CLIENT_ID,
});
// Intent that starts the account linking flow.
app.intent('actions.intent.TEXT', (conv) => {
  conv.ask(new SignIn('To get your account details'));
});

드림

<ph type="x-smartling-placeholder">

</ph>

자바

@ForIntent("actions.intent.TEXT")
public ActionResponse text(ActionRequest request) {
  ResponseBuilder rb = getResponseBuilder(request);
  return rb.add(new SignIn().setContext("To get your account details")).build();
}

드림

<ph type="x-smartling-placeholder">

</ph>

JSON

{
  "expectUserResponse": true,
  "expectedInputs": [
    {
      "inputPrompt": {
        "richInitialPrompt": {
          "items": [
            {
              "simpleResponse": {
                "textToSpeech": "PLACEHOLDER"
              }
            }
          ]
        }
      },
      "possibleIntents": [
        {
          "intent": "actions.intent.SIGN_IN",
          "inputValueData": {
            "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec",
            "optContext": "To get your account details"
          }
        }
      ]
    }
  ],
  "conversationToken": "{\"data\":{}}",
  "userStorage": "{\"data\":{}}"
}

데이터 액세스 요청 처리

어시스턴트 요청에 액세스 토큰이 포함된 경우, 먼저 액세스 토큰이 유효하고 만료되지 않았는지 확인한 다음 데이터베이스에서 연결된 사용자 계정을 검색합니다.