REST Resource: adBreak.networks.assets.adBreaks

संसाधन: AdBreak

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

JSON के काेड में दिखाना 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
फ़ील्ड
name

string

सिर्फ़ आउटपुट के लिए. विज्ञापन ब्रेक का संसाधन नाम. इस फ़ील्ड का फ़ॉर्मैट "networks/{network_code}/assets/{asset_key}/adBreaks/{adBreakId}" होगा.

network_code, Google Ad Manager में मौजूद वह नेटवर्क कोड है जिससे यह कॉन्टेंट जुड़ा है.

asset_key, Google Ad Manager में मौजूद लाइव स्ट्रीम इवेंट की कुंजी है. इसी कुंजी के तहत, विज्ञापन ब्रेक बनाया गया था.

adBreakId, विज्ञापन ब्रेक की कुंजी है. OUTPUT ONLY.
createTime

string (Timestamp format)

सिर्फ़ आउटपुट के लिए. विज्ञापन ब्रेक बनाए जाने का समय.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
expectedDuration

string (Duration format)

ज़रूरी है. ब्रेक की अनुमानित अवधि.

यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
customParams
(deprecated)

string

ज़रूरी नहीं. Ad Manager में कस्टम शर्तों के हिसाब से टारगेटिंग के लिए, इस ब्रेक के विज्ञापन अनुरोधों में शामिल किए जाने वाले की-वैल्यू पेयर. उदाहरण: 'key1=value&key2=value2,value22' अब इस्तेमाल नहीं किया जा सकता: कृपया "cust_params" कुंजी का इस्तेमाल करके, breakParams.ad_tag_params में cust_params सेट करें.
scte35CueOut

string

ज़रूरी नहीं. scte35 cue out से Base 64 में कोड में बदला गया डेटा. इसमें splice_insert() या time_signal() कमांड शामिल हो सकती है. उदाहरण: - with time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - with splice_insert(): "/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

ज़रूरी नहीं. Google Ad Manager पॉड टेंप्लेट का नाम. बंद कर दिया गया: कृपया "ptpln" कुंजी का इस्तेमाल करके, breakParams.ad_tag_params में cust_params सेट करें.
breakState

enum (BreakState)

सिर्फ़ आउटपुट के लिए. विज्ञापन ब्रेक की मौजूदा स्थिति.
expectedStartTime

string (Timestamp format)

ज़रूरी नहीं. विज्ञापन ब्रेक के शुरू होने का अनुमानित समय.

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

ज़रूरी नहीं. यह फ़ंक्शन, विज्ञापन के लिए ब्रेक को expectedStartTime + expireDuration पर खत्म कर देता है. अगर expectedStartTime सेट नहीं है, तो फ़ैसला लेने की प्रोसेस शुरू होने के बाद, विज्ञापन ब्रेक की समयसीमा expireDuration पर खत्म हो जाएगी. डिफ़ॉल्ट: 30 मिनट कम से कम: 5 मिनट ज़्यादा से ज़्यादा: 6 घंटे

यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
breakSequence

string (int64 format)

सिर्फ़ आउटपुट के लिए. विज्ञापन ब्रेक का मिडरॉल सीक्वेंस आईडी. अगर breakParams.ad_tag_params में mridx कुंजी का इस्तेमाल करके, विज्ञापन के लिए एक से ज़्यादा ब्रेक के लिए एक ही breakSequence तय किया गया है, तो ऐसा किया जा सकता है. इससे GAM के दो विज्ञापन ब्रेक लिंक हो जाते हैं.
breakParams

object (BreakParams)

ज़रूरी नहीं. इस ब्रेक के लिए विज्ञापन अनुरोधों में शामिल किए जाने वाले ब्रेक पैरामीटर.
matchParams

object (MatchParams)

ज़रूरी नहीं. इस कुकी का इस्तेमाल स्टिच्ड डीएआई के लिए किया जाता है. इससे यह तय किया जाता है कि एपीआई के ज़रिए बनाया गया विज्ञापन ब्रेक, मेनिफ़ेस्ट में मौजूद विज्ञापन ब्रेक से कैसे मैच किया जाता है. जब किसी नए ब्रेक का पता चलता है, तो मैच फ़ंक्शन को किसी इवेंट के उन सभी विज्ञापन ब्रेक के ख़िलाफ़ चलाया जाएगा जिनका breakState SCHEDULED या DECISIONED है. इससे यह पता चलेगा कि विज्ञापन ब्रेक के matchParams में सेट किए गए सभी पैरामीटर, पता लगाए गए ब्रेक से मेल खाते हैं या नहीं. इनमें से कोई भी शर्त पूरी होने पर, मैच मिल जाता है: 1. विज्ञापन ब्रेक में matchParams फ़ील्ड होता है. इसमें सेट किए गए सभी पैरामीटर, नए ब्रेक से मैच करते हैं. 2. विज्ञापन ब्रेक DECISIONED है और इसमें matchParams फ़ील्ड नहीं है.

