記錄

.NET 用戶端程式庫會記錄發送給 Google Ads API這類記錄檔可以寫入 TraceListener、 或自訂的 ILogger。 執行個體。

TraceListener

如要啟用 TraceListener 記錄功能，請在 Main 方法，再發出任何 API 呼叫。

using Google.Ads.GoogleAds.Util;
...

// Detailed logs.
TraceUtilities.Configure(TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE,
    "C:\\logs\\details.log", System.Diagnostics.SourceLevels.All);

// Summary logs.
TraceUtilities.Configure(TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE,
    "C:\\logs\\details.log", System.Diagnostics.SourceLevels.All);

ILogger

如果您的應用程式記錄檔已使用 ILogger，請採取這項解決方案 可讓您在現有記錄檔中整合 Google Ads API 記錄。

請先建立 LoggerFactory，或新增篩選器 (如果您已建立的話) Google Ads API 記錄：

var loggerFactory = LoggerFactory.Create(delegate (ILoggingBuilder builder)
{
  // Log to stdout.
  builder.AddConsole();
  builder.AddFilter(TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE, LogLevel.Trace);
  builder.AddFilter(TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE, LogLevel.Trace);
});

然後使用 LoggerFactory 建立要求和回應的記錄器 摘要和詳細資料：

ILogger summaryLogger = loggerFactory.CreateLogger(TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE);
ILogger detailLogger = loggerFactory.CreateLogger(TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE);

最後設定用戶端程式庫，將其追蹤記錄重新導向至您的 ILogger 執行個體：

TraceUtilities.ConfigureSummaryLogger(summaryLogger);
TraceUtilities.ConfigureDetailLogger(detailLogger);

這項解決方案可讓您將 Google Ads API 要求和回應記錄整合到 現有記錄架構，例如 Log4Net、NLog 和 Serilog。

記錄層級

程式庫會將不同類型的事件記錄到不同的記錄層級。換 成功的 API 回應，摘要會記錄在 INFO，而完整的 要求與回應記錄在 DEBUG。

收到 API 錯誤的要求時，系統會將摘要訊息記錄在 WARN，而完整的要求和回應會記錄在 INFO。

部分失敗的記錄會在 DEBUG 記錄。

要求 ID

在大部分的情況下，用戶端程式庫產生的記錄可提供足夠的資訊 來解決問題與支援團隊聯絡時 論壇/別名，您可以提供會遮蓋機密內容的記錄 ) 或單純提供要求 ID (記錄為 部分回應記錄)。

如果您偏好自行擷取要求 ID，可以使用 方法如下：

透過一般 API 呼叫擷取

您可以使用自訂 CallSetting，搭配 TrailingMetadataHandler 擷取內容 要求 ID

CallSettings callSettings = CallSettings.FromTrailingMetadataHandler(
    delegate (Metadata metadata) {
        // Extract the request ID from the trailing metadata.
        string requestId = metadata.Get("request-id").Value;
    });
// Add the campaigns.
MutateCampaignsResponse retVal = campaignService.MutateCampaigns(
    customerId.ToString(), operations.ToArray(), callSettings);

透過串流 API 呼叫擷取

要求 ID 會做為串流 API 回應物件的一部分傳回 呼叫。舉例來說，您可以透過以下形式取得 SearchStream 呼叫的要求 ID： 如下：

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V17.GoogleAdsService);

// Retrieve all campaigns.
string query = @"SELECT
                campaign.id,
                campaign.name,
                campaign.network_settings.target_content_network
            FROM campaign
            ORDER BY campaign.id";

// Issue a search request.
googleAdsService.SearchStream(customerId.ToString(), query,
    delegate (SearchGoogleAdsStreamResponse resp)
    {
        // Extract the request ID from the response.
        string requestId = resp.RequestId;
        foreach (GoogleAdsRow googleAdsRow in resp.Results)
        {
            Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
        }
    }
);

例外狀況

要求 ID 會在 GoogleAdsException 例外狀況中傳回 。

try
{
  // Make an API call.
  ...
}
catch (GoogleAdsException e)
{
    string requestId = e.RequestId;
}

進階記錄功能

