การกำหนดค่า

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

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

หมายเหตุ: ตั้งค่าฟิลด์ grpcChannelCredential, unaryMiddlewares, streamingMiddlewares และ grpcInterceptors จากไฟล์การกำหนดค่า หรือสตริงไม่ได้ แต่ตั้งค่าแบบไดนามิกได้เท่านั้น

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

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

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

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

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 เท่านั้น