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

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

अपवाद

एपीआई कॉल पूरा न होने पर, 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>