IMA डीएआई SDK टूल का इस्तेमाल शुरू करना

डीआई (डायनामिक विज्ञापन) का वह समाधान चुनें जिसमें आपकी दिलचस्पी है

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

IMA SDK टूल की मदद से, वेबसाइटों और ऐप्लिकेशन में मल्टीमीडिया विज्ञापनों को आसानी से इंटिग्रेट किया जा सकता है.

IMA SDK टूल, वीएएसटी (वीडियो विज्ञापन देने के लिए टेंप्लेट) का पालन करने वाले किसी भी विज्ञापन सर्वर से विज्ञापनों का अनुरोध कर सकते हैं. साथ ही, आपके ऐप्लिकेशन में विज्ञापन चलाने की सुविधा को मैनेज कर सकते हैं.

IMA डीएआई SDK की मदद से, ऐप्लिकेशन वीओडी या लाइव कॉन्टेंट के लिए, विज्ञापन और कॉन्टेंट वीडियो के लिए स्ट्रीम का अनुरोध करते हैं. इसके बाद, SDK टूल एक कॉम्बिनेटेड वीडियो स्ट्रीम दिखाता है, ताकि आपको अपने ऐप्लिकेशन में विज्ञापन और कॉन्टेंट वीडियो के बीच स्विच करने की ज़रूरत न पड़े.

इस गाइड में, CAF के लिए IMA DAI SDK टूल का इस्तेमाल करके, डीएआई पॉड सर्विंग स्ट्रीम चलाने का तरीका बताया गया है.

इस गाइड का इस्तेमाल करने से पहले, Chromecast Application Framework के वेब रिसीवर प्रोटोकॉल के बारे में जानें. इस गाइड में, सीएफ़ रिसीवर के कॉन्सेप्ट के बारे में बुनियादी जानकारी का होना ज़रूरी है. जैसे, मैसेज इंटरसेप्ट करने वाले टूल और mediaInformation ऑब्जेक्ट. साथ ही, सीएफ़ भेजने वाले को एमुलेट करने के लिए, कास्ट कमांड और कंट्रोल टूल का इस्तेमाल करने की जानकारी होना ज़रूरी है.

IMA डीएआई पॉड सर्विंग का इस्तेमाल करने के लिए, आपके पास पॉड सर्विंग पार्टनर के साथ काम करने के साथ-साथ, Ad Manager 360 ऐडवांस खाता होना चाहिए. अगर आपके पास Ad Manager खाता है, तो ज़्यादा जानकारी के लिए अपने खाता मैनेजर से संपर्क करें. Ad Manager के लिए साइन अप करने के बारे में जानने के लिए, Ad Manager के सहायता केंद्र पर जाएं.

अन्य प्लैटफ़ॉर्म के साथ इंटिग्रेट करने या IMA क्लाइंट-साइड SDK टूल इस्तेमाल करने के बारे में जानने के लिए, इंटरैक्टिव मीडिया विज्ञापन SDK टूल देखें.

IMA डीएआई पॉड दिखाने की सुविधा के बारे में खास जानकारी

IMA CAF DAI SDK का इस्तेमाल करके पॉड सर्विंग लागू करने के लिए, दो मुख्य कॉम्पोनेंट ज़रूरी हैं. इनके बारे में इस गाइड में बताया गया है:

  • StreamRequest: यह एक ऑब्जेक्ट है, जो Google के विज्ञापन सर्वर को स्ट्रीम का अनुरोध करता है. अनुरोधों में नेटवर्क कोड, कस्टम एसेट कुंजी, और वैकल्पिक एपीआई कुंजी के साथ-साथ, अन्य वैकल्पिक पैरामीटर की जानकारी होती है.
  • StreamManager: यह एक ऐसा ऑब्जेक्ट है जो वीडियो स्ट्रीम और IMA DAI SDK के बीच कम्यूनिकेशन को मैनेज करता है. जैसे, ट्रैकिंग पिंग को ट्रिगर करना और पब्लिशर को स्ट्रीम इवेंट फ़ॉरवर्ड करना.

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

  • रजिस्टर किए गए टेस्ट डिवाइसों वाला Cast डेवलपर कंसोल खाता.
  • होस्ट किया गया वेब रिसीवर ऐप्लिकेशन, जिसे आपके Cast डेवलपर कंसोल में रजिस्टर किया गया हो. साथ ही, इस गाइड में दिए गए कोड को होस्ट करने के लिए, इसमें बदलाव किया जा सकता हो.
  • भेजने वाला ऐप्लिकेशन, जो आपके वेब रिसीवर ऐप्लिकेशन का इस्तेमाल करने के लिए कॉन्फ़िगर किया गया हो. इस उदाहरण के लिए, कास्ट कमांड और कंट्रोल टूल को भेजने वाले ऐप्लिकेशन के तौर पर इस्तेमाल करें.

