このページは Cloud Translation API によって翻訳されました。

Python のクイックスタート

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。

Google Workspace のクイックスタートでは、API クライアントライブラリを使用して、認証と承認フローの詳細の一部を処理します。ご自身でアプリを開発する際には、このクライアントライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡素な認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と承認について学習することをおすすめします。

Google Drive Activity API にリクエストを送信する Python コマンドラインアプリケーションを作成します。

目標

環境をセットアップする。
クライアントライブラリをインストールする。
サンプルをセットアップします。
サンプルを実行します。

前提条件

このクイックスタートを実行するには、次の前提条件を満たしている必要があります。

Python 3.10.7 以降
pip パッケージ管理ツール
Google Cloud プロジェクト。

Google アカウント。

環境の設定

このクイックスタートを完了するには、環境を設定します。

API を有効にする

Google API を使用する前に、Google Cloud プロジェクトで API を有効にする必要があります。1 つの Google Cloud プロジェクトで 1 つ以上の API を有効にできます。

Google Cloud コンソールで、Google Drive Activity API を有効にします。

API の有効化

OAuth 同意画面を構成する

このクイックスタートを完了するために新しい Google Cloud プロジェクトを使用している場合は、OAuth 同意画面を構成し、自分自身をテストユーザーとして追加します。Cloud プロジェクトでこの手順をすでに完了している場合は、次のセクションに進みます。

Google Cloud コンソールで、メニュー > [API とサービス] > [OAuth 同意画面] に移動します。
OAuth 同意画面に移動
[ユーザーの種類] で [内部] を選択し、[作成] をクリックします。
アプリ登録フォームに入力し、[保存して続行] をクリックします。
ここではスコープの追加をスキップして、[保存して次へ] をクリックします。今後、Google Workspace 組織外で使用するアプリを作成する場合は、[ユーザータイプ] を [外部] に変更し、アプリに必要な認可スコープを追加する必要があります。
アプリ登録の概要を確認します。変更するには、[編集] をクリックします。アプリの登録に問題がなければ、[ダッシュボードに戻る] をクリックします。

デスクトップアプリケーションの認証情報を承認する

エンドユーザーを認証し、アプリ内のユーザーデータにアクセスするには、1 つ以上の OAuth 2.0 クライアント ID を作成する必要があります。クライアント ID は、Google の OAuth サーバーで個々のアプリを識別するために使用します。アプリが複数のプラットフォームで実行される場合は、プラットフォームごとに個別のクライアント ID を作成する必要があります。

Google Cloud コンソールで、メニュー > [API とサービス] > [認証情報] に移動します。
[認証情報] に移動
[認証情報を作成] > [OAuth クライアント ID] をクリックします。
[アプリケーションの種類] > [デスクトップアプリ] をクリックします。
[名前] フィールドに、認証情報の名前を入力します。この名前は Google Cloud コンソールにのみ表示されます。
[作成] をクリックします。[OAuth クライアントを作成しました] 画面が表示され、新しいクライアント ID とクライアントシークレットが表示されます。
[OK] をクリックします。新しく作成された認証情報が [OAuth 2.0 クライアント ID] の下に表示されます。
ダウンロードした JSON ファイルを credentials.json として保存し、ファイルを作業ディレクトリに移動します。

Google クライアントライブラリをインストールする

Python 用 Google クライアントライブラリをインストールします。

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

サンプルを構成する

作業ディレクトリに quickstart.py という名前のファイルを作成します。

quickstart.py に次のコードを追加します。

drive/activity-v2/quickstart.py

GitHub で表示

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.activity.readonly"]


def main():
  """Shows basic usage of the Drive Activity API.

  Prints information about the last 10 events that occured the user's Drive.
  """
  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())

  service = build("driveactivity", "v2", credentials=creds)

  # Call the Drive Activity API
  try:
    results = service.activity().query(body={"pageSize": 10}).execute()
    activities = results.get("activities", [])

    if not activities:
      print("No activity.")
    else:
      print("Recent activity:")
      for activity in activities:
        time = getTimeInfo(activity)
        action = getActionInfo(activity["primaryActionDetail"])
        actors = map(getActorInfo, activity["actors"])
        targets = map(getTargetInfo, activity["targets"])
        actors_str, targets_str = "", ""
        actor_name = actors_str.join(actors)
        target_name = targets_str.join(targets)

        # Print the action occurred on drive with actor, target item and timestamp
        print(f"{time}: {action}, {actor_name}, {target_name}")

  except HttpError as error:
    # TODO(developer) - Handleerrors from drive activity API.
    print(f"An error occurred: {error}")


# Returns the name of a set property in an object, or else "unknown".
def getOneOf(obj):
  for key in obj:
    return key
  return "unknown"


# Returns a time associated with an activity.
def getTimeInfo(activity):
  if "timestamp" in activity:
    return activity["timestamp"]
  if "timeRange" in activity:
    return activity["timeRange"]["endTime"]
  return "unknown"


# Returns the type of action.
def getActionInfo(actionDetail):
  return getOneOf(actionDetail)


# Returns user information, or the type of user if not a known user.
def getUserInfo(user):
  if "knownUser" in user:
    knownUser = user["knownUser"]
    isMe = knownUser.get("isCurrentUser", False)
    return "people/me" if isMe else knownUser["personName"]
  return getOneOf(user)


# Returns actor information, or the type of actor if not a user.
def getActorInfo(actor):
  if "user" in actor:
    return getUserInfo(actor["user"])
  return getOneOf(actor)


# Returns the type of a target and an associated title.
def getTargetInfo(target):
  if "driveItem" in target:
    title = target["driveItem"].get("title", "unknown")
    return f'driveItem:"{title}"'
  if "drive" in target:
    title = target["drive"].get("title", "unknown")
    return f'drive:"{title}"'
  if "fileComment" in target:
    parent = target["fileComment"].get("parent", {})
    title = parent.get("title", "unknown")
    return f'fileComment:"{title}"'
  return f"{getOneOf(target)}:unknown"


if __name__ == "__main__":
  main()

サンプルの実行

作業ディレクトリで、サンプルをビルドして実行します。
```
python3 quickstart.py
```

サンプルを初めて実行すると、アクセスを承認するよう求められます。
1. Google アカウントにログインしていない場合は、プロンプトが表示されたらログインします。複数のアカウントにログインしている場合は、承認に使用するアカウントを 1 つ選択します。
2. [Accept] をクリックします。
Python アプリケーションが実行され、Google Drive Activity API が呼び出されます。

認証情報はファイルシステムに保存されるため、次回サンプルコードを実行するときに認証を求められることはありません。