การกำหนดค่า

ไลบรารีของไคลเอ็นต์ 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')
    // ...
    ->build();

$googleAdsClient = (new GoogleAdsClientBuilder())
    ->withOAuth2Credential($oAuth2Credential)
    ->withDeveloperToken('INSERT_DEVELOPER_TOKEN_HERE')
    // ...
    ->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] impersonatedEmail: อีเมลที่จะแอบอ้างเป็นบุคคลอื่น
  2. ช่องที่ใช้โดย GoogleAdsClientBuilder:
    • [GOOGLE_ADS] developerToken: โทเค็นของนักพัฒนาสำหรับการเข้าถึง API
    • [GOOGLE_ADS] loginCustomerId: รหัสของลูกค้าที่ได้รับอนุญาตที่จะใช้ในคำขอ
    • [GOOGLE_ADS] linkedCustomerId: รหัสลูกค้าที่ลิงก์
    • [LOGGING] logFilePath: เส้นทางไฟล์สำหรับการบันทึก
    • [LOGGING] logLevel: ระดับการบันทึก
    • [CONNECTION] proxy: URL ของพร็อกซีเซิร์ฟเวอร์ที่ใช้สำหรับการเชื่อมต่ออินเทอร์เน็ต
    • [CONNECTION] transport: การขนส่ง
    • [CONNECTION] grpcChannelIsSecure: ช่อง gRPC ปลอดภัยหรือไม่
    • [CONNECTION] grpcChannelCredential: ข้อมูลเข้าสู่ระบบของช่อง gRPC
    • [CONNECTION] unaryMiddlewares: มิดเดิลแวร์เอกนารี
    • [CONNECTION] streamingMiddlewares: มิดเดิลแวร์สตรีมมิง
    • [CONNECTION] grpcInterceptors: ตัวตรวจจับของ gRPC
  3. [GAPIC] useGapicV2Source: จะใช้ซอร์สโค้ด GAPIC v2 เมื่อสร้างไคลเอ็นต์บริการหรือไม่

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

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

  1. ต้องไม่ตั้งค่าช่อง [OAUTH2] สำหรับทั้งโหมดแอปพลิเคชันและโหมดบัญชีบริการพร้อมกัน
  2. ต้องตั้งค่า [OAUTH2] jsonKeyFilePath และ [OAUTH2] scopes เมื่อใช้โหมดบัญชีบริการ
  3. ต้องตั้งค่า [OAUTH2] clientId, [OAUTH2] clientSecret และ [OAUTH2] refreshToken เมื่อใช้โหมดแอปพลิเคชัน
  4. ต้องตั้งค่า [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
  11. ตั้งค่า [CONNECTION] grpcChannelCredential ได้เมื่อตั้งค่า [CONNECTION] transport เป็น grpc เท่านั้น
  12. ตั้งค่า [CONNECTION] grpcChannelCredential ได้เฉพาะเมื่อ [CONNECTION] grpcChannelIsSecure คือ true