Wenn Sie sich mit anderen Nutzern über unsere Produkte austauschen und Feedback geben möchten, treten Sie dem offiziellen Ad Manager-Discord-Kanal auf dem Server der Google Advertising and Measurement Community bei.

IMA SDK einrichten

Plattform auswählen: HTML5 Android iOS tvOS

Mit den IMA SDKs können Sie ganz einfach Multimediaanzeigen in Ihre Websites und Apps einbinden. IMA SDKs can Anzeigen von jedem VAST-konformen Ad-Server anfordern und die Anzeigenwiedergabe in Ihren Apps verwalten. Mit den clientseitigen IMA SDKs, behalten Sie die Kontrolle über die Wiedergabe von Videoinhalten, während das SDK die Anzeigenwiedergabe übernimmt. Anzeigen werden in einem separaten Videoplayer wiedergegeben, der über dem Videoplayer für die Inhalte der App positioniert ist.

In dieser Anleitung wird gezeigt, wie Sie das IMA SDK in eine Videoplayer App einbinden. Wenn Sie eine abgeschlossene Beispiel Integration ansehen oder nachvollziehen möchten, laden Sie das BasicExample von GitHub herunter.

Übersicht über die clientseitige IMA-Implementierung

Die clientseitige IMA-Implementierung umfasst vier Haupt-SDK-Komponenten, die in dieser Anleitung beschrieben werden:

IMAAdDisplayContainer: Ein Containerobjekt, das angibt, wo IMA Anzeigen-UI-Elemente rendert und die Sichtbarkeit misst, einschließlich Active View und Open Measurement.
IMAAdsLoader: Ein Objekt, das Anzeigen anfordert und Ereignisse aus Antworten auf Anzeigenanfragen verarbeitet. Sie sollten nur ein Anzeigenladeprogramm instanziieren, das während der gesamten Lebensdauer der Anwendung wiederverwendet werden kann.
IMAAdsRequest: Ein Objekt, das eine Anzeigenanfrage definiert. In Anzeigenanfragen wird die URL für das VAST-Anzeigen-Tag sowie zusätzliche Parameter wie Anzeigendimensionen angegeben.
IMAAdsManager: Ein Objekt, das die Antwort auf die Anzeigenanfrage enthält, die Anzeigenwiedergabe steuert und auf Anzeigen ereignisse wartet, die vom SDK ausgelöst werden.

Vorbereitung

Für den Start ist Folgendes erforderlich:

Xcode 13 oder höher
Methode zum Installieren des IMA SDK:
- Swift Package Manager (empfohlen)
- CocoaPods
- Eine heruntergeladene Kopie des IMA SDK für iOS

1. Neues Xcode-Projekt erstellen

Erstellen Sie in Xcode ein neues iOS-Projekt mit Objective-C oder Swift. Verwenden Sie BasicExample als Projektnamen.

2. IMA SDK zum Xcode-Projekt hinzufügen

Wählen Sie eine bevorzugte Methode aus, um das IMA SDK zu installieren.

SDK mit CocoaPods installieren

CocoaPods ist ein Abhängigkeitsmanager für Xcode-Projekte und die empfohlene Methode zum Installieren des IMA SDK. Weitere Informationen zur Installation oder Verwendung von CocoaPods finden Sie in der CocoaPods-Dokumentation. Nachdem Sie CocoaPods installiert haben, folgen Sie dieser Anleitung, um das IMA SDK zu installieren:

Erstellen Sie im selben Verzeichnis wie die Datei BasicExample.xcodeproj eine Text datei mit dem Namen Podfile und fügen Sie die folgende Konfiguration hinzu:

Objective-C

platform :ios, '15'

target "BasicExample" do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.30.0'
end
Podfile

Swift

platform :ios, '15'

target "BasicExample" do
  pod 'GoogleAds-IMA-iOS-SDK', '~> 3.30.0'
end
Podfile

Führen Sie im Verzeichnis mit der Podfile-Datei pod install --repo-update aus.
Prüfen Sie, ob die Installation erfolgreich war, indem Sie die Datei BasicExample.xcworkspace öffnen. Sie sollte zwei Projekte enthalten: BasicExample und Pods (die von CocoaPods installierten Abhängigkeiten).

