Google Picker API

Google 선택 도구 대화상자

Google 선택 도구는 Google Drive에 저장된 정보의 '파일 열기' 대화상자입니다. Google 선택 도구에는 다음과 같은 기능이 있습니다.

  • Google Drive UI와 유사한 디자인
  • Drive 파일의 미리보기 및 썸네일 이미지가 표시된 여러 뷰
  • 사용자가 기본 애플리케이션에서 나가지 않는 인라인 모달 창

Google Picker API는 웹 앱에서 사용자가 Drive 파일을 열거나 업로드할 수 있도록 하는 자바스크립트 API입니다.

애플리케이션 요구사항

Google 선택 도구를 사용하는 애플리케이션은 기존의 모든 서비스 약관을 준수해야 합니다. 무엇보다도 요청에서 본인을 올바르게 식별해야 합니다.

Google Cloud 프로젝트도 있어야 합니다.

환경 설정

Google Picker API를 사용하려면 환경을 설정해야 합니다.

API 사용 설정

Google API를 사용하기 전에 Google Cloud 프로젝트에서 사용 설정해야 합니다. 단일 Google Cloud 프로젝트에서 하나 이상의 API를 사용 설정할 수 있습니다.

  • Google Cloud 콘솔에서 Google Picker API를 사용 설정합니다.

    API 사용 설정

API 키 만들기

API 키는 대문자, 소문자, 숫자, 밑줄, 하이픈(예: AIzaSyDaGmWKa4JsXZ-HjGw7ISLn_3namBGewQe)을 포함하는 긴 문자열입니다. 이 인증 방법은 '이 링크가 있는 인터넷의 모든 사용자' 공유 설정을 사용하여 공유된 Google Workspace 파일과 같이 공개적으로 사용 가능한 데이터에 익명으로 액세스하는 데 사용됩니다. 자세한 내용은 API 키를 사용하여 인증을 참고하세요.

API 키를 만들려면 다음 단계를 따르세요.

  1. Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.

    사용자 인증 정보로 이동

  2. 사용자 인증 정보 만들기 > API 키를 클릭합니다.
  3. 새 API 키가 표시됩니다.
    • 복사를 클릭하여 앱 코드에서 사용할 API 키를 복사합니다. API 사용자 인증 정보는 '프로젝트 사용자 인증 정보의 'API 키' 섹션에서도 확인할 수 있습니다.
    • 키 제한을 클릭하여 고급 설정을 업데이트하고 API 키 사용을 제한합니다. 자세한 내용은 API 키 제한사항 적용을 참고하세요.

웹 애플리케이션의 사용자 인증 정보 승인

최종 사용자로 인증하고 앱의 사용자 데이터에 액세스하려면 OAuth 2.0 클라이언트 ID를 하나 이상 만들어야 합니다. 클라이언트 ID는 Google의 OAuth 서버에서 단일 앱을 식별하는 데 사용됩니다. 앱이 여러 플랫폼에서 실행되는 경우 플랫폼마다 별도의 클라이언트 ID를 만들어야 합니다.

  1. Google Cloud 콘솔에서 메뉴 > API 및 서비스 > 사용자 인증 정보로 이동합니다.

    사용자 인증 정보로 이동

  2. 사용자 인증 정보 만들기 > OAuth 클라이언트 ID를 클릭합니다.
  3. 애플리케이션 유형 > 웹 애플리케이션을 클릭합니다.
  4. 이름 필드에 사용자 인증 정보의 이름을 입력합니다. 이 이름은 Google Cloud Console에만 표시됩니다.
  5. 앱과 관련된 승인된 URI를 추가합니다.
    • 클라이언트 측 앱 (자바스크립트): 승인된 자바스크립트 원본에서 URI 추가를 클릭합니다. 그런 다음 브라우저 요청에 사용할 URI를 입력합니다. 애플리케이션에서 OAuth 2.0 서버로 API 요청을 보낼 수 있는 도메인을 식별합니다.
    • 서버 측 앱 (자바, Python 등): 승인된 리디렉션 URI에서 URI 추가를 클릭합니다. 그런 다음 OAuth 2.0 서버가 응답을 보낼 수 있는 엔드포인트 URI를 입력합니다.
  6. 만들기를 클릭합니다. OAuth 클라이언트 생성 화면이 열리고 새 클라이언트 ID와 클라이언트 보안 비밀번호가 표시됩니다.

    클라이언트 ID를 기록해 둡니다. 클라이언트 비밀번호는 웹 애플리케이션에 사용되지 않습니다.

  7. OK를 클릭합니다. 새로 생성된 사용자 인증 정보가 OAuth 2.0 클라이언트 ID 아래에 표시됩니다.
  8. 선택사항: 자바스크립트 빠른 시작의 기본 요건으로 사용자 인증 정보를 만드는 경우 API 키도 생성해야 합니다.
