واجهة برمجة تطبيقات VOD لإدراج الإعلانات الديناميكية

تمكّنك واجهة برمجة تطبيقات إدراج الإعلان الديناميكي من طلب وتتبع مجموعات بث فيديو DAI عند الطلب (VOD). يتم دعم مجموعات البث HLS وDASH.

الخدمة: dai.google.com

مسار stream مرتبط بـ https://dai.google.com

الطريقة: ساحة المشاركات

طلب HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

عنوان الطلب

Authorization: DCLKDAI key="<api-key>"

معلمات المسار

نص الطلب

نص الطلب من النوع application/x-www-form-urlencoded ويحتوي على المعلمات التالية:

نص الاستجابة

إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على رمز Stream جديد. بالنسبة إلى أحداث البث من جهة الخادم، تحتوي Stream هذه على الحقلين stream_id وstream_manifest فقط.

فتح القياس

يتضمّن حقل Verifications معلومات حول التحقق من القياس المفتوح لعمليات البث غير إشارة الخادم. يحتوي Verifications على عنصر أو أكثر من عناصر Verification التي تسرد الموارد والبيانات الوصفية اللازمة للتحقق من تشغيل تصميم الإعلان باستخدام رمز قياس من طرف ثالث. لا يتوفّر سوى JavaScriptResource. لمزيد من المعلومات، يُرجى الاطلاع على مختبر IAB التقني ومواصفات VAST 4.1.

الطريقة: التحقق من الوسائط

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

الطلبات إلى نقطة النهاية media verification غير ثابتة.

طلب HTTP

GET {media-verification-url}/{ad-media-id}

نص الاستجابة

media verification يعرض الردود التالية:

• HTTP/1.1 204 No Content في حال نجاح التحقُّق من الوسائط وإرسال جميع الإشعارات.
• HTTP/1.1 404 Not Found إذا تعذّر على الطلب التحقق من الوسائط بسبب تنسيق عنوان URL غير صحيح أو انتهاء صلاحيته.
• HTTP/1.1 404 Not Found في حال نجاح طلب تحقق سابق لهذا المعرّف.
• HTTP/1.1 409 Conflict إذا كان هناك طلب آخر يرسل إشعارات في الوقت الحالي.

معرّفات وسائط الإعلانات (HLS)

سيتم ترميز معرّفات وسائط الإعلانات في البيانات الوصفية المحددة بوقت من HLS باستخدام المفتاح TXXX، المحجوز لإطارات "المعلومات النصية التي يحددها المستخدم". وستكون محتويات الإطار غير مُشفَّرة وستبدأ دائمًا بالنص "google_".

يجب إلحاق كامل محتوى النص للإطار إلى media_verification_url لكل طلب التحقق من الإعلان.

أرقام تعريف وسائط الإعلانات (DASH)

سيتم إدراج معرّفات وسائط الإعلان في البيان من خلال استخدام عنصر EventStreamDASH.

سيكون لكل EventStream معرّف موارد منتظم (URI) لمعرّف المخطط urn:google:dai:2018. وستحتوي على أحداث تتضمّن السمة messageData التي تحتوي على معرّف وسائط إعلان يبدأ بـ “google_”. يجب إلحاق المحتوى الكامل للسمة messageData إلى media_verification_url لكل طلب تحقق من الإعلان.

بيانات الاستجابة

Stream

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

تلفزيون Apple

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

إعلان

{
  "seq": number,
  "start": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}

الحدث

{
  "time": number,
  "type": string,
}

العنوان الفرعي

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

الرمز

{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}

بيانات النقر

{
  "url": string,
}

صورة احتياطية

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

Wrapper

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

إثبات الملكية

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

حدث التتبع

{
  "event": string,
  "uri": string,
}

معرّف الإعلانات العام

{
  "id_value": string,
  "id_registry": string,
}

الإعلان المصاحب

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
}

ملف تفاعلي

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}