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

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

सेवा: dai.google.com

सभी यूआरआई, https://dai.google.com से जुड़े हुए हैं

तरीका: stream

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

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

अनुरोध का हेडर

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

पाथ पैरामीटर

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा application/x-www-form-urlencoded टाइप का होता है और इसमें ये पैरामीटर शामिल होते हैं:

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

अगर अनुरोध सही से काम करता है, तो जवाब के मुख्य हिस्से में एक नया Stream शामिल होता है. सर्वर-साइड-बीकनिंग स्ट्रीम के लिए, इस Stream में सिर्फ़ stream_id और stream_manifest फ़ील्ड शामिल होते हैं.

मेज़रमेंट खोलें

DAI API में, Verifications फ़ील्ड में ओपन मेज़रमेंट की पुष्टि करने से जुड़ी जानकारी होती है. इस फ़ील्ड में एक या उससे ज़्यादा Verification एलिमेंट होते हैं. इनमें क्रिएटिव के प्लेबैक की पुष्टि करने के लिए, तीसरे पक्ष के मेज़रमेंट कोड को लागू करने के लिए ज़रूरी संसाधन और मेटाडेटा की सूची होती है. सिर्फ़ JavaScriptResource का इस्तेमाल किया जा सकता है. ज़्यादा जानकारी के लिए, IAB Tech Lab और VAST 4.1 की खास जानकारी देखें.

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

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

media verification एंडपॉइंट के अनुरोध, आइडेमपोटेंट होते हैं.

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

GET https://{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_" टेक्स्ट से शुरू होगा.

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

तरीका: मेटाडेटा

metadata_url पर मौजूद मेटाडेटा एंडपॉइंट, विज्ञापन यूज़र इंटरफ़ेस (यूआई) बनाने के लिए इस्तेमाल की गई जानकारी दिखाता है. मेटाडेटा एंडपॉइंट, सर्वर-साइड-बीकनिंग स्ट्रीम के लिए उपलब्ध नहीं है. इसमें विज्ञापन मीडिया की पुष्टि शुरू करने की ज़िम्मेदारी सर्वर की होती है.

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

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

क्वेरी पैरामीटर

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

अनुरोध पूरा होने पर, जवाब में PodMetadata का एक इंस्टेंस दिखता है.

मेटाडेटा के साथ काम करना

मेटाडेटा में तीन अलग-अलग सेक्शन होते हैं: tags, ads, और विज्ञापन breaks. डेटा में एंट्री करने का पॉइंट, tags सेक्शन है. इसके बाद, टैग के ज़रिए दोहराएं और पहली ऐसी एंट्री ढूंढें जिसका नाम, वीडियो स्ट्रीम में मौजूद विज्ञापन मीडिया आईडी का प्रीफ़िक्स हो. उदाहरण के लिए, आपके पास ऐसा विज्ञापन मीडिया आईडी हो सकता है:

google_1234567890

इसके बाद, आपको google_12345 नाम का टैग ऑब्जेक्ट दिखेगा. इस मामले में, यह आपके विज्ञापन के मीडिया आईडी से मेल खाता है. सही विज्ञापन मीडिया प्रीफ़िक्स ऑब्जेक्ट ढूंढने के बाद, विज्ञापन आईडी, विज्ञापन ब्रेक आईडी, और इवेंट टाइप देखा जा सकता है. इसके बाद, विज्ञापन आईडी का इस्तेमाल ads ऑब्जेक्ट को इंडेक्स करने के लिए किया जाता है. साथ ही, विज्ञापन ब्रेक आईडी का इस्तेमाल breaks ऑब्जेक्ट को इंडेक्स करने के लिए किया जाता है.

जवाब का डेटा

स्ट्रीम

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

विज्ञापन

{
  "ad_break_id": string,
  "position": 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,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}

आइकॉन

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