ईमेल भेजने वाले के MediaInfo ऑब्जेक्ट कॉन्फ़िगर करना

सबसे पहले, ईमेल भेजने वाले ऐप्लिकेशन के MediaInfo ऑब्जेक्ट को कॉन्फ़िगर करें, ताकि इन फ़ील्ड को शामिल किया जा सके:

फ़ील्ड सामग्री
contentId इस मीडिया आइटम का यूनीक आइडेंटिफ़ायर.

CONTENT_ID

contentUrl ज़रूरी नहीं. अगर डीएआई स्ट्रीम लोड नहीं होती है, तो चलाने के लिए बैकअप स्ट्रीम का यूआरएल.

BACKUP_STREAM_URL

contentType ज़रूरी नहीं. कॉन्टेंट के बैकअप की स्ट्रीम का Mimetype. यह सिर्फ़ DASH स्ट्रीम के लिए ज़रूरी है.

CONTENT_STREAM_MIMETYPE

streamType इस वैल्यू के लिए इस्तेमाल की गई स्ट्रिंग लिटरल या कॉन्स्टेंट, ईमेल भेजने वाले के प्लैटफ़ॉर्म के हिसाब से अलग-अलग होता है.
customData customData फ़ील्ड में, ज़रूरी अन्य फ़ील्ड का एक की-वैल्यू स्टोर होता है. इस सैंपल में, आपकी डीएआई स्ट्रीम के पैरामीटर शामिल हैं. किसी प्रोडक्शन ऐप्लिकेशन में, इसके बजाय कोई ऐसा आइडेंटिफ़ायर पास किया जा सकता है जिसका इस्तेमाल आपका कास्ट रिसीवर ऐप्लिकेशन, सर्वर साइड के अनुरोध की मदद से इन पैरामीटर को वापस पाने के लिए करेगा.
फ़ील्ड सामग्री
daiStreamType आपकी डीएआई स्ट्रीम का टाइप. "LIVE" या "VOD" में से कोई एक

DAI_STREAM_TYPE

networkCode आपके Google Ad Manager 360 खाते का नेटवर्क कोड.

NETWORK_CODE

customAssetKey यह फ़ील्ड सिर्फ़ लाइव स्ट्रीम के लिए ज़रूरी है. कस्टम एसेट की, जो Google Ad Manager 360 में आपके पॉड दिखाने वाले इवेंट की पहचान करती है.

CUSTOM_ASSET_KEY

apiKey IMA DAI SDK से स्ट्रीम आईडी पाने के लिए, वैकल्पिक एपीआई पासकोड.

API_KEY

इसे शुरू करने में आपकी मदद करने के लिए, यहां कुछ कोड सैंपल दिए गए हैं:

वेब

Cast वेब सेंडर में इन वैल्यू को कॉन्फ़िगर करने के लिए, सबसे पहले ज़रूरी डेटा के साथ एक MediaInfo ऑब्जेक्ट बनाएं. इसके बाद, वेब रिसीवर से लोड करने का अनुरोध करें.

// Create mediaInfo object
const mediaInfo = new chrome.cast.media.MediaInfo("CONTENT_ID");
mediaInfo.contentUrl = "BACKUP_STREAM_URL";
mediaInfo.contentType = "CONTENT_STREAM_MIMETYPE";
mediaInfo.streamType = chrome.cast.media.StreamType.LIVE;
mediaInfo.customData = {
  daiStreamType: "DAI_STREAM_TYPE",
  networkCode: "NETWORK-CODE",
  customAssetKey: "CUSTOM_ASSET_KEY",
  apiKey: "API_KEY"
};

