การกำหนดค่า

ไลบรารีของไคลเอ็นต์ PHP ของ Google Ads API มีการตั้งค่าการกำหนดค่าหลายอย่างที่คุณ ใช้เพื่อปรับแต่งลักษณะการทำงานของไลบรารีได้

ไฟล์การกำหนดค่า

คุณจัดเก็บการตั้งค่าการกำหนดค่าส่วนใหญ่เหล่านี้ไว้ในไฟล์การกำหนดค่า INI และใช้เมื่อสร้างอินสแตนซ์ไคลเอ็นต์ได้ เช่น google_ads_php.ini

ทั้งเครื่องมือสร้างข้อมูลเข้าสู่ระบบและเครื่องมือสร้างไคลเอ็นต์มีเมธอด fromFile สำหรับโหลด การตั้งค่าจากไฟล์ดังกล่าว

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile('/path/to/google_ads_php.ini')
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

หากไม่มีเส้นทางการกำหนดค่าที่ระบุเป็นอาร์กิวเมนต์ fromFile เมธอดจะโหลดจากเส้นทางการกำหนดค่าเริ่มต้น ซึ่งได้แก่

1. ค่าของตัวแปรสภาพแวดล้อมที่ชื่อ GOOGLE_ADS_CONFIGURATION_FILE_PATH หากมีการตั้งค่า
2. หรือไฟล์ google_ads_php.ini ในไดเรกทอรี HOME

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->fromFile()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->fromFile()
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

การกำหนดค่าแบบไดนามิก

คุณตั้งค่าการกำหนดค่าเหล่านี้แบบไดนามิกได้เมื่อสร้างอินสแตนซ์ของไคลเอ็นต์

$oAuth2Credential = (new OAuth2TokenBuilder())
    ->withClientId('INSERT_CLIENT_ID_HERE')
    ->withClientSecret('INSERT_CLIENT_SECRET_HERE')
    ->withRefreshToken('INSERT_REFRESH_TOKEN_HERE')
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->build();

ตัวแปรสภาพแวดล้อมการกำหนดค่า

คุณตั้งค่าการกำหนดค่าบางอย่างจากตัวแปรสภาพแวดล้อมได้เมื่อ สร้างอินสแตนซ์ไคลเอ็นต์ (ดูตัวแปรสภาพแวดล้อมมาตรฐาน)

ทั้งเครื่องมือสร้างข้อมูลเข้าสู่ระบบและไคลเอ็นต์มีเมธอด fromEnvironmentVariables เพื่อโหลดการตั้งค่าจากตัวแปรสภาพแวดล้อม

$oAuth2Credential = (new OAuth2TokenBuilder())
    // ...
    ->fromEnvironmentVariables()
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    // ...
    ->fromEnvironmentVariables()
    ->build();

ฟิลด์การกำหนดค่า

การตั้งค่าการกำหนดค่ารองรับฟิลด์หลายรายการที่จัดระเบียบไว้ในหมวดหมู่ต่างๆ ดังนี้

