タイムアウトと再試行

一部の 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 エラーを返します。

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

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