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

多くのディスプレイとVideo 360 API のメソッドは複雑なオペレーションを実行しますが、オペレーションは 数秒で完了します。これらのメソッドへのリクエストは、リクエストより API またはクライアント側でエラーが発生している、想定されるレイテンシ。このページでは ベスト プラクティスをいくつか紹介します。

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

いくつかの具体的なメソッドは、リファレンス ドキュメントでラベル付けされています。 定期的に予想されるレイテンシを超える場合です他の方法でも 定期的に行うことをおすすめします。

一部のクライアント ライブラリでは、デフォルトのタイムアウト制限により、 低レイテンシのリクエストの実行に適していますサポートされているクライアントのサブセットのデフォルト タイムアウト ライブラリは次のとおりです。

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

デフォルトのタイムアウト値を引き上げることで、クライアントサイドのタイムアウトを回避できます。フォロー クライアント ライブラリのデフォルトのタイムアウトを runtime:

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. ディスプレイ キャンペーンと広告プランを作成する際に、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. 次のコマンドを使用して、Guzzle HTTP ライブラリをダウンロードしてインストールします。 Composer

    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 を返す 表示されます。

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

エラーが解決しない場合は、お問い合わせフォームを使用してサポートにお問い合わせください。