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

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

सेवा: dai.google.com

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

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

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

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

पाथ पैरामीटर

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

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

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

अगर एपीआई सही से जुड़ जाता है, तो जवाब के मुख्य हिस्से में एक नया Stream ऑब्जेक्ट शामिल होता है.

Open Measurement

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

तरीका: पॉड सेगमेंट

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

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

पाथ पैरामीटर

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

फ़ुटनोट

1. शुरू करने वाले सेगमेंट के लिए, sd की ज़रूरत नहीं होती. ↩
2. जिन इवेंट में विज्ञापन के लिए लगातार ब्रेक की सुविधा चालू है उनके लिए pd की ज़रूरत नहीं होती. ↩

उदाहरण

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak-2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST

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

अगर अनुरोध स्वीकार कर लिया जाता है, तो जवाब का मुख्य हिस्सा, स्ट्रीम का एक ऐसा सेगमेंट होगा जिसे चलाया जा सके. इस सेगमेंट में, अनुरोध में बताए गए फ़ॉर्मैट और पैरामीटर शामिल होंगे.

तरीका: एचएलएस पॉड मेनिफ़ेस्ट

किसी लाइव स्ट्रीम का एचएलएस विज्ञापन पॉड मेनिफ़ेस्ट वापस लाता है. यह मेनिफ़ेस्ट, क्लाइंट वीडियो प्लेयर के लिए लोड और चलाने के लिए तैयार होता है.

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

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/pod/{pod_id}.m3u8?stream_id={stream_id}&pd={pod_duration}

पाथ पैरामीटर

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

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

अगर एपीआई सही से जुड़ जाता है, तो जवाब के मुख्य हिस्से में मल्टीवैरिएंट वाली एचएलएस प्लेलिस्ट शामिल होती है.

तरीका: DASH पॉड मेनिफ़ेस्ट

यह डेटा, लाइव स्ट्रीम के ऐसे MPEG-DASH विज्ञापन पॉड मेनिफ़ेस्ट को फ़ेच करता है जो क्लाइंट वीडियो प्लेयर को लोड करने और चलाने के लिए तैयार है.

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

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

पाथ पैरामीटर

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

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

अगर अनुरोध पूरा हो जाता है, तो जवाब के मुख्य हिस्से में MPEG-DASH mpd प्लेलिस्ट होती है.

तरीका: DASH पॉड पीरियड टेंप्लेट

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

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

पाथ पैरामीटर

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

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

अगर एपीआई सही से जुड़ जाता है, तो जवाब के मुख्य हिस्से में एक नया PodTemplateResponse ऑब्जेक्ट शामिल होता है.

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

वीडियो चलाने के दौरान विज्ञापन मीडिया आइडेंटिफ़ायर मिलने पर, ऊपर दिए गए 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 अगर इस समय कोई दूसरा अनुरोध पहले से ही पिंग भेज रहा है.

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

विज्ञापन मीडिया आइडेंटिफ़ायर को एक अलग मेटाडेटा ट्रैक में एन्कोड किया जाएगा — एचएलएस ट्रांसपोर्ट स्ट्रीम के लिए टाइम मेटाडेटा या एमपी4 फ़ाइलों के लिए ईमेल. विज्ञापन मीडिया आइडेंटिफ़ायर हमेशा 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,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}

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

PodTemplateResponse

{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}

आइकॉन

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