此页面由 Cloud Translation API 翻译。

开始使用

我们建议将客户端库与 Apache Maven（或 Gradle）搭配使用。

创建新的 Maven/Gradle 项目

在您选择的 IDE 中创建新的 Maven/Gradle 项目。我们的工件发布到 Maven Central 代码库。

Maven 依赖项为：

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads</artifactId>
  <version>33.0.0</version>
</dependency>

Gradle 依赖项为：

implementation 'com.google.api-ads:google-ads:33.0.0'

您也可以从源代码构建。为了本指南假设您已设置具有所需依赖项的项目可用。

获取凭据以进行 API 身份验证

访问 Google Ads API 需要 OAuth 凭据和 Google Ads API 开发者令牌。本部分将介绍它们的含义、使用方法和。

开发者令牌（用于访问 API）

开发者令牌与管理员相关联账号，可在 Google Ads 网页界面中找到。

虽然开发者令牌与经理账号相关联，但它并不会访问该账号。相反，开发者令牌会授予而账号级访问权限则通过 OAuth 进行配置。

OAuth 凭据（用于访问 Google Ads 账号）

若要授权给 Google 账号用户，使其有权访问 Google Ads 账号，您必须提供一组 OAuth 凭据。

常用的 OAuth 流程有两种：桌面（安装版）应用或 Web 应用两者的主要区别在于，桌面应用请打开系统浏览器并提供一个本地重定向 URI，用于处理来自 Google 的授权服务器，而 Web 应用可以重定向任意第三方浏览器来完成授权并将凭据发送回您的服务器。该库还支持不常用的服务账号。

如果您使用自己的凭据进行授权（桌面应用流程）: 请参阅 OAuth 桌面应用数据流。其中包括需要使用您自己的凭据进行授权。
如果您以第三方 Google 用户的身份进行授权（网站流程）: 请参阅 OAuth Web 应用流程。这个举例说明如何为任意第三方设置 OAuth 授权用户。
如果您授权为 Google Apps 网域用户（服务账号流程）: 请参阅 OAuth 服务账号数据流。这个示例展示了如何为 Google Apps 域用户设置 OAuth 授权。

如果您通过 Google Ads 经理账号访问 Google Ads 客户账号则您还必须指定登录客户 ID（如下所述）。

登录客户 ID（用于通过经理账号访问 Google Ads 账号）

（可选）指定有权访问以下内容的经理账号的客户 ID：与广告投放账号有关如果您要访问该客户，则必须指定此字段。是通过经理账号建立的无需指定所有经理客户 ID 所对应的路径中，只能是您在创建客户 ID 时指定的您用来获取访问权限的信息有关详情，请参阅文档。

使用您的凭据配置客户端库

您可以使用配置文件来配置客户端库环境变量或以编程方式在本指南中，我们将使用配置文件方法，重点关注桌面流程和 Web 流程。使用如果您只拥有一组凭据（例如，您在一个经理账号下管理账号）。

创建一个包含以下内容的 ~/ads.properties 文件。

api.googleads.clientId=INSERT_CLIENT_ID_HERE
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

将占位符替换为您在上一步中获得的凭据。

此外，如果您的刷新令牌是针对经理账号的，您应该将此账号的客户 ID 指定为登录客户：

api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

验证凭据

为确保所有设置正确无误，我们将在运行 GetCampaigns 示例。

首先，导航到 google-ads-examples 目录。

$ cd google-ads-examples

此示例需要使用 --customerId 形参，其值为您的 Google Ads 账号客户 ID（不带短划线）。

如需使用 Gradle 运行，请执行以下操作：

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --customerId INSERT_CUSTOMER_ID_HERE"

浏览其他示例

google-ads-examples 中的 examples 软件包包含几个实用示例。大多数示例都需要参数。您可以将形参作为实参（推荐）传递，也可以修改源代码中的 INSERT_XXXXX_HERE 值。查看使用情况声明例如，请将 --help 作为唯一的参数传递。

使用 Gradle：

$ ./gradlew -q runExample --example="basicoperations.GetCampaigns --help"

您还可以在 Gradle 中使用 listExamples 任务列出所有示例，子目录中的示例，或说明中包含搜索条目的示例条款。

# List all examples:
$ ./gradlew -q listExamples
# List examples in the 'basicoperations' subdirectory:
$ ./gradlew -q listExamples --subdirectory='basicoperations'
# Search for examples where the description includes 'Performance Max':
$ ./gradlew -q listExamples --searchTerm='Performance Max'