Early ad break notification v1

Early Ad Break Notification API का इस्तेमाल करना

  • उस लाइव स्ट्रीम का आइडेंटिफ़ायर जिसमें विज्ञापन के लिए ब्रेक बनाया जा रहा है. यह आइडेंटिफ़ायर इनमें से कोई एक हो सकता है:
  • लाइव स्ट्रीम की “ऐसेट कुंजी”.
  • लाइव स्ट्रीम का “कस्टम एसेट पासकोड”. इसकी मदद से, अपनी आइडेंटिफ़ायर स्ट्रिंग तय करके, अपना पासकोड मैनेज किया जा सकता है.
  • लाइव स्ट्रीम का “कॉन्टेंट सोर्स आईडी” और “कॉन्टेंट आईडी”.

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

  • अगले विज्ञापन के लिए ब्रेक की अनुमानित अवधि. विज्ञापन के लिए ब्रेक की अवधि, असल अवधि के जितना हो सके उतना होनी चाहिए.

इन ज़रूरी फ़ील्ड के अलावा, कस्टम टारगेटिंग पैरामीटर, लागू करने के लिए विज्ञापन पॉड टेंप्लेट का नाम या SCTE35 क्यू आउट डेटा भी भेजा जा सकता है. हालांकि, यह डेटा उपलब्ध होने पर ही भेजा जा सकता है.

ज़रूरी शर्तें

EABN API का इस्तेमाल करने के लिए, आपको एक सेवा खाता बनाना होगा और खाते को अपने Google Ad Manager नेटवर्क में जोड़ना होगा.

सेवा खाता बनाया जा रहा है

EABN API को कॉल करने के लिए सेवा खाता बनाने के लिए, यह तरीका अपनाएं: - अगर आपके पास Google Cloud खाता है, तो सेवा खाता बनाने के लिए IAM मॉड्यूल का इस्तेमाल करें. ज़्यादा जानकारी के लिए, सेवा खाते बनाना और मैनेज करना लेख पढ़ें. - अगर आपके पास Google Cloud खाता नहीं है, तो Google API Console से खाता बनाने के लिए यह तरीका अपनाएं:

  1. नया प्रोजेक्ट बनाएं या कोई मौजूदा प्रोजेक्ट चुनें.
  2. क्रेडेंशियल पेज पर, सेवा खाते मैनेज करें पर क्लिक करें.
  3. सेवा खाते पेज पर, सेवा खाता बनाएं पर क्लिक करें.
  4. सेवा खाता बनाएं पेज पर, खाते की जानकारी डालें. इसके बाद, बनाएं पर क्लिक करें.

सेवा खाता बनाने के बाद, खाते की JSON कुंजी कॉपी करें. इसका इस्तेमाल पुष्टि करने के लिए किया जाता है.

अपने Google Ad Manager नेटवर्क में सेवा खाता जोड़ना

अपने सेवा खाते को अपने नेटवर्क में जोड़ने के लिए, एपीआई ऐक्सेस के लिए सेवा खाते का उपयोगकर्ता जोड़ना में दिया गया तरीका अपनाएं.

एपीआई को चालू करना

सेवा खाता बनाने के बाद, अपने खाते के लिए एपीआई चालू करने के लिए, अपने खाता मैनेजर को यह जानकारी दें:

  • आपके Google Cloud खाते का ईमेल पता
  • आपका सेवा खाता
  • आपके Google Ad Manager नेटवर्क का नेटवर्क कोड.

आपके खाता मैनेजर के एपीआई चालू करने के बाद, एपीआई चालू करने के लिए यह तरीका अपनाएं:

  1. Google API लाइब्रेरी में, “Google Ad Manager Video API” खोजें.
  2. चालू करें पर क्लिक करें.

ध्यान दें: अगर खोज के नतीजों में एपीआई नहीं दिखता है, तो अपने खाता मैनेजर से संपर्क करके पुष्टि करें कि आपके खाते को DAI API के लिए चालू किया गया है.

एपीआई का इस्तेमाल करना

JSON/REST अनुरोधों का इस्तेमाल करके, EABN API को कॉल किया जा सकता है.

अनुमति देना

EABN API को अनुमति वाले कॉल करने के लिए, आपको अपने सेवा खाते की JSON कुंजी और दायरे https://www.googleapis.com/auth/video-ads का इस्तेमाल करके, OAuth2 सेवा खाते के क्रेडेंशियल जनरेट करने होंगे. ज़्यादा जानकारी के लिए, सर्वर से सर्वर ऐप्लिकेशन के लिए OAuth 2.0 का इस्तेमाल करना लेख पढ़ें.

आपको EABN API को किए जाने वाले हर कॉल के लिए, अनुमति वाले टोकन को Auth हेडर के तौर पर शामिल करना होगा.

विज्ञापन के लिए ब्रेक की सूचना पहले से भेजना

