開始使用

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

您必須具備 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 取得存取權限如需詳細資訊,請參閱相關資源 說明文件

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

您可以採用設定檔來設定用戶端程式庫 環境變數在本指南中,我們會使用 設定檔做法,並著重於電腦版和網路流程。使用 但如果只有一組設定檔 憑證 (例如,您透過單一管理員來管理帳戶)。

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