1. ฟิลด์ที่ OAuth2TokenBuilder ใช้
   • โหมดแอปพลิเคชัน
     • [OAUTH2] clientId: รหัสไคลเอ็นต์ OAuth2
     • [OAUTH2] clientSecret: รหัสลับไคลเอ็นต์ OAuth2
     • [OAUTH2] refreshToken: โทเค็นการรีเฟรช OAuth2
   • โหมดบัญชีบริการ
     • [OAUTH2] jsonKeyFilePath: เส้นทางคีย์ JSON
     • [OAUTH2] scopes: ขอบเขต OAuth2 (ค่าเริ่มต้นคือ https://www.googleapis.com/auth/adwords ใน v32.1.0 ขึ้นไป ต้องระบุในเวอร์ชันก่อน v32.1.0 หรือเมื่อใช้ขอบเขตที่กำหนดเอง fromEnvironmentVariables() จะไม่อ่านจากตัวแปรสภาพแวดล้อม)
     • [OAUTH2] impersonatedEmail: อีเมลที่ไม่บังคับเพื่อใช้แอบอ้างตัว เมื่อใช้การมอบสิทธิ์ระดับโดเมนของ Google Workspace
   • โหมดข้อมูลรับรองเริ่มต้นของแอปพลิเคชัน
     • เมื่อไม่ได้ตั้งค่าทั้งฟิลด์โหมดแอปพลิเคชันและโหมดบัญชีบริการ OAuth2TokenBuilder จะกลับไปใช้ข้อมูลเข้าสู่ระบบเริ่มต้นของแอปพลิเคชัน (ADC) โดยอัตโนมัติ
2. ฟิลด์ที่ GoogleAdsClientBuilder ใช้
   • [GOOGLE_ADS] developerToken: (หยุดให้บริการในวันที่ 9 กันยายน 2026) โทเค็นนักพัฒนาซอฟต์แวร์ Google Ads API ไม่บังคับ เซิร์ฟเวอร์ API จะไม่สนใจพารามิเตอร์นี้ไม่ว่าไลบรารีของไคลเอ็นต์จะเป็นเวอร์ชันใด และจะถูกปฏิเสธใน Google Ads API เวอร์ชันหลักในอนาคต
     • v35.0.0 ขึ้นไป: ไม่จำเป็นเมื่อเริ่มต้นไคลเอ็นต์ (GoogleAdsClientBuilder นำการตรวจสอบโทเค็นของนักพัฒนาฝั่งไคลเอ็นต์ในเครื่องออก )
     • เวอร์ชันก่อนหน้า v35.0.0: ต้องมีการตรวจสอบการกำหนดค่าฝั่งไคลเอ็นต์ในเครื่อง
   • [GOOGLE_ADS] loginCustomerId: รหัสของลูกค้าที่ได้รับอนุญาตเพื่อใช้ในคำขอ
   • [GOOGLE_ADS] linkedCustomerId: รหัสลูกค้าที่ลิงก์
   • [GOOGLE_ADS] endpoint: อุปกรณ์ปลายทางเซิร์ฟเวอร์ Google Ads API ทางเลือกที่ไม่บังคับ
   • [LOGGING] logFilePath: เส้นทางสำหรับเอาต์พุตการบันทึก
   • [LOGGING] logLevel: ระดับการบันทึก
   • [CONNECTION] proxy: URL ของพร็อกซีเซิร์ฟเวอร์ที่ใช้สำหรับการเชื่อมต่ออินเทอร์เน็ต
   • [CONNECTION] transport: การรับส่งเครือข่าย (grpc หรือ rest)
   • [CONNECTION] grpcChannelIsSecure: ช่อง gRPC ปลอดภัยหรือไม่
   • [CONNECTION] grpcChannelCredential: ข้อมูลเข้าสู่ระบบของช่อง gRPC
   • [CONNECTION] unaryMiddlewares: มิดเดิลแวร์แบบเอกภาค
   • [CONNECTION] streamingMiddlewares: มิดเดิลแวร์การสตรีม
   • [CONNECTION] grpcInterceptors: ตัวสกัดกั้น gRPC

การตรวจสอบการกำหนดค่า

ระบบจะตรวจสอบการตั้งค่าการกำหนดค่าเมื่อสร้างอินสแตนซ์ของไคลเอ็นต์และข้อยกเว้น จะเกิดขึ้นเมื่อไม่ถูกต้อง กฎการตรวจสอบมีดังนี้

1. ต้องไม่ตั้งค่าฟิลด์ [OAUTH2] ทั้งโหมดแอปพลิเคชันและโหมดบัญชีบริการพร้อมกัน
2. ต้องตั้งค่า [OAUTH2] jsonKeyFilePath เมื่อใช้โหมดบัญชีบริการ (ใน เวอร์ชันก่อน v32.1.0 จะต้องตั้งค่า [OAUTH2] scopes ด้วย ใน v32.1.0 ขึ้นไป scopes จะเป็นค่าเริ่มต้น https://www.googleapis.com/auth/adwords)
3. ต้องตั้งค่า [OAUTH2] clientId, [OAUTH2] clientSecret และ [OAUTH2] refreshToken เมื่อใช้โหมดแอปพลิเคชัน
4. ในเวอร์ชันก่อน v35.0.0 ระบบจะตรวจสอบ [GOOGLE_ADS] developerToken โดย การตรวจสอบฝั่งไคลเอ็นต์ในเครื่อง (ใน v35.0.0 และเวอร์ชันที่ใหม่กว่า ไม่จำเป็นต้องมี [GOOGLE_ADS] developerToken)
5. หากตั้งค่า [GOOGLE_ADS] loginCustomerId และ [GOOGLE_ADS] linkedCustomerId ต้องเป็นตัวเลขจำนวนบวก
6. หากตั้งค่าไว้ [CONNECTION] proxy ต้องเป็น URL ที่ถูกต้อง (ดูFILTER_VALIDATE_URL ตัวกรอง)
7. หากตั้งค่าไว้ [LOGGING] logLevel ต้องเป็นระดับบันทึก PSR ที่ถูกต้องใน ตัวพิมพ์ใหญ่ เช่น INFO
8. หากตั้งค่า [CONNECTION] transport ต้องเป็น grpc หรือ rest
9. หากตั้งค่า [CONNECTION] transport เป็น grpc สภาพแวดล้อมต้องรองรับการรับส่ง gRPC (ดูคู่มือการรับส่ง)
10. [CONNECTION] grpcChannelIsSecure ต้องเป็น true เมื่อไม่ได้ตั้งค่า [CONNECTION] transport เป็น grpc (การเชื่อมต่อ REST ต้องใช้ HTTPS เสมอ)
11. คุณจะตั้งค่า [CONNECTION] grpcChannelCredential ได้ก็ต่อเมื่อตั้งค่า [CONNECTION] transport เป็น grpc เท่านั้น
12. [CONNECTION] grpcChannelCredential จะตั้งค่าได้ก็ต่อเมื่อ [CONNECTION] grpcChannelIsSecure เป็น true เท่านั้น