SDK Runtime API: מדריך לשילוב

כשתקראו את מסמכי התיעוד של ארגז החול לפרטיות ב-Android, השתמשו בלחצן תצוגה מקדימה למפתחים או בטא כדי לבחור את גרסת התוכנית שאיתה אתם עובדים, מכיוון שההוראות עשויות להשתנות.


כדי לעזור לכם בתכנון השילוב, המדריך הזה כולל סקירה מקיפה של תהליך השילוב, שעשויה לכלול תכונות שעדיין לא הוטמעו בשלב הנוכחי של ארגז החול לפרטיות בתצוגה המקדימה למפתחי Android. במקרים כאלה, נספק הנחיות לגבי ציר הזמן.

בתרשים הבא מוצגת תהליך הפיתוח המעודכן של השילוב עם זמן ריצה ל-SDK. אפשר לעבוד במקביל על קטעים שמופיעים באותה העמודה. לדוגמה, אפשר לבצע את מעורבות השותפים בו-זמנית עם הגדרת סביבת הבדיקה.

תרשים חזותי של זרימת העבודה של שילוב זמן ריצה ב-SDK.
תהליך העבודה לשילוב זמן הריצה של ה-SDK.

דרישות מוקדמות והגדרה

על ידי מילוי הקטע הזה של שלבי העבודה, תוכלו לוודא שאתם מבינים היטב את זמן הריצה של ה-SDK, וכדי שתוכלו לקבל תוצאות משמעותיות כשמשתמשים ב-API בסביבה העסקית של הפרסום הדיגיטלי.

היכרות עם ה-API

בתור התחלה, כדאי לקרוא את ההצעה לעיצוב כדי להכיר את זמן הריצה ל-SDK, את היכולות שלו ואת ההגבלות שלו.

במדריך למפתחים מוסבר איך לשלב את הקוד ואת הקריאות ל-API שנדרשים בתרחישים לדוגמה.

שלחו כל משוב שיש לכם על התיעוד, במיוחד לגבי השאלות הפתוחות.

אפשר להירשם כדי לקבל עדכונים לגבי ארגז החול לפרטיות ב-Android. כך תוכלו להתעדכן בתכונות החדשות שיושקו בגרסאות עתידיות.

הגדרה ובדיקה של האפליקציה לדוגמה

כשתהיו מוכנים להתחיל בשילוב, תוכלו להוריד את הגרסה העדכנית ביותר של התצוגה המקדימה למפתחים ב-Android Studio לפי ההוראות המפורטות כאן. כדי להשתמש במדריך הזה צריך להשתמש בגרסה הכי עדכנית של Canary של Android Studio. אתם יכולים להריץ את הגרסה הזו של Android Studio במקביל לגרסאות אחרות שבהן אתם משתמשים, אז פנו אלינו אם הדרישה הזו לא עבדה.

התאימו את הקוד ומריצים אותו באפליקציה לדוגמה כדי להכיר טוב יותר את התקנת ה-RE SDK בשם "example-sdk" ואת אפליקציית הלקוח שנקראת client-app במכשיר או באמולטור כדי לוודא שמודעה לדוגמה תיטען.

התאמת ה-SDK הקיים לזמן הריצה של ה-SDK

מטרת הקטע הזה היא להטמיע פונקציונליות, כמו הצגת מודעת באנר, מה-SDK הקיים ב-SDK מותאם לזמן ריצה (RE SDK) ולהגדיר את התקשורת בין האפליקציה לבין RE SDK.

  • כדי להטמיע פונקציונליות ב-RE SDK, צריך ליצור או לעדכן את sdk-example ו-sdk-embed.

  • מבחינה ארכיטקטונית, כדאי להוסיף את RE SDK כתלות ב-SDK הקיים, שמשמש כ-wrapper. כך אפליקציית הלקוח יכולה להמשיך לקרוא ישירות ל-SDK הקיים או ל-wrapper. wrapper SDK עשוי לנתב קריאות ל-API על סמך אסטרטגיות שונות שמתוארות בהמשך.

תרשים חזותי של ארכיטקטורת המערכת אחרי שילוב זמן ריצה של SDK.
ארכיטקטורת מערכת אחרי שילוב זמן ריצה של SDK.

בתרחישים לדוגמה שמחייבים נתונים מותאמים אישית, כמו קריאה ל-PPAPIs, צריך ליצור הגדרת API באמצעות IPC. באמצעות IBinder ו-AIDL של Android, יוצרים פרוטוקול תקשורת כדי לשלוח מידע ל-SDK עם תמיכה בזמן ריצה, לגבי כל המידע או הפעולות הנדרשות. מידע נוסף במדריך למפתחים של זמן ריצה ל-SDK זמין כאן.

ניתוב התנועה ל-SDK Enabledtime Enabled (זמן ריצה)

אסטרטגיות ניתוב לקריאות ל-API

בהתאם לתרחישי השימוש שלכם, מומלץ לנתב קריאות ל-SDK דרך ה-SDK הקיים ונתיבי הקוד של RE 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 גם לנתיב קוד ה-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 שקשורות למודעות, למפתחים שנרשמו לתוכנית הבטא ומבצעים בדיקות מקומיות. אם אתם מעוניינים להשתתף, תוכלו להירשם כאן.