विज्ञापन के लिए ब्रेक की सूचना पहले भेजने के लिए, तीन मान्य ईएबीएन यूआरएल में से किसी एक पर पोस्ट अनुरोध भेजें. यह इस बात पर निर्भर करता है कि आपको लाइव स्ट्रीम की जानकारी कैसे देनी है. यहां दिए गए सेक्शन में, यूआरएल के बीच के अंतर के बारे में बताया गया है. साथ ही, अनुरोध और जवाब के उदाहरण भी दिए गए हैं.

यूआरएल

विज्ञापन के लिए ब्रेक की सूचना देने वाले तीन मान्य यूआरएल हैं. विज्ञापन के लिए ब्रेक (POST) बनाने या असाइन किए गए विज्ञापन के लिए ब्रेक की सूची (GET) पाने के लिए, तीनों तरह के ब्रेक का इस्तेमाल किया जा सकता है.

लाइव स्ट्रीम के ऐसेट पासकोड का इस्तेमाल करने के लिए, इनका इस्तेमाल करें:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

लाइव स्ट्रीम की कस्टम ऐसेट कुंजी का इस्तेमाल करने के लिए, इनका इस्तेमाल करें:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

कॉन्टेंट सोर्स आईडी और Content ID के तरीके का इस्तेमाल करने के लिए, इनका इस्तेमाल करें:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

सभी पैरामीटर के लिए:

  • network_code, आपके Google Ad Manager नेटवर्क का नेटवर्क कोड दिखाता है.
  • asset_key, लाइव स्ट्रीम की जानकारी वाले पेज पर दिखाई गई एसेट कुंजी को दिखाता है.
  • custom_asset_key, आपकी लाइव स्ट्रीम की कस्टम एसेट कुंजी दिखाता है.
  • content_source_id, Google Ad Manager में कॉन्टेंट सोर्स का आईडी दिखाता है.
  • content_id, Google Ad Manager में किसी कॉन्टेंट के आईडी को दिखाता है.

ध्यान दें: तय किया गया content_source_id/content_id पेयर, Google Ad Manager में किसी लाइव स्ट्रीम से जुड़ा होना चाहिए.

अनुरोध का मुख्य हिस्सा - इसका इस्तेमाल सिर्फ़ विज्ञापन के लिए ब्रेक बनाने के लिए किया जाता है (POST)

ऑब्जेक्ट

expectedDuration

ज़रूरी है विज्ञापन के लिए ब्रेक की अवधि, Google के स्टैंडर्ड फ़ॉर्मैट में दी गई हो. जैसे, xx.xxxs, जहां xx.xxx सेकंड की संख्या है

customParams

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

=

और इसमें

&

.
उदाहरण:

key=value&key2=value2,value3


टारगेटिंग के बारे में ज़्यादा जानने के लिए, अपनी स्ट्रीम में टारगेटिंग पैरामीटर की वैल्यू दें लेख पढ़ें.

podTemplateName

वैकल्पिक विज्ञापन पॉड टेंप्लेट का नाम

scte35CueOut

वैकल्पिक scte35 क्यू आउट से Base-64 में कोड में बदला गया डेटा. इसमें ये शामिल हो सकते हैं

splice_insert()

या

time_signal()

निर्देश दें.
उदाहरण:

  • time_signal():

    /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==

  • splice_insert():

    /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=

अनुरोध के उदाहरण

विज्ञापन के लिए ब्रेक बनाना
POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
    "expectedDuration": "30s",
    "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
    "customParams": "param1=value1&param2=value2",
    "podTemplateName": "podtemplate"
}
जवाब का मुख्य भाग

रिस्पॉन्स बॉडी में, adBreak ऑब्जेक्ट में भेजे गए सभी पैरामीटर के साथ-साथ एक अतिरिक्त name फ़ील्ड भी होता है. इस फ़ील्ड में, बनाए गए विज्ञापन के ब्रेक का Google-वाइड स्टैंडर्ड आईडी होता है. यह फ़ील्ड इस फ़ॉर्मैट में दिखता है:

networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}
जवाब का उदाहरण
HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
  "customParams": "param1=value1&param2=value2",
  "podTemplateName": "podtemplate"
}
असाइन किए गए विज्ञापन के लिए ब्रेक की सूची
GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
जवाब का मुख्य भाग

रिस्पॉन्स बॉडी में, स्ट्रीम के लिए असाइन किए गए हर विज्ञापन के लिए एक अतिरिक्त breakState फ़ील्ड के साथ विज्ञापन के लिए ब्रेक होते हैं. breakState फ़ील्ड में ये वैल्यू इस्तेमाल की जा सकती हैं:

 // Ad break decisioning has started.
BREAK_STATE_DECISIONED

// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE
जवाब का उदाहरण
HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "breakState": "BREAK_STATE_COMPLETE"
}