建議您將用戶端程式庫與 Apache Maven (或 Gradle) 搭配使用。
建立新的 Maven/Gradle 專案
在您選擇的 IDE 中建立新的 Maven/Gradle 專案。我們的構件會發布至 Maven 中央存放區。
Maven 依附元件如下:
<dependency>
<groupId>com.google.api-ads</groupId>
<artifactId>google-ads</artifactId>
<version>36.0.0</version>
</dependency>
Gradle 依附元件如下:
implementation 'com.google.api-ads:google-ads:36.0.0'
您也可以從原始碼建構。本指南假設您已設定專案,並提供必要的依附元件。
取得用於驗證 API 的憑證
如要存取 Google Ads API,您必須具備 OAuth 憑證和 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 Domain 使用者設定 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
驗證憑證
為確保一切設定正確無誤,我們將執行 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'