使用 Python 指令碼呼叫 Data Portability API

在這個快速入門導覽課程中，您會取得帳戶的 OAuth 憑證，並使用 Python 指令碼將要求傳送至 Data Portability API 端點。

涵蓋內容

在本快速入門導覽課程中，您將使用 Python 指令碼執行以下作業：

• 提供有效的 OAuth 權杖，將通過驗證的要求傳送至 InitiatePortabilityArchive 端點。回應是有效的 job_id。
• 將通過驗證的要求傳送至 GetPortabilityArchiveState 端點，並下載資料。回應應包含有效的工作狀態；工作完成後，也會附上已簽署的網址。
• 將通過驗證的要求傳送至 ResetAuthorization 端點。這項要求會撤銷所有由使用者授予的 OAuth 範圍。

必要條件

如要執行本快速入門導覽課程，您必須：

• 確認您可以使用 Data Portability API。如需支援的國家/地區清單，請參閱「與第三方分享資料副本」頁面的常見問題。
• 完成 Data Portability API 的設定步驟，並確認您已使用新專案。
• 取得貴機構所擁有或控管帳戶的存取權。 這個帳戶的搜尋活動資料已在這個快速入門導覽課程中匯出。

在開始本快速入門導覽課程之前，您還必須為 Python 用戶端程式庫設定 OAuth、Python 和 OAuth 套件。

設定 OAuth

• 按照步驟為已安裝的應用程式設定 OAuth。這個流程與網路伺服器應用程式的 OAuth 流程類似。設定 OAuth 用戶端 ID 時：
  • 「應用程式類型」應為「電腦版應用程式」。
  • 建立用戶端 ID 後，請以 JSON 格式下載用戶端密鑰，並將檔案命名為 client_secrets.json。
  • 為 Data Portability API 設定範圍時，本快速入門導覽課程會使用下列資源群組：
    • myactivity.search：https://www.googleapis.com/auth/dataportability.myactivity.search
    • myactivity.youtube：https://www.googleapis.com/auth/dataportability.myactivity.youtube

設定 Python

您必須在本機電腦上設定 Python，才能執行本快速入門導覽課程中使用的指令碼。如何設定 Python：

• 安裝 Pip 套件管理工具和 Python 3.9 (或更高版本)。
• 安裝適用於 Python 的 Google API 用戶端程式庫。

• 執行下列指令，安裝 Python 用戶端程式庫的 google_auth_oauthlib 套件。這個套件提供 oauthlib 與 google-auth (Python 的 Google 驗證程式庫)。

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

執行指令碼

這個指令碼會在 OAuth 流程中使用 localhost 重新導向。使用這個選項時，應用程式必須監聽 localhost 通訊埠，然後開啟系統瀏覽器來啟動 OAuth 授權流程。

按一下這個連結即可開啟指令碼，或在連結上按一下滑鼠右鍵，下載指令碼的副本。

Data Portability API Python 快速入門導覽課程指令碼

如要執行指令碼，請輸入下列指令：

python3 data-portability-quickstart.py

如要進一步瞭解指令碼採取的動作，請參閱註解。