使用 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。此流程类似于 Web 服务器应用的 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 端口，然后打开系统浏览器以启动 OAuth 授权流程。

点击此链接打开脚本，或者右键点击链接下载脚本副本。

Data Portability API Python 快速入门脚本

如需运行该脚本，请输入以下命令：

python3 data-portability-quickstart.py

脚本所执行的操作会在注释中详细说明。