如果 API 記錄無法提供足夠的詳細資料，請前往以下頁面啟用層級較低的記錄功能： 而非 gRPC 等級請注意，輸出內容可能相當龐大。gRPC 記錄檔 寫入 stderr，但您可以附加自己的記錄器，如下所示。 支援的環境 變數。

Environment.SetEnvironmentVariable("GRPC_VERBOSITY", "DEBUG");
Environment.SetEnvironmentVariable("GRPC_TRACE", "http");
GrpcEnvironment.SetLogger(new ConsoleLogger());

使用 App.config 的 TraceListener 設定 (舊版)

如果您的應用程式是針對 .NET Framework 目標建構，您可以載入記錄 應用程式的 App.config 或 Web.config 檔案中設定。這是 針對 .NET Core 建構的應用程式不支援舊版 .NET 功能 目標。

如要使用這項功能，請將下列變更新增至設定 檔案：

  1. 在 <configuration> 區段下方加入下列程式碼片段。

    <system.diagnostics>
  <sources>
    <source name="GoogleAds.DeprecationMessages"
        switchName="GoogleAds.DeprecationMessages"
        switchType="System.Diagnostics.SourceSwitch">
      <listeners>
        <add name="myListener" type="System.Diagnostics.EventLogTraceListener"
           initializeData="Application"/>
      </listeners>
    </source>
    <source name="GoogleAds.DetailedRequestLogs"
        switchName="GoogleAds.DetailedRequestLogs"
        switchType="System.Diagnostics.SourceSwitch">
      <listeners>
        <add name="detailedRequestLogListener" type="System.Diagnostics.ConsoleTraceListener"
           initializeData="true"/>
        <!-- Use the following to log to file. Modify the initializeData
             attribute to control the path to the detailed request log file. -->
        <!--
        <add name="detailedRequestLogListener" type="System.Diagnostics.TextWriterTraceListener"
             initializeData="C:\Logs\detailed_logs.log"/>
        <remove name="Default"/>
        -->
      </listeners>
    </source>
    <source name="GoogleAds.SummaryRequestLogs" switchName="GoogleAds.SummaryRequestLogs"
        switchType="System.Diagnostics.SourceSwitch">
      <listeners>
        <add name="summaryRequestLogListener" type="System.Diagnostics.ConsoleTraceListener"
           initializeData="true"/>
        <!-- Use the following to log to file. Modify the initializeData
             attribute to control the path to the summary request log file. -->
        <!--
        <add name="summaryRequestLogListener" type="System.Diagnostics.TextWriterTraceListener"
             initializeData="C:\Logs\summary_logs.log"/>
        -->
        <remove name="Default"/>
      </listeners>
    </source>
  </sources>
  <switches>
    <!-- Use this trace switch to control the deprecation trace messages
         written by Ads* .NET libraries. The default is level is set to
         Warning. To disable all messages, set this value to Off. See
         msdn.microsoft.com/en-us/library/system.diagnostics.sourcelevels.aspx
         for all possible values this key can take. -->
    <add name="GoogleAds.DeprecationMessages" value="Warning"/>
    <!-- Use this trace switch to control the detailed request logs written by Ads*
         .NET libraries. The default level is set to Off. Logs are generated at
         both the Error and Information levels. -->
    <add name="GoogleAds.DetailedRequestLogs" value="Off"/>
    <!-- Use this trace switch to control the summary request logs written by
         Ads* .NET libraries. The default level is set to Off. Logs are
         generated at both the Error and Information levels. -->
    <add name="GoogleAds.SummaryRequestLogs" value="Off"/>
  </switches>
  <trace autoflush="true"/>
</system.diagnostics>

  2. 在 <configSections> 區段下方加入下列程式碼片段。

    <section name="system.diagnostics" type="System.Diagnostics.SystemDiagnosticsSection"/>

    您的 App.config 將如下所示：

    <?xml version="1.0" encoding="utf-8"?>
<configuration>
  <configSections>
    <section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"/>
    <section name="system.diagnostics" type="System.Diagnostics.SystemDiagnosticsSection"/>
  </configSections>
  <GoogleAdsApi>
    <!-- Google Ads API settings. -->
  </GoogleAdsApi>
  <system.diagnostics>
    <!-- Logging settings. -->
  </system.diagnostics>
</configuration>