การกำหนดค่า

ไลบรารีไคลเอ็นต์ 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 เท่านั้น