TV 및 입력 제한 기기 애플리케이션용 OAuth 2.0

이 문서에서는 TV, 게임 콘솔, 프린터와 같은 기기에서 실행되는 애플리케이션을 통해 Google API에 액세스하도록 OAuth 2.0 승인을 구현하는 방법을 설명합니다. 더 구체적으로 이 흐름은 브라우저에 액세스할 수 없거나 입력 기능이 제한된 기기용으로 설계되었습니다.

OAuth 2.0을 사용하면 사용자가 사용자 이름, 비밀번호, 기타 정보를 비공개로 유지하면서 특정 데이터를 애플리케이션과 공유할 수 있습니다. 예를 들어 TV 애플리케이션은 OAuth 2.0을 사용하여 Google Drive에 저장된 파일을 선택할 권한을 얻을 수 있습니다.

이 흐름을 사용하는 애플리케이션은 개별 기기에 배포되므로 앱이 비밀을 유지할 수 없다고 가정합니다. 사용자는 앱에 있거나 앱이 백그라운드에서 실행 중일 때 Google API에 액세스할 수 있습니다.

대안

브라우저 및 전체 입력 기능에 액세스할 수 있는 Android, iOS, macOS, Linux 또는 Windows(유니버설 Windows 플랫폼 포함)와 같은 플랫폼용 앱을 작성하는 경우 모바일 및 데스크톱 애플리케이션용 OAuth 2.0 흐름을 사용하세요. 앱이 그래픽 인터페이스가 없는 명령줄 도구인 경우에도 이 흐름을 사용해야 합니다.

Google 계정으로 사용자를 로그인하고 JWT ID 토큰을 사용하여 기본 사용자 프로필 정보를 가져오기 만 원하는 경우 TV 및 제한된 입력 장치에서 로그인을 참고하세요.

기본 요건

프로젝트에 API 사용 설정

Google API를 호출하는 모든 애플리케이션은 API Console에서 이러한 API를 사용 설정해야 합니다.

프로젝트에 API를 사용 설정하려면 다음 단계를 따르세요.

1. Google API Console의Open the API Library
2. If prompted, select a project, or create a new one.
3. API Library 에는 사용 가능한 모든 API가 제품군 및 인기도별로 분류되어 있습니다. 사용 설정하려는 API가 목록에 없는 경우 검색을 사용하여 찾거나 해당 API가 속한 제품군에서 모두 보기를 클릭합니다.
4. 사용 설정하려는 API를 선택한 다음 사용 설정 버튼을 클릭합니다.
5. If prompted, enable billing.
6. If prompted, read and accept the API's Terms of Service.

승인 사용자 인증 정보 만들기

OAuth 2.0을 사용하여 Google API에 액세스하는 모든 애플리케이션에는 Google의 OAuth 2.0 서버에 애플리케이션을 식별하는 승인 사용자 인증 정보가 있어야 합니다. 다음 단계에서는 프로젝트의 사용자 인증 정보를 만드는 방법을 설명합니다. 그러면 애플리케이션에서 사용자 인증 정보를 사용하여 해당 프로젝트에 대해 사용 설정한 API에 액세스할 수 있습니다.

1. Go to the Credentials page.
2. 사용자 인증 정보 만들기 > OAuth 클라이언트 ID를 클릭합니다.
3. TV 및 입력 제한 기기 애플리케이션 유형을 선택합니다.
4. OAuth 2.0 클라이언트의 이름을 지정하고 만들기를 클릭합니다.

액세스 범위 식별

범위를 사용 설정하면 애플리케이션은 필요한 리소스에 대한 액세스만 요청하고 사용자는 애플리케이션에 부여하는 액세스 양을 제어할 수 있습니다. 따라서 요청된 범위 수와 사용자 동의 얻을 가능성 사이에는 역관계가 있을 수 있습니다.

OAuth 2.0 승인을 구현하기 전에 앱에서 액세스 권한이 필요한 범위를 지정하는 것이 좋습니다.

설치된 앱 또는 기기의 허용된 범위 목록을 참고하세요.

OAuth 2.0 액세스 토큰 가져오기

애플리케이션이 제한된 입력 기능을 갖춘 기기에서 실행되더라도 사용자가 이 인증 흐름을 완료하려면 더 풍부한 입력 기능을 갖춘 기기에 별도로 액세스할 수 있어야 합니다. 흐름의 단계는 다음과 같습니다.

