המדריך הזה עוסק בשילוב של IMA DAI SDK באפליקציה של נגן וידאו. אם אתם רוצים לראות או לעקוב אחרי שילוב לדוגמה, אתם יכולים להוריד את BasicExample מ-GitHub.
סקירה כללית על IMA DAI
הטמעת IMA DAI כוללת ארבעה רכיבי SDK עיקריים, כפי שמוצג במדריך הזה:
IMAAdDisplayContainer– אובייקט קונטיינר שנמצא מעל הרכיב של הפעלת הסרטון ומכיל את רכיבי ממשק המשתמש של המודעה.IMAAdsLoader– אובייקט שמבקש שידורים ומטפל באירועים שמופעלים על ידי אובייקטים של תגובה לבקשת שידור. צריך ליצור מופע של טוען מודעות אחד בלבד, שאפשר לעשות בו שימוש חוזר לאורך כל חיי האפליקציה.-
IMAStreamRequest–IMAVODStreamRequestאוIMALiveStreamRequest. אובייקט שמגדיר בקשה לשידור. הבקשות לשידור יכולות להיות לווידאו על פי דרישה (VOD) או לשידורים חיים. בבקשות לשידור חי מציינים מפתח נכס, ובבקשות ל-VOD מציינים מזהה CMS ומזהה סרטון. שני סוגי הבקשות יכולים לכלול מפתח API שנדרש כדי לגשת לסטרימים שצוינו, וקוד רשת של Google Ad Manager כדי ש-IMA SDK יטפל במזהי מודעות כפי שצוין בהגדרות של Google Ad Manager. IMAStreamManager– אובייקט שמטפל בשידורים של הטמעת מודעות דינמיות ובאינטראקציות עם הקצה העורפי של DAI. מנהל השידור גם מטפל בפינגים של מעקב ומעביר אירועים של שידורים ומודעות לבעל האפליקציה.
דרישות מוקדמות
לפני שמתחילים, צריך:
- Xcode מגרסה 13 ואילך
- שיטה להתקנת IMA SDK:
- Swift Package Manager (מועדף)
- עותק להורדה של IMA SDK ל-iOS
אתם צריכים את הפרמטרים גם כדי לבקש את השידור מ-IMA SDK. לדוגמאות של פרמטרים של בקשות, ראו דוגמאות לשידורים.
| פרמטרים של שידור חי | |
|---|---|
| מפתח נכס |
מפתח הנכס שמזהה את השידור החי שלכם ב-Google Ad Manager. לדוגמה: c-rArva4ShKVIAkNfy6HUQ
|
| פרמטרים של שידור VOD | |
| מזהה מקור התוכן |
מזהה מקור התוכן מ-Google Ad Manager. לדוגמה: 2548831
|
| מזהה סרטון |
מזהה הסרטון מ-Google Ad Manager. לדוגמה: tears-of-steel
|
| פרמטרים נפוצים (VOD ושידור חי) | |
| קוד הרשת |
הקוד שלך ברשת Google Ad Manager. לדוגמה: 21775744923
|
יצירת פרויקט Xcode חדש
ב-Xcode, יוצרים פרויקט iOS חדש באמצעות Objective-C בשם BasicExample.
הוספת IMA DAI SDK לפרויקט Xcode
כדי להתקין את IMA SDK, בוחרים את השיטה המועדפת.
מומלץ: להתקין את ה-SDK באמצעות Swift Package Manager
ערכת Interactive Media Ads SDK תומכת ב-Swift Package Manager החל מגרסה 3.18.4. כדי לייבא את חבילת Swift, פועלים לפי השלבים הבאים:
ב-Xcode, מתקינים את חבילת Swift של IMA DAI SDK: עוברים אל File > Add Packages (קובץ > הוספת חבילות).
בהנחיה שמופיעה, מחפשים את מאגר ה-GitHub של חבילת Swift של IMA DAI SDK:
https://github.com/googleads/swift-package-manager-google-interactive-media-ads-iosבוחרים את הגרסה של IMA DAI SDK Swift Package שבה רוצים להשתמש. בפרויקטים חדשים, משתמשים באפשרות Up to Next Major Version.
אחרי שתסיימו, פלטפורמת Xcode תטפל ביחסי התלות שבחבילה ותוריד אותם ברקע. לפרטים נוספים על הוספת יחסי תלות של חבילות, קראו את המאמר של Apple.
הורדה והתקנה של ה-SDK באופן ידני
אם אתם לא רוצים להשתמש ב-Swift Package Manager, אתם יכולים להוריד את IMA SDK ולהוסיף אותו לפרויקט באופן ידני.
יצירת נגן וידאו
מטמיעים נגן וידאו ב-view controller הראשי, ועוטפים נגן AV ב-UI view. ערכת ה-IMA SDK משתמשת בתצוגת ממשק המשתמש כדי להציג רכיבים של ממשק המשתמש של המודעה.
Objective-C
Swift
מאתחלים את טוען המודעות
מייבאים את IMA SDK אל ה-view controller ומאמצים את הפרוטוקולים IMAAdsLoaderDelegate ו-IMAStreamManagerDelegate כדי לטפל באירועים של טעינת המודעות ושל מנהל השידורים.
מוסיפים את המאפיינים הפרטיים האלה כדי לאחסן רכיבים מרכזיים של IMA SDK:
IMAAdsLoader- מנהל את הבקשות לשידור לאורך כל משך החיים של האפליקציה.
IMAAdDisplayContainer- מטפל בהוספה ובניהול של רכיבים בממשק המשתמש של המודעות.
-
IMAAVPlayerVideoDisplay– מנהל את התקשורת בין IMA SDK לבין נגן המדיה ומטפל במטא-נתונים מתוזמנים. -
IMAStreamManager– מנהל את ההפעלה של השידור ומפעיל אירועים שקשורים למודעות.
מאתחלים את טוען המודעות, את מאגר המודעות לתצוגה ואת תצוגת הווידאו אחרי שהתצוגה נטענת.
Objective-C
Swift
שליחת בקשה לשידור
כשמשתמש לוחץ על כפתור ההפעלה, שולחים בקשה חדשה לשידור.
משתמשים במחלקה IMALiveStreamRequest לשידורים חיים. בשידורי VOD, משתמשים במחלקה IMAVODStreamRequest.
הבקשה לשידור דורשת את הפרמטרים של השידור, וגם הפניה למאגר להצגת המודעות ולתצוגת הסרטון.
Objective-C
Swift
האזנה לאירועי טעינה של שידורים
הכיתה IMAAdsLoader קוראת לשיטות IMAAdsLoaderDelegate כשהבקשה לסטרימינג מאותחלת בהצלחה או נכשלת.
ב-delegate method adsLoadedWithData, מגדירים את IMAStreamManagerDelegate.
מאתחלים את מנהל השידור. במהלך ההפעלה, מנהל השידור מתחיל את ההפעלה.
ב-method של הנציג failedWithErrorData, מתעדים את השגיאה ביומן. אם רוצים, מפעילים את השידור החי לגיבוי. שיטות מומלצות ל-DAI
Objective-C
Swift
האזנה לאירועי מודעות
ה-IMAStreamManager קורא ל-methods של IMAStreamManagerDelegate כדי להעביר אירועים ושגיאות של סטרימינג לאפליקציה.
בדוגמה הזו, מתעדים את אירועי המודעות הראשיים במסוף:
Objective-C
Swift
מפעילים את האפליקציה. אם היא פועלת, מבקשים ומפעילים שידורי Google DAI באמצעות IMA SDK. כדי לקבל מידע על תכונות מתקדמות יותר של ה-SDK, אפשר לעיין במדריכים אחרים שמפורטים בסרגל הצד הימני או בדוגמאות ב-GitHub.