タイムアウトと再試行を構成する

Display & Video 360 API の多くのメソッドは複雑な処理を実行するため、完了までに数秒以上かかることがあります。これらのメソッドへのリクエストは予想されるレイテンシを超えることがあり、API またはクライアント側でエラーが発生する可能性があります。このページでは、リクエストのレイテンシが長くなることに起因する問題に対処するためのプラクティスについて説明します。

クライアント ライブラリのデフォルトのタイムアウトを延長

リファレンス ドキュメントでは、いくつかの特定のメソッドに、予想されるレイテンシを定期的に超えることが明記されています。他のメソッドでも、高レイテンシが定期的に発生する可能性があります。

一部のクライアント ライブラリでは、デフォルトのタイムアウト制限により、レイテンシが高いリクエストを行うときにエラーが発生することがあります。サポートされているクライアント ライブラリのサブセットのデフォルトのタイムアウトは次のとおりです。

  • Java: 20 秒
  • Python: 60 秒
  • PHP: 60 秒

クライアントサイドのタイムアウトは、これらのデフォルトのタイムアウト値を引き上げることで回避できます。クライアント ライブラリのデフォルトのタイムアウトを実行時に調整する手順は次のとおりです。

Java

  1. 必要なリソースをインポートする。

    import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestInitializer;
import java.io.IOException;

  2. HTTP タイムアウトを設定する関数を作成します。

    /**
 * Adjusts HTTP timeout values used by the provided request initializer.
 *
 * @param requestInitializer The {@link HttpRequestInitializer} used to authorize requests.
 * @param newHttpTimeout The HTTP timeout for requests in seconds.
 * @return An {@link HttpRequestInitializer} with modified HTTP timeout values.
 */
private static HttpRequestInitializer setHttpTimeout(
    final HttpRequestInitializer requestInitializer,
    final int newHttpTimeout) {
  return new HttpRequestInitializer() {
    @Override
    public void initialize(HttpRequest httpRequest) throws IOException {
      requestInitializer.initialize(httpRequest);
      httpRequest.setConnectTimeout(newHttpTimeout * 1_000);
      httpRequest.setReadTimeout(newHttpTimeout * 1_000);
    }
  };
}

  3. Display & Video 360 API クライアントの作成時に関数を呼び出します。

    // Create authorized API client with non-default timeouts.
DisplayVideo service =
    new DisplayVideo.Builder(
        credential.getTransport(),
        credential.getJsonFactory(),
        setHttpTimeout(credential, http-timeout-in-seconds)
    )
        .setApplicationName("displayvideo-java-installed-app-sample")
        .build();

Python

  1. Google API Python クライアント ライブラリの HTTP モジュールをインポートします。

    from googleapiclient import http

  2. デフォルトのタイムアウト定数を更新。

    http.DEFAULT_HTTP_TIMEOUT_SEC = http-timeout-in-seconds

  3. API サービスを構築する。

    # Build the API service.
service = discovery.build(
  'displayvideo',
  'v3',
  discoveryServiceUrl=discovery_url,
  credentials=credentials)

PHP

  1. Composer を使用して Guzzle HTTP ライブラリをダウンロードしてインストールします。

    composer require guzzlehttp/guzzle:^7.0

  2. Guzzle HTTP クライアントを作成し、タイムアウト値を割り当てます。

    $httpClient = new \GuzzleHttp\Client(['timeout' => http-timeout-in-seconds]);

  3. Google クライアントを作成し、Guzzle HTTP クライアントを割り当てます。

    $client = new Google_Client();
$client->setHttpClient($httpClient);

API タイムアウト エラーを処理する

まれに、複雑なオペレーションを実行するリクエストがサーバー側のタイムアウト（180 秒）を超え、API が 408 または 504 エラー レスポンスを返すことがあります。

リクエストがこれらのエラーコードのいずれかで応答した場合は、指数バックオフを使用してリクエストを再試行することをおすすめします。

エラーが解消されない場合は、お問い合わせフォームからサポートにお問い合わせください。