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

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

सेवा: dai.google.com

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

तरीका: Stream

तरीके
stream POST /linear/v1/hls/event/{assetKey}/stream

दिए गए इवेंट आईडी के लिए डीएआई स्ट्रीम बनाता है.

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

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

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

पैरामीटर
api‑key string

स्ट्रीम बनाते समय दी गई एपीआई पासकोड से, प्रकाशक के नेटवर्क के लिए मान्य होना चाहिए.

अनुरोध के मुख्य हिस्से में देने के बजाय, एपीआई पासकोड को पास किया जा सकता है को नीचे दिए गए फ़ॉर्मैट में डालें:

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

पाथ पैरामीटर

पैरामीटर
assetKey string

स्ट्रीम का इवेंट आईडी.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है ध्यान दें: स्ट्रीम ऐसेट कुंजी एक आइडेंटिफ़ायर है. इसे यहां भी देखा जा सकता है Ad Manager का यूज़र इंटरफ़ेस (यूआई).

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

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

पैरामीटर
dai-ssb वैकल्पिक

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

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

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

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

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

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

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

media verification एंडपॉइंट के लिए किए जाने वाले अनुरोध, एक तरह के अनुरोध होते हैं.

तरीके
media verification GET /{media_verification_url}/{ad_media_id}

मीडिया की पुष्टि वाले किसी इवेंट के एपीआई को सूचना देता है.

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

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

तरीके
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

विज्ञापन के मेटाडेटा की जानकारी हासिल करता है.

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

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

GET https://{metadata_url}

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

अगर सफल होता है, तो जवाब में PodMetadata.

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

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

google_1234567890

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

जवाब का डेटा

स्ट्रीम

स्ट्रीम का इस्तेमाल, JSON फ़ॉर्मैट.
JSON के काेड में दिखाना
{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}
फ़ील्ड
stream_id string

GAM का स्ट्रीम आइडेंटिफ़ायर.
stream_manifest string

स्ट्रीम के मेनिफ़ेस्ट यूआरएल का इस्तेमाल, एचएलएस में अलग-अलग वैरिएंट वाली प्लेलिस्ट पाने के लिए किया जाता है या DASH में MPD.
hls_master_playlist string

(अब सेवा में नहीं है) एचएलएस के अलग-अलग वैरिएंट की प्लेलिस्ट का यूआरएल. "stream_manifest" का इस्तेमाल करें आज़माएं.
media_verification_url string

मीडिया की पुष्टि करने वाला यूआरएल, जिसका इस्तेमाल प्लेबैक इवेंट को ट्रैक करने के लिए बेस एंडपॉइंट के तौर पर किया जाता है.
metadata_url string

आने वाले समय में स्ट्रीम होने वाले विज्ञापन इवेंट की जानकारी देने के लिए, पोल का इस्तेमाल किया जाता है.
session_update_url string

सेशन अपडेट करने वाले यूआरएल का इस्तेमाल, इस स्ट्रीम के लिए टारगेटिंग पैरामीटर को अपडेट करने के लिए किया जाता है. स्ट्रीम के लिए अनुरोध करते समय, टारगेटिंग पैरामीटर की ओरिजनल वैल्यू कैप्चर की जाती है.
polling_frequency number

मेटाडेटा_url या CTR_url का अनुरोध करने पर, पोलिंग की फ़्रीक्वेंसी सेकंड में.

PodMetadata

PodMetadata में, विज्ञापनों, विज्ञापन के लिए ब्रेक, और मीडिया आईडी टैग के मेटाडेटा की जानकारी शामिल होती है.
JSON के काेड में दिखाना
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
फ़ील्ड
tags map[string, object(TagSegment)]

टैग प्रीफ़िक्स से इंडेक्स किए गए टैग सेगमेंट का मैप.
ads map[string, object(Ad)]

विज्ञापन आईडी से इंडेक्स किए गए विज्ञापनों का मैप.
ad_breaks map[string, object(AdBreak)]

विज्ञापन के लिए ब्रेक के आईडी की मदद से इंडेक्स किए गए विज्ञापन के लिए ब्रेक का मैप.

TagSegment

Tagsegment में किसी विज्ञापन का रेफ़रंस, उसके विज्ञापन के लिए ब्रेक, और इवेंट टाइप शामिल होता है. टाइप="प्रोग्रेस" वाला Tagसेगमेंट विज्ञापन मीडिया को पिंग नहीं किया जाना चाहिए पुष्टि करने वाला एंडपॉइंट.
JSON के काेड में दिखाना
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
फ़ील्ड
ad string