1. 애플리케이션이 Google의 승인 서버에 애플리케이션이 액세스 권한을 요청할 범위를 식별하는 요청을 전송합니다.
2. 서버는 기기 코드, 사용자 코드와 같이 후속 단계에서 사용되는 여러 정보로 응답합니다.
3. 사용자가 별도의 기기에서 입력하여 앱을 승인할 수 있는 정보를 표시합니다.
4. 애플리케이션이 Google의 승인 서버를 폴링하여 사용자가 앱을 승인했는지 확인하기 시작합니다.
5. 사용자가 더 풍부한 입력 기능을 갖춘 기기로 전환하고 웹브라우저를 실행한 다음 3단계에 표시된 URL로 이동하여 3단계에 표시된 코드를 입력합니다. 그러면 사용자는 애플리케이션에 대한 액세스 권한을 부여하거나 거부할 수 있습니다.
6. 폴링 요청에 대한 다음 응답에는 앱이 사용자를 대신하여 ���청을 승인하는 데 필요한 토큰이 포함됩니다. 사용자가 애플리케이션 액세스를 거부한 경우 응답에 토큰이 포함되지 않습니다.

아래 이미지는 이 프로세��를 ���������니다.

다음 섹션에서 이 단계를 자세히 설명합니다. 기기에 있을 수 있는 다양한 기능과 런타임 환경을 고려하여 이 문서에 표시된 예에서는 curl 명령줄 유틸리티를 사용합니다. 이러한 예는 다양한 언어와 런타임으로 쉽게 이식할 수 있어야 합니다.

1단계: 기기 및 사용자 코드 요청

