बैकग्राउंड ऑडियो विज्ञापन प्लेबैक

यह गाइड उन पब्लिशर के लिए है जो अपने Android ऐप्लिकेशन में ऑडियो विज्ञापन लोड करना चाहते हैं.

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

  • IMA Android SDK का 3.16.1 या इसके बाद का वर्शन.

हमारा सुझाव है कि अगर पब्लिशर के पास फ़िलहाल ऑडियो प्लेयर ऐप्लिकेशन नहीं है, तो GitHub पर ऑडियो प्लेयर का उदाहरण देखें. इस उदाहरण में, फ़ोरग्राउंड प्लेयर के तौर पर ExoPlayer का इस्तेमाल किया गया है. इस गाइड के बाकी हिस्से में, IMA विज्ञापनों के बैकग्राउंड ऑडियो में वीडियो चलाने की ज़रूरी सुविधाओं के बारे में बताया गया है.

अपने ऐप्लिकेशन में बैकग्राउंड में विज्ञापन चलाने की सुविधा जोड़ना

ऐप्लिकेशन के बैकग्राउंड मोड में होने पर, संगीत और ऑडियो विज्ञापन चलाना जारी रखने के लिए, Service कॉम्पोनेंट बनाया जा सकता है जिसमें कस्टम ऑडियो प्लेयर और विज्ञापन लोड करने वाला हिस्सा शामिल होता है.

अगर आपके ऐप्लिकेशन में MainActivity और AudioPlayerService ऑडियो चलाने के लिए है, तो अपनी AndroidManifest.xml फ़ाइल में बदलाव करने का तरीका नीचे बताया गया है:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="…">
  <uses-permission android:name="android.permission.INTERNET"/>
  <uses-permission android:name="android.permission.FOREGROUND_SERVICE"/>
  <application … >
    <activity android:name=".MainActivity" android:exported="true">
      <intent-filter>
        <action android:name="android.intent.action.MAIN"/>
        <category android:name="android.intent.category.LAUNCHER"/>
      </intent-filter>
    </activity>
    <service android:name=".AudioPlayerService"
             android:exported="false"/>
  </application>
</manifest>

इस सेवा में, आपके पास कस्टम ऑडियो प्लेयर बनाने का विकल्प है. यह कोई भी मीडिया प्लेयर हो सकता है. हालांकि, इसके लिए ज़रूरी है कि यह IMA SDK के साथ इंटरैक्ट करने के लिए VideoAdPlayer इंटरफ़ेस भी लागू करता हो.

IMA SDK v. 3.16.1 में एक नया फ़ंक्शन जोड़ा गया, createAudioAdDisplayContainer, ताकि विज्ञापन लोड करने वाले के लिए एक खास कंटेनर बनाया जा सके, ताकि ऑडियो विज्ञापनों का अनुरोध किया जा सके.

यह कोड स्निपेट शुरू करने और ऑडियो विज्ञापन का अनुरोध करने के लिए, AudioPlayerService का एक उदाहरण दिखाता है.

import android.app.Service;

import com.google.ads.interactivemedia.v3.api.AdDisplayContainer;
import com.google.ads.interactivemedia.v3.api.AdsLoader;
import com.google.ads.interactivemedia.v3.api.AdsRequest;
import com.google.ads.interactivemedia.v3.api.CompanionAdSlot;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;
import com.google.ads.interactivemedia.v3.api.ImaSdkSettings;
import com.google.ads.interactivemedia.v3.api.player.VideoAdPlayer;

import com.google.common.collect.ImmutableList;

/** Plays music and ads even when the app enters background mode. */
public class AudioPlayerService extends Service {

  /**
   * A custom audio player that implements the `VideoAdPlayer` interface.
   */
  private VideoAdPlayer audioPlayer;

  /**
   * An object to create other SDK objects: `AdDisplayContainer`, `AdsLoader` and `AdRequest`.
   */
  private ImaSdkFactory sdkFactory;

  /**
   * An object to make ad requests that would return an `AdsManager`.
   */
  private AdsLoader adsLoader;

  /**
   * An optional list of ViewGroup for rendering companion banners.
   */
  private ImmutableList<CompanionAdSlot> companionAdSlots;

