クライアント ライブラリのベスト プラクティス

以下は、Cloud クライアント ライブラリと Google API クライアント ライブラリの両方を使用するときに、最適なパフォーマンスと可能な限り最高のエクスペリエンスを得るのに役立つベスト プラクティスです。

クライアント オブジェクトとセッションを再利用する

同じライブラリを使用してリクエストを作成する場合は、リクエストごとに新しいクライアント オブジェクトを作成するのではなく、可能な限り多くのリクエストで同じクライアント オブジェクトを再利用する必要があります。同じインスタンスからのリクエストは、認証情報インスタンスを共有します。

セッション クライアントのインスタンスによって行われた最初のリクエストでは、認証、承認、アクセス トークンの生成が行われます。この処理はネットワーク経由で行われるため、数秒かかることがあります。同じクライアントインスタンスでさらに呼び出しを行う場合、セッションクライアントは、有効である限り(通常は 1 時間)同じアクセストークンを再利用します。有効期限が切れると、セッションクライアントは自動的にアクセストークンを更新します。最適なパフォーマンスを得るには、アプリケーションが行ったすべてのリクエストに対して同じセッションクライアントのインスタンスを再利用し、クライアントが、同じ認証情報セットの下で実行する必要のあるすべてのリクエストについて、必要に応じてアクセス トークンを更新できるようにします。

さらに、クライアント ライブラリで使用される一部の認証ストラテジーには、レート制限が関連付けられています。クライアントの各インスタンスには独自の認証情報キャッシュがあるため、短期間に多数を作成するとレート制限が発生し、ライブラリ リクエストが認証に失敗する可能性があります。

本番環境用の依存関係を固定する

npmpip などのパッケージ マネージャーからライブラリをインストールする場合、本番環境用の組み込みのバージョニングを使用してバージョンを固定することが重要です。これにより、ビルドではこれらのライブラリの同じバージョンが一貫して使用されます。これは、API サーフェスを変更できるベータ クライアントを使用する場合に特に重要です。関連するライブラリのドキュメントでは、このことはライブラリ パッケージのドキュメントに記載されています。

最新情報を入手する

Google Cloud の機能と API が変わると、クライアント ライブラリも変わります。クライアント ライブラリは頻繁に変更され、多くには毎日のように更新とリリースがあります。できるだけベストなサポートを受けるには、リリースを最新の状態に保つ必要があります。多くのライブラリはセマンティック バージョニングをサポートしており、アップグレードの作業量を簡単に判断できます。パフォーマンスの低下(または問題)が発生していて、古いバージョンのクライアント ライブラリを使用している場合は、アップグレードして、新しいバージョンのすべての改善点を活用することを検討してください。