SDK manuell herunterladen und installieren

Wenn Sie Swift Package Manager nicht verwenden möchten, laden Sie das IMA SDK herunter und fügen Sie es manuell Ihrem Projekt hinzu.

Anleitung ein-/ausblenden

Laden Sie auf der Downloadseite für das iOS IMA SDK die neueste Version des iOS IMA SDK herunter und extrahieren Sie sie.
Öffnen Sie BasicExample.xcodeproj.
Klicken Sie im linken Bereich auf den Projektnamen.
Klicken Sie im mittleren Bereich auf Build Phases (Build-Phasen).
Maximieren Sie den Abschnitt Link Binary With Libraries (Binärdatei mit Bibliotheken verknüpfen).
Klicken Sie unten in der Bibliotheksliste auf das Pluszeichen [+].
Klicken Sie auf Add Other (Andere hinzufügen).
Wählen Sie im Verzeichnis, in dem Sie das heruntergeladene SDK extrahiert haben, GoogleInteractiveMediaAds.framework aus und klicken Sie auf Open.
Klicken Sie unten in der Bibliotheksliste noch einmal auf das Pluszeichen [+].
Prüfen Sie in der Spalte Status, ob GoogleInteractiveMediaAds.framework auf Required gesetzt ist.
Fügen Sie das Linker-Flag -ObjC in Ihren Buildeinstellungen hinzu. Weitere Informationen finden Sie unter Apple QA1490.

3. Videoplayer erstellen

Implementieren Sie zuerst einen Videoplayer. Dieser Player verwendet zunächst nicht das IMA SDK und enthält keine Methode zum Auslösen der Wiedergabe.

Objective-C

Importieren Sie die Player-Abhängigkeiten:

#import "ViewController.h"

@import AVFoundation;ViewController.m

Richten Sie die Player-Variablen ein:

@interface ViewController () <IMAAdsLoaderDelegate, IMAAdsManagerDelegate>

/// Content video player.
@property(nonatomic, strong) AVPlayer *contentPlayer;

/// Play button.
@property(nonatomic, weak) IBOutlet UIButton *playButton;

/// UIView in which we will render our AVPlayer for content.
@property(nonatomic, weak) IBOutlet UIView *videoView;ViewController.m

Initialisieren Sie den Videoplayer, wenn die Ansicht geladen wird:

@implementation ViewController

// The content URL to play.
NSString *const kTestAppContentUrl_MP4 =
    @"https://storage.googleapis.com/gvabox/media/samples/stock.mp4";

// Ad tag
NSString *const kTestAppAdTagUrl = @"https://pubads.g.doubleclick.net/gampad/ads?"
  @"iu=/21775744923/external/single_ad_samples&sz=640x480&cust_params=sample_ct%3Dlinear&"
  @"ciu_szs=300x250%2C728x90&gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&"
  @"correlator=";

- (void)viewDidLoad {
  [super viewDidLoad];

  self.playButton.layer.zPosition = MAXFLOAT;

  [self setupAdsLoader];
  [self setUpContentPlayer];
}

#pragma mark Content Player Setup

- (void)setUpContentPlayer {
  // Load AVPlayer with path to our content.
  NSURL *contentURL = [NSURL URLWithString:kTestAppContentUrl_MP4];
  self.contentPlayer = [AVPlayer playerWithURL:contentURL];

  // Create a player layer for the player.
  AVPlayerLayer *playerLayer = [AVPlayerLayer playerLayerWithPlayer:self.contentPlayer];

  // Size, position, and display the AVPlayer.
  playerLayer.frame = self.videoView.layer.bounds;
  [self.videoView.layer addSublayer:playerLayer];

  // Set up our content playhead and contentComplete callback.
  self.contentPlayhead = [[IMAAVPlayerContentPlayhead alloc] initWithAVPlayer:self.contentPlayer];
  [[NSNotificationCenter defaultCenter] addObserver:self
                                           selector:@selector(contentDidFinishPlaying:)
                                               name:AVPlayerItemDidPlayToEndTimeNotification
                                             object:self.contentPlayer.currentItem];
}