  /**
   * Creates an AdsLoader for requesting ads and handling ad events.
   */
  public void initializeAds() {
    sdkFactory = ImaSdkFactory.getInstance();
    ImaSdkSettings imaSdkSettings = ImaSdkFactory.getInstance().createImaSdkSettings();
    AdDisplayContainer container = ImaSdkFactory.createAudioAdDisplayContainer(this, audioPlayer);
    if (companionAdSlots != null) {
      container.setCompanionSlots(companionAdSlots);
    }
    adsLoader = sdkFactory.createAdsLoader(this, imaSdkSettings, container);

    // Adds event handling logic for ads.
    // For more details, see
    // https://developers.google.com/interactive-media-ads/docs/sdks/android#create-an-adsloader
    adsLoader.addAdsLoadedListener(…);
    adsLoader.addAdErrorListener(…);
  }

  /**
   * Adds a companion ad slot. This slot is not required but can be set in ads initialization.
   *
   * @param companionAdSlot UI container for rendering companion banners.
   */
  public void addCompanionAdSlot(CompanionAdSlot companionAdSlot) {
    this.companionAdSlots = ImmutableList.of(companionAdSlot);
  }

  /**
   * Makes an audio ad request.
   *
   * @param adTagUrl Url to download an ad tag.
   */
  public void requestAd(String adTagUrl) {
    AdsRequest request = sdkFactory.createAdsRequest();
    request.setAdTagUrl(adTagUrl);
    adsLoader.requestAds(request);
  }
  ...
}

सहभागी विज्ञापन स्लॉट के साथ विज्ञापनों का इस्तेमाल करना

आप सहयोगी विज्ञापन स्लॉट के साथ या उसके बिना विज्ञापन शुरू कर सकते हैं. साथ-साथ चलने वाले विज्ञापनों को रेंडर करने का विकल्प चुनने पर, आपको सर्विस बाइंडर की मदद से MainActivity क्लास को AudioPlayerService का ऐक्सेस देना होगा, जैसा कि यहां दिखाया गया है:

import android.app.Service;
import android.content.Intent;
import android.os.Binder;
import android.os.IBinder;

import androidx.annotation.Nullable;
...
/** Plays music and ads even when the app enters background mode. */
public class AudioPlayerService extends Service {
  ...
  @Nullable
  @Override
  public IBinder onBind(Intent intent) {
    return new ServiceBinder(this);
  }

  /**
   * Provides access to the `AudioPlayerService` instance after binding.
   */
  public class ServiceBinder extends Binder {
    private final AudioPlayerService boundService;

    /**
     * @param service The bound instance of the service
     */
    public ServiceBinder(AudioPlayerService service) {
      boundService = service;
    }

    public AudioPlayerService getBoundService() {
      return boundService;
    }
  }
}

MainActivity क्लास से विज्ञापन शुरू करने के दौरान, addCompanionAdSlot() फ़ंक्शन को कॉल करके, यूज़र इंटरफ़ेस (यूआई) कंटेनर को पास किया जा सकता है. इससे, सहयोगी बैनर विज्ञापन रेंडर किए जा सकते हैं.

import android.app.Activity;
import android.content.ComponentName;
import android.content.Context;
import android.content.ServiceConnection;
import android.os.Bundle;
import android.os.IBinder;
import android.view.ViewGroup;

import com.google.ads.interactivemedia.v3.api.CompanionAdSlot;
import com.google.ads.interactivemedia.v3.api.ImaSdkFactory;

public class MainActivity extends Activity {

  private AudioPlayerService boundService;
  private ServiceConnection connection;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main_activity);

    ImaSdkFactory sdkFactory = ImaSdkFactory.getInstance();

    ViewGroup companionView = findViewById(R.id.companionAdSlotFrame);
    final CompanionAdSlot companionAdSlot = sdkFactory.createCompanionAdSlot();
    companionAdSlot.setContainer(companionView);
    companionAdSlot.setSize(640, 640);

    connection =
        new ServiceConnection() {
          @Override
          public void onServiceConnected(ComponentName name, IBinder binder) {
            boundService = ((AudioPlayerService.ServiceBinder) binder).getBoundService();
            boundService.addCompanionAdSlot(companionAdSlot);
            boundService.initializeAds();
          }
          ...
        };
    ...
    bindService(intent, connection, Context.BIND_AUTO_CREATE);
  }
  ...
}

अगर आपको कोई समस्या आती है, तो ऑडियो प्लेयर के उदाहरण से इसकी तुलना की जा सकती है. बैकग्राउंड ऑडियो विज्ञापन चलाने से जुड़े सवालों के जवाब पाने के लिए, कृपया IMA SDK फ़ोरम में संपर्क करें.