Günlük Kaydı

.NET istemci kitaplığı, Google Ads API'ye yapılan istekleri, yanıtları ve özet mesajları günlüğe kaydeder. Günlükler, özel bir TraceListener veya özel bir ILogger örneğine yazılabilir.

TraceListener

Herhangi bir API çağrısı yapmadan önce Main yönteminize aşağıdaki satırı ekleyerek bir TraceListener için günlük kaydını etkinleştirebilirsiniz.

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

Uygulama günlükleriniz için halihazırda ILogger kullanıyorsanız bu çözüm, Google Ads API günlüklerini mevcut günlüklerinize entegre etmenizi sağlar.

İlk olarak bir LoggerFactory oluşturun veya varsa Google Ads API günlükleri için filtreleri ekleyin:

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

Ardından, LoggerFactory kullanarak istek ve yanıt özetleri ve ayrıntılar için günlük kaydediciler oluşturun:

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

Son olarak, istemci kitaplığını, izlerini ILogger örneklerinize yönlendirecek şekilde yapılandırın:

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

Bu çözüm, Google Ads API istek ve yanıt günlüklerini Log4Net, NLog ve Serilog gibi mevcut günlük kaydı çerçevelerine entegre etmenizi sağlar.

Günlük seviyeleri

Kitaplık, farklı etkinlik türlerini farklı günlük düzeylerine kaydeder. Başarılı bir API yanıtı için özet INFO adresinde, tüm istek ve yanıtlar ise DEBUG adresinde günlüğe kaydedilir.

API hatasına neden olan bir istekte özet mesajı, WARN adresinde, istek ve yanıtın tamamı ise INFO adresinde günlüğe kaydedilir.

Kısmi hatalar DEBUG ile günlüğe kaydedilir.

Talep numarası

Çoğu durumda, istemci kitaplığı tarafından oluşturulan günlükler, sorunlarınızı gidermek için yeterli bilgi sağlar. Destek forumuna/takma adlara ulaşırken günlükleri (varsayılan olarak hassas bilgileri çıkartır) sağlayabilir veya yalnızca istek kimliğini (yanıt günlüğünün bir parçası olarak günlüğe kaydedilir) paylaşabilirsiniz.

İstek kimliğini kendiniz yakalamayı tercih ederseniz aşağıdaki yaklaşımlardan birini kullanabilirsiniz:

Normal API çağrılarıyla ayıklama

Normal tekli çağrılardan istek kimliklerini yakalamak için TrailingMetadataHandler içeren özel bir CallSetting kullanabilirsiniz.

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

Akış API çağrılarıyla ayıklama

İstek kimliği, akış API çağrıları için yanıt nesnesinin bir parçası olarak döndürülür. Örneğin, bir SearchStream çağrısının istek kimliğini aşağıdaki şekilde alabilirsiniz:

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

İstisnalar

Bir API çağrısı başarısız olduğunda GoogleAdsException istisnası kapsamında istek kimliği döndürülür.

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

Gelişmiş günlük kaydı

API günlüğü size yeterli ayrıntı sağlamıyorsa gRPC düzeyinde daha düşük düzeyli günlük kaydını etkinleştirin. Sonucun hacimli olabileceğini unutmayın. gRPC günlükleri stderr'a yazılır ancak aşağıda gösterildiği gibi kendi günlük kaydedicinizi ekleyebilirsiniz. Desteklenen ortam değişkenleri.

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

App.config'i kullanan TraceListener yapılandırması (eski)

Uygulamanız bir .NET Framework hedefi için derliyorsa günlük kaydı yapılandırmasını, uygulamanızın App.config veya Web.config dosyasından yükleyebilirsiniz. Bu, .NET Core hedefleri için oluşturulmuş uygulamalarda desteklenmeyen eski bir .NET işlevidir.

Bu özelliği kullanmak için yapılandırma dosyanıza aşağıdaki değişiklikleri eklemeniz gerekir:

  1. <configuration> bölümünün altına aşağıdaki snippet'i ekleyin.

    <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> bölümünün altına aşağıdaki snippet'i ekleyin.

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

    Bu durumda App.config ayarınız aşağıdaki gibi görünür:

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