अगर matchParams सेट किए गए हैं, तो उन्हें खाली नहीं छोड़ा जा सकता. ऐसा इसलिए, ताकि गलती से "सभी से मैच करें" व्यवहार न हो (यह तब होता है, जब matchParams मौजूद तो हों, लेकिन खाली हों). अगर फ़ील्ड किसी अनुरोध में मौजूद है, तो उसके कम से कम एक फ़ील्ड को सेट किया जाना चाहिए.

विज्ञापन ब्रेक की जांच इस क्रम में की जाती है: 1. matchParams के साथ, expectedStartTime के बढ़ते क्रम और createTime के बढ़ते क्रम के हिसाब से क्रम में लगाया जाता है. इसमें, क्रम में लगाने पर expectedStartTime के बिना विज्ञापन ब्रेक को प्राथमिकता दी जाती है 2. matchParams के बिना, expectedStartTime के बढ़ते क्रम और createTime के बढ़ते क्रम के हिसाब से क्रम में लगाया जाता है. इसमें, क्रम में लगाने पर expectedStartTime के बिना विज्ञापन ब्रेक को प्राथमिकता दी जाती है

अगर सभी लंबित EABN मैच नहीं होते हैं, तो DAI, JIT फ़ैसले लेने के तरीके पर वापस आ जाएगा. इसके लिए, वह अगले उपलब्ध मिडरोल इंडेक्स का इस्तेमाल करेगा
servedBreak

object (ServedBreak)

सिर्फ़ आउटपुट के लिए. इससे दिखाए गए विज्ञापन ब्रेक की असल जानकारी मिलती है. इसे सिर्फ़ COMPLETE breakState वाले विज्ञापन ब्रेक के लिए सेट करें.

BreakState

विज्ञापन ब्रेक की स्थिति.

Enums
BREAK_STATE_UNSPECIFIED विज्ञापन ब्रेक की स्थिति के बारे में जानकारी नहीं है.
BREAK_STATE_DECISIONED विज्ञापन ब्रेक दिखाने का फ़ैसला लिया गया है, लेकिन अब तक उपयोगकर्ताओं को नहीं दिखाया गया है.
BREAK_STATE_COMPLETE उपयोगकर्ताओं को विज्ञापन ब्रेक दिखाया गया.
BREAK_STATE_SCHEDULED विज्ञापन ब्रेक को फ़ैसले के लिए शेड्यूल किया गया है.
BREAK_STATE_EXPIRED विज्ञापन ब्रेक की समयसीमा खत्म हो गई है और इसका इस्तेमाल नहीं किया जा सकता. डिफ़ॉल्ट रूप से, विज्ञापन ब्रेक, expectedStartTime के 30 मिनट बाद खत्म हो जाएंगे. अगर expectedStartTime सेट नहीं किया गया है, तो विज्ञापन ब्रेक, विज्ञापन दिखाने का फ़ैसला लेने के 30 मिनट बाद खत्म हो जाएंगे. expireDuration फ़ील्ड का इस्तेमाल करके, एक्सपायरी की तारीख सेट की जा सकती है.

BreakParams

विज्ञापन ब्रेक से जुड़े पैरामीटर.

JSON के काेड में दिखाना 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
फ़ील्ड
macros[]

object (KeyValue)

ज़रूरी नहीं. कस्टम मैक्रो वैल्यू, विज्ञापन टैग में किसी भी प्लेसहोल्डर को बदल देती हैं. विज्ञापन अनुरोध के समय, DAI, विज्ञापन टैग मैक्रो को %%DAI_PATTERN:[MACRO_KEY]%% के फ़ॉर्म में बड़ा करेगा. यहां MACRO_KEY कुंजी है.

अगर इन्हें सेट किया जाता है, तो ये मैक्रो, पॉड सर्व करने के अनुरोध पर सेट किए गए मैक्रो से ज़्यादा प्राथमिकता लेंगे.
adTagParams[]

object (KeyValue)

ज़रूरी नहीं. यह पैरामीटर, विज्ञापन के मुख्य अनुरोध पर विज्ञापन टैग पैरामीटर को बदल देता है.

इनका इस्तेमाल यह तय करने के लिए किया जाता है कि क्या यह cust_params सेट किए गए पॉड दिखाने के अनुरोधों से पहले ट्रिगर होता है.

