واجهات برمجة التطبيقات لحزمة SDK لإدراج إعلان ديناميكي لإعلانات الوسائط التفاعلية من Google

1. 1. google.ima.dai.api.Ad
   2. google.ima.dai.api.AdPodInfo
   3. google.ima.dai.api.AdProgressData
   4. google.ima.dai.api.CompanionAd
   5. google.ima.dai.api.CuePoint
   6. google.ima.dai.api.LiveStreamRequest
   7. google.ima.dai.api.StreamData
   8. google.ima.dai.api.StreamEvent
   9. google.ima.dai.api.StreamEvent.Type
   10. google.ima.dai.api.StreamManager
   11. google.ima.dai.api.StreamRequest
   12. google.ima.dai.api.VODStreamRequest
   13. google.ima.VERSION

الفئة google.ima.dai.api.Ad

الطُرق

getAdId، getAdPodInfo، getAdSystem، getAdvertiserName، getApiFramework، getCompanionAds، getCreativeAdId، getCreativeId، getDealId، getDescription، getDuration، getTitle، getVastMediaHeight، getVastMediaWidth، getWrapperAdIds، getWrapperAdSystems، getWrapperCreativeIds

فئة تمثّل عنصر إعلان أثناء إدراج الإعلان الديناميكي تعرِض هذه الفئة مجموعة فرعية من خصائص ima.Ad.

getAdId()

المرتجعات string:

getAdPodInfo()

المرتجعات google.ima.dai.api.AdPodInfo:

getAdSystem()

المرتجعات string:

getAdvertiserName()

المرتجعات string:

getApiFramework()

المرتجعات string:

getCompanionAds()

المرتجعات Array.<google.ima.dai.api.CompanionAd>:

getCreativeAdId()

المرتجعات string:

getCreativeId()

المرتجعات string:

getDealId()

المرتجعات string:

getDescription()

المرتجعات string:

getDuration()

المرتجعات number:

getTitle()

المرتجعات string:

getVastMediaHeight()

المرتجعات number:

getVastMediaWidth()

المرتجعات number:

getWrapperAdIds()

المرتجعات Array.<string>:

getWrapperAdSystems()

المرتجعات Array.<string>:

getWrapperCreativeIds()

المرتجعات Array.<string>:

الفئة google.ima.dai.api.AdPodInfo

الطُرق

‫getAdPosition، getMaxDuration، getPodIndex، getTimeOffset، getTotalAds

فئة تمثّل عنصر معلومات مجموعة إعلانية أثناء إدراج الإعلانات الديناميكية تعرِض هذه الفئة مجموعة فرعية من سمات ima.AdPodInfo.

getAdPosition()

المرتجعات number:

getMaxDuration()

المرتجعات number:

getPodIndex()

المرتجعات number:

getTimeOffset()

المرتجعات number:

getTotalAds()

المرتجعات number:

الفئة google.ima.dai.api.AdProgressData

الحقول

‫adBreakDuration، adPosition، currentTime، duration، totalAds

فئة لتحديد بيانات مستوى تقدّم الإعلان

الخصائص

الاسم	النوع	الوصف
adBreakDuration
adPosition
currentTime
duration
totalAds

الفئة google.ima.dai.api.CompanionAd

الطُرق

getAdSlotId، getContent، getContentType، getHeight، getWidth

فئة تمثّل عنصر إعلان مصاحب أثناء إدراج الإعلان الديناميكي تعرِض هذه الفئة مجموعة فرعية من سمات ima.CompanionAd.

getAdSlotId()

المرتجعات string:

getContent()

المرتجعات string:

getContentType()

المرتجعات string:

getHeight()

المرتجعات number:

getWidth()

المرتجعات number:

الفئة google.ima.dai.api.CuePoint

الحقول

end، played، start

فئة لتحديد سمات نقطة إشارة البدء التي تمثّل فاصلًا إعلانيًا في أحداث الفيديو عند الطلب المستندة إلى إعادة التشغيل المباشر

الخصائص

الاسم	النوع	الوصف
end		وقت انتهاء نقطة البدء هذه.
played		إذا تم تشغيل نقطة البدء هذه.
start		وقت بدء نقطة الربط هذه.

الفئة google.ima.dai.api.LiveStreamRequest

الحقول

assetKey

فئة لتحديد خصائص طلب البث المباشر

المنشئ:

المَعلمة	النوع	الوصف
opt_liveStreamRequest	Object	عنصر تمّ تحديد سمات طلب بثّ له من قبل

الخصائص

