واجهة برمجة التطبيقات لوقت تشغيل SDK: دليل الدمج

أثناء الاطّلاع على مستندات "مبادرة حماية الخصوصية" على Android، استخدِم الزر معاينة المطوّر أو الزر إصدار تجريبي لاختيار إصدار البرنامج الذي تعمل معه، لأنّ التعليمات قد تختلف.


لمساعدتك في التخطيط للدمج، يوفّر هذا الدليل نظرة شاملة على عملية الدمج، والتي قد تتضمّن ميزات لم يتم تنفيذها بعد في المرحلة الحالية من "مبادرة حماية الخصوصية" على معاينة مطوّري برامج Android. وفي هذه الحالات، يتم توفير إرشادات حول الجدول الزمني.

يعرض الرسم البياني أدناه سير عمل التطوير المحدّث لعملية دمج "وقت تشغيل SDK". يمكن العمل على الأقسام المدرجة في العمود نفسه بشكل متوازٍ. على سبيل المثال، يمكن إجراء تفاعل الشركاء بالتزامن مع إعداد بيئة الاختبار.

مخطّط مرئي لسير عمل دمج وقت تشغيل حزمة تطوير البرامج (SDK)
سير العمل لدمج وقت تشغيل حزمة تطوير البرامج (SDK)

المتطلّبات الأساسية والإعداد

يضمن إكمال هذا القسم المتعلق بما قبل العمل التعرّف جيدًا على "وقت تشغيل SDK" وإعدادك لتحقيق نتائج مفيدة عند استخدام واجهة برمجة التطبيقات في المنظومة المتكاملة لتكنولوجيا الإعلان.

التعرف على واجهة برمجة التطبيقات

ابدأ بقراءة مقترح التصميم للتعرّف على وقت تشغيل SDK وإمكانياته وقيوده.

اقرأ دليل المطوّر لمعرفة كيفية دمج الرمز البرمجي وطلبات واجهة برمجة التطبيقات التي ستحتاجها لحالات الاستخدام.

يُرجى إرسال أي ملاحظات لديك عن المستندات، لا سيّما بخصوص الأسئلة المفتوحة.

اشترِك لتلقّي آخر الأخبار حول "مبادرة حماية الخصوصية" على Android. سيساعدك ذلك في مواكبة الميزات الجديدة التي سيتم تقديمها في الإصدارات المستقبلية.

إعداد نموذج التطبيق واختباره

بعد الاستعداد لبدء عملية الدمج، نزِّل أحدث إصدار من "معاينة المطوِّر" في "استوديو Android" من خلال اتّباع التعليمات الواردة هنا. ويتطلّب هذا الدليل استخدام أحدث إصدار Canary من "استوديو Android". يمكنك تشغيل هذا الإصدار من "استوديو Android" بالتوازي مع الإصدارات الأخرى التي تستخدمها، لذا يُرجى إعلامنا إذا لم يكن هذا الشرط مناسبًا لك.

يمكنك إنشاء الرمز البرمجي ثم تشغيله في نموذج التطبيق للتعرّف على كيفية تثبيت حزمة RE SDK باسم "example-sdk"، وتطبيق العميل الذي يحمل اسم "client-app" على جهاز أو محاكي لضمان تحميل نموذج إعلان.

تكييف حزمة SDK الحالية مع "وقت تشغيل SDK"

الهدف من هذا القسم هو تنفيذ وظائف، مثل عرض إعلان بانر من حزمة تطوير البرامج (SDK) الحالية في حزمة SDK مُفعَّلة في وقت التشغيل، وإعداد التواصل بين التطبيق وحزمة RE SDK.

  • أنشئ أو عدِّل نموذج sdk-example وsdk- ثالثة لتنفيذ الوظائف في حزمة RE SDK.

  • من الناحية الهندسية، ننصحك بإضافة حزمة RE SDK كتبعية إلى حزمة SDK الحالية، والتي تعمل كبرنامج تضمين. يسمح هذا لتطبيق العميل بمواصلة استدعاء حزمة SDK الحالية أو برنامج التضمين مباشرةً. قد توجّه حزمة تطوير البرامج (SDK) برنامج تضمين طلبات البيانات من واجهة برمجة التطبيقات استنادًا إلى الاستراتيجيات المختلفة الموضّحة أدناه.

رسم بياني مرئي لبنية النظام بعد دمج وقت تشغيل حزمة تطوير البرامج (SDK)
بنية النظام بعد دمج وقت تشغيل حزمة تطوير البرامج (SDK)

