Logowanie

Biblioteka klienta .NET rejestruje żądania, odpowiedzi i komunikaty podsumowujące wysyłane do interfejsu Google Ads API. Logi można zapisywać w niestandardowej instancji TraceListener lub niestandardowej instancji ILogger.

TraceListener

Możesz włączyć logowanie w usłudze TraceListener, dodając ten wiersz w metodzie Main przed wykonaniem jakichkolwiek wywołań interfejsu 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

Jeśli używasz już protokołu ILogger na potrzeby logów aplikacji, to rozwiązanie pozwoli Ci zintegrować dzienniki interfejsu Google Ads API z istniejącymi logami.

Najpierw utwórz LoggerFactory, a jeśli już masz, dodaj filtry dla dzienników interfejsu 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);
});

Następnie za pomocą LoggerFactory utwórz rejestratory na potrzeby podsumowań i szczegółów żądań i odpowiedzi:

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

Na koniec skonfiguruj bibliotekę klienta tak, aby przekierowywała logi czasu do instancji ILogger:

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

To rozwiązanie pozwala zintegrować logi żądań i odpowiedzi interfejsu Google Ads API z istniejącymi platformami logowania, takimi jak Log4Net, NLog czy Serilog.

Poziomy logu

Biblioteka rejestruje różne typy zdarzeń na różnych poziomach logów. Pomyślna odpowiedź interfejsu API jest logowana tutaj: INFO, a pełne żądanie i odpowiedzi są rejestrowane w DEBUG.

W przypadku żądania, które powoduje błąd interfejsu API, wiadomość z podsumowaniem jest logowana na stronie WARN, a pełne żądanie i odpowiedź logowane w INFO.

Częściowe błędy są rejestrowane na stronie DEBUG.

Identyfikator zgłoszenia

W większości przypadków logi generowane przez bibliotekę klienta zawierają wystarczającą ilość informacji, które pomagają rozwiązać problemy. Kontaktując się z forum pomocy lub aliasami, możesz udostępnić dzienniki (domyślnie usuwa poufne informacje) lub po prostu udostępnić identyfikator żądania (rejestrowany jako część dziennika odpowiedzi).

Jeśli wolisz samodzielnie rejestrować identyfikator żądania, możesz zastosować jedną z tych metod:

Wyodrębnianie za pomocą zwykłych wywołań interfejsu API

Aby przechwytywać identyfikatory żądań ze zwykłych jednoargumentowych wywołań, możesz użyć niestandardowego elementu CallSetting z elementem 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);

Wyodrębnianie przez wywołania interfejsu API strumieniowania

Identyfikator żądania jest zwracany jako część obiektu odpowiedzi dla strumieniowego wywołań interfejsu API. Identyfikator żądania dla wywołania SearchStream możesz np. uzyskać w ten sposób:

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

Wyjątki

Za każdym razem, gdy wywołanie interfejsu API kończy się niepowodzeniem, identyfikator żądania jest zwracany w ramach wyjątku GoogleAdsException.

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

Zaawansowane logowanie

Jeśli dziennik interfejsu API nie zawiera wystarczającej ilości informacji, włącz logowanie niższego poziomu na poziomie gRPC. Pamiętaj, że wynik może być duży. Logi gRPC są zapisywane w programie stderr, ale możesz dołączyć własny rejestrator, jak pokazano poniżej. Obsługiwane zmienne środowiskowe.

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

Konfiguracja TraceListener za pomocą App.config (starsza wersja)

Jeśli Twoja aplikacja jest kompilowana pod kątem środowiska docelowego .NET Framework, możesz wczytać konfigurację logowania z pliku App.config lub Web.config aplikacji. To jest starsza funkcja .NET, która nie jest obsługiwana w przypadku aplikacji utworzonych na potrzeby środowiska .NET Core.

Aby korzystać z tej funkcji, musisz dodać te zmiany do pliku konfiguracji:

1. Dodaj ten fragment kodu w sekcji <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. Dodaj ten fragment kodu w sekcji <configSections>.

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

   App.config wygląda wtedy tak:

   <?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>