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

الطُرق

getAdPodInfo وgetAdPodInfo وgetAdSystem وgetAdvertiserName وgetApiFramework وgetCompanionAds وgetCreativeAdId وgetCreativeId وgetDealIdgetDisplayId,getApiFrameId,getCompanionAds وgetCreativeAdId وgetCreativeId, getDealId,getDealId,getDealId,getApiFramework, getCompanionAds.getDescriptiongetDurationgetTitlegetVastMediaHeightgetVastMediaWidthgetWrapperAdIdsgetWrapperAdSystemsgetWrapperCreativeIds

فئة تمثّل عنصر إعلان أثناء إدراج الإعلان الديناميكي. تعرض هذه الفئة مجموعة فرعية من مواقع 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

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

أماكن إقامة

الاسم	Type	الوصف
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، تم تشغيلها، start

تمثّل هذه السمة فئة لتحديد خصائص نقطة الاتصال التي تمثّل فاصلاً إعلانيًا في أحداث البث المباشر للفيديوهات التي تستخدم ميزة DAI.

أماكن إقامة

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

الصف google.ima.dai.api.LiveStreamRequest

الحقول

assetKey

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

المنشئ:

المَعلمة	Type	الوصف
opt_liveStreamRequest	Object	الذي سبق وتم تخصيص خصائص طلب البث به.

أماكن إقامة

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

الصف google.ima.dai.api.StreamData

الحقول

adProgressData وcuepoints وerrorMessage وstreamId وsubtitles، عنوان URL

فئة لتحديد بيانات مصدر البيانات.

أماكن إقامة

الاسم	Type	الوصف
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: يؤدي إلى عرض كائن مع معلومات ساحة المشاركات.

قيم التعداد google.ima.dai.api.StreamEvent.Type

الحقول

AD_BREAK_ENDED وAD_BREAK_STARTED وAD_PROGRESS ونقرة وCOMPLETE وCUEPOINTS_CHANGED وخطأ وFIRST_QUARTILE وLOADED نقطةM}{/20MMIDPOINTSTREAM_INITIALIZEDTHIRD_QUARTILE

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

القيم

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

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

المنشئ:

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

contentTimeForStreamTime(streamTime)

لعرض وقت المحتوى بدون إعلانات لفترة بث محدّدة. تعرض وقت البث المخصص لأحداث البث المباشر

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

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

onTimedMetadata(metadata)

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

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

previousCuePointForStreamTime(streamTime)

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

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

المَعلمة	Type	الوصف
streamTime	number	وقت البث المطلوب.

processMetadata(type, data, timestamp)

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

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

requestStream(streamRequest)

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

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

setClickElement(clickElement)

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

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

streamTimeForContentTime(contentTime)

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

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

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

الصف google.ima.dai.api.StreamRequest

الحقول

adTagParameters، وapiKey، وstreamActivityMonitorId

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

أماكن إقامة

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

الصف google.ima.dai.api.VODStreamRequest

الحقول

contentSourceId وvideoId

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

المنشئ:

المَعلمة	Type	الوصف
opt_VODStreamRequest	Object	الذي سبق وتم تخصيص خصائص طلب البث به.

أماكن إقامة

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

ثابت google.ima.VERSION

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