// Make load request to cast web receiver
const castSession = cast.framework.CastContext.getInstance().getCurrentSession();
const request = new chrome.cast.media.LoadRequest(mediaInfo);
castSession.loadMedia(request).then(
  () => { console.log('Load succeed'); },
  (errorCode) => { console.log('Error code: ' + errorCode); });

Android

Cast वेब सेंडर में इन वैल्यू को कॉन्फ़िगर करने के लिए, सबसे पहले ज़रूरी डेटा के साथ एक MediaInfo ऑब्जेक्ट बनाएं. इसके बाद, वेब रिसीवर से लोड करने का अनुरोध करें.

JSONObject customData = new JSONObject()?
  .put("daiStreamType", "DAI_STREAM_TYPE")
  .put("networkCode", "NETWORK-CODE")
  .put("customAssetKey", "CUSTOM_ASSET_KEY")
  .put("apiKey", "API_KEY");
MediaInfo mediaInfo = MediaInfo.Builder("CONTENT_ID")
  .setContentUrl("BACKUP_STREAM_URL")
  .setContentType("CONTENT_STREAM_MIMETYPE")
  .setStreamType(MediaInfo.STREAM_TYPE_LIVE)
  .setCustomData(customData)
  .build();

RemoteMediaClient remoteMediaClient = mCastSession.getRemoteMediaClient();
remoteMediaClient.load(new MediaLoadRequestData.Builder().setMediaInfo(mediaInfo).build());

iOS (Obj-C)

Cast वेब सेंडर में इन वैल्यू को कॉन्फ़िगर करने के लिए, सबसे पहले ज़रूरी डेटा के साथ एक GCKMediaInformation ऑब्जेक्ट बनाएं. इसके बाद, वेब रिसीवर से लोड करने का अनुरोध करें.

NSURL url = [NSURL URLWithString:@"BACKUP_STREAM_URL"];
NSDictionary *customData = @{
  @"daiStreamType": @"DAI_STREAM_TYPE",
  @"networkCode": @"NETWORK-CODE",
  @"customAssetKey": @"CUSTOM_ASSET_KEY",
  @"apiKey": @"API_KEY"};
mediaInfoBuilder.customData = customData;

GCKMediaInformationBuilder *mediaInfoBuilder =
  [[GCKMediaInformationBuilder alloc] initWithContentID: @"CONTENT_ID"];
mediaInfoBuilder.contentURL = url;
mediaInfoBuilder.contentType = @"CONTENT_STREAM_MIMETYPE";
mediaInfoBuilder.streamType = GCKMediaStreamTypeLive;
mediaInfoBuilder.customData = customData;
self.mediaInformation = [mediaInfoBuilder build];

GCKRequest *request = [self.sessionManager.currentSession.remoteMediaClient loadMedia:self.mediaInformation];
if (request != nil) {
  request.delegate = self;
}

iOS (Swift)

Cast वेब सेंडर में इन वैल्यू को कॉन्फ़िगर करने के लिए, सबसे पहले ज़रूरी डेटा के साथ एक GCKMediaInformation ऑब्जेक्ट बनाएं. इसके बाद, वेब रिसीवर से लोड करने का अनुरोध करें.

let url = URL.init(string: "BACKUP_STREAM_URL")
guard let mediaURL = url else {
  print("invalid mediaURL")
  return
}

let customData = [
  "daiStreamType": "DAI_STREAM_TYPE",
  "networkCode": "NETWORK-CODE",
  "customAssetKey": "CUSTOM_ASSET_KEY",
  "region": "API_KEY"
]

let mediaInfoBuilder = GCKMediaInformationBuilder.init(contentId: "CONTENT_ID")
mediaInfoBuilder.contentURL = mediaUrl
mediaInfoBuilder.contentType = @"CONTENT_STREAM_MIMETYPE"
mediaInfoBuilder.streamType = GCKMediaStreamType.Live
mediaInfoBuilder.customData = customData
mediaInformation = mediaInfoBuilder.build()

guard let mediaInfo = mediaInformation else {
  print("invalid mediaInformation")
  return
}

if let request = sessionManager.currentSession?.remoteMediaClient?.loadMedia
(mediaInfo) {
  request.delegate = self
}

सीएसी टूल

