開始使用

建議您搭配 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 驗證

您必須具備 OAuth 憑證和 Google Ads API 開發人員權杖,才能存取 Google Ads API。本節說明這些憑證的定義、用途以及取得的方式。

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

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

雖然開發人員權杖與管理員帳戶連結,但並不提供該帳戶的存取權。反之,開發人員權杖一般會授予 API 存取權,且帳戶層級存取權是透過 OAuth 設定。

OAuth 憑證 (用於存取 Google Ads 帳戶)

如要授權以 Google 帳戶使用者的身分存取 Google Ads 帳戶,您必須提供一組 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

驗證憑證

為確保所有設定皆正確無誤,我們會執行 GetCampaign 範例

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