الاسم	النوع	الوصف
assetKey		يُستخدَم هذا الإجراء لتحديد البث الذي يجب تشغيله. مفتاح مادة عرض طلب البث المباشر هو معرّف يمكن العثور عليه في واجهة مستخدم "مساحة العرض في الفيديو".

الفئة google.ima.dai.api.StreamData

الحقول

adProgressData، cuepoints، errorMessage، streamId، subtitles، url

فئة لتحديد بيانات البث

الخصائص

الاسم	النوع	الوصف
adProgressData		معلومات متعلّقة بالتوقيت للإعلان الذي يتم عرضه حاليًا
cuepoints		نقاط تشغيل الإعلانات للبث عند الطلب وقد تتغيّر هذه الأرقام مع تقدّم البث. ولن تتم تعبئة هذا الحقل إلا في أداة معالجة الحدث لحالة CUEPOINTS_CHANGED AdEvent.
errorMessage
streamId
subtitles
url

الفئة google.ima.dai.api.StreamEvent

الطُرق

getAd، getStreamData

يُنشئ مدير مصدر البيانات هذا النوع من الأحداث كإشعار عند تغيُّر حالة مصدر البيانات.

getAd()

الإرجاع google.ima.dai.api.Ad: عنصر الإرجاع الذي يتضمّن معلومات الإعلان

getStreamData()

الإرجاع google.ima.dai.api.StreamData: عرض عنصر يتضمّن معلومات البث

Enum google.ima.dai.api.StreamEvent.Type

الحقول

AD_BREAK_ENDED، AD_BREAK_STARTED، AD_PROGRESS، CLICK، COMPLETE، CUEPOINTS_CHANGED، ERROR، FIRST_QUARTILE، LOADED، MIDPOINT، STARTED، STREAM_INITIALIZED، THIRD_QUARTILE

قائمة بأنواع الأحداث المتوافقة مع حزمة IMA SDK

القيم

القيمة	الوصف
AD_BREAK_ENDED	يتمّ تشغيله عند انتهاء الفاصل الإعلاني.
AD_BREAK_STARTED	يتمّ تشغيله عند بدء فاصل إعلاني.
AD_PROGRESS	يتمّ تشغيله عند توفّر معلومات جديدة عن مستوى تقدّم الإعلان.
CLICK	يتمّ إرسال هذا الحدث عند النقر على عنصر النقرة أثناء عرض إعلان.
COMPLETE	يتمّ تشغيله عند اكتمال عرض إعلان.
CUEPOINTS_CHANGED	يتم إرسالها لأحداث البث عند الطلب عند تغيير نقاط البدء.
ERROR	يتمّ تشغيله عند حدوث خطأ.
FIRST_QUARTILE	يتمّ تشغيله عندما يصل الإعلان إلى الربع الأوّل.
LOADED	يتم تشغيله عندما يكون بيان البث متاحًا.
MIDPOINT	يتمّ تشغيله عندما يصل الإعلان إلى منتصفه.
STARTED	يتمّ تشغيله عند بدء عرض إعلان.
STREAM_INITIALIZED	يتم تشغيله عند بدء البث.
THIRD_QUARTILE	يتمّ تشغيله عندما يصل الإعلان إلى الربع الثالث.

الفئة google.ima.dai.api.StreamManager

الطُرق

contentTimeForStreamTime، onTimedMetadata، previousCuePointForStreamTime، processMetadata، requestStream، setClickElement، streamTimeForContentTime

تعالج أحداث بث الإعلانات الديناميكية. تدير هذه الواجهة التفاعلات مع واجهة برمجة التطبيقات لعرض الإعلانات الديناميكي وتعمل على معالجة إشارات التتبّع بالإضافة إلى إعادة توجيه أحداث البث والإعلانات إلى الناشر. لا يرث هذا المدير من BaseAdsManager لأنّه ليس مديرًا لإعلان معيّن، بل هو مدير للبث بأكمله.

المنشئ:

المَعلمة	النوع	الوصف
videoElement	HTMLVideoElement	عنصر مشغّل الفيديو الفعلي

contentTimeForStreamTime(streamTime)

تعرِض هذه السمة وقت المحتوى بدون الإعلانات لوقت بث معيّن. تعرِض هذه السمة وقت البث المباشر المحدَّد.

تعرض number: وقت المحتوى الذي يتوافق مع وقت البث المُعطى بعد إزالة الإعلانات.

المَعلمة	النوع	الوصف
streamTime	number	وقت البث مع الإعلانات المُدرَجة (بالثواني)

onTimedMetadata(metadata)

