開始使用

建議將用戶端程式庫與 Apache Maven (或 Gradle) 搭配使用。

建立新的 Maven/Gradle 專案

在您選擇的 IDE 中建立新的 Maven/Gradle 專案。我們的構件會發布至 Maven 中央存放區

Maven 依附元件如下:

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

Gradle 依附元件如下:

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

您也可以從原始碼開始建構。為符合本指南的目的,我們假設您在專案設定中提供了必要的依附元件。

取得憑證以使用 API 進行驗證

存取 Google Ads API 需要 OAuth 憑證和 Google Ads API 開發人員權杖。本節將說明這些資源、使用方式及如何取得說明。

開發人員權杖 (用於存取 API)

開發人員權杖與管理員帳戶連結,您可在 Google Ads 網頁介面中找到。

雖然開發人員權杖已連結至管理員帳戶,但無法提供該帳戶的存取權。反之,開發人員權杖一般會授予存取權給 API,而帳戶層級的存取權是透過 OAuth 進行設定。

OAuth 憑證 (存取 Google Ads 帳戶)

如要以具備 Google Ads 帳戶存取權的 Google 帳戶使用者進行授權,您必須提供一組 OAuth 憑證。

通常會使用兩種 OAuth 流程:電腦 (已安裝) 應用程式或網頁應用程式。兩者的主要差異在於,桌面應用程式必須開啟系統瀏覽器,並提供本機重新導向 URI,以處理來自 Google 授權伺服器的回應;而網頁應用程式則可重新導向任意第三方瀏覽器,完成授權並將憑證傳回至您的伺服器。這個程式庫也支援不常用的服務帳戶流程。

如果使用自己的憑證授權 (電腦版應用程式流程)
請參閱 OAuth 電腦版應用程式流程。其中包括以自己的憑證進行授權所需的所有詳細資料。
以第三方 Google 使用者 (網站流程) 的身分授權
請參閱 OAuth 網頁應用程式流程。以下範例會說明如何為任意第三方使用者設定 OAuth 授權。
如果您以 Google Apps 網域使用者 (服務帳戶流程) 的身分授權
請參閱 OAuth 服務帳戶流程。以下範例說明如何為 Google Apps 網域使用者設定 OAuth 授權。

如要透過 Google Ads 管理員帳戶存取 Google Ads 客戶帳戶,您必須一併指定登入客戶 ID,詳情請見下方說明。

登入客戶 ID (可透過管理員帳戶存取 Google Ads 帳戶)

視需要指定可授予放送帳戶存取權的管理員帳戶的客戶 ID。如果您透過管理員帳戶存取客戶帳戶,則必須指定此欄位。您無需在客戶 ID 路徑上指定所有管理員帳戶,只需列出您取得存取權限時所使用的最上層管理員 ID。詳情請參閱相關說明文件

使用您的憑證設定用戶端程式庫

您可以使用設定檔、環境變數,或透過程式來設定用戶端程式庫。在本指南中,我們將使用設定檔方法,並著重於電腦版和網頁流程。如果您只有一組憑證 (例如在單一管理工具下管理帳戶),使用設定檔通常是不錯的做法。

建立含有以下內容的檔案 ~/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

驗證憑證

為確保所有設定正確無誤,我們會執行 Get 廣告活動 範例

首先,請前往 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'