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

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

सेवा: dai.google.com

stream तरीके का पाथ, https://dai.google.com से जुड़ा है

तरीका: स्ट्रीम

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

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 फ़ील्ड होते हैं.

Open Measurement

Verifications फ़ील्ड में, सर्वर-साइड-बीकनिंग स्ट्रीम के लिए, Open Measurement की पुष्टि से जुड़ी जानकारी होती है. 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 अगर इस समय कोई दूसरा अनुरोध पहले से ही पिंग भेज रहा है.

विज्ञापन मीडिया आईडी (एचएलएस)

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

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

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

विज्ञापन मीडिया आइडेंटिफ़ायर, 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),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

इवेंट

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

सबटाइटल

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

SkipMetadata

{
  "offset": number,
  "tracking_url": 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,
}

Companion

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