التهيئة

توفِّر مكتبة برامج 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: رقم تعريف الشخص المعتمد customer لاستخدامه في الطلب.
   • [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".