日志记录

<ph type="x-smartling-placeholder">

.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 会以 部分）。

如果您希望自行捕获请求 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>