このライブラリは、Google Ads API とのやり取りをさまざまな方法でログに記録するように構成できます。詳細なリクエストとレスポンスだけでなく、簡潔な概要メッセージをログに記録できます。これらの設定は、クライアント ライブラリの構成によって管理されます。使用可能なさまざまな構成オプションの詳細は次のとおりです。
このライブラリは Python の組み込みロギング フレームワークを使用し、デフォルトで stderr にログを記録します。指定すると、構成で定義された logging オブジェクトが dict として logging.config.dictConfig に直接渡されます。
クライアントを初期化する前にロギング構成を設定して、ロギングをプログラムで構成することもできます。クライアント ロガー インスタンスを取得して、次の例で構成できます。
import logging
logging.basicConfig(level=logging.INFO, format='[%(asctime)s - %(levelname)s] %(message).5000s')
logging.getLogger('google.ads.googleads.client').setLevel(logging.INFO)
クライアント ロガーは、クライアントの初期化時に構成されます。その後のロギング構成の変更は無視されます。YAML ファイルのロギング構成をプログラムでオーバーライドするには、クライアントが初期化される前に上記の行を呼び出してください。
ログレベル
クライアントはいくつかの異なるレベルでログを生成します。構成を設定すると、以下の一部またはすべてを確認できます。
| レベル | リクエストの成功 | リクエストに失敗しました |
|---|---|---|
DEBUG |
完全なリクエスト オブジェクトとレスポンス オブジェクトが JSON として含まれる詳細なログ。 | リクエストと例外オブジェクトが JSON として含まれる詳細なログ。 |
INFO |
特定のリクエスト フィールドとレスポンス フィールドを含む簡潔な概要。 | リクエストと例外オブジェクトが JSON として含まれる詳細なログ。 |
WARNING |
なし | 特定のリクエスト情報、例外の状態、メッセージを含む簡潔な概要。 |
Python ロギング フレームワークは、構成されたレベルよりも重大度が低いログメッセージを無視するため、WARNING に設定すると、失敗したリクエストに関連する簡潔なメッセージのみが表示されます。DEBUG に設定すると、上記の表に示すすべてのタイプのログが表示されます。
ファイルへのロギング
ログ メッセージをファイルにパイプで簡単に転送できます。たとえば、get_campaigns の例を実行すると、次のように表示されます。
python get_campaigns.py -c $CLIENT_ID 2> example.log
ロギング インターセプタ
Python クライアント ライブラリは、gRPC インターセプタを使用してリクエストとレスポンスの詳細にアクセスし、ログに記録します。カスタム ロジックを使用して gRPC インターセプタを作成することで、独自のカスタム ロギングを設定できます。カスタム ロギング インターセプタの詳細と例については、ロギング ガイドをご覧ください。