- (IBAction)onPlayButtonTouch:(id)sender {
  [self requestAds];
  self.playButton.hidden = YES;
}ViewController.m

Swift

Importieren Sie die Player-Abhängigkeiten:

import AVFoundationPlayerContainerViewController.swift

Richten Sie die Player-Variablen ein:

class PlayerContainerViewController: UIViewController, IMAAdsLoaderDelegate, IMAAdsManagerDelegate {
  static let contentURL = URL(
    string: "https://storage.googleapis.com/gvabox/media/samples/stock.mp4")!

  private var contentPlayer = AVPlayer(url: PlayerContainerViewController.contentURL)

  private lazy var playerLayer: AVPlayerLayer = {
    AVPlayerLayer(player: contentPlayer)
  }()PlayerContainerViewController.swift

Initialisieren Sie den Videoplayer, wenn die Ansicht geladen wird:

private lazy var videoView: UIView = {
  let videoView = UIView()
  videoView.translatesAutoresizingMaskIntoConstraints = false
  view.addSubview(videoView)

  NSLayoutConstraint.activate([
    videoView.bottomAnchor.constraint(
      equalTo: view.safeAreaLayoutGuide.bottomAnchor),
    videoView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
    videoView.trailingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.trailingAnchor),
    videoView.leadingAnchor.constraint(equalTo: view.safeAreaLayoutGuide.leadingAnchor),
  ])
  return videoView
}()

// MARK: - View controller lifecycle methods

override func viewDidLoad() {
  super.viewDidLoad()

  videoView.layer.addSublayer(playerLayer)
  adsLoader.delegate = self

  NotificationCenter.default.addObserver(
    self,
    selector: #selector(contentDidFinishPlaying(_:)),
    name: .AVPlayerItemDidPlayToEndTime,
    object: contentPlayer.currentItem)
}

override func viewDidAppear(_ animated: Bool) {
  super.viewDidAppear(animated)
  playerLayer.frame = videoView.layer.bounds
}

override func viewWillTransition(
  to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator
) {
  coordinator.animate { _ in
    // do nothing
  } completion: { _ in
    self.playerLayer.frame = self.videoView.layer.bounds
  }
}

// MARK: - Public methods

func playButtonPressed() {
  requestAds()
}PlayerContainerViewController.swift

4. IMA SDK importieren

So importieren Sie das IMA SDK:

Objective-C

Importieren Sie das IMA SDK:

@import GoogleInteractiveMediaAds;ViewController.m

Erstellen Sie Variablen für die in der App verwendeten Klassen IMAAdsLoader, IMAAVPlayerContentPlayhead und IMAAdsManager:

// SDK
/// Entry point for the SDK. Used to make ad requests.
@property(nonatomic, strong) IMAAdsLoader *adsLoader;

/// Playhead used by the SDK to track content video progress and insert mid-rolls.
@property(nonatomic, strong) IMAAVPlayerContentPlayhead *contentPlayhead;

/// Main point of interaction with the SDK. Created by the SDK as the result of an ad request.
@property(nonatomic, strong) IMAAdsManager *adsManager;ViewController.m

Swift

Importieren Sie das IMA SDK:

import GoogleInteractiveMediaAds
PlayerContainerViewController.swift

Erstellen Sie Variablen für die in der App verwendeten Klassen IMAAdsLoader, IMAAVPlayerContentPlayhead und IMAAdsManager:

static let adTagURLString =
  "https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/"
  + "single_ad_samples&sz=640x480&cust_params=sample_ct%3Dlinear&ciu_szs=300x250%2C728x90&"
  + "gdfp_req=1&output=vast&unviewed_position_start=1&env=vp&correlator="

private let adsLoader = IMAAdsLoader()
private var adsManager: IMAAdsManager?

private lazy var contentPlayhead: IMAAVPlayerContentPlayhead = {
  IMAAVPlayerContentPlayhead(avPlayer: contentPlayer)
}()PlayerContainerViewController.swift

