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

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

अपवाद

एपीआई कॉल पूरे न होने पर, अनुरोध आईडी को 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 कोर टारगेट के लिए बनाए गए ऐप्लिकेशन के साथ काम नहीं करता.

इस सुविधा का इस्तेमाल करने के लिए, आपको अपनी कॉन्फ़िगरेशन फ़ाइल में ये बदलाव करने होंगे:

  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>