تمرير قاموس للبيانات الوصفية التي تمت معالجتها يتوقّع المعجم استخدام المفتاح TXXX مع سلسلة البيانات الوصفية التي يحدّدها المستخدم كقيمة. إذا كان مشغّل الوسائط يقدّم بيانات وصفية أولية، يمكنك استدعاء ima.dai.api.StreamManager.processMetadata بدلاً من ذلك.

المَعلمة	النوع	الوصف
metadata	Object	قاموس البيانات الوصفية

previousCuePointForStreamTime(streamTime)

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

تعرض google.ima.dai.api.CuePoint: نقطة البدء السابقة لوقت البث المحدَّد.

المَعلمة	النوع	الوصف
streamTime	number	وقت البث الذي تم التقديم أو الإيقاف إليه

processMetadata(type, data, timestamp)

تعالج البيانات الوصفية الموقّتة لأحداث البث المباشر. استخدِم هذه الطريقة إذا كان مشغّل الفيديو يقدّم بيانات وصفية غير مفسّرة مع الطوابع الزمنية، وإلا استخدِم ima.dai.api.StreamManager.onTimedMetadata.

المَعلمة	النوع	الوصف
type	string	أدخِل البيانات الوصفية. يجب أن يكون "ID3".
data	Uint8Array	بيانات العلامة الأولية بالنسبة إلى ID3، يجب أن تكون العلامة بأكملها.
timestamp	number	الوقت الذي يجب معالجة البيانات فيه

requestStream(streamRequest)

تطلب تحميل بث باستخدام مَعلمات البث المقدَّمة.

المَعلمة	النوع	الوصف
streamRequest	google.ima.dai.api.StreamRequest	يحتوي على مَعلمات لتحميل البيانات الوصفية للبث.

setClickElement(clickElement)

تُستخدَم لضبط عنصر النقر على الإعلانات. يُستخدَم هذا العنصر كمُستلِم للنقرات أو التمريرات أثناء تشغيل الإعلان، وقد يؤدي ذلك إلى التنقّل بعيدًا عن الصفحة الحالية.

المَعلمة	النوع	الوصف
clickElement	Element	العنصر المستخدَم كرابط للانتقال إلى الإعلان

streamTimeForContentTime(contentTime)

تعرِض هذه السمة وقت البث مع الإعلانات لوقت محتوى معيّن. لعرض وقت المحتوى المحدَّد لأحداث البث المباشر

تعرض number: وقت البث الذي يتوافق مع وقت المحتوى المُعطى بعد إدراج الإعلانات.

المَعلمة	النوع	الوصف
contentTime	number	مدة المحتوى بدون أي إعلانات (بالثواني)

الفئة google.ima.dai.api.StreamRequest

الحقول

‫adTagParameters، apiKey، streamActivityMonitorId

فئة لتحديد خصائص طلب البث

الخصائص

الاسم	النوع	الوصف
adTagParameters		يمكنك إلغاء مجموعة محدودة من مَعلمات علامة الإعلان في طلب البث. اطّلِع على مزيد من المعلومات في مقالة إرسال مَعلمات الاستهداف إلى البث. يمكنك استخدام المَعلمتَين dai-ot وdai-ov لتحديد الإصدار المفضّل من البث. اطّلِع على تجاوز مَعلمات الصيغة في البث للحصول على مزيد من المعلومات.
apiKey		مفتاح واجهة برمجة التطبيقات لطلب البث ويتم ضبطه من خلال واجهة مستخدِم "مدير إعلانات Google" وتقديمه للناشر لإتاحة محتوى موقعه الإلكتروني. وتتحقّق من التطبيقات التي تحاول الوصول إلى المحتوى.
streamActivityMonitorId		رقم التعريف الذي سيتم استخدامه لتصحيح أخطاء البث باستخدام أداة مراقبة نشاط البث. ويُستخدَم ذلك لتوفير طريقة ملائمة للسماح للناشرين بالعثور على سجلّ بث في أداة "مراقبة نشاط البث".

الفئة google.ima.dai.api.VODStreamRequest

الحقول

contentSourceId، videoId

فئة لتحديد سمات طلب بث الفيديو عند الطلب

المنشئ:

المَعلمة	النوع	الوصف
opt_VODStreamRequest	Object	عنصر تمّ تحديد سمات طلب البث له

الخصائص

الاسم	النوع	الوصف
contentSourceId		معرّف فريد لمحتوى الناشر، من نظام إدارة المحتوى مطلوب لبث المحتوى عند الطلب.
videoId		معرّف لمصدر محتوى الفيديو مطلوب لأحداث البث عند الطلب.

الثابت google.ima.VERSION

سلسلة تحتوي على الإصدار الكامل من حزمة SDK