واجهات برمجة التطبيقات لحزمة 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

Class 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:

Class google.ima.dai.api.AdProgressData

الحقول

adBreakDuration, adPosition, currentTime, duration, totalAds

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

الخصائص

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

Class google.ima.dai.api.CompanionAd

الطُرق

getAdSlotId, getContent, getContentType, getHeight, getWidth

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

getAdSlotId()

المرتجعات string:

getContent()

المرتجعات string:

getContentType()

المرتجعات string:

getHeight()

المرتجعات number:

getWidth()

المرتجعات number:

Class google.ima.dai.api.CuePoint

الحقول

end, played, start

فئة لتحديد خصائص نقطة إشارة بدء، وهي تمثّل فاصل إعلاني في بثات DAI عند الطلب.

الخصائص

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

Class google.ima.dai.api.LiveStreamRequest

الحقول

assetKey

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

الدالة الإنشائية:

المَعلمة	النوع	الوصف
opt_liveStreamRequest	Object	عنصر تمّت فيه مسبقًا إضافة خصائص طلب البث.

الخصائص

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

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

الحقول

adProgressData, cuepoints, errorMessage, streamId, subtitles, url

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

الخصائص

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

Class 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	يتمّ إطلاقه عندما يصل الإعلان إلى الربع الثالث.

Class 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)

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

Returns 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)

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

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

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

Class google.ima.dai.api.StreamRequest

الحقول

adTagParameters, apiKey, streamActivityMonitorId

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

الخصائص

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

Class google.ima.dai.api.VODStreamRequest

الحقول

contentSourceId, videoId

فئة لتحديد خصائص طلب بث الفيديو عند الطلب.

الدالة الإنشائية:

المَعلمة	النوع	الوصف
opt_VODStreamRequest	Object	كائن تمّت فيه إضافة خصائص طلب البث.

الخصائص

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

الثابت google.ima.VERSION

سلسلة تحتوي على الإصدار الكامل من حزمة تطوير البرامج (SDK).