इस टैग के विज्ञापन का आईडी.
ad_break_id string

इस टैग के विज्ञापन के लिए ब्रेक का आईडी.
type string

इस टैग का इवेंट टाइप.

AdBreak

AdBreak, स्ट्रीम में विज्ञापन के लिए एक ब्रेक की जानकारी देता है. इसमें एक अवधि, टाइप (मिड/प्री/पोस्ट) और विज्ञापनों की संख्या.
JSON के काेड में दिखाना
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
फ़ील्ड
type string

मान्य ब्रेक टाइप हैं: प्री, मिड, और पोस्ट.
duration number

इस विज्ञापन के लिए ब्रेक की कुल अवधि, सेकंड में.
expected_duration number

विज्ञापन के लिए ब्रेक का अनुमानित समय (सेकंड में), इसमें सभी विज्ञापन और सभी स्लेट शामिल हैं.
ads number

विज्ञापन के लिए ब्रेक में विज्ञापनों की संख्या.
विज्ञापन, स्ट्रीम में मौजूद किसी विज्ञापन के बारे में बताता है.
JSON के काेड में दिखाना
{
  "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),
}
फ़ील्ड
ad_break_id string

इस विज्ञापन के लिए विज्ञापन के लिए ब्रेक का आईडी.
position number

विज्ञापन के लिए ब्रेक में इस विज्ञापन की पोज़िशन, 1 से शुरू.
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 string

क्लिक ट्रैकिंग के ऐसे यूआरएल जो ज़रूरी नहीं हैं.
verifications [object(Verification)]

ओपन मेज़रमेंट की पुष्टि करने की एंट्री, जिसमें संसाधनों की जानकारी हो पुष्टि करने के लिए, तीसरे पक्ष के मेज़रमेंट कोड को लागू करने के लिए ज़रूरी मेटाडेटा और मेटाडेटा क्रिएटिव तरीके से चलाना.
slate boolean

वैकल्पिक बूल जो मौजूदा एंट्री को दिखाता है, स्लेट है.
icons [object(Icon)]

आइकॉन की सूची खाली होने पर हटा दी जाती है.
wrappers [object(Wrapper)]

रैपर की सूची, खाली होने पर छोड़ दी जाती है.
universal_ad_id object(UniversalAdID)

Universal विज्ञापन आईडी ज़रूरी नहीं है.
extensions string

सभी <एक्सटेंशन> की वैकल्पिक सूची वीएएसटी में नोड होते हैं.
companions [object(Companion)]

इस विज्ञापन के साथ दिखाए जा सकने वाले वैकल्पिक सहयोगी.
interactive_file object(InteractiveFile)

ज़रूरी नहीं इंटरैक्टिव क्रिएटिव (सिमआईडी), जो विज्ञापन चलने के दौरान दिखाया जाना चाहिए.

आइकॉन

आइकॉन में वीएएसटी (वीडियो विज्ञापन देने के लिए टेंप्लेट) आइकॉन के बारे में जानकारी होती है.
JSON के काेड में दिखाना
{
  "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,
}
फ़ील्ड
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

ClickData में, आइकॉन क्लिकथ्रू के बारे में जानकारी होती है.
JSON के काेड में दिखाना
{
  "url": string,
}
फ़ील्ड
url string

FallbackImage

फ़ॉलबैक इमेज में, वीएएसटी (वीडियो विज्ञापन देने के लिए टेंप्लेट) फ़ॉलबैक इमेज की जानकारी होती है.
JSON के काेड में दिखाना
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
फ़ील्ड
creative_type string

height int32

width int32

resource string

alt_text string

Wrapper

रैपर में किसी रैपर विज्ञापन की जानकारी होती है. इसमें डील आईडी मौजूद न होने पर.
JSON के काेड में दिखाना
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
फ़ील्ड
system string

विज्ञापन सिस्टम आइडेंटिफ़ायर.
ad_id string

रैपर विज्ञापन के लिए इस्तेमाल किया जाने वाला विज्ञापन आईडी.
creative_id string

रैपर विज्ञापन के लिए इस्तेमाल किया गया क्रिएटिव आईडी.
creative_ad_id string

रैपर विज्ञापन के लिए इस्तेमाल किया गया क्रिएटिव विज्ञापन आईडी.
deal_id string

रैपर विज्ञापन के लिए डील का वैकल्पिक आईडी.

पुष्टि करने का तरीका

