基本用法

Java 客户端库的基本用法如下:

创建新的 Maven 或 Gradle 项目

在您选择的 IDE 中创建新的 Maven 或 Gradle 项目。我们的制品已发布到 Maven 中央代码库

我们建议使用 Google Ads API 的物料清单 (BOM) 来管理依赖项版本。

您也可以从源代码进行构建。在本指南中,我们假设您已设置项目,并且已添加所需的依赖项。

如果您是从源代码进行构建,请确保在 IDE 中启用注释处理。

配置 API 访问权限

如需连接到 Google Ads API,您需要提供身份验证和授权凭据。如需详细了解所需的凭据以及如何配置客户端库,请参阅身份验证和授权指南

发出首次调用

配置好凭据后,您就可以发出第一个 API 调用了。

为了验证您的凭据并进行首次调用,我们将运行 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'