mcpField
D
data-manager-api-setup

data-manager-api-setup

github.com/google开发21.6k6.4k 次安装今天更新
代码仓库

关于 data-manager-api-setup

用于配置和使用 Data Manager API 的指南，说明如何启用 API、配置用户或服务账号 ADC、验证凭据并排查访问问题，以及安装各语言客户端和用户标识符处理工具库。

主要功能

  1. 01启用 Data Manager API
  2. 02配置用户或服务账号 ADC
  3. 03验证凭据并排查访问问题
  4. 04安装各语言客户端库
  5. 05格式化并保护用户标识符

适用场景

  1. 01为 API 访问准备 Google Cloud 项目
  2. 02配置本地开发者身份验证
  3. 03安装用于标识符导入的库

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/google/skills --skill data-manager-api-setup

安装后在 Claude Code 中输入/data-manager-api-setup确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
dotnet.md
java.md
node.md
partner-links.md
php.md
python.md

详细介绍

Data Manager API 设置

设置身份验证

请参阅设置 API 访问权限 了解详情。

1. 启用 API

前提条件：Google Cloud 项目、Google Cloud CLI（gcloud），以及拥有可启用 API 的项目角色的 Google 帐户，例如 Owner、 Editor 或 Service Usage Admin。务必告知用户所需的角色。如果尚未安装 gcloud，请先提示用户安装。

gcloud services enable datamanager.googleapis.com --project={project_id}
gcloud services list --enabled --project=PROJECT_ID --filter="datamanager.googleapis.com"
2. 生成应用默认凭据（ADC）

根据用户的场景选择相应的方法：

  • 用户帐户（以用户自己的 Google 帐户身份发出 API 调用）：Data Manager API 作用域属于敏感信息，因此用户必须先配置其项目的 Google Auth Platform：

    1. Data Access 页面：添加 Data Manager API 作用域。

    2. Audience 页面：将 Publishing status 设为 Testing。对于 Google Workspace 组织，使用 Internal 用户类型；否则使用 External，并将用户的帐户添加为 Test user。

    3. 创建（或重复使用）Desktop app OAuth 客户端，并下载其 JSON 配置文件。

    4. 用户运行以下命令，此命令会打开浏览器登录：

      gcloud auth application-default login \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
  --client-id-file="{client_id_file_path}"

    未验证应用屏幕：由于 Data Manager API 作用域属于敏感信息，因此会显示此警告。在 Testing 阶段，External 测试用户仍会看到此警告，但可以继续操作。其他用户登录前，应用必须完成 OAuth 应用验证。 服务帐号无需验证。

  • 服务帐号（以应用身份而非个人身份发出 API 调用）：对于本地开发，请使用服务帐号模拟，而不要使用服务帐号密钥，因为如果管理不当，密钥会带来安全风险。

    • 为项目上的服务帐号授予 Service Usage Consumer IAM 角色 （roles/serviceusage.serviceUsageConsumer）。

    • 为运行 gcloud 的用户授予该服务帐号的 Token Creator 角色 （roles/iam.serviceAccountTokenCreator）。

    • 运行：

      gcloud auth application-default login \
  --impersonate-service-account={service_account_email} \
  --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform"

  • 在广告主帐户中创建合作伙伴关联的数据合作伙伴：请阅读 Partner Links。

多个 API：若要将相同凭据用于其他 API，请将相应作用域追加到上述命令的 --scopes 列表中（例如，Google Ads API 使用 https://www.googleapis.com/auth/adwords，Display & Video 360 API 使用 https://www.googleapis.com/auth/display-video）。

验证：如果凭据配置正确，运行 gcloud auth application-default print-access-token 会打印访问令牌。

有效令牌仍出现 PERMISSION_DENIED 时的故障排除：将用户或服务帐号添加到目标帐户（例如 Google Ads 帐户或其经理帐户）。对于服务帐号，还要确认其在 Cloud 项目中拥有 Service Usage Consumer 角色。

生产环境：有关生产环境身份验证（Google Cloud 内部或外部的工作负载、代表其他用户行事的应用，或合作伙伴关联），请参阅 部署到生产环境。

安装客户端和实用工具库

请参阅安装客户端库 了解详情。

配套的实用工具库提供预构建的辅助类 和函数，可在将用户标识符（例如电子邮件、电话号码和实际地址）导入 API 前，对其进行正确的格式化、哈希处理和加密。强烈建议使用这些库，以确保用户标识符的格式符合 API 规范。

请选择以下对应语言的安装指南：

  • Python 设置参考（软件包：google-ads-datamanager 和 google-ads-datamanager-util）
  • Java 设置参考（软件包：com.google.api-ads:data-manager 和 com.google.api-ads:data-manager-util）
  • Node 设置参考（软件包：@google-ads/datamanager 和 @google-ads/datamanager-util）
  • PHP 设置参考（软件包：googleads/data-manager 和 googleads/data-manager-util）
  • .NET 设置参考（软件包：Google.Ads.DataManager.V1 和 Google.Ads.DataManager.Util）

评论

支持 Markdown