الإعدادات

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

التحقّق من الإعدادات

يتم التحقق من إعدادات التهيئة عند إنشاء مثيل للعملاء والاستثناءات عندما تكون غير صالحة. وفي ما يلي القواعد:

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".