الإعدادات

توفّر مكتبة برامج لغة 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: الرمز المميز للمطوِّر للدخول إلى واجهة برمجة التطبيقات.
    • [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.