กําหนดค่าการบันทึก

ไลบรารีของไคลเอ็นต์ .NET จะบันทึกคำขอ คำตอบ และข้อความสรุปที่ส่งไปยัง Google Ads API โดยจะเขียนบันทึกไปยังTraceListenerที่กำหนดเองหรือไปยังอินสแตนซ์ ILogger ที่กำหนดเองก็ได้

TraceListener

คุณเปิดใช้การบันทึกไปยัง TraceListener ได้โดยการเพิ่มบรรทัดต่อไปนี้ในเมธอด Main ก่อนที่จะเรียก API

using Google.Ads.GoogleAds.Util;

// Detailed logs.
TraceUtilities.Configure(
    TraceUtilities.DETAILED_REQUEST_LOGS_SOURCE,
    "logs/details.log",
    System.Diagnostics.SourceLevels.All);

// Summary logs.
TraceUtilities.Configure(
    TraceUtilities.SUMMARY_REQUEST_LOGS_SOURCE,
    "logs/summary.log",
    System.Diagnostics.SourceLevels.All);

ILogger

หากคุณใช้ ILogger สำหรับบันทึกแอปพลิเคชันอยู่แล้ว โซลูชันนี้จะช่วยให้คุณผสานรวมบันทึก Google Ads API เข้ากับโครงสร้างพื้นฐานการบันทึกที่มีอยู่ได้

ก่อนอื่น ให้สร้าง LoggerFactory หรือหากมีอยู่แล้ว ให้เพิ่มตัวกรอง สำหรับบันทึก Google Ads API ดังนี้

var loggerFactory = LoggerFactory.Create(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);

โซลูชันนี้ช่วยให้คุณผสานรวมบันทึกคำขอ API และการตอบกลับของ Google Ads API เข้ากับ เฟรมเวิร์กการบันทึกที่มีอยู่ เช่น Log4Net, NLog และ Serilog

ระดับบันทึก

โดยไลบรารีจะบันทึกเหตุการณ์ประเภทต่างๆ ในระดับบันทึกที่แตกต่างกัน ดังนี้

• การตอบกลับจาก API ที่สำเร็จ: ระบบจะบันทึกข้อมูลสรุปไว้ที่ INFO และบันทึกคำขอและการตอบกลับทั้งหมดไว้ที่ DEBUG
• การตอบกลับข้อผิดพลาดของ API: ระบบจะบันทึกข้อความสรุปไว้ที่ WARN ส่วนคำขอและการตอบกลับทั้งหมดจะบันทึกไว้ที่ INFO
• ไม่สำเร็จบางส่วน: บันทึกที่ DEBUG

รหัสคำขอ

ในกรณีส่วนใหญ่ บันทึกที่สร้างโดยไลบรารีของไคลเอ็นต์จะมีรายละเอียดเพียงพอ ที่จะใช้แก้ปัญหา เมื่อติดต่อทีมสนับสนุน โปรดระบุบันทึก (ซึ่งจะ ปกปิดช่องการตรวจสอบสิทธิ์ที่ละเอียดอ่อนโดยค่าเริ่มต้น) หรือแชร์รหัสคำขอ ซึ่งจะบันทึกเป็นส่วนหนึ่งของบันทึกการตอบกลับ

หากต้องการบันทึกรหัสคำขอแบบเป็นโปรแกรม ให้ใช้วิธีใดวิธีหนึ่งต่อไปนี้

แยกจากการเรียก API แบบเอกภาคีทั่วไป

คุณสามารถใช้ CallSettings ที่กำหนดเองกับ TrailingMetadataHandler เพื่อบันทึก รหัสคำขอจากการเรียกแบบเอกภาคปกติได้โดยทำดังนี้

CallSettings callSettings = CallSettings.FromTrailingMetadataHandler(
    metadata =>
    {
        // Extract and log the request ID from the trailing metadata.
        string requestId = metadata.Get("request-id")?.Value;
        Console.WriteLine($"Request ID: {requestId}");
    });
// Add the campaigns.
MutateCampaignsResponse retVal = campaignService.MutateCampaigns(
    customerId.ToString(), operations.ToArray(), callSettings);

ดึงข้อมูลจากการเรียก API การสตรีม

ระบบจะแสดงรหัสคำขอเป็นส่วนหนึ่งของออบเจ็กต์การตอบกลับสำหรับการเรียก Streaming API เช่น คุณสามารถรับรหัสคำขอสำหรับการเรียกใช้ SearchStream ได้ดังนี้

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V25.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,
    (SearchGoogleAdsStreamResponse resp) =>
    {
        // Extract the request ID from the response.
        string requestId = resp.RequestId;
        Console.WriteLine($"Request ID: {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;
    Console.WriteLine($"Failed Request ID: {requestId}");
}

กำหนดค่าการบันทึกขั้นสูง

หากบันทึก API ไม่ให้รายละเอียดเพียงพอ ให้เปิดใช้การบันทึกระดับล่างที่ ระดับการรับส่ง gRPC โปรดทราบว่าเอาต์พุตอาจมีจำนวนมาก

เมื่อใช้การรับส่ง Grpc.Net.Client เริ่มต้น ให้กําหนดค่าบันทึกระดับการรับส่งผ่านผู้ให้บริการ ILogger ของ .NET โดยการเพิ่มตัวกรองสําหรับหมวดหมู่ Grpc (เช่น builder.AddFilter("Grpc", LogLevel.Debug))

หากคุณใช้Grpc.Coreการรับส่งข้อมูล (UseGrpcCore = true) แบบเดิม gRPC จะเขียนบันทึกไปยัง stderr โดยค่าเริ่มต้น หรือคุณจะแนบเครื่องบันทึกของคุณเองตามที่แสดงในตัวอย่างต่อไปนี้ก็ได้ ดูรายละเอียดเพิ่มเติมได้ที่ตัวแปรสภาพแวดล้อม gRPC ที่รองรับ

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 สมัยใหม่

หากต้องการใช้ฟีเจอร์นี้ ให้เพิ่มการเปลี่ยนแปลงต่อไปนี้ลงในไฟล์กำหนดค่า

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 a 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 a 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 Google Ads .NET libraries. The default level is set to
            Warning. To disable all messages, set this value to Off. -->
       <add name="GoogleAds.DeprecationMessages" value="Warning" />
       <!-- Use this trace switch to control the detailed request logs written
            by Google 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 Google 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>