लॉग इन हो रहा है

.NET क्लाइंट लाइब्रेरी, Google Ads API को किए गए अनुरोधों, जवाबों, और खास जानकारी वाले मैसेज को लॉग करती है. लॉग को कस्टम TraceListener या कस्टम ILogger इंस्टेंस में लिखा जा सकता है.

TraceListener

किसी भी एपीआई कॉल करने से पहले, अपने Main तरीके में यह लाइन जोड़कर, TraceListener में लॉगिंग की सुविधा चालू की जा सकती है.

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

अगर आपने अपने ऐप्लिकेशन लॉग के लिए पहले से ही 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);

इस समाधान की मदद से, Google Ads API के अनुरोध और जवाब के लॉग को, Log4Net, NLog, और Serilog जैसे मौजूदा लॉगिंग फ़्रेमवर्क में इंटिग्रेट किया जा सकता है.

लॉग लेवल

लाइब्रेरी, अलग-अलग तरह के इवेंट को अलग-अलग लॉग लेवल पर लॉग करती है. एपीआई से मिले सही जवाब के लिए, खास जानकारी INFO पर लॉग की जाती है. साथ ही, पूरा अनुरोध और जवाब DEBUG पर लॉग किए जाते हैं.

अगर किसी अनुरोध की वजह से एपीआई में गड़बड़ी होती है, तो खास जानकारी वाला मैसेज WARN पर लॉग किया जाता है. साथ ही, पूरा अनुरोध और जवाब INFO पर लॉग किया जाता है.

कुछ फ़ाइलों का फ़ॉर्मैट नहीं बदला जा सका, इसकी जानकारी DEBUG पर लॉग की जाती है.

अनुरोध का आईडी

ज़्यादातर मामलों में, क्लाइंट लाइब्रेरी से जनरेट किए गए लॉग से, आपकी समस्याओं को हल करने के लिए ज़रूरी जानकारी मिलती है. सहायता फ़ोरम/उपनामों से संपर्क करते समय, आपके पास लॉग उपलब्ध कराने का विकल्प होता है. इनमें, डिफ़ॉल्ट रूप से संवेदनशील जानकारी छिपी होती है. इसके अलावा, सिर्फ़ अनुरोध आईडी शेयर किया जा सकता है. यह आईडी, जवाब के लॉग के हिस्से के तौर पर लॉग किया जाता है.

अगर आपको अनुरोध आईडी खुद कैप्चर करना है, तो इनमें से किसी एक तरीके का इस्तेमाल करें:

सामान्य एपीआई कॉल की मदद से डेटा निकालना

सामान्य यूनीऐरी कॉल से अनुरोध आईडी कैप्चर करने के लिए, TrailingMetadataHandler के साथ कस्टम CallSetting का इस्तेमाल किया जा सकता है.

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

स्ट्रीमिंग एपीआई कॉल की मदद से डेटा निकालना

स्ट्रीमिंग एपीआई कॉल के लिए, अनुरोध आईडी को रिस्पॉन्स ऑब्जेक्ट के हिस्से के तौर पर दिखाया जाता है. उदाहरण के लिए, SearchStream कॉल के लिए अनुरोध आईडी इस तरह पाया जा सकता है:

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V19.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 अपवाद के हिस्से के तौर पर दिखाया जाता है.

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

बेहतर लॉगिंग

अगर एपीआई लॉग से आपको ज़रूरत के मुताबिक जानकारी नहीं मिलती है, तो gRPC लेवल पर ज़्यादा लो लेवल लॉगिंग चालू करें. ध्यान रखें कि आउटपुट काफ़ी बड़ा हो सकता है. gRPC लॉग, stderr में लिखे जाते हैं. हालांकि, नीचे दिए गए तरीके से अपना लॉगर अटैच किया जा सकता है. इस्तेमाल किए जा सकने वाले एनवायरमेंट वैरिएबल.

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

App.config (लेगसी) का इस्तेमाल करके TraceListener कॉन्फ़िगरेशन

अगर आपका ऐप्लिकेशन .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>