중요: Picker 객체를 만들 때 애플리케이션에서는 비공개 사용자 데이터에 액세스하는 뷰가 포함된 OAuth 2.0 액세스 토큰을 전송해야 합니다. 액세스 토큰을 요청하려면 OAuth 2.0을 사용하여 Google API에 액세스하기를 참고하세요.

Google 선택 도구 표시

이 가이드의 나머지 부분에서는 웹 앱에서 Google 선택 도구를 로드하고 표시하는 방법을 설명합니다. 전체 예를 보려면 Google 선택 도구 코드 샘플로 이동하세요.

Google 선택 도구 라이브러리 로드

Google 선택 도구 라이브러리를 로드하려면 로드에 성공한 후 호출할 라이브러리 이름과 콜백 함수를 사용하여 gapi.load()를 호출합니다.

    <script>
      let tokenClient;
      let accessToken = null;
      let pickerInited = false;
      let gisInited = false;

      // Use the API Loader script to load google.picker
      function onApiLoad() {
        gapi.load('picker', onPickerApiLoad);
      }

      function onPickerApiLoad() {
        pickerInited = true;
      }

      function gisLoaded() {
        // TODO(developer): Replace with your client ID and required scopes
        tokenClient = google.accounts.oauth2.initTokenClient({
          client_id: 'YOUR_CLIENT_ID',
          scope: 'YOUR_SCOPES',
          callback: '', // defined later
        });
        gisInited = true;
    }
    </script>
    <!-- Load the Google API Loader script. -->
    <script async defer src="https://apis.google.com/js/api.js" onload="onApiLoad()"></script>
    <script async defer src="https://accounts.google.com/gsi/client" onload="gisLoaded()"></script>
    

onApiLoad() 함수는 Google 선택 도구 라이브러리를 로드합니다. onPickerApiLoad() 콜백 함수는 Google 선택 도구 라이브러리가 성공적으로 로드된 후 호출됩니다.

Google 선택 도구 표시

createPicker() 함수는 Google Picker API 로드가 완료되고 OAuth 토큰이 만들어졌는지 확인합니다. 그런 다음 이 함수는 Google 선택 도구의 인스턴스를 만들고 표시합니다.

    // Create and render a Google Picker object for selecting from Drive
    function createPicker() {
      const showPicker = () => {
        // TODO(developer): Replace with your API key
        const picker = new google.picker.PickerBuilder()
            .addView(google.picker.ViewId.DOCS)
            .setOAuthToken(accessToken)
            .setDeveloperKey('YOUR_API_KEY')
            .setCallback(pickerCallback)
            .build();
        picker.setVisible(true);
      }

      // Request an access token
      tokenClient.callback = async (response) => {
        if (response.error !== undefined) {
          throw (response);
        }
        accessToken = response.access_token;
        showPicker();
      };

      if (accessToken === null) {
        // Prompt the user to select a Google Account and ask for consent to share their data
        // when establishing a new session.
        tokenClient.requestAccessToken({prompt: 'consent'});
      } else {
        // Skip display of account chooser and consent dialog for an existing session.
        tokenClient.requestAccessToken({prompt: ''});
      }
    }
    

Google 선택 도구 인스턴스를 만들려면 성공 시 호출할 View, oauthToken, developerKey, 콜백 함수(pickerCallback)를 제공해야 합니다.

