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

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

ध्यान दें कि TraceListeners.Configure को हर ऐप्लिकेशन के लाइफ़साइकल में सिर्फ़ एक बार कॉल किया जाना चाहिए. ऐसा इसलिए, क्योंकि यह TraceListener बनाता है, जिसका इस्तेमाल ऐप्लिकेशन के सभी एपीआई अनुरोधों में अपने-आप किया जाएगा. आपको हर एपीआई अनुरोध के लिए नया TraceListener बनाने की ज़रूरत नहीं है.

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.V21.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 फ़्रेमवर्क के लिए बनाया गया है, तो अपने ऐप्लिकेशन की 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>