डाइनैमिक ऐड इंसर्शन वीओडी एपीआई

डाइनैमिक ऐड इंसर्शन एपीआई की मदद से, डीएआई वीडियो-ऑन-डिमांड (वीओडी) स्ट्रीम का अनुरोध किया जा सकता है और उन्हें ट्रैक किया जा सकता है. एचएलएस और डैश स्ट्रीम का इस्तेमाल किया जा सकता है.

सेवा: dai.google.com

stream तरीके का पाथ, https://dai.google.com के हिसाब से है

तरीका: Stream

एचटीटीपी अनुरोध

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 Tech Lab और VAST 4.1 की विशेषताएं देखें.

तरीका: मीडिया से पुष्टि करना

वीडियो चलाते समय आपको कोई विज्ञापन मीडिया आइडेंटिफ़ायर मिलता है. इसके तुरंत बाद, stream एंडपॉइंट से media_verification_url का इस्तेमाल करके अनुरोध करें. media_verification_url एक ऐब्सलूट पाथ है. सर्वर साइड-बीकनिंग स्ट्रीम के लिए मीडिया की पुष्टि करने के अनुरोध ज़रूरी नहीं हैं, जहां सर्वर मीडिया की पुष्टि करने की प्रक्रिया शुरू करता है.

media verification एंडपॉइंट के लिए किए जाने वाले अनुरोध, एक तरह के अनुरोध होते हैं.

एचटीटीपी अनुरोध

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

जवाब का मुख्य भाग

media verification ये जवाब दिखाता है:

• अगर मीडिया की पुष्टि हो जाती है और सभी पिंग भेज दिए जाते हैं, तो HTTP/1.1 204 No Content.
• यूआरएल के गलत फ़ॉर्मैट या समयसीमा खत्म होने की वजह से, मीडिया की पुष्टि करने के अनुरोध में HTTP/1.1 404 Not Found.
• HTTP/1.1 404 Not Found, अगर इस आईडी की पुष्टि करने का पिछला अनुरोध पूरा हो गया था.
• अगर कोई दूसरा अनुरोध पहले से ही पिंग भेज रहा है, तो HTTP/1.1 409 Conflict.

विज्ञापन मीडिया आईडी (HLS)

विज्ञापन मीडिया आइडेंटिफ़ायर को एचएलएस के टाइम्ड मेटाडेटा में एन्कोड किया जाएगा. इसके लिए, TXXX कुंजी का इस्तेमाल किया जाएगा. इसे "उपयोगकर्ता के तय किए गए टेक्स्ट की जानकारी" वाले फ़्रेम के लिए रिज़र्व किया जाएगा. फ़्रेम के कॉन्टेंट को एन्क्रिप्ट नहीं किया जाएगा और वह हमेशा "google_" टेक्स्ट से शुरू होगा.

विज्ञापन की पुष्टि के हर अनुरोध के लिए, फ़्रेम के पूरे टेक्स्ट कॉन्टेंट को media_verification_url में जोड़ना चाहिए.

विज्ञापन मीडिया आईडी (DASH)

विज्ञापन मीडिया आइडेंटिफ़ायर, डैश के EventStream एलिमेंट का इस्तेमाल करके मेनिफ़ेस्ट में शामिल किए जाएंगे.

हर EventStream में urn:google:dai:2018 का स्कीम आईडी यूआरआई होगा. इनमें messageData एट्रिब्यूट वाले इवेंट होंगे, जिनमें “google_” से शुरू होने वाला विज्ञापन मीडिया आईडी होगा. विज्ञापन की पुष्टि करने के हर अनुरोध के लिए, messageData एट्रिब्यूट का पूरा कॉन्टेंट media_verification_url में जोड़ना चाहिए.

जवाब का डेटा

स्ट्रीम

{
  "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)],
}

AppleTV

{
  "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,
}

ClickData

{
  "url": string,
}

FallbackImage

{
  "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,
}

TrackingEvent

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

UniversalAdID

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

कंपैनियन

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

InteractiveFile

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