Günlük Kaydı

.NET istemci kitaplığı, Google Ads API'ye gönderilen 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

API çağrısı yapmadan önce Main yönteminize aşağıdaki satırı ekleyerek TraceListener için giriş yapmayı 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 etmenize olanak tanır.

İlk olarak bir LoggerFactory oluşturun. Zaten bir LoggerFactory oluşturduysanız Google Ads API günlüklerine yönelik 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 istek ve yanıt özetleri ile ayrıntılar için günlüğe kaydediciler oluşturmak amacıyla LoggerFactory öğesini kullanın:

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 düzeyleri

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, tam istek ve yanıtlar ise DEBUG adresinde günlüğe kaydedilir.

API hatasıyla sonuçlanan bir istekte özet mesajı WARN adresinde, tam istek ve yanıt ise INFO adresinde günlüğe kaydedilir.

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

Talep numarası

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

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

Sıradan API çağrılarıyla ayıklama

Normal tekli çağrılardan istek kimliklerini yakalamak için TrailingMetadataHandler ile birlikte ö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ı aracılığı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.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);
        }
    }
);

İstisnalar

Bir API çağrısı başarısız olduğunda GoogleAdsException istisnasının bir parçası olarak 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üğünde yeterince ayrıntılı bilgi yoksa gRPC düzeyinde daha düşük düzeyli günlük kaydını etkinleştirin. Çıkışın hacimli olabileceğini unutmayın. gRPC günlükleri stderr'e yazılır ancak kendi günlük kaydedicinizi aşağıda gösterildiği gibi ekleyebilirsiniz. Desteklenen ortam değişkenleri.

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

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

Uygulamanız bir .NET Framework hedefi için derleniyorsa 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 geliştirilen 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. Aşağıdaki snippet'i <configuration> bölümünün altına 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. Aşağıdaki snippet'i <configSections> bölümünün altına ekleyin.

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

   Ardından App.config 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>