이 단계에서 기기는 Google의 승인 서버(https://oauth2.googleapis.com/device/code)에 HTTP POST 요청을 전송하여 애플리케이션과 애플리케이션에서 사용자를 대신하여 액세스하려는 액세스 범위를 식별합니다. device_authorization_endpoint 메타데이터 값을 사용하여 탐색 문서에서 이 URL을 가져와야 합니다. 다음 HTTP 요청 매개변수를 포함합니다.

예

다음 스니펫은 샘플 요청을 보여줍니다.

POST /device/code HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&scope=email%20profile

다음 예는 동일한 요청을 전송하는 curl 명령어를 보여줍니다.

curl -d "client_id=client_id&scope=email%20profile" \
     https://oauth2.googleapis.com/device/code

2단계: 승인 서버 응답 처리

승인 서버는 다음 응답 중 하나를 반환합니다.

성공 응답

요청이 유효하��� 응답은 다음 속성이 포함된 JSON 객체가 됩니다.

다음 스니펫은 샘플 응답을 보여줍니다.

{
  "device_code": "4/4-GMMhmHCXhWEzkobqIHGG_EnNYYsAkukHspeYUk9E8",
  "user_code": "GQVQ-JKEC",
  "verification_url": "https://www.google.com/device",
  "expires_in": 1800,
  "interval": 5
}

할당량 초과 응답

기기 코드 요청이 클라이언트 ID와 연결된 할당량을 초과하면 다음 오류가 포함된 403 응답이 수신됩니다.

{
  "error_code": "rate_limit_exceeded"
}

이 경우 백오프 전략을 사용하여 요청 빈도를 줄입니다.

3단계: 사용자 코드 표시

2단계에서 가져온 verification_url 및 user_code를 사용자에게 표시합니다. 두 값 모두 US-ASCII 문자 집합의 인쇄 가능한 문자를 포함할 수 있습니다. 사용자에게 표시되는 콘텐츠는 사용자에게 별도의 기기에서 verification_url로 이동하여 user_code를 입력하도록 안내해야 합니다.

다음 규칙을 염두에 두고 사용자 인터페이스 (UI)를 디자인하세요.

• user_code
  • user_code는 15개의 'W' 크기 문자를 처리할 수 있는 필드에 표시되어야 합니다. 즉, WWWWWWWWWWWWWWW 코드를 올바르게 표시할 수 있으면 UI가 유효하며 user_code가 UI에 표시되는 방식을 테스트할 때 이 문자열 값을 사용하는 것이 좋습니다.
  • user_code는 대소문자를 구분하므로 대소문자 변경이나 다른 서식 문자 삽입과 같은 방식으로 수정해서는 안 됩니다.
• verification_url
  • verification_url를 표시하는 공간은 길이가 40자인 URL 문자열을 처리할 만큼 충분히 넓어야 합니다.
  • 표시용 스키마를 선택적으로 삭제하는 경우를 제외하고 어떠한 방식으로도 verification_url를 수정해서는 안 됩니다. 표시상의 이유로 URL에서 스키마(예: https://)를 삭제하려는 경우 앱이 http 및 https 변형을 모두 처리할 수 있는지 확인합니다.

4단계: Google의 승인 서버 폴링

사용자가 별도의 기기를 사용하여 verification_url로 이동하고 액세스를 승인하거나 거부하므로 사용자가 액세스 요청에 응답해도 요청 기기에 자동으로 알림이 전송되지 않습니다. 따라서 요청하는 기기는 Google의 승인 서버를 폴링하여 사용자가 요청에 응답한 시점을 확인해야 합니다.

요청하는 기기는 사용자가 액세스 요청에 응답했음을 나타내는 응답을 수신할 때까지 또는 2단계에서 가져온 device_code 및 user_code가 만료될 때까지 폴링 요청을 계속 전송해야 합니다. 2단계에서 반환된 interval는 요청 간에 대기할 시간(초)을 지정합니다.

폴링할 엔드포인트의 URL은 https://oauth2.googleapis.com/token입니다. 폴링 요청에는 다음 매개변수가 포함됩니다.

예

다음 스니펫은 샘플 요청을 보여줍니다.

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=client_id&
client_secret=client_secret&
device_code=device_code&
grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code

다음 예는 동일한 요청을 전송하는 curl 명령어를 보여줍니다.

curl -d "client_id=client_id&client_secret=client_secret& \
         device_code=device_code& \
         grant_type=urn%3Aietf%3Aparams%3Aoauth%3Agrant-type%3Adevice_code" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         https://oauth2.googleapis.com/token

5단계: 사용자가 액세스 요청에 응답함

다음 이미지는 사용자가 3단계에서 표시한 verification_url로 이동할 때 표시되는 페이지와 유사한 페이지를 보여줍니다.

user_code를 입력하고 ����� 로그인하지 않��� 경우 Google에 로그인하면 아래와 같은 동의 화면이 표시됩니다.

6단계: 폴링 요청에 대한 응답 처리

Google의 승인 서버는 각 폴링 요청에 다음 응답 중 하나로 응답합니다.

액세스 권한이 부여됨

사용자가 동의 화면에서 Allow를 클릭하여 기기에 대한 액세스 권한을 부여한 경우 응답에 액세스 토큰과 갱신 토큰이 포함됩니다. 토큰을 사용하면 기기가 사용자를 대신하여 Google API에 액세스할 수 있습니다. 응답의 scope 속성은 기기가 액세스할 수 있는 API를 결정합니다.

이 경우 API 응답에는 다음 필드가 포함됩니다.

다음 스니펫은 샘플 응답을 보여줍니다.

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "openid https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email",
  "token_type": "Bearer",
  "refresh_token": "1/xEoDL4iW3cxlI7yDbSRFYNG01kVKM2C-259HOF2aQbI"
}

액세스 토큰의 수명은 제한적입니다. 애플리케이션이 장시간 동안 API에 액세스해야 하는 경우 갱신 토큰을 사용하여 새 액세스 토큰을 가져올 수 있습니다. 애플리케이션에 이러한 유형의 액세스가 필요한 경우 나중에 사용할 수 있도록 갱신 토큰을 저장해야 합니다.

액세스가 거부됨

사용자가 기기에 대한 액세스 권한 부여를 거부하면 서버 응답에 403 HTTP 응답 상태 코드 (Forbidden)가 포함됩니다. 응답에는 다음 오류가 포함됩니다.

{
  "error": "access_denied",
  "error_description": "Forbidden"
}

승인 대기 중

사용자가 아직 승인 흐름을 완료하지 않은 경우 서버는 428 HTTP 응답 상태 코드 (Precondition Required)를 반환합니다. 응답에는 다음 오류가 포함됩니다.

{
  "error": "authorization_pending",
  "error_description": "Precondition Required"
}

폴링이 너무 빈번함

기기가 폴링 요청을 너무 자주 전송하면 서버는 403 HTTP 응답 상태 코드 (Forbidden)를 반환합니다. 응답에는 다음 오류가 포함됩니다.

{
  "error": "slow_down",
  "error_description": "Forbidden"
}

기타 오류

또한 폴링 요청에 필수 매개변수가 누락되었거나 매개변수 값이 잘못된 경우 승인 서버에서 오류를 반환합니다. 이러한 요청에는 일반적으로 400(Bad Request) 또는 401 (Unauthorized) HTTP 응답 상태 코드가 있습니다. 이러한 오류는 다음과 같습니다.

Google API 호출

애플리케이션이 액세스 토큰을 획득한 후 API에 필요한 액세스 범위가 부여된 경우 이 토큰을 사용하여 지정된 사용자 계정을 대신하여 Google API를 호출할 수 있습니다. 이렇게 하려면 access_token 쿼리 매개변수 또는 Authorization HTTP 헤더 Bearer 값을 포함하여 API 요청에 액세스 토큰을 포함합니다. 가능하면 HTTP 헤더를 사용하는 것이 좋습니다. 쿼리 문자열은 서버 로그에 표시되는 경향이 있기 때문입니다. 대부분의 경우 클라이언트 라이브러리를 사용하여 Google API 호출을 설정할 수 있습니다 (예: Drive Files API를 호출하는 경우).

OAuth 2.0 플레이그라운드에서 모든 Google API를 사용해 보고 범위를 확인할 수 있습니다.

HTTP GET 예시

Authorization: Bearer HTTP 헤더를 사용하여 drive.files 엔드포인트 (Drive Files API)를 호출하는 경우 다음과 같이 표시될 수 있습니다. 자체 액세스 토큰을 지정해야 합니다.

GET /drive/v2/files HTTP/1.1
Host: www.googleapis.com
Authorization: Bearer access_token

다음은 access_token 쿼리 문자열 매개변수를 사용하여 인증된 사용자의 동일한 API를 호출하는 예입니다.

GET https://www.googleapis.com/drive/v2/files?access_token=access_token

curl 예

curl 명령줄 애플리케이션을 사용하여 이러한 명령어를 테스트할 수 있습니다. 다음은 HTTP 헤더 옵션을 사용하는 예입니다 (권장).

curl -H "Authorization: Bearer access_token" https://www.googleapis.com/drive/v2/files

또는 쿼리 문자열 매개변수 옵션을 사용할 수 있습니다.

curl https://www.googleapis.com/drive/v2/files?access_token=access_token

액세스 토큰 갱신

액세스 토큰은 주기적으로 만료되어 관련 API 요청에 대한 잘못된 사용자 인증 정보가 됩니다. 토큰과 연결된 범위의 오프라인 액세스를 요청한 경우에는 사용자에게 권한을 요청하지 않고 액세스 토큰을 갱신할 수 있습니다 (사용자가 없는 경우 포함).

액세스 토큰을 새로고침하기 위해 애플리케이션은 다음 매개변수가 포함된 HTTPS POST 요청을 Google의 승인 서버 (https://oauth2.googleapis.com/token)로 전송합니다.

다음 스니펫은 샘플 요청을 보여줍니다.

POST /token HTTP/1.1
Host: oauth2.googleapis.com
Content-Type: application/x-www-form-urlencoded

client_id=your_client_id&
client_secret=your_client_secret&
refresh_token=refresh_token&
grant_type=refresh_token

사용자가 애플리케이션에 부여된 액세스 권한을 취소하지 않는 한 토큰 서버는 새 액세스 토큰이 포함된 JSON 객체를 반환합니다. 다음 스니펫은 샘플 응답을 보여줍니다.

{
  "access_token": "1/fFAGRNJru1FTz70BzhT3Zg",
  "expires_in": 3920,
  "scope": "https://www.googleapis.com/auth/drive.metadata.readonly https://www.googleapis.com/auth/calendar.readonly",
  "token_type": "Bearer"
}

발급되는 새로고침 토큰 수에는 제한이 있습니다. 클라이언트/사용자 조합당 한도와 모든 클라이언트에서 사용자당 한도가 각각 있습니다. 갱신 토큰은 장기 저장소에 저장하고 유효한 상태인 한 계속 사용해야 합니다. 애플리케이션에서 새로고침 토큰을 너무 많이 요청하��� 이러한 제한이 발생할 수 있으며, 이 경우 이전 새로고침 토큰이 작동을 멈춥니다.

토큰 취소

경우에 따라 사용자가 애플리케이션에 부여된 액세스 권한을 취소하려고 할 수 있습니다. 사용자는 계정 설정으로 이동하여 액세스 권한을 취소할 수 있습니다. 자세한 내용은 내 계정에 액세스할 수 있는 서드 파티 사이트 및 앱의 사이트 또는 앱 액세스 권한 삭제 섹션 지원 문서를 참고하세요.

애플리케이션이 프로그래매틱 방식으로 부여된 액세스 권한을 취소할 수도 있습니다. 프로그래매틱 취소는 사용자가 구독을 취소하거나 애플리케이션을 삭제하거나 앱에 필요한 API 리소스가 크게 변경된 경우에 중요합니다. 즉, 삭제 프로세스의 일부에는 이전에 애플리케이션에 부여된 권한이 삭제되도록 하는 API 요청이 포함될 수 있습니다.

토큰을 프로그래매틱 방식으로 취소하려면 애플리케이션에서 https://oauth2.googleapis.com/revoke에 요청을 보내고 토큰을 매개변수로 포함합니다.

curl -d -X -POST --header "Content-type:application/x-www-form-urlencoded" \
        https://oauth2.googleapis.com/revoke?token={token}

토큰은 액세스 토큰 또는 갱신 토큰일 수 있습니다. 토큰이 액세스 토큰이고 상응하는 갱신 토큰이 있는 경우 갱신 토큰도 취소됩니다.

취소가 성공적으로 처리되면 응답의 HTTP 상태 코드는 200입니다. 오류 상태의 경우 HTTP 상태 코드 400가 오류 코드와 함께 반환됩니다.

허용되는 범위

기기의 OAuth 2.0 흐름은 다음 범위에서만 지원됩니다.