5. Content-Playhead-Tracker und End-of-Stream-Observer implementieren

Um Mid-Roll-Anzeigen abzuspielen, muss das IMA SDK die aktuelle Position Ihrer Videoinhalte verfolgen. Erstellen Sie dazu eine Klasse, die IMAContentPlayhead implementiert. Wenn Sie einen AVPlayer verwenden, wie in diesem Beispiel gezeigt, stellt das SDK die Klasse IMAAVPlayerContentPlayhead bereit, die dies für Sie übernimmt. Wenn Sie AVPlayer nicht verwenden, müssen Sie IMAContentPlayhead in einer eigenen Klasse implementieren.

Sie müssen dem SDK auch mitteilen, wenn die Wiedergabe Ihrer Inhalte beendet ist, damit Post-Roll-Anzeigen präsentiert werden können. Rufen Sie dazu die contentComplete Methode für das IMAAdsLoader-Objekt mit AVPlayerItemDidPlayToEndTimeNotification auf.

Objective-C

Erstellen Sie die IMAAVPlayerContentPlayhead-Instanz in der Player-Einrichtung:

// Set up our content playhead and contentComplete callback.
self.contentPlayhead = [[IMAAVPlayerContentPlayhead alloc] initWithAVPlayer:self.contentPlayer];
[[NSNotificationCenter defaultCenter] addObserver:self
                                         selector:@selector(contentDidFinishPlaying:)
                                             name:AVPlayerItemDidPlayToEndTimeNotification
                                           object:self.contentPlayer.currentItem];ViewController.m

Erstellen Sie die Methode contentDidFinishPlaying(), um IMAAdsLoader.contentComplete() aufzurufen, wenn die Wiedergabe der Inhalte beendet ist:

- (void)contentDidFinishPlaying:(NSNotification *)notification {
  // Make sure we don't call contentComplete as a result of an ad completing.
  if (notification.object == self.contentPlayer.currentItem) {
    [self.adsLoader contentComplete];
  }
}ViewController.m

Swift

Erstellen Sie den Observer für das Ende der Wiedergabe in der Player-Einrichtung:

NotificationCenter.default.addObserver(
  self,
  selector: #selector(contentDidFinishPlaying(_:)),
  name: .AVPlayerItemDidPlayToEndTime,
  object: contentPlayer.currentItem)PlayerContainerViewController.swift

Erstellen Sie die Methode contentDidFinishPlaying(), um IMAAdsLoader.contentComplete() aufzurufen, wenn die Wiedergabe der Inhalte beendet ist:

@objc func contentDidFinishPlaying(_ notification: Notification) {
  // Make sure we don't call contentComplete as a result of an ad completing.
  if notification.object as? AVPlayerItem == contentPlayer.currentItem {
    adsLoader.contentComplete()
  }
}PlayerContainerViewController.swift

6. Anzeigenladeprogramm initialisieren und Anzeigenanfrage senden

Um eine Reihe von Anzeigen anzufordern, müssen Sie eine IMAAdsLoader-Instanz erstellen. Dieses Ladeprogramm verarbeitet IMAAdsRequest-Objekte, die mit einer bestimmten Anzeigen-Tag-URL verknüpft sind.

Als Best Practice sollten Sie nur eine Instanz von IMAAdsLoader für den gesamten Lebenszyklus Ihrer App verwenden. Wenn Sie zusätzliche Anzeigenanfragen senden möchten, erstellen Sie ein neues IMAAdsRequest-Objekt, verwenden Sie aber dasselbe IMAAdsLoader-Objekt. Weitere Informationen finden Sie in den IMA SDK-FAQs.

Objective-C

- (void)setupAdsLoader {
  self.adsLoader = [[IMAAdsLoader alloc] initWithSettings:nil];
  self.adsLoader.delegate = self;
}

