רישום

ספריית הלקוח של ‎ .NET מתעדת ביומן בקשות, תגובות ומסרים של סיכום שנשלחים ל-Google Ads API. אפשר לכתוב את היומנים ב-TraceListener בהתאמה אישית, או במכונה בהתאמה אישית של ILogger.

TraceListener

כדי להפעיל את הרישום ביומן ב-TraceListener, מוסיפים את השורה הבאה לשיטה Main לפני שמבצעים קריאות ל-API.

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.

רמות יומן

הספרייה מתעדת סוגים שונים של אירועים ברמות יומן שונות. בתגובה מוצלחת של API, הסיכום מתועד ב-INFO, והבקשה המלאה והתשובות מתועדות ב-DEBUG.

בבקשה שמובילה לשגיאת API, הודעת הסיכום מתועדת ביומן ב-WARN, והבקשה והתגובה המלאות מתועדות ביומן ב-INFO.

כשלים חלקיים מתועדים ביומן ב-DEBUG.

מזהה בקשה

ברוב המקרים, היומנים שנוצרים על ידי ספריית הלקוח מספקים פרטים מספיקים לפתרון הבעיות. כשאתם פונים לפורום התמיכה או לאימייל החלופי, אתם יכולים לספק את היומנים (שבהם מידע רגיש מושמט כברירת מחדל) או פשוט לשתף את מזהה הבקשה (שמתועד ביומן התשובות).

אם אתם מעדיפים לתעד את מזהה הבקשה בעצמכם, תוכלו להשתמש באחת מהגישות הבאות:

חילוץ באמצעות קריאות רגילות ל-API

אפשר להשתמש ב-CallSetting בהתאמה אישית עם TrailingMetadataHandler כדי לתעד מזהי בקשות מבקשות יוניאריות רגילות.

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

חילוץ באמצעות קריאות API בסטרימינג

מזהה הבקשה מוחזר כחלק מאובייקט התגובה בקריאות API בסטרימינג. לדוגמה, אפשר לקבל את מזהה הבקשה של קריאה ל-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 בכל פעם שקריאה ל-API נכשלת.

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

רישום ביומן מתקדם

אם יומן ה-API לא מספק מספיק פרטים, אפשר להפעיל רישום ביומן ברמה נמוכה יותר ברמת ה-gRPC. חשוב לזכור שהפלט יכול להיות גדול. יומני ה-gRPC נכתבים ב-stderr, אבל אפשר לצרף יומן משלכם, כפי שמתואר בהמשך. משתני סביבה נתמכים

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

הגדרת TraceListener באמצעות App.config (מדור קודם)

אם האפליקציה שלכם נוצרה ליעד של ‎ .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>