בקשות, תגובות והודעות סיכום שנשלחו ל-Google Ads API ביומן הלקוח. אפשר לכתוב את היומנים למכונה TraceListener
מותאמת אישית או למכונה מותאמת אישית של ILogger
.
TraceListener
אפשר להפעיל את הרישום ל-TraceListener
על ידי הוספת השורה הבאה ל-method 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
כדי לתעד מזהי בקשות מקריאות רגילות של Unary.
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.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
בכל פעם שקריאה ל-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.
כדי להשתמש בתכונה הזו צריך להוסיף את השינויים הבאים לקובץ התצורה:
צריך להוסיף את קטע הקוד הבא מתחת לקטע
<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>
צריך להוסיף את קטע הקוד הבא מתחת לקטע
<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>