कास्ट कमांड और कंट्रोल टूल में इन वैल्यू को कॉन्फ़िगर करने के लिए, 'मीडिया लोड करें' टैब पर क्लिक करें. इसके बाद, पसंद के मुताबिक लोड करने का अनुरोध टाइप को 'लोड करें' पर सेट करें. इसके बाद, टेक्स्ट एरिया में मौजूद JSON डेटा को इस JSON से बदलें:

{
  "media": {
    "contentId": "CONTENT_ID",
    "contentUrl": "BACKUP_STREAM_URL",
    "contentType": ""CONTENT_STREAM_MIMETYPE"",
    "streamType": "LIVE",
    "customData": {
      "daiStreamType": "DAI_STREAM_TYPE",
      "networkCode": "NETWORK-CODE",
      "customAssetKey": "CUSTOM_ASSET_KEY",
      "oAuthToken": "API_KEY"
    }
  }
}

बाकी चरण की जांच करने के लिए, इस कस्टम लोड अनुरोध को पाने वाले व्यक्ति को भेजा जा सकता है.

बुनियादी सीएफ़ रिसीवर बनाना

CAF SDK कस्टम वेब रिसीवर की गाइड में बताए गए तरीके से, कस्टम वेब रिसीवर बनाएं.

पैसे पाने वाले का कोड कुछ ऐसा दिखेगा:

<html>
<head>
  <script
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js">
  </script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    // ...
  </script>
</body>
</html>

IMA DAI SDK टूल इंपोर्ट करना और Player Manager पाना

CAF को लोड करने वाली स्क्रिप्ट के ठीक बाद, अपने वेब रिसीवर में CAF के लिए IMA DAI SDK टूल इंपोर्ट करने के लिए, स्क्रिप्ट टैग जोड़ें. स्क्रिप्ट टैग में, रिसीवर शुरू करने से पहले रिसीवर कॉन्टेक्स्ट और प्लेयर मैनेजर को कॉन्स्टेंट के तौर पर सेव करें.

<html>
<head>
  <script
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();

    castContext.start();
  </script>
</body>
</html>

IMA स्ट्रीम मैनेजर को शुरू करना

IMA स्ट्रीम मैनेजर को शुरू करें.

<html>
<head>
  <script type="text/javascript"
      src="//www.gstatic.com/cast/sdk/libs/caf_receiver/v3/cast_receiver_framework.js"></script>
  <script src="//imasdk.googleapis.com/js/sdkloader/cast_dai.js"></script>
</head>
<body>
  <cast-media-player></cast-media-player>
  <script>
    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();
    const streamManager = new google.ima.cast.dai.api.StreamManager();

    castContext.start();
  </script>
</body>
</html>

Stream Manager लोड इंटरसेप्टर बनाना

आपके मीडिया आइटम CAF को भेजे जाने से पहले, LOAD मैसेज इंटरसेप्टर में स्ट्रीम का अनुरोध बनाएं.

    const castContext = cast.framework.CastReceiverContext.getInstance();
    const playerManager = castContext.getPlayerManager();
    const streamManager = new google.ima.cast.dai.api.StreamManager();

    /**
     * Creates a livestream request object for a Pod Serving stream.
     * @param {!LoadRequestData} castRequest The request object from the cast sender
     * @return {StreamRequest} an IMA stream request
     */
    const createStreamRequest = (castRequest) => { /* ... */};

    /**
     * Initates a DAI stream request for the final stream manifest.
     * @param {!LoadRequestData} castRequest The request object from the cast sender
     * @return {Promise<LoadRequestData>} a promise that resolves to an updated castRequest, containing the DAI stream manifest
     */
    const createDAICastRequest = (castRequest) => {
        return streamManager.requestStream(castRequest, createStreamRequest(castRequest))
          .then((castRequestWithPodStreamData) => {
            console.log('Successfully made DAI stream request.');
            // ...
            return castRequestWithPodStreamData;
          })
          .catch((error) => {
            console.log('Failed to make DAI stream request.');
            // CAF will automatically fallback to the content URL
            // that it can read from the castRequest object.
            return castRequest;
          });
    };

    playerManager.setMessageInterceptor(
        cast.framework.messages.MessageType.LOAD, createDAICastRequest);

    castContext.start();

स्ट्रीम का अनुरोध करना