आम तौर पर, पैरामीटर, ब्रेक के लिए विज्ञापन के मुख्य अनुरोध पर क्वेरी स्ट्रिंग पैरामीटर को बदल देते हैं. कस्टम यूआरएल फ़ॉर्मैट वाले कुछ विज्ञापन सर्वर के लिए, पैरामीटर विज्ञापन सर्वर की ज़रूरी शर्तों को पूरा करने के लिए, विज्ञापन टैग में मौजूद कुछ जगहों को बदल सकते हैं. AdBreak पर "mridx" वैल्यू सेट करने से, breakSequence फ़ील्ड में दी गई वैल्यू बदल जाएगी. हालांकि, ऐसा तब होगा, जब यह वैल्यू मान्य पॉज़िटिव पूर्णांक हो. यह GAM के अलावा अन्य विज्ञापन सर्वर के लिए भी लागू होता है.

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

KeyValue

यह की-वैल्यू पेयर को दिखाता है.

JSON के काेड में दिखाना 
{
  "key": string,
  "value": string
}
फ़ील्ड
key

string

ज़रूरी है. इस की-वैल्यू पेयर की कुंजी.
value

string

ज़रूरी है. इस की-वैल्यू पेयर की वैल्यू.

MatchParams

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

JSON के काेड में दिखाना 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
फ़ील्ड
scte35Binary

string

ज़रूरी नहीं. SCTE-35 बाइनरी. इस फ़ील्ड से मैच करने के लिए, मेनिफ़ेस्ट में मौजूद विज्ञापन ब्रेक में वही SCTE-35 बाइनरी स्ट्रिंग (base64-encoded) होनी चाहिए. अगर यह खाली है, तो इसे छोड़ दिया जाता है.
scte35Upid

string

ज़रूरी नहीं. SCTE-35 UPID (यूनीक प्रोग्राम आइडेंटिफ़ायर). इस फ़ील्ड से मेल खाने के लिए, इन-मैनिफ़ेस्ट विज्ञापन ब्रेक का SCTE-35 UPID एक जैसा होना चाहिए. UPID एक ऐसी वैल्यू होती है जिसे SCTE-35 बाइनरी से पार्स किया जाता है. अगर यह खाली है, तो इसे छोड़ दिया जाता है.
scte35EventId

integer (uint32 format)

ज़रूरी नहीं. SCTE-35 इवेंट आईडी. इस फ़ील्ड से मैच करने के लिए, मेनिफ़ेस्ट में मौजूद विज्ञापन ब्रेक का इवेंट आईडी (स्प्लाइस इवेंट आईडी/सेगमेंटेशन इवेंट आईडी) एक जैसा होना चाहिए. इवेंट आईडी एक ऐसी वैल्यू होती है जिसे SCTE-35 बाइनरी से पार्स किया जाता है. अगर यह खाली है, तो इसे छोड़ दिया जाता है.
breakDuration

boolean

ज़रूरी नहीं. ब्रेक की अवधि. इस फ़ील्ड से मेल खाने के लिए, मेनिफ़ेस्ट में मौजूद विज्ञापन ब्रेक की अवधि, विज्ञापन ब्रेक की expectedDuration के बराबर होनी चाहिए. इसमें 1 मि॰से॰ का अंतर हो सकता है. अगर यह वैल्यू 'गलत है' पर सेट है, तो इस चरण को छोड़ दिया जाएगा.

ServedBreak

इससे दिखाए गए विज्ञापन ब्रेक की असल जानकारी मिलती है.

JSON के काेड में दिखाना 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
फ़ील्ड
breakDetectTime

string (Timestamp format)

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

यह आरएफ़सी 3339 का इस्तेमाल करता है. इसमें जनरेट किया गया आउटपुट हमेशा Z-नॉर्मलाइज़ किया जाएगा और इसमें 0, 3, 6 या 9 फ़्रैक्शनल अंक इस्तेमाल किए जाएंगे. "Z" के अलावा, अन्य ऑफ़सेट भी स्वीकार किए जाते हैं. उदाहरण: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" या "2014-10-02T15:01:23+05:30".
detectedDuration

string (Duration format)

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

यह सेकंड में अवधि होती है. इसमें नौ दशमलव अंक तक हो सकते हैं. इसके आखिर में 's' होता है. उदाहरण: "3.5s".
scte35CueOut

string

सिर्फ़ आउटपुट के लिए. पहचाना गया base64-encoded SCTE-35 मैसेज, मैच करने वाले विज्ञापन ब्रेक पर पास किया गया.

तरीके

create

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

delete

 लाइव स्ट्रीम में विज्ञापन के लिए ब्रेक को मिटाने के लिए एपीआई.

get

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

list

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

patch

 लाइव स्ट्रीम के दौरान विज्ञापन ब्रेक को अपडेट करने के लिए एपीआई.