- (void)requestAds {
  // Create an ad display container for ad rendering.
  IMAAdDisplayContainer *adDisplayContainer =
      [[IMAAdDisplayContainer alloc] initWithAdContainer:self.videoView
                                          viewController:self
                                          companionSlots:nil];
  // Create an ad request with our ad tag, display container, and optional user context.
  IMAAdsRequest *request = [[IMAAdsRequest alloc] initWithAdTagUrl:kTestAppAdTagUrl
                                                adDisplayContainer:adDisplayContainer
                                                   contentPlayhead:self.contentPlayhead
                                                       userContext:nil];
  [self.adsLoader requestAdsWithRequest:request];
}ViewController.m

Swift

private func requestAds() {
  // Create ad display container for ad rendering.
  let adDisplayContainer = IMAAdDisplayContainer(
    adContainer: videoView, viewController: self, companionSlots: nil)
  // Create an ad request with our ad tag, display container, and optional user context.
  let request = IMAAdsRequest(
    adTagUrl: PlayerContainerViewController.adTagURLString,
    adDisplayContainer: adDisplayContainer,
    contentPlayhead: contentPlayhead,
    userContext: nil)

  adsLoader.requestAds(with: request)
}PlayerContainerViewController.swift

7. Anzeigenladeprogramm-Delegate einrichten

Bei einem erfolgreichen Ladeereignis ruft das IMAAdsLoader die adsLoadedWithData Methode des zugewiesenen Delegates auf und übergibt ihr eine Instanz von IMAAdsManager. Sie können dann den Anzeigenmanager initialisieren, der die einzelnen Anzeigen lädt, wie in der Antwort auf die Anzeigen-Tag-URL definiert.

Außerdem müssen Sie alle Fehler behandeln, die während des Ladevorgangs auftreten können. Wenn Anzeigen nicht geladen werden, muss die Medienwiedergabe ohne Anzeigen fortgesetzt werden, um die Nutzererfahrung nicht zu beeinträchtigen.

Objective-C

- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  // Grab the instance of the IMAAdsManager and set ourselves as the delegate.
  self.adsManager = adsLoadedData.adsManager;
  self.adsManager.delegate = self;
  // Create ads rendering settings to tell the SDK to use the in-app browser.
  IMAAdsRenderingSettings *adsRenderingSettings = [[IMAAdsRenderingSettings alloc] init];
  adsRenderingSettings.linkOpenerPresentingController = self;
  // Initialize the ads manager.
  [self.adsManager initializeWithAdsRenderingSettings:adsRenderingSettings];
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Something went wrong loading ads. Log the error and play the content.
  NSLog(@"Error loading ads: %@", adErrorData.adError.message);
  [self.contentPlayer play];
}ViewController.m

Swift

func adsLoader(_ loader: IMAAdsLoader, adsLoadedWith adsLoadedData: IMAAdsLoadedData) {
  // Grab the instance of the IMAAdsManager and set ourselves as the delegate.
  adsManager = adsLoadedData.adsManager
  adsManager?.delegate = self

  // Create ads rendering settings and tell the SDK to use the in-app browser.
  let adsRenderingSettings = IMAAdsRenderingSettings()
  adsRenderingSettings.linkOpenerPresentingController = self

  // Initialize the ads manager.
  adsManager?.initialize(with: adsRenderingSettings)
}

func adsLoader(_ loader: IMAAdsLoader, failedWith adErrorData: IMAAdLoadingErrorData) {
  if let message = adErrorData.adError.message {
    print("Error loading ads: \(message)")
  }
  contentPlayer.play()
}PlayerContainerViewController.swift

8. Anzeigenmanager-Delegate einrichten

Schließlich benötigt der Anzeigenmanager ein eigenes Delegate, um Ereignisse und Statusänderungen zu verwalten. Das IMAAdManagerDelegate-Objekt enthält Methoden zum Verarbeiten von Anzeigenereignissen und -fehlern sowie Methoden zum Auslösen der Wiedergabe und zum Pausieren Ihrer Videoinhalte.

Wiedergabe starten

Warten Sie auf das Ereignis LOADED, um die Wiedergabe von Inhalten und Anzeigen zu starten. Weitere Informationen finden Sie unter didReceiveAdEvent.

Objective-C

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdEvent:(IMAAdEvent *)event {
  // When the SDK notified us that ads have been loaded, play them.
  if (event.type == kIMAAdEvent_LOADED) {
    [adsManager start];
  }
}ViewController.m

