Early ad break notification

विज्ञापन के लिए सबसे पहले ब्रेक लेने की सूचना एपीआई का इस्तेमाल करना

ध्यान दें: यह एपीआई अब भी बीटा वर्शन में है. अगर आपको ईएबीएन प्रोग्राम के ऐक्सेस का अनुरोध करना है, तो अपने खाता मैनेजर से संपर्क करें.

विज्ञापन के लिए ब्रेक की सूचना (ईएबीएन) एपीआई की मदद से, Google Ad Manager को विज्ञापन के लिए ब्रेक की सूचना दी जा सकती है. ऐसा विज्ञापन के लिए ब्रेक शुरू होने से पहले ही, विज्ञापन के लिए ब्रेक के मेटाडेटा की मदद से किया जाता है. विज्ञापन के लिए ब्रेक से एक घंटे पहले तक, सूचना का अनुरोध भेजा जा सकता है. इस गाइड में, EABN API को चालू और इस्तेमाल करने के तरीके के साथ-साथ अनुरोध और रिस्पॉन्स के सैंपल के बारे में बताया गया है.

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

ईएबीएन एपीआई पर किए जाने वाले कॉल में यह जानकारी शामिल होनी चाहिए:

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

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

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

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

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

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

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

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

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

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

आपके सेवा खाते को Google Ad Manager नेटवर्क से जोड़ा जा रहा है

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

एपीआई की सुविधा चालू की जा रही है

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

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

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

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

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

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

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

अनुमति देना

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

आपको ईएबीएन एपीआई को किए जाने वाले हर कॉल के लिए, अनुमति वाले टोकन को ऑथराइज़ेशन हेडर के तौर पर शामिल करना होगा.

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

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

यूआरएल

विज्ञापन के लिए ब्रेक की शुरुआती सूचना के तीन मान्य यूआरएल होते हैं. विज्ञापन के लिए ब्रेक (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 सोर्स आईडी और 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 में किसी लाइव स्ट्रीम से जुड़ा होना चाहिए.

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

ऑब्जेक्ट

expectedDuration

ज़रूरी है Google के मानक अवधि फ़ॉर्मैट (xx.xxxs जहां xx.xxx सेकंड की संख्या है) का इस्तेमाल करके इस विज्ञापन के लिए ब्रेक की अवधि

customParams

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

=

और इन्होंने शामिल किया

&

.
उदाहरण:

key=value&key2=value2,value3


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

podTemplateName

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

scte35CueOut

वैकल्पिक scte35 क्यू आउट से बेस-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"
}