CAF लोड अनुरोध के आधार पर, पॉड सर्विंग स्ट्रीम बनाने के लिए createStreamRequest फ़ंक्शन को पूरा करें.

    /**
     * Creates a livestream request object for a Pod Serving stream.
     * @param {!LoadRequestData} castRequest The request object from the cast sender
     * @return {StreamRequest} an IMA stream request
     */
    const createStreamRequest = (castRequest) => {
      const customData = castRequest.media.customData;
      let streamRequest;
      if (customData.daiStreamType == "LIVE") {
        streamRequest = new google.ima.cast.dai.api.PodStreamRequest();
        streamRequest.customAssetKey = customData.customAssetKey;
        streamRequest.networkCode = customData.networkCode;
        streamRequest.apiKey = customData.apiKey;
      } else if (customData.daiStreamType == "VOD") {
        streamRequest = new google.ima.cast.dai.api.PodVodStreamRequest();
        streamRequest.networkCode = customData.networkCode;
        streamRequest.apiKey = customData.apiKey;
      }
      return streamRequest;
    };

अपने VTP से स्टिच किया गया मेनिफ़ेस्ट वापस पाना

अगर स्ट्रीम का अनुरोध पूरा हो जाता है, तो स्ट्रीम का आईडी पाने के लिए streamManager.getStreamId() का इस्तेमाल करें. आपका वीडियो टेक्निकल पार्टनर (वीटीपी) या कस्टम मेनिफ़ेस्ट मैनिप्युलेटर, इस स्ट्रीम आईडी का इस्तेमाल करके मेनिफ़ेस्ट यूआरएल वापस पाने के लिए निर्देश देगा.

मेनिफ़ेस्ट का यूआरएल वापस पाने के बाद, मौजूदा contentUrl को नए manifestUrl से बदलें.

आखिर में, बदली गई स्ट्रीम मेनिफ़ेस्ट को दिखाने से पहले, streamManager पर loadStreamMetadata तरीका आज़माएं. इससे IMA SDK को यह जानकारी मिलेगी कि वह स्ट्रीम मेटाडेटा का अनुरोध सुरक्षित तरीके से कर सकता है. यह कॉल सिर्फ़ वीओडी स्ट्रीम के लिए ज़रूरी है.

    /**
     * Initates a DAI stream request for the final stream manifest.
     * @param {!LoadRequestData} castRequest The request object from the cast sender
     * @return {Promise<LoadRequestData>} a promise that resolves to an updated castRequest, containing the DAI stream manifest
     */
    const createDAICastRequest = (castRequest) => {
        return streamManager.requestStream(castRequest, createStreamRequest(castRequest))
          .then((castRequestWithPodStreamData) => {
            console.log('Successfully made DAI stream request.');

            // This is a sample VTP integration. Consult your VTP documentation
            // for how to retrieve an ad-stitched stream manifest URL.
            const manifestTemplate = "https://.../manifest.m3u8?gam_stream_id=[[STREAMID]]";
            const streamId = streamManager.getStreamId();
            const manifestUrl = manifestTemplate.replace('[[STREAMID]]', streamId)
            // Assign your manifestUrl to the request's content URL.
            castRequestWithPodStreamData.media.contentUrl = manifestUrl;

            // After generating the manifest URL, VOD streams must notify the
            // IMA SDK that it is safe to request ad pod metadata.
            // This is only necessary for VOD streams. It is a no-op for
            // livestreams, so no conditional is needed.
            streamManager.loadStreamMetadata();

            return castRequestWithPodStreamData;
          })
          .catch((error) => {
            console.log('Failed to make DAI stream request.');
            // CAF will automatically fallback to the content URL
            // that it can read from the castRequest object.
            return castRequest;
          });
    };

IMA DAI ऐसेट को हटाना

IMA DAI SDK की मदद से, पॉड सेर्विंग स्ट्रीम में विज्ञापनों का अनुरोध करने और उन्हें दिखाने के बाद, हमारा सुझाव है कि पॉड सेर्विंग सेशन पूरा होने के बाद, सभी संसाधनों को हटा दें. स्ट्रीम का प्लेबैक रोकने, विज्ञापन की सभी ट्रैकिंग रोकने, और लोड की गई सभी स्ट्रीम ऐसेट को रिलीज़ करने के लिए, StreamManager.destroy() को कॉल करें.