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

ไลบรารีของไคลเอ็นต์ .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 แบบ Unary ทั่วไป

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

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 สตรีมมิง

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

// Get the GoogleAdsService.
GoogleAdsServiceClient googleAdsService = client.GetService(
    Services.V26.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>