高度な使用方法

このガイドでは、Java クライアント ライブラリの高度な側面をカスタマイズする方法について説明します。一般的なパターンとして、これらの機能の多くは標準メソッドではなく、基盤となる Callable に依存しています。呼び出し可能オブジェクトは、ここに記載されていない RPC ごとの他の機能を探すのに適しています。

タイムアウト

Java ライブラリは、呼び出しごとにタイムアウトを設定するためのサーフェスを提供します。デフォルト値は、googleads_grpc_service_config.json の method_config/timeout 設定に基づいて設定されます。API 呼び出しの最大時間を短く制限する必要がある場合は、より小さい値を設定します。

この機能を使用するには、呼び出し可能オブジェクトを直接使用する必要があります。たとえば、GoogleAdsService.searchStream() を呼び出す場合、タイムアウトは次のように設定されます。

try (GoogleAdsServiceClient googleAdsServiceClient =
    googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
  // Constructs the SearchGoogleAdsStreamRequest.
  SearchGoogleAdsStreamRequest request = ...

  // Executes the API call, with a timeout of 5 minutes.
  ServerStream<SearchGoogleAdsStreamResponse> result = googleAdsServiceClient
      .searchStreamCallable()
      .call(request,
          GrpcCallContext.createDefault().withTimeout(Duration.of(5, ChronoUnit.MINUTES)));
}

タイムアウトは 2 時間以上に設定できますが、API は非常に長いリクエストをタイムアウトして DEADLINE_EXCEEDED エラーを返すことがあります。このことが問題になる場合は、通常、クエリを分割してチャンクを並行して実行するのが最善です。これにより、長時間実行されているリクエストが失敗し、回復する唯一の方法が最初からリクエストを再度トリガーすることになる状況を回避できます。

再試行の設定

Java ライブラリには、呼び出しごとに再試行設定を構成するためのサーフェスも用意されています。この機能を使用するには、呼び出し可能オブジェクトを直接使用する必要があります。たとえば、GoogleAdsService.searchStream() を呼び出す場合、再試行設定は次のように構成されます。

// Creates a context object with the custom retry settings.
GrpcCallContext context = GrpcCallContext.createDefault()
    .withRetrySettings(RetrySettings.newBuilder()
    .setInitialRetryDelay(Duration.ofMillis(10L))
    .setMaxRetryDelay(Duration.ofSeconds(10L))
    .setRetryDelayMultiplier(1.4)
    .setMaxAttempts(10)
    .setLogicalTimeout(Duration.ofSeconds(30L))
    .build());

// Creates and issues a search Google Ads stream request.
ServerStream<SearchGoogleAdsStreamResponse> stream =
    googleAdsServiceClient.searchStreamCallable().call(request, context);

起動時間のパフォーマンスの最適化

GoogleAdsClient インスタンスが初めて作成されるときに、わずかな遅延が発生することがあります。これは、サービス（GoogleAdsClient.getVersionXX()）の Fluent インターフェースが、サービス クラスを構築するためのより便利なメカニズムを提供するために、すべての API クラスを一度に読み込むためです。

初回リクエストのパフォーマンスがアプリケーションのクリティカル パスにある場合は、次の手順に沿って対応する必要があります。

  1. ユーザー リクエストを処理する前に、起動時に GoogleAdsClient を作成します。

  2. プロセスが最初に開始されたときに、Google Ads API にウォームアップ リクエストをいくつか送信します。次に例を示します。

    // Runs some warm-up requests.
try (GoogleAdsServiceClient googleAdsServiceClient =
    googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
  // Runs 5 warm-up requests. In our profiling we see that 90% of performance
  // loss is only experienced on the first API call. After 3 subsequent calls we
  // saw a negligible improvement in performance.
  for (int i = 0; i < 5; ++i) {
    // Warm-up queries are run with a nonexistent CID so the calls will fail. If
    // you have a CID that you know will be accessible with the OAuth
    // credentials provided you may want to provide that instead and avoid the
    // try-catch.
    try {
      googleAdsServiceClient.search("-1", "Warm-up query");
    } catch (GoogleAdsException ex) {
      // Do nothing, we're expecting this to fail.
    }
  }
}

ウォームアップ リクエストは、プロセスごとに 1 回だけ実行する必要があります。以降のサービス クライアントの作成では、プリロードされたクラスが自動的に再利用されます。

サービス クライアントの再利用

GoogleAdsClient.getVersionXXX().createYYYServiceClient() の呼び出しごとに新しい TCP 接続が作成されるため、可能な限りサービス クライアント インスタンスを再利用する必要があります。

クライアントが不要になったら、必ずクライアントを閉じるようにしてください。これは、try-with-resources ブロックで行うか、サービス クライアントで close() を呼び出すことで行えます。

クローズされたサービス クライアントを使用して API リクエストを作成しようとすると、サービス クライアント メソッドは java.util.concurrent.RejectedExecutionException をスローします。

JAR が 32 MB を超えると App Engine のデプロイが失敗する

App Engine では、アップロードするファイルごとに 32 MB の割り当てがあります。google-ads の JAR は、これよりもかなり大きくなります。シェード/シャドー JAR デプロイを使用すると、さらに大きくなります。jar を手動でデプロイすると、次のようなエラーが発生することがあります。

ERROR: (gcloud.app.deploy) Cannot upload file [<your-app>/WEB-INF/lib/google-ads-38.0.0.jar],
which has size [66095767] (greater than maximum allowed size of [33554432])

代わりに、App Engine の Gradle プラグインまたは Maven プラグインを使用してデプロイします。各コマンドには enableJarSplitting オプションがあり、各 jar を 10 MB のチャンクに分割してアップロードします。

シャドウの依存関係

プロジェクトにライブラリと競合する依存関係がある場合は、次のいずれかのコマンドを使用してプロジェクトの依存関係を調べ、必要に応じてプロジェクトの依存関係を変更する必要があります。

Maven

mvn dependency:tree

Gradle

./gradlew dependencies

依存関係の競合を解決できない場合は、代わりにライブラリのシェーディングされたバージョンに依存できます。

Maven

<dependency>
  <groupId>com.google.api-ads</groupId>
  <artifactId>google-ads-shadowjar</artifactId>
  <version>38.0.0</version>
</dependency>

Gradle

implementation 'com.google.api-ads:google-ads-shadowjar:38.0.0'