Java

Google は、Ad Manager API とのやり取りに使用する Java クライアント ライブラリを提供しています。 クライアント ライブラリは Apache Maven または Gradle で使用することをおすすめします。

まず、任意の IDE で新しいプロジェクトを作成するか、既存のプロジェクトに依存関係を追加します。Google は、クライアント ライブラリ アーティファクトを Maven Central リポジトリに 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 認証情報の作成と構成については、 認証をご覧ください。

最初のリクエストを送信する

各サービスには、各 REST メソッドの同期メソッドと非同期メソッドの両方を含む 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);
    }
  }
}

他のメソッドとリソースの例については、GitHub リポジトリ googleapis/google-cloud-javaをご覧ください。

HTTP リクエストとレスポンスをログに記録する

com.google.api.client.http.HttpTransport クラスは、すべての HTTP リクエストを行います。このクラスは java.util.logging （JUL）を使用して、URL、ヘッダー、 コンテンツなど、HTTP リクエストとレスポンスの詳細をログに記録します。

ロギングを有効にするには、このクラスのロガーをログレベル CONFIG 以上に設定します。この手順は、使用するロギング実装によって異なります。

JUL

ロギングを有効にするには、logging.properties ファイルで com.google.api.client.http.level を CONFIG 以上に設定します。

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 Logging Adapter を使用して JUL メッセージをログに記録できます。これは、SystemProperty を使用するか、Log4jBridgeHandler と JUL logging.properties ファイルを使用して構成できます。

システム プロパティ

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

Log4j Bridge Handler

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

これらの設定により、Ad Manager API ログがレベル CONFIG 以上の Logger に書き込まれます。次の log4j2.xml ファイルの例では、System.out に書き込む Logger を構成しています。

<?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 のエラーはすべて、Java クライアント ライブラリの 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");

プロキシ設定を構成する

Java クライアント ライブラリは、http.proxyHost と https.proxyHost の両方のシステム プロパティ設定を尊重します。これらの設定の詳細については、 Java ネットワークとプロキシをご覧ください。