بالنسبة إلى حالات الاستخدام التي تتطلب بيانات مخصّصة، مثل استدعاء PPAPIs، يجب إنشاء تعريف لواجهة برمجة التطبيقات باستخدام IPC. باستخدام Ipinger وAIDL لنظام Android، أنشئ بروتوكول اتصال لإرسال المعلومات إلى حزمة SDK التي تم تفعيل وقت التشغيل فيها للحصول على أي معلومات أو إجراءات مطلوبة لازمة. يمكنك الاطّلاع على مزيد من المعلومات في دليل مطوّري برامج "وقت تشغيل SDK" هنا.

توجيه عدد الزيارات إلى حزمة تطوير البرامج (SDK) المفعّلة في وقت التشغيل

استراتيجيات التوجيه لطلبات البيانات من واجهة برمجة التطبيقات

استنادًا إلى حالات الاستخدام، ننصحك بتوجيه طلبات حزمة تطوير البرامج (SDK) من خلال مسارَي الرموز الحالية وحزمة تطوير البرامج (SDK) الحالية. سيساعدك هذا في تنفيذ اختبار A/B في الطرح الأولي. لتسهيل عملية دمج التطبيقات، يأخذ هذا الدليل في الاعتبار أنّ التطبيق سيعتمد على RE SDK، وسيتم تفويض المستخدمين إلى حزمة SDK الحالية عند الاقتضاء. ننصحك بأخذ الاستراتيجيات التالية في الاعتبار:

توجيه نسبة مئوية من طلبات حزمة تطوير البرامج (SDK) إلى حزمة RE SDK

يجب توجيه نسبة مئوية فقط من طلبات حزمة تطوير البرامج (SDK) إلى حزمة RE SDK. قم بتوجيه الباقي إلى مسار رمز SDK الحالي. على سبيل المثال، يمكنك استخدام هذه الاستراتيجية للحالات التي تحتاج فيها إلى تلبية طلب حزمة تطوير البرامج (SDK) مرة واحدة، مثل عرض إعلان بانر.

  • يمكنك تعديل حزمة تطوير البرامج (SDK) الحالية لتوجيه نسبة مئوية من الطلبات إلى حزمة RE SDK. على سبيل المثال، يمكنك استخدام علامة ضبط ديناميكية مستندة إلى الخادم، مثل الإعداد عن بُعد في Firebase، للتحكّم في معايير التحويل ديناميكيًا.
  • يجعل هذا أساسًا حزمة SDK الحالية الواجهة الوحيدة التي يتفاعل معها التطبيق ويكون مسؤولًا عن توجيه طلبات SDK إلى RE SDK الجديدة.
  • يجب أن تعيد التعليمة البرمجية توجيه الطلبات التي يمكن معالجتها بواسطة RE SDK فقط. على سبيل المثال، تحقّق من أنّ شكل الإعلان متوافق مع وقت تشغيل حزمة تطوير البرامج (SDK).
  • اتّبِع هذه التعليمات لتعديل رمز حزمة SDK للتفاعل مع حزمة RE SDK.

الرمز الزائف لمنطق التوجيه:

void showAd(AdRequest request) {
  if (request.isBannerAd() && enableRuntimeSdkDiversion() == true) {
    // Call showAd() from the RE SDK
  } else {
    // Call showAd() using the existing SDK code path
  }
}

توجيه جميع طلبات حزم تطوير البرامج (SDK) إلى كلٍّ من حِزم تطوير البرامج (SDK) الحالية وحِزم تطوير البرامج RE

وجِّه جميع طلبات حِزم SDK إلى كلّ من مسار الرمز الحالي لحزمة SDK ومسار رمز RE SDK على الأجهزة المتوافقة. ضع هذه الاستراتيجية في الاعتبار للحالات التي تحتاج فيها إلى ممارسة مسارات التعليمات البرمجية الحالية والجديدة لأغراض المقارنة. على سبيل المثال، مقارنة نتائج تقارير الإحالات الناجحة

  • يُرجى تعديل الرمز لتوجيه جميع طلبات حزمة SDK إلى كل من مسار رمز حزمة SDK الحالي ومسار رمز RE SDK. يجب التأكّد من أنّ الوظيفة متوفّرة في "وقت تشغيل SDK" وأنّه تم تحميل حزمة RE SDK بنجاح.

الرمز الزائف لمنطق التوجيه:

void reportAttribution(AdRequest request) {
  if (request.isFeatureSupported() && isSdkLoaded() == true) {
    // Call RE SDK
  }

  // Call existing SDK code path
}

إصدار تجريبي مغلق لتوزيع حزمة تطوير البرامج (SDK) التي يتم تفعيلها في وقت التشغيل

يقدّم Google Play برنامجًا تجريبيًا مغلقًا لحِزم SDK ذات صلة بالإعلانات، وذلك لمطوّري البرامج الذين يشتركون في البرنامج التجريبي وأجروا اختبارات محلية. إذا كنت مهتمًا بالمشاركة، يمكنك الاشتراك هنا.