Java

Google 提供 Java 用戶端程式庫，用於與 Ad Manager API 互動。 建議您搭配 Apache Maven 或 Gradle 使用用戶端程式庫。

如要開始使用，請在所選 IDE 中建立新專案，或新增 依附元件Google 會將用戶端程式庫構件發布至 Maven 中央存放區 com.google.api-ads/ad-manager。

Maven 

<!-- pom.xml -->
<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>ad-manager</artifactId>
  <version>0.1.0</version>
</dependency>

Gradle 

implementation 'com.google.api-ads:ad-manager:0.1.0'

設定憑證

Java 用戶端程式庫使用 OAuth2 和應用程式預設憑證 (ADC) 進行驗證。

ADC 會按照以下位置搜尋憑證：

  1. GOOGLE_APPLICATION_CREDENTIALS 環境變數。
  2. 透過 Google Cloud CLI (gcloud CLI) 設定的使用者憑證。
  3. 在 Google Cloud 中運作時，已連結至該 Google Cloud 資源的服務帳戶。

如要瞭解如何建立及設定 ADC 憑證，請參閱 驗證：

提出第一個要求

每項服務都有一個包含同步和非同步的 ServiceClient 物件 方法。下列範例會讀取 Network 同步執行。

import com.google.ads.admanager.v1.GetNetworkRequest;
import com.google.ads.admanager.v1.Network;
import com.google.ads.admanager.v1.NetworkName;
import com.google.ads.admanager.v1.NetworkServiceClient;

public class SyncGetNetwork {

  public static void main(String[] args) throws Exception {
    syncGetNetwork();
  }

  public static void syncGetNetwork() throws Exception {
    try (NetworkServiceClient networkServiceClient = NetworkServiceClient.create()) {
      GetNetworkRequest request =
          GetNetworkRequest.newBuilder()
              .setName(NetworkName.of("[NETWORK_CODE]").toString())
              .build();
      Network response = networkServiceClient.getNetwork(request);
    }
  }
}
SyncGetNetwork.java

如需其他方法和資源的範例，請前往 GitHub 存放區 googleapis/google-cloud-java。

記錄 HTTP 要求和回應

com.google.api.client.http.HttpTransport 類別會提出所有 HTTP 要求。 此類別會使用 java.util.logging敬上 (JUL) 記錄 HTTP 要求與回應詳細資料，包括網址、標頭及 內容。

如要啟用記錄功能，請將這個類別的記錄器設為 CONFIG 以上版本。記錄步驟會因記錄類型而有所不同 導入的項目

7 月

如要啟用記錄功能，請將 com.google.api.client.http.level 設為 CONFIG 或 檢視 logging.properties 檔案中的優先順序。

handlers=java.util.logging.ConsoleHandler
com.google.api.client.http.level=CONFIG
java.util.logging.ConsoleHandler.level=CONFIG

或者，您也可以在 Java 程式碼中啟用記錄功能。


import com.google.api.client.http.HttpTransport;
import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
import java.util.logging.Logger;

public static void enableLogging() {
  Logger logger = Logger.getLogger(HttpTransport.class.getName());
  logger.setLevel(Level.CONFIG);
  ConsoleHandler handler = new ConsoleHandler();
  handler.setLevel(Level.CONFIG);
  logger.addHandler(handler);
}

Log4j

如果您使用 Log4j 進行記錄，則可以使用 Log4j JDK 記錄轉接器 記錄 JUL 訊息。您可以透過 SystemProperty 或 使用 Log4jBridgeHandler 和 JUL logging.properties 檔案。

系統資源

-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager

Log4j 橋接器處理常式

handlers = org.apache.logging.log4j.jul.Log4jBridgeHandler
org.apache.logging.log4j.jul.Log4jBridgeHandler.propagateLevels = true

這些設定會將 Ad Manager API 記錄寫入任何記錄器中 CONFIG 以上版本。下列範例 log4j2.xml 檔案會設定 寫入 System.out 的記錄器。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%m%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Logger name="com.google.api.client.http.HttpTransport" level="debug">
      <AppenderRef ref="Console"/>
    </Logger>
    <Root level="error">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

處理錯誤

所有 Ad Manager API 錯誤都是 ApiException 。

404 Not Found 和 401 Unauthorized 以外的所有錯誤都包含 ErrorDetails 以及補充資訊

剖析錯誤

錯誤原因欄位是用來識別錯誤類型的唯一識別碼。使用 這個欄位來判斷錯誤的處理方式。

ErrorDetails errorDetails = apiException.getErrorDetails();
if (errorDetails != null) {
  // Unique error code in UPPER_SNAKE_CASE.
  String errorCode = errorDetails.getReason();
}

Ad Manager API 錯誤也會包含可寫入的不重複 request_id 向支援團隊尋求協助 來排解問題以下範例會擷取 request_id。

ErrorDetails errorDetails = apiException.getErrorDetails();
if (errorDetails != null && errorDetails.getRequestInfo() != null) {
  // Unique request identifier.
  String requestId = errorDetails.getRequestInfo().getRequestId();
}

建構資源名稱

用戶端程式庫提供用來建構資源名稱的輔助類別 而非客戶 ID

import com.google.ads.admanager.v1.OrderName;

// ...

//  Constructs a String in the format:
//  "networks/{networkCode}/orders/{orderId}"
OrderName.of("123", "789");

指定 Proxy 設定

Java 用戶端程式庫會遵循 http.proxyHost 和 https.proxyHost 系統資源設定。如要進一步瞭解這些設定，請參見 Java 網路和 Proxy。