Picker 객체는 한 번에 View를 렌더링합니다. ViewId(google.​picker.​ViewId.*) 또는 유형의 인스턴스를 만들어(google.​picker.​*View) 하나 이상의 뷰를 지정합니다. 뷰를 렌더링하는 방법을 추가로 제어하려면 유형별로 뷰를 지정하세요.

Google 선택 도구에 뷰가 2개 이상 추가된 경우 사용자는 왼쪽 탭을 클릭하여 한 뷰에서 다른 뷰로 전환합니다. 탭은 ViewGroup 객체를 사용하여 논리적으로 그룹화할 수 있습니다.

선택 도구 콜백 구현

선택 도구 콜백은 파일을 선택하거나 취소를 누르는 등 Google 선택 도구에서 사용자 상호작용에 반응하는 데 사용할 수 있습니다.

    // A simple callback implementation.
    function pickerCallback(data) {
      let url = 'nothing';
      if (data[google.picker.Response.ACTION] == google.picker.Action.PICKED) {
        let doc = data[google.picker.Response.DOCUMENTS][0];
        url = doc[google.picker.Document.URL];
      }
      let message = `You picked: ${url}`;
      document.getElementById('result').innerText = message;
    }
    

콜백은 JSON으로 인코딩된 data 객체를 수신합니다. 이 객체에는 사용자가 Google 선택 도구 (google.picker.Response.ACTION)를 사용하여 실행하는 모든 작업이 포함됩니다. 사용자가 항목을 선택하면 google.picker.Response.DOCUMENTS 배열도 채워집니다. 이 예에서는 google.picker.Document.URL가 기본 페이지에 표시되어 있습니다. 데이터 필드에 대한 자세한 내용은 JSON 참조 문서를 확인하세요.

특정 파일 형식 필터링

ViewGroup를 사용하여 특정 항목을 필터링합니다. 다음 예에서 'Google Drive' 하위 보기에는 문서 및 프레젠테이션만 표시됩니다.

    let picker = new google.picker.PickerBuilder()
        .addViewGroup(
          new google.picker.ViewGroup(google.picker.ViewId.DOCS)
              .addView(google.picker.ViewId.DOCUMENTS)
              .addView(google.picker.ViewId.PRESENTATIONS))
        .setOAuthToken(oauthToken)
        .setDeveloperKey(developerKey)
        .setCallback(pickerCallback)
        .build();
    

Google 선택 도구의 디자인 조정

PickerBuilder.enableFeature() 함수를 사용하여 Google 선택 도구 창의 모양을 미세 조정합니다. 예를 들어 뷰가 하나만 있는 경우 사용자에게 항목을 볼 수 있는 공간을 더 많이 제공하기 위해 탐색 창을 숨길 수 있습니다. 다음은 이 기능을 보여주는 스프레드시트 검색 선택 도구의 예입니다.

     let picker = new google.picker.PickerBuilder()
         .addView(google.picker.ViewId.SPREADSHEETS)
         .enableFeature(google.picker.Feature.NAV_HIDDEN)
         .setDeveloperKey(developerKey)
         .setCallback(pickerCallback)
         .build();
     

다른 언어로 Google 선택 도구 렌더링

setLocale(locale) 메서드를 사용하여 PickerBuilder 인스턴스에 언어를 제공하여 UI 언어를 지정합니다. 다음은 프랑스어의 예입니다.

    let picker = new google.picker.PickerBuilder()
        .addView(google.picker.ViewId.IMAGE_SEARCH)
        .setLocale('fr')
        .setDeveloperKey(developerKey)
        .setCallback(pickerCallback)
        .build();
    

다음은 현재 지원되는 언어 목록입니다.

af
am
ar
bg
bn
ca
cs
da
de
el
en
en-GB
es
es-419
et
eu
fa
fi
fil
fr
fr-CA
gl
gu
hi
hr
hu
id
is
it
iw
ja
kn
ko
lt
lv
ml
mr
ms
nl
no
pl
pt-BR
pt-PT
ro
ru
sk
sl
sr
sv
sw
ta
te
th
tr
uk
ur
vi
zh-CN
zh-HK
zh-TW
zu