רישום

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

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

כדי להשתמש בתכונה הזו צריך להוסיף את השינויים הבאים להגדרות האישיות file:

  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>