Python スクリプトを使用して Data Portability API を呼び出す

このクイックスタートでは、アカウントの OAuth トークンを取得し、Python スクリプトを使用して Data Portability API エンドポイントにリクエストを送信します。

学習内容

このクイックスタートでは、Python スクリプトを使用して次の作業を行います。

  • 有効な OAuth トークンを指定して、認証済みリクエストを InitiatePortabilityArchive エンドポイントに送信します。レスポンスは有効な job_id である。
  • 認証されたリクエストを GetPortabilityArchiveState エンドポイントに送信し、データをダウンロードします。レスポンスには有効なジョブの状態が含まれ、ジョブが完了すると署名付き URL が含まれます。
  • 認証済みのリクエストを ResetAuthorization エンドポイントに送信します。このリクエストにより、ユーザーが指定したすべての OAuth スコープが取り消されます。

前提条件

このクイックスタートを実行するには、次の手順が必要です。

  • Data Portability API が利用できることを確認します。サポートされている国と地域のリストについては、「データのコピーをサードパーティと共有する」ページのよくある質問をご覧ください。
  • Data Portability API の設定手順を完了し、新しいプロジェクトを使用していることを確認します。
  • 組織が所有または管理しているアカウントへのアクセス権を取得します。このクイックスタートでは、このアカウントの検索アクティビティ データがエクスポートされます。

このクイックスタートを始める前に、OAuth、Python、Python クライアント ライブラリ用の OAuth パッケージも設定する必要があります。

OAuth を設定する

  • 手順に沿って、インストール済みのアプリケーション用に OAuth を構成します。このフローは、ウェブサーバー アプリケーションの OAuth フローに似ています。OAuth クライアント ID を構成する場合:
    • [アプリケーションの種類] は [デスクトップ アプリ] にします。
    • クライアント ID を作成したら、クライアント シークレットを JSON 形式でダウンロードし、ファイルに client_secrets.json という名前を付けます。
    • Data Portability API のスコープを構成する場合、このクイックスタートでは次のリソース グループを使用します。

Python をセットアップする

このクイックスタートで使用するスクリプトを実行するには、ローカルマシンに Python を設定する必要があります。Python を設定するには:

  • Pip パッケージ管理ツールと Python 3.9（またはそれ以降）をインストールします。
  • Python 用 Google API クライアント ライブラリをインストールします。

  • 次のコマンドを実行して、Python クライアント ライブラリの google_auth_oauthlib パッケージをインストールします。このパッケージは、Python 用の Google 認証ライブラリである google-auth との oauthlib の統合を提供します。

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

スクリプトを実行する

このスクリプトは、OAuth フローで localhost リダイレクトを使用します。このオプションでは、アプリケーションが localhost ポートでリッスンし、システム ブラウザを開いて OAuth 認証フローを開始する必要があります。

このリンクをクリックしてスクリプトを開くか、リンクを右クリックしてスクリプトのコピーをダウンロードします。

Data Portability API Python クイックスタート スクリプト

スクリプトを実行するには、次のコマンドを入力します。

python3 data-portability-quickstart.py

スクリプトが実行するアクションは、コメントに詳述されます。