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

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

सेवा: 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 फ़ील्ड में, सर्वर-साइड-बीकनिंग स्ट्रीम के अलावा अन्य स्ट्रीम के लिए, OpenMeasurement की पुष्टि करने से जुड़ी जानकारी होती है. 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)

विज्ञापन मीडिया आइडेंटिफ़ायर को मेनिफ़ेस्ट में डालने के लिए, 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,
}