ไลบรารีของไคลเอ็นต์ Google Ads API มีการตั้งค่าการกำหนดค่าหลายอย่างที่คุณใช้ในการปรับแต่งลักษณะการทำงานของไลบรารีได้
กำหนดค่าไลบรารีขณะรันไทม์
วิธีที่แนะนำในการกำหนดค่าไลบรารีของไคลเอ็นต์คือการเริ่มต้นออบเจ็กต์ GoogleAdsConfig
ระหว่างรันไทม์
GoogleAdsConfig config = new GoogleAdsConfig()
{
DeveloperToken = "******",
OAuth2Mode = "APPLICATION",
OAuth2ClientId = "******.apps.googleusercontent.com",
OAuth2ClientSecret = "******",
OAuth2RefreshToken = "******"
};
GoogleAdsClient client = new GoogleAdsClient(config);
ตัวเลือกการกำหนดค่าสำรอง
นอกจากนี้เรายังมีตัวเลือกเพิ่มเติมในการกำหนดค่าไลบรารีของไคลเอ็นต์อีกด้วย หากต้องการเปิดใช้ ให้เพิ่มการอ้างอิง Nuget ในแพ็กเกจ Google.Ads.GoogleAds.Extensions
ในโปรเจ็กต์
หากคุณใช้ตัวเลือกใดตัวเลือกหนึ่งเหล่านี้ ระบบจะไม่ระบบเลือกการตั้งค่าการกำหนดค่าโดยอัตโนมัติ คุณควรโหลดการตั้งค่าไว้อย่างชัดแจ้งดังที่แสดงด้านล่าง
กำหนดค่าโดยใช้ App.config
การตั้งค่าทั้งหมดเฉพาะสำหรับ Google Ads API
จะจัดเก็บอยู่ในโหนด GoogleAdsApi
ของไฟล์ App.config
การกำหนดค่าทั่วไป App.config
มีดังนี้
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler" />
</configSections>
<GoogleAdsApi>
<!-- Set the service timeout in milliseconds. -->
<add key="Timeout" value="2000" />
<!-- Proxy settings for library. -->
<add key="ProxyServer" value="http://localhost:8888"/>
<add key="ProxyUser" value=""/>
<add key="ProxyPassword" value=""/>
<add key="ProxyDomain" value=""/>
<!-- API-specific settings -->
<add key="DeveloperToken" value="******"/>
<!-- OAuth2 settings -->
<add key = "OAuth2Mode" value="APPLICATION"/>
<add key = "OAuth2ClientId" value = "******.apps.googleusercontent.com" />
<add key = "OAuth2ClientSecret" value = "******" />
<add key = "OAuth2RefreshToken" value = "******" />
</GoogleAdsApi>
<startup>
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" />
</startup>
</configuration>
หากต้องการโหลดการตั้งค่าการกำหนดค่าจากไฟล์ App.config
ให้เรียกใช้เมธอด LoadFromDefaultAppConfigSection
ในออบเจ็กต์ GoogleAdsConfig
ดังนี้
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromDefaultAppConfigSection();
GoogleAdsClient client = new GoogleAdsClient(config);
ระบุไฟล์ App.config แยกต่างหาก
หากไม่ต้องการให้ App.config
รกตา คุณย้ายการกำหนดค่าเฉพาะไลบรารีไปยังไฟล์การกำหนดค่าของตัวเองโดยใช้พร็อพเพอร์ตี้ configSource
ได้
ขั้นตอนที่ 1: ระบุ configSource ใน App.config ของคุณ
แก้ไข App.config
ให้มีลักษณะเช่นนี้
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="GoogleAdsApi" type="System.Configuration.DictionarySectionHandler"/>
</configSections>
<GoogleAdsApi configSource="GoogleAdsApi.config"/>
...
</configuration>
ขั้นตอนที่ 2: ระบุเนื้อหาของไฟล์การกำหนดค่า
จากนั้นให้สร้างไฟล์การกำหนดค่าอีกไฟล์โดยใช้ชื่อที่คุณระบุใน configSource
และย้ายโหนดการกำหนดค่าจาก App.config
ไปยังไฟล์นี้
<?xml version="1.0" encoding="utf-8" ?>
<GoogleAdsApi>
... More settings.
</GoogleAdsApi>
ขั้นตอนที่ 3: แก้ไขกฎบิลด์ใน csproj ของคุณ
สุดท้าย ใส่ไฟล์การกำหนดค่าใหม่ในโปรเจ็กต์ของคุณ เปลี่ยนคุณสมบัติของไฟล์เป็นคัดลอกไปยังโฟลเดอร์เอาต์พุตเสมอ
ตอนนี้ให้สร้างและเรียกใช้โปรเจ็กต์ แอปพลิเคชันจะเริ่มรับค่าจากไฟล์การกำหนดค่าใหม่
การกำหนดค่าโดยใช้ไฟล์ JSON ที่กำหนดเอง
คุณใช้อินสแตนซ์ IConfigurationRoot
เพื่อกำหนดค่าไลบรารีของไคลเอ็นต์ได้
สร้างไฟล์ JSON
สร้างไฟล์ JSON ชื่อ GoogleAdsApi.json
ที่มีโครงสร้างคล้ายกับไฟล์ App.config
{
"Timeout": "2000",
"ProxyServer": "http://localhost:8888",
"ProxyUser": "",
"ProxyPassword": "",
"ProxyDomain": "",
"DeveloperToken": "******",
"OAuth2Mode": "APPLICATION",
"OAuth2ClientId": "******.apps.googleusercontent.com",
"OAuth2ClientSecret": "******",
"OAuth2RefreshToken": "******",
}
โหลดการกำหนดค่า
จากนั้น โหลดไฟล์ JSON ลงใน IConfigurationRoot
ConfigurationBuilder builder = new ConfigurationBuilder()
.SetBasePath(Directory.GetCurrentDirectory())
.AddJsonFile("GoogleAdsApi.json");
IConfigurationRoot configRoot = builder.Build();
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationRoot(configRoot);
GoogleAdsClient client = new GoogleAdsClient(config);
การกำหนดค่าโดยใช้ settings.json
กระบวนการในส่วนนี้คล้ายกับการใช้ JSON ที่กำหนดเอง เพียงแต่ว่าคีย์ควรอยู่ในส่วนชื่อ GoogleAdsApi
:
{
"GoogleAdsApi":
{
"DeveloperToken": "******",
"OAuth2Mode": "APPLICATION",
"OAuth2ClientId": "******.apps.googleusercontent.com",
"OAuth2ClientSecret": "******",
"OAuth2RefreshToken": "******",
...
}
// More settings...
}
ถัดไป คุณสามารถใช้อินสแตนซ์ IConfiguration
ในหน้าเว็บได้ ดังนี้
IConfigurationSection section = Configuration.GetSection("GoogleAdsApi");
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromConfigurationSection(section);
GoogleAdsClient client = new GoogleAdsClient(config);
การกำหนดค่าโดยใช้ตัวแปรสภาพแวดล้อม
นอกจากนี้คุณยังเริ่มต้น GoogleAdsClient
โดยใช้ตัวแปรสภาพแวดล้อมได้ด้วย
GoogleAdsConfig config = new GoogleAdsConfig();
config.LoadFromEnvironmentVariables();
GoogleAdsClient client = new GoogleAdsClient(config);
ดูรายการตัวแปรสภาพแวดล้อมที่รองรับทั้งหมด
ช่องการกําหนดค่า
ต่อไปนี้คือรายการการตั้งค่าที่ไลบรารี .NET ของ Google Ads รองรับ
การตั้งค่าการเชื่อมต่อ
Timeout
: ใช้คีย์นี้เพื่อตั้งค่าระยะหมดเวลาของบริการเป็นมิลลิวินาที ค่าเริ่มต้นจะกำหนดตามการตั้งค่าmethod_config/timeout
ใน googleads_grpc_service_config.json ตั้งค่าต่ำลงหากคุณต้องการบังคับใช้ขีดจำกัดเวลาที่สั้นลงสำหรับเวลาสูงสุดสำหรับการเรียก API คุณกำหนดระยะหมดเวลาเป็น 2 ชั่วโมงขึ้นไปได้ แต่ API อาจยังคงหมดเวลาคำขอที่ใช้เวลานานมากและแสดงผลข้อผิดพลาดDEADLINE_EXCEEDED
ProxyServer
: ตั้งค่านี้เป็น URL ของพร็อกซีเซิร์ฟเวอร์ HTTP หากคุณใช้พร็อกซีเพื่อเชื่อมต่ออินเทอร์เน็ตProxyUser
: ตั้งค่าเป็นชื่อผู้ใช้ที่คุณต้องการเพื่อตรวจสอบสิทธิ์กับพร็อกซีเซิร์ฟเวอร์ เว้นว่างไว้ถ้าไม่ต้องการชื่อผู้ใช้ProxyPassword
: ตั้งค่านี้เป็นรหัสผ่านของProxyUser
หากคุณกำหนดค่าสำหรับProxyUser
ProxyDomain
: ตั้งค่าเป็นโดเมนสำหรับProxyUser
หากพร็อกซีเซิร์ฟเวอร์กำหนดให้ตั้งค่าMaxReceiveMessageLengthInBytes
: ใช้การตั้งค่านี้เพื่อเพิ่มขนาดสูงสุดของการตอบกลับจาก API ที่ไลบรารีของไคลเอ็นต์จัดการได้ ค่าเริ่มต้นคือ 64 MBMaxMetadataSizeInBytes
: ใช้การตั้งค่านี้เพื่อเพิ่มขนาดสูงสุดของการตอบกลับข้อผิดพลาด API ที่ไลบรารีของไคลเอ็นต์จัดการได้ ค่าเริ่มต้นคือ 16 MB
ปรับการตั้งค่า
MaxReceiveMessageLengthInBytes
และMaxMetadataSizeInBytes
เพื่อแก้ไขข้อผิดพลาดResourceExhausted
บางอย่าง การตั้งค่าเหล่านี้จะแก้ไขข้อผิดพลาดของแบบฟอร์มStatus(StatusCode="ResourceExhausted",Detail="Received message larger than max (423184132 versus 67108864)"
ในตัวอย่างนี้ ข้อผิดพลาดเกิดจากขนาดข้อความ (
423184132 bytes
) ใหญ่กว่าที่ไลบรารีจัดการได้ (67108864 bytes
) เพิ่มMaxReceiveMessageLengthInBytes
เป็น500000000
เพื่อหลีกเลี่ยงข้อผิดพลาดนี้โปรดทราบว่าข้อผิดพลาดยังบ่งชี้ว่าโค้ดได้จัดการกับออบเจ็กต์ Response ที่มีขนาดใหญ่มาก (เช่น
SearchGoogleAdsResponse
ขนาดใหญ่) ซึ่งอาจส่งผลกระทบด้านประสิทธิภาพสำหรับโค้ดของคุณเนื่องจากฮีปของออบเจ็กต์ขนาดใหญ่ของ .NET หากเรื่องนี้กลายเป็นข้อกังวลด้านประสิทธิภาพ คุณอาจต้องสำรวจวิธีจัดระเบียบการเรียก API ใหม่หรือออกแบบส่วนต่างๆ ของแอปใหม่
การตั้งค่า OAuth2
เมื่อใช้ OAuth2 เพื่อให้สิทธิ์การเรียกกับเซิร์ฟเวอร์ Google Ads API คุณควรตั้งค่าคีย์การกำหนดค่าต่อไปนี้
AuthorizationMethod
: ตั้งค่าเป็นOAuth2
OAuth2Mode
: ตั้งค่าเป็นAPPLICATION
หรือSERVICE_ACCOUNT
OAuth2ClientId
: ตั้งค่านี้เป็นรหัสไคลเอ็นต์ OAuth2OAuth2ClientSecret
: ตั้งค่านี้เป็นรหัสลับไคลเอ็นต์ OAuth2OAuth2Scope
: ตั้งค่านี้เป็นขอบเขตอื่น หากคุณต้องการให้สิทธิ์โทเค็น OAuth2 สำหรับ API หลายรายการ การตั้งค่านี้เป็นแบบไม่บังคับ
หากใช้ OAuth2Mode == APPLICATION
อยู่ คุณต้องตั้งค่าคีย์การกำหนดค่าเพิ่มเติมต่อไปนี้
OAuth2RefreshToken
: ตั้งค่านี้เป็นโทเค็นการรีเฟรช OAuth2 ที่สร้างไว้ล่วงหน้า หากต้องการใช้โทเค็น OAuth2 ซ้ำ การตั้งค่านี้เป็นแบบไม่บังคับOAuth2RedirectUri
: ตั้งค่านี้เป็น URL เปลี่ยนเส้นทาง OAuth2 การตั้งค่านี้เป็นแบบไม่บังคับ
โปรดดูรายละเอียดเพิ่มเติมในคำแนะนำต่อไปนี้
หากใช้ OAuth2Mode == SERVICE_ACCOUNT
คุณต้องตั้งค่าคีย์การกำหนดค่าเพิ่มเติมต่อไปนี้
OAuth2PrnEmail
: ตั้งค่านี้เป็นอีเมลของบัญชีที่คุณแอบอ้างOAuth2SecretsJsonPath
: ตั้งค่านี้เป็นเส้นทางไฟล์การกำหนดค่า JSON แบบ OAuth2
ดูรายละเอียดเพิ่มเติมได้ที่คำแนะนำขั้นตอนบัญชีบริการ OAuth
การตั้งค่าการเดินทาง
UseGrpcCore
: กำหนดการตั้งค่านี้เป็นtrue
เพื่อใช้ไลบรารีGrpc.Core
เป็นเลเยอร์การรับส่งข้อมูลเบื้องหลัง ดูรายละเอียดเพิ่มเติมในคู่มือการสนับสนุนของ gRPC
การตั้งค่า Google Ads API
การตั้งค่าต่อไปนี้ใช้สำหรับ Google Ads API โดยเฉพาะ
DeveloperToken
: ตั้งค่านี้เป็นโทเค็นของนักพัฒนาของคุณLoginCustomerId
: นี่คือรหัสลูกค้าของลูกค้าที่ได้รับสิทธิ์สำหรับใช้ในคำขอ โดยไม่มีขีดกลางสั้น (-
)LinkedCustomerId
: ส่วนหัวนี้จำเป็นสำหรับเมธอดที่อัปเดตทรัพยากรของเอนทิตีเมื่อได้รับสิทธิ์ผ่านบัญชีที่ลิงก์ใน UI ของ Google Ads (ทรัพยากรAccountLink
ใน Google Ads API) เท่านั้น ตั้งค่านี้เป็นรหัสลูกค้าของผู้ให้บริการข้อมูลที่อัปเดตทรัพยากรของรหัสลูกค้าที่ระบุ ซึ่งควรตั้งค่าโดยไม่มีขีดกลางสั้น (-
) ดูข้อมูลเพิ่มเติมเกี่ยวกับบัญชีที่ลิงก์