הפעלה של מודעות אודיו ברקע

המדריך הזה מיועד לבעלי אתרים שרוצים לטעון מודעות אודיו לאפליקציות שלהם ל-Android.

חשוב: לא מומלץ להפעיל מודעות וידאו במצב רקע.

דרישות מוקדמות

• IMA Android SDK גרסה 3.16.1 ואילך.

אם אין להם כרגע אפליקציה של נגן אודיו, אנחנו ממליצים לבעלי תוכן דיגיטלי לעיין בדוגמה לנגן אודיו ב-github. בדוגמה הזו, ExoPlayer הוא הנגן הקדמי. בהמשך המדריך מתוארות התכונות הנדרשות להפעלת אודיו ברקע של מודעות IMA.

נקודה חשובה: הדוגמה הבסיסית מטמיעה את התוסף Exoplayer-IMA שמטפל ברוב ההגדרות של IMA SDK. לכן אי אפשר להשתמש בדוגמה הבסיסית כנקודת התחלה במדריך הזה.

הוספת הפעלה של מודעות ברקע לאפליקציה שלך

כדי שההפעלה של מודעות המוזיקה והאודיו תמשיך כשהאפליקציה במצב רקע, אפשר ליצור רכיב 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>

בשירות תוכלו ליצור נגן אודיו בהתאמה אישית, שיכול להיות כל נגן מדיה, כל עוד מוטמע בו גם הממשק של VideoAdPlayer לאינטראקציה עם IMA SDK.

בגרסה 3.16.1 של IMA SDK נוספה פונקציה חדשה, 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);
  }
  ...
}

שימוש במודעות עם מיקומי מודעות נלוות

אפשר להפעיל מודעות עם או בלי מיקומי מודעות נלוות. אם תבחרו לעבד מודעות נלוות, תצטרכו לתת גישה ל-AudioPlayerService למחלקה MainActivity באמצעות Service Bder כפי שמוצג בהמשך:

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 לקבלת תמיכה.