Günlük Kaydı

.NET istemci kitaplığı, Google Ads API'si. Günlükler, TraceListener veya özel ILogger kullanır.

TraceListener

Aşağıdaki satırı uygulamanıza ekleyerek bir TraceListener hizmetine giriş yapmayı etkinleştirebilirsiniz: Main yöntemini kullanın.

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 zaten 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 filtreleri ekleyin Google Ads API günlükleri için:

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 için günlük kaydediciler oluşturun özetler ve ayrıntılar:

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 sayfanıza yönlendirecek şekilde yapılandırın örnekler:

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

Bu çözüm, Google Ads API istek ve yanıt günlüklerini günlük kaydı çerçevelerini (ör. Log4Net, NLog ve Serilog) kullanabilir.

Günlük seviyeleri

Kitaplık, farklı etkinlik türlerini farklı günlük düzeylerine kaydeder. Örneğin, özeti, INFO olarak günlüğe kaydedilir ve istek ve yanıtlar, DEBUG adresinde günlüğe kaydedilir.

API hatasıyla sonuçlanan bir istekte özet mesajı şu adreste günlüğe kaydedilir: WARN ve tam istek ile yanıt, 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, ayrıntılarına göz atın. Destek birimine ulaşırken forum/takma adlar kullanıyorsanız, günlükleri sağlayabilirsiniz (hassas bilgileri bilgisi varsa) veya yalnızca istek kimliğini (günlüğe bölümünde bulabilirsiniz).

İstek kimliğini kendiniz yakalamayı tercih ederseniz, şu yaklaşımlardan yararlanabilirsiniz:

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

Yakalamak için TrailingMetadataHandler ile özel bir CallSetting kullanabilirsiniz normal tekli çağrılardan kimlik iste.

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'si için yanıt nesnesinin bir parçası olarak döndürülür. çağrısının en iyi yolu. Örneğin, bir SearchStream çağrısının istek kimliğini şu şekilde alabilirsiniz: şöyle olur:

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

İstek kimliği, GoogleAdsException istisnasının bir parçası olarak döndürülür. bir API çağrısının başarısız olmasıyla ilgilidir.

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

Gelişmiş günlük kaydı

API günlüğü yeterli ayrıntı sağlamıyorsa şu adresten daha alt düzey günlük kaydını etkinleştirin: diğeri ise gRPC düzeyindedir. Sonucun hacimli olabileceğini unutmayın. gRPC günlükleri ancak aşağıda gösterildiği gibi kendi günlük kaydedicinizi ekleyebilirsiniz. Desteklenen ortam değişkenleri ile birlikte kullanılamaz.

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ını yükleyebilirsiniz yapılandırma dosyasını uygulamanızın App.config veya Web.config dosyasından ekleyebilirsiniz. Bu, .NET Core için oluşturulmuş uygulamalarda desteklenmeyen eski .NET işlevi belirler.

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

  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>