पुष्टि में, ओपन मेज़रमेंट के लिए जानकारी शामिल होती है. इससे, तीसरे पक्ष के विज्ञापन दिखने से जुड़े आंकड़े और पुष्टि का मेज़रमेंट. फ़िलहाल, सिर्फ़ JavaScript के संसाधनों का इस्तेमाल किया जा सकता है. https://iabtechlab.com/standards/open-measurement-sdk/ देखें
JSON के काेड में दिखाना
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
फ़ील्ड
vendor string

पुष्टि करने वाला वेंडर.
java_script_resources [object(JavaScriptResource)]

पुष्टि करने के लिए JavaScript के संसाधनों की सूची.
tracking_events [object(TrackingEvent)]

पुष्टि के लिए ट्रैकिंग इवेंट की सूची.
parameters string

बूस्ट्रैप की पुष्टि करने वाले कोड में एक ओपेक स्ट्रिंग भेजी गई है.

JavaScriptResource

JavaScriptResource में JavaScript के ज़रिए पुष्टि करने की जानकारी शामिल है.
JSON के काेड में दिखाना
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
फ़ील्ड
script_url string

JavaScript पेलोड के लिए यूआरआई.
api_framework string

APIFramework उस वीडियो फ़्रेमवर्क का नाम है जो पुष्टि करने के लिए भेजा गया कोड.
browser_optional boolean

इस स्क्रिप्ट को ब्राउज़र.

TrackingEvent

TrackingEvent में ऐसे यूआरएल शामिल हैं जिन्हें क्लाइंट को कुछ खास मामलों में पिंग किया जाना चाहिए स्थितियों के बारे में बताना.
JSON के काेड में दिखाना
{
  "event": string,
  "uri": string,
}
फ़ील्ड
event string

ट्रैकिंग इवेंट का टाइप.
uri string

ट्रैकिंग इवेंट को पिंग किया जाना है.

UniversalAdID

UniversalAdID का इस्तेमाल ऐसा यूनीक क्रिएटिव आइडेंटिफ़ायर देने के लिए किया जाता है जो मैनेज किया जा सकता है.
JSON के काेड में दिखाना
{
  "id_value": string,
  "id_registry": string,
}
फ़ील्ड
id_value string

विज्ञापन के लिए चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी.
id_registry string

रजिस्ट्री वेबसाइट के यूआरएल की पहचान करने के लिए इस्तेमाल की जाने वाली स्ट्रिंग जहां चुने गए क्रिएटिव का यूनिवर्सल विज्ञापन आईडी कैटलॉग है.

Companion

कंपैनियन मोड में, दिखाए जा सकने वाले कंपैनियन विज्ञापनों की जानकारी मौजूद है साथ में बदलाव करें.
JSON के काेड में दिखाना
{
  "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)],
}
फ़ील्ड
click_data object(ClickData)

इस कंपैनियन के लिए क्लिक डेटा.
creative_type string

<StaticResource> पर CreativeType एट्रिब्यूट वीएएसटी में नोड होना चाहिए, अगर यह स्टैटिक टाइप का कंपैनियन है.
height int32

इस कंपैनियन की लंबाई (पिक्सल में).
width int32

इस कंपैनियन की चौड़ाई (पिक्सल में).
resource string

स्टैटिक और iframe साथ काम करने वालों के लिए, यह लोड किया जाने वाला यूआरएल होगा और दिखाया जाएगा. एचटीएमएल कंपैनियन के लिए, यह एचटीएमएल स्निपेट होगा जिसे कंपैनियन मोड का इस्तेमाल कर रहे हैं.
type string

इस कंपैनियन का टाइप. यह स्टैटिक, iframe या एचटीएमएल हो सकता है.
ad_slot_id string

इस कंपैनियन के लिए स्लॉट आईडी.
api_framework string

इस कंपैनियन के लिए एपीआई फ़्रेमवर्क.
tracking_events [object(TrackingEvent)]

इस कंपैनियन के लिए ट्रैकिंग इवेंट की सूची.

InteractiveFile

InteractiveFile में इंटरैक्टिव क्रिएटिव की जानकारी शामिल है (जैसे SIMID) जिसे विज्ञापन प्लेबैक के दौरान दिखाया जाना चाहिए.
JSON के काेड में दिखाना
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
फ़ील्ड
resource string

इंटरैक्टिव क्रिएटिव का यूआरएल.
type string

संसाधन के तौर पर दी गई फ़ाइल का MIME टाइप.
variable_duration boolean

इस क्रिएटिव को चालू करने की अवधि को बढ़ाने के लिए कहा जा सकता है या नहीं.
ad_parameters string

<AdParameters> का मान नोड को वीएएसटी (वीडियो विज्ञापन देने के लिए टेम्प्लेट) में जोड़ना होगा.