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

Class 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

قائمة بأنواع الأحداث المتوافقة مع "حزمة تطوير البرامج للإعلانات التفاعلية"

القيم

القيمة	الوصف
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)

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

Returns 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