Ведение журнала

Клиентская библиотека .NET регистрирует запросы, ответы и сводные сообщения, отправляемые в API Google Ads. Журналы могут записываться в пользовательский 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);

Обратите внимание, что TraceListeners.Configure следует вызывать только один раз за весь жизненный цикл приложения, поскольку созданный им TraceListener будет автоматически использоваться во всех API-запросах приложения; вам не нужно создавать новый для каждого API-запроса.

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);

Это решение позволяет интегрировать журналы запросов и ответов API Google Ads в существующие системы логирования, такие как Log4Net, NLog и Serilog.

Уровни логарифма

Библиотека регистрирует различные типы событий на разных уровнях логирования. В случае успешного ответа API сводная информация регистрируется на INFO , а полный запрос и ответы — на DEBUG .

В случае запроса, приводящего к ошибке API, сводное сообщение регистрируется в WARN , а полный запрос и ответ — в INFO .

Частичные сбои регистрируются в DEBUG .

Идентификатор запроса

В большинстве случаев журналы, генерируемые клиентской библиотекой, содержат достаточно подробную информацию для устранения неполадок. При обращении в службу поддержки предоставьте либо сами журналы (при этом конфиденциальная информация по умолчанию скрывается), либо укажите идентификатор запроса, который записывается в журнал ответа.

Если вы предпочитаете самостоятельно получить идентификатор запроса, вы можете использовать один из следующих способов:

Извлечение данных посредством обычных вызовов API.

Вы можете использовать пользовательский параметр CallSetting с обработчиком TrailingMetadataHandler для получения идентификаторов запросов из обычных унарных вызовов.

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.

Идентификатор запроса возвращается в составе объекта ответа для потоковых вызовов API. Например, идентификатор запроса для вызова SearchStream можно получить следующим образом:

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V23.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);
        }
    }
);

Исключения

Идентификатор запроса возвращается в составе исключения GoogleAdsException всякий раз, когда вызов API завершается неудачей.

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());

Настройка TraceListener с помощью App.config (устаревшая версия)

Если ваше приложение создано для платформы .NET Framework, вы можете загрузить конфигурацию логирования из файла App.config или Web.config вашего приложения. Это устаревшая функция .NET, которая не поддерживается для приложений, созданных для платформы .NET Core.

Для использования этой функции необходимо внести следующие изменения в файл конфигурации:

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>