Python 快速入門導覽課程

快速入門導覽課程說明如何設定並執行應用程式，呼叫 Google Workspace API。

Google Workspace 快速入門導覽課程會使用 API 用戶端程式庫來處理部分驗證和授權流程。建議您針對應用程式的應用程式採用用戶端程式庫。本快速入門導覽課程會使用適用於測試環境的簡化驗證方法。針對實際工作環境，建議您先瞭解驗證與授權，再選擇適合應用程式的存取憑證。

建立 Python 指令列應用程式，向 Google Drive API 傳送要求。

目標

  • 設定環境。
  • 安裝用戶端程式庫。
  • 設定範例。
  • 執行範例。

必要條件

如要執行本快速入門導覽課程，您必須具備下列先決條件：

  • 擁有已啟用 Google 雲端硬碟的 Google 帳戶。

設定環境

如要完成這個快速入門導覽課程，請設定環境。

啟用 API

您必須先在 Google Cloud 專案中啟用 API，才能使用 Google API。 您可以在單一 Google Cloud 專案中啟用一或多個 API。

  • 在 Google Cloud 控制台中啟用 Google Drive API。

    啟用 API

為桌面應用程式授權

如要以使用者的身分進行驗證，以及存取應用程式中的使用者資料，您必須建立一或多個 OAuth 2.0 用戶端 ID。用戶端 ID 是用來識別 Google 的 OAuth 伺服器的單一應用程式。如果您的應用程式在多個平台上執行，就必須為每個平台建立個別的用戶端 ID。
  1. 在 Google Cloud 控制台中，依序點選「選單」圖示 >「API 和服務」>「憑證」。

    前往「憑證」

  2. 依序按一下「建立憑證」>「OAuth 用戶端 ID」。
  3. 依序按一下「應用程式類型」>「電腦版應用程式」。
  4. 在「Name」(名稱) 欄位中，輸入憑證名稱。這個名稱只會在 Google Cloud 控制台中顯示。
  5. 按一下「建立」，畫面上會出現 OAuth 用戶端建立畫面，並顯示新的用戶端 ID 和用戶端密鑰。
  6. 按一下「OK」。新建立的憑證會顯示在「OAuth 2.0 Client ID」下方。
  7. 將下載的 JSON 檔案儲存為 credentials.json，然後將檔案移至工作目錄。

安裝 Google 用戶端程式庫

  • 安裝 Python 適用的 Google 用戶端程式庫：

    pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

設定範例

  1. 在工作目錄中，建立名為 quickstart.py 的檔案。

  2. 在 quickstart.py 中加入下列程式碼：

    drive/quickstart/quickstart.py
    from __future__ import print_function

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# If modifying these scopes, delete the file token.json.
SCOPES = ['https://www.googleapis.com/auth/drive.metadata.readonly']


def main():
    """Shows basic usage of the Drive v3 API.
    Prints the names and ids of the first 10 files the user has access to.
    """
    creds = None
    # The file token.json stores the user's access and refresh tokens, and is
    # created automatically when the authorization flow completes for the first
    # time.
    if os.path.exists('token.json'):
        creds = Credentials.from_authorized_user_file('token.json', SCOPES)
    # If there are no (valid) credentials available, let the user log in.
    if not creds or not creds.valid:
        if creds and creds.expired and creds.refresh_token:
            creds.refresh(Request())
        else:
            flow = InstalledAppFlow.from_client_secrets_file(
                'credentials.json', SCOPES)
            creds = flow.run_local_server(port=0)
        # Save the credentials for the next run
        with open('token.json', 'w') as token:
            token.write(creds.to_json())

    try:
        service = build('drive', 'v3', credentials=creds)

        # Call the Drive v3 API
        results = service.files().list(
            pageSize=10, fields="nextPageToken, files(id, name)").execute()
        items = results.get('files', [])

        if not items:
            print('No files found.')
            return
        print('Files:')
        for item in items:
            print(u'{0} ({1})'.format(item['name'], item['id']))
    except HttpError as error:
        # TODO(developer) - Handle errors from drive API.
        print(f'An error occurred: {error}')


if __name__ == '__main__':
    main()

執行範例

  1. 在工作目錄中，建構並執行範例：

    python3 quickstart.py

  2. 首次執行範例時，系統會提示您授權存取：

    1. 如果您尚未登入 Google 帳戶，系統會提示您登入。如果您同時登入多個帳戶，請選取一個要用於授權的帳戶。
    2. 然後點選 [Accept]。

    授權資訊儲存在檔案系統中，因此當您下次執行程式碼範例時，系統不會提示您授權。

您已成功建立第一個 Python 應用程式，向 Google Drive API 傳送要求。

後續步驟