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

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

सेवा: 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 की खास बातें देखें.

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

वीडियो चलाते समय कोई विज्ञापन मीडिया आइडेंटिफ़ायर मिलने के बाद, ऊपर दिए गए स्ट्रीम एंडपॉइंट से मिले 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)],
}

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

कंपैनियन

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