Swift

func adsManager(_ adsManager: IMAAdsManager, didReceive event: IMAAdEvent) {
  // When the SDK notifies us the ads have been loaded, play them.
  if event.type == IMAAdEventType.LOADED {
    adsManager.start()
  }
}PlayerContainerViewController.swift

Fehler verarbeiten

Fügen Sie auch einen Handler für Anzeigenfehler hinzu. Wenn ein Fehler auftritt, wie im vorherigen Schritt, setzen Sie die Wiedergabe der Inhalte fort.

Objective-C

- (void)adsManager:(IMAAdsManager *)adsManager didReceiveAdError:(IMAAdError *)error {
  // Something went wrong with the ads manager after ads were loaded. Log the error and play the
  // content.
  NSLog(@"AdsManager error: %@", error.message);
  [self.contentPlayer play];
}ViewController.m

Swift

func adsManager(_ adsManager: IMAAdsManager, didReceive error: IMAAdError) {
  // Something went wrong with the ads manager after ads were loaded.
  // Log the error and play the content.
  if let message = error.message {
    print("AdsManager error: \(message)")
  }
  contentPlayer.play()
}PlayerContainerViewController.swift

Auf Wiedergabe- und Pausenereignisse warten

Die letzten beiden Delegate-Methoden, die Sie implementieren müssen, lösen Wiedergabe- und Pausenereignisse für die zugrunde liegenden Videoinhalte aus, wenn das IMA SDK sie anfordert. Wenn die Wiedergabe und das Pausieren auf Anfrage ausgelöst werden, verpasst der Nutzer keine Teile der Videoinhalte, wenn Anzeigen präsentiert werden.

Objective-C

- (void)adsManagerDidRequestContentPause:(IMAAdsManager *)adsManager {
  // The SDK is going to play ads, so pause the content.
  [self.contentPlayer pause];
}

- (void)adsManagerDidRequestContentResume:(IMAAdsManager *)adsManager {
  // The SDK is done playing ads (at least for now), so resume the content.
  [self.contentPlayer play];
}ViewController.m

Swift

func adsManagerDidRequestContentPause(_ adsManager: IMAAdsManager) {
  // The SDK is going to play ads, so pause the content.
  contentPlayer.pause()
}

func adsManagerDidRequestContentResume(_ adsManager: IMAAdsManager) {
  // The SDK is done playing ads (at least for now), so resume the content.
  contentPlayer.play()
}PlayerContainerViewController.swift

Jetzt weißt du Bescheid. Sie fordern jetzt Anzeigen mit dem IMA SDK an und präsentieren sie. Weitere Informationen zu zusätzlichen SDK-Funktionen finden Sie in den anderen Anleitungen oder in den Beispielen auf GitHub.

Nächste Schritte

Um die Anzeigeneinnahmen auf der iOS-Plattform zu maximieren, fordern Sie die Berechtigung für App-Transparenz und Tracking an, um IDFA zu verwenden.

IMA SDK einrichten Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Übersicht über die clientseitige IMA-Implementierung

Vorbereitung

1. Neues Xcode-Projekt erstellen

2. IMA SDK zum Xcode-Projekt hinzufügen

Empfohlen: SDK mit Swift Package Manager installieren

SDK mit CocoaPods installieren

Objective-C

Swift

SDK manuell herunterladen und installieren

Anleitung ein-/ausblenden

3. Videoplayer erstellen

Objective-C

Swift

4. IMA SDK importieren

Objective-C

Swift

5. Content-Playhead-Tracker und End-of-Stream-Observer implementieren

Objective-C

Swift

6. Anzeigenladeprogramm initialisieren und Anzeigenanfrage senden

Objective-C

Swift

7. Anzeigenladeprogramm-Delegate einrichten

Objective-C

Swift

8. Anzeigenmanager-Delegate einrichten

Wiedergabe starten

Objective-C

Swift

Fehler verarbeiten

Objective-C

Swift

Auf Wiedergabe- und Pausenereignisse warten

Objective-C

Swift

Nächste Schritte

IMA SDK einrichten