راه اندازی IMA SDK برای DAI، راه اندازی IMA SDK برای DAI، راه اندازی IMA SDK برای DAI، راه اندازی IMA SDK برای DAI

پلتفرم مورد نظر را انتخاب کنید: HTML5 اندروید iOS tvOS Cast Roku

کیت‌های توسعه نرم‌افزار IMA ادغام تبلیغات چندرسانه‌ای را در وب‌سایت‌ها و برنامه‌های شما آسان می‌کنند. کیت‌های توسعه نرم‌افزار IMA می‌توانند از هر سرور تبلیغاتی سازگار با VAST درخواست تبلیغات کنند و پخش تبلیغات را در برنامه‌های شما مدیریت کنند. با کیت‌های توسعه نرم‌افزار IMA DAI، برنامه‌ها درخواست پخش جریانی برای تبلیغات و ویدیوی محتوا - چه VOD و چه محتوای زنده - ارسال می‌کنند. سپس SDK یک جریان ویدیویی ترکیبی را برمی‌گرداند، به طوری که شما مجبور نیستید جابجایی بین ویدیوی تبلیغ و محتوا را در برنامه خود مدیریت کنید.

راهکار DAI مورد نظرتان را انتخاب کنید

سرویس کامل DAI

این راهنما به ادغام IMA DAI SDK در یک برنامه پخش کننده ویدیو می‌پردازد. اگر می‌خواهید نمونه ادغام تکمیل شده را مشاهده یا دنبال کنید، BasicExample را از GitHub دانلود کنید.

مرور کلی IMA DAI

پیاده‌سازی IMA DAI شامل چهار جزء اصلی SDK است، همانطور که این راهنما نشان می‌دهد:

  • IMAAdDisplayContainer – یک شیء کانتینر که روی عنصر پخش ویدیو قرار می‌گیرد و عناصر رابط کاربری تبلیغ را در خود جای می‌دهد.
  • IMAAdsLoader - شیء‌ای که جریان‌ها را درخواست می‌کند و رویدادهایی را که توسط اشیاء پاسخ درخواست جریان ایجاد می‌شوند، مدیریت می‌کند. شما فقط باید یک بارگذار تبلیغات را نمونه‌سازی کنید که می‌تواند در طول عمر برنامه دوباره استفاده شود.
  • IMAStreamRequest – یا یک IMAVODStreamRequest یا یک IMALiveStreamRequest . شیء‌ای که درخواست پخش جریانی را تعریف می‌کند. درخواست‌های پخش جریانی می‌توانند برای پخش‌های ویدیویی درخواستی یا پخش زنده باشند. درخواست‌های پخش زنده یک کلید دارایی را مشخص می‌کنند، در حالی که درخواست‌های VOD یک شناسه CMS و شناسه ویدیو را مشخص می‌کنند. هر دو نوع درخواست می‌توانند به صورت اختیاری شامل یک کلید API مورد نیاز برای دسترسی به پخش‌های مشخص شده و یک کد شبکه Google Ad Manager برای IMA SDK باشند تا شناسه‌های تبلیغات را مطابق با تنظیمات Google Ad Manager مدیریت کند.
  • IMAStreamManager – شیء‌ای که جریان‌های درج تبلیغات پویا و تعاملات با بک‌اند DAI را مدیریت می‌کند. مدیر جریان همچنین پینگ‌های ردیابی را مدیریت کرده و رویدادهای جریان و تبلیغات را به ناشر ارسال می‌کند.

پیش‌نیازها

قبل از شروع، به موارد زیر نیاز دارید:

شما همچنین برای درخواست جریان خود از IMA SDK به پارامترها نیاز دارید. برای مثال‌هایی از پارامترهای درخواست، به Sample Streams مراجعه کنید.

پارامترهای پخش زنده
کلید دارایی کلید دارایی که پخش زنده شما را در Google Ad Manager مشخص می‌کند .
مثال: c-rArva4ShKVIAkNfy6HUQ
پارامترهای جریان VOD
شناسه منبع محتوا شناسه منبع محتوا از Google Ad Manager.
مثال: 2548831
شناسه ویدیو شناسه ویدیو از Google Ad Manager.
مثال: tears-of-steel
پارامترهای رایج (VOD و پخش زنده)
کد شبکه کد شبکه مدیریت تبلیغات گوگل شما.
مثال: 21775744923

ایجاد یک پروژه جدید Xcode

در Xcode، یک پروژه iOS جدید با استفاده از Objective-C با نام "BasicExample" ایجاد کنید.

اضافه کردن IMA DAI SDK به پروژه Xcode

برای نصب IMA SDK، یک روش ترجیحی را انتخاب کنید.

توصیه می‌شود: SDK را با استفاده از Swift Package Manager نصب کنید

کیت توسعه نرم‌افزاری تبلیغات رسانه‌ای تعاملی (Interactive Media Ads SDK) از نسخه ۳.۱۸.۴ به بعد از Swift Package Manager پشتیبانی می‌کند. برای وارد کردن بسته Swift، این مراحل را دنبال کنید.

  1. در Xcode، بسته‌ی سویفت IMA DAI SDK را نصب کنید: به مسیر File > Add Packages بروید.

  2. در اعلانی که ظاهر می‌شود، مخزن گیت‌هاب IMA DAI SDK Swift Package را جستجو کنید:

    https://github.com/googleads/swift-package-manager-google-interactive-media-ads-ios
    
  3. نسخه‌ای از بسته نرم‌افزاری سویفت IMA DAI SDK را که می‌خواهید استفاده کنید، انتخاب کنید. برای پروژه‌های جدید، از Up to Next Major Version استفاده کنید.

وقتی کارتان تمام شد، Xcode وابستگی‌های بسته شما را حل کرده و آنها را در پس‌زمینه دانلود می‌کند. برای جزئیات بیشتر در مورد نحوه اضافه کردن وابستگی‌های بسته، به مقاله اپل مراجعه کنید.

نصب IMA DAI SDK با استفاده از CocoaPods

CocoaPods یک مدیر وابستگی برای پروژه‌های Xcode جهت نصب IMA DAI SDK است. برای اطلاعات بیشتر در مورد نصب یا استفاده از CocoaPods، به مستندات CocoaPods مراجعه کنید. پس از نصب CocoaPods، از این دستورالعمل‌ها برای نصب IMA DAI SDK استفاده کنید:

  1. در همان دایرکتوری که فایل BasicExample.xcodeproj شما قرار دارد، یک فایل متنی به نام Podfile ایجاد کنید و پیکربندی زیر را به آن اضافه کنید:

    platform :ios, '15'
    
    target 'BasicExample' do
      pod 'GoogleAds-IMA-iOS-SDK', '~> 3.28.10'
    end
    

  2. از دایرکتوری که شامل Podfile است، دستور زیر را اجرا کنید:

    pod install --repo-update

دانلود و نصب دستی SDK

اگر نمی‌خواهید از Swift Package Manager استفاده کنید، IMA SDK را دانلود کرده و به صورت دستی به پروژه خود اضافه کنید.

ساخت یک پخش کننده ویدیوی ساده

یک پخش‌کننده ویدیو را در کنترلر نمای اصلی خود پیاده‌سازی کنید؛ یک پخش‌کننده AV را در نمای رابط کاربری قرار دهید. IMA SDK از نمای رابط کاربری برای نمایش عناصر رابط کاربری تبلیغاتی استفاده می‌کند.

هدف-سی

#import "ViewController.h"

#import <AVKit/AVKit.h>

/// Content URL.
static NSString *const kBackupContentUrl =
    @"http://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8";

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

@property(nonatomic, weak) IBOutlet UIView *videoView;
/// Video player.
@property(nonatomic, strong) AVPlayer *videoPlayer;
@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];
  self.view.backgroundColor = [UIColor blackColor];

  // Load AVPlayer with the path to your content.
  NSURL *contentURL = [NSURL URLWithString:kBackupContentUrl];
  self.videoPlayer = [AVPlayer playerWithURL:contentURL];

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

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

- (IBAction)onPlayButtonTouch:(id)sender {
  [self.videoPlayer play];
  self.playButton.hidden = YES;
}

@end

سویفت

// Copyright 2024 Google LLC. All rights reserved.
//
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not use this
// file except in compliance with the License. You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software distributed under
// the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
// ANY KIND, either express or implied. See the License for the specific language governing
// permissions and limitations under the License.

import AVFoundation
import UIKit

class ViewController: UIViewController {

  /// Content URL.
  static let backupStreamURLString =
    "http://devimages.apple.com/iphone/samples/bipbop/bipbopall.m3u8"

  /// Play button.
  @IBOutlet private weak var playButton: UIButton!

  @IBOutlet private weak var videoView: UIView!
  /// Video player.
  private var videoPlayer: AVPlayer?

  override func viewDidLoad() {
    super.viewDidLoad()

    playButton.layer.zPosition = CGFloat(MAXFLOAT)

    // Load AVPlayer with path to our content.
    // note: this unwrap is safe because the URL is a constant string.
    let contentURL = URL(string: ViewController.backupStreamURLString)!
    videoPlayer = AVPlayer(url: contentURL)

    // Create a player layer for the player.
    let playerLayer = AVPlayerLayer(player: videoPlayer)

    // Size, position, and display the AVPlayer.
    playerLayer.frame = videoView.layer.bounds
    videoView.layer.addSublayer(playerLayer)
  }

  @IBAction func onPlayButtonTouch(_ sender: Any) {
    videoPlayer?.play()
    playButton.isHidden = true
  }
}

مقداردهی اولیه‌ی بارگذاری تبلیغات

IMA SDK را به کنترلر نمای خود وارد کنید و پروتکل‌های IMAAdsLoaderDelegate و IMAStreamManagerDelegate را برای مدیریت رویدادهای بارگذاری تبلیغات و مدیریت جریان اتخاذ کنید.

این ویژگی‌های خصوصی را برای ذخیره اجزای کلیدی IMA SDK اضافه کنید:

  • IMAAdsLoader - درخواست‌های استریم را در طول عمر برنامه شما مدیریت می‌کند.
  • IMAAdDisplayContainer - درج و مدیریت عناصر رابط کاربری تبلیغ را مدیریت می‌کند.
  • IMAAVPlayerVideoDisplay - بین IMA SDK و پخش‌کننده رسانه شما ارتباط برقرار می‌کند و فراداده‌های زمان‌بندی‌شده را مدیریت می‌کند.
  • IMAStreamManager - پخش جریان را مدیریت می‌کند و رویدادهای مرتبط با تبلیغات را فعال می‌کند.

پس از بارگذاری نما، بارگذاری‌کننده تبلیغات، ظرف نمایش تبلیغات و نمایش ویدیو را مقداردهی اولیه کنید.

هدف-سی

@import GoogleInteractiveMediaAds;

// ...

@interface ViewController () <IMAAdsLoaderDelegate, IMAStreamManagerDelegate>
/// The entry point for the IMA DAI SDK to make DAI stream requests.
@property(nonatomic, strong) IMAAdsLoader *adsLoader;
/// The container where the SDK renders each ad's user interface elements and companion slots.
@property(nonatomic, strong) IMAAdDisplayContainer *adDisplayContainer;
/// The reference of your video player for the IMA DAI SDK to monitor playback and handle timed
/// metadata.
@property(nonatomic, strong) IMAAVPlayerVideoDisplay *imaVideoDisplay;
/// References the stream manager from the IMA DAI SDK after successful stream loading.
@property(nonatomic, strong) IMAStreamManager *streamManager;

// ...

@end

@implementation ViewController

- (void)viewDidLoad {
  [super viewDidLoad];

  // ...

  self.adsLoader = [[IMAAdsLoader alloc] initWithSettings:nil];
  self.adsLoader.delegate = self;

  // Create an ad display container for rendering each ad's user interface elements and companion
  // slots.
  self.adDisplayContainer =
      [[IMAAdDisplayContainer alloc] initWithAdContainer:self.videoView
                                          viewController:self
                                          companionSlots:nil];

  // Create an IMAAVPlayerVideoDisplay to give the SDK access to your video player.
  self.imaVideoDisplay = [[IMAAVPlayerVideoDisplay alloc] initWithAVPlayer:self.videoPlayer];
}

سویفت

import GoogleInteractiveMediaAds
// ...

class ViewController: UIViewController, IMAAdsLoaderDelegate, IMAStreamManagerDelegate {
  // ...

  /// The entry point for the IMA DAI SDK to make DAI stream requests.
  private var adsLoader: IMAAdsLoader?
  /// The container where the SDK renders each ad's user interface elements and companion slots.
  private var adDisplayContainer: IMAAdDisplayContainer?
  /// The reference of your video player for the IMA DAI SDK to monitor playback and handle timed
  /// metadata.
  private var imaVideoDisplay: IMAAVPlayerVideoDisplay!
  /// References the stream manager from the IMA DAI SDK after successfully loading the DAI stream.
  private var streamManager: IMAStreamManager?

  // ...

  override func viewDidLoad() {
    super.viewDidLoad()

    // ...

    adsLoader = IMAAdsLoader(settings: nil)
    adsLoader?.delegate = self

    // Create an ad display container for rendering ad UI elements and the companion ad.
    adDisplayContainer = IMAAdDisplayContainer(
      adContainer: videoView,
      viewController: self,
      companionSlots: nil)

    // Create an IMAAVPlayerVideoDisplay to give the SDK access to your video player.
    imaVideoDisplay = IMAAVPlayerVideoDisplay(avPlayer: videoPlayer)
  }

درخواست پخش جریانی بدهید

وقتی کاربر دکمه پخش را فشار می‌دهد، یک درخواست پخش جدید ارسال می‌کند. برای پخش زنده از کلاس IMALiveStreamRequest استفاده کنید. برای پخش VOD از کلاس IMAVODStreamRequest استفاده کنید.

درخواست پخش زنده به پارامترهای پخش زنده شما و همچنین ارجاع به کانتینر نمایش تبلیغ و نمایش ویدیوی شما نیاز دارد.

هدف-سی

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

- (void)requestStream {
  // Create a stream request. Use one of "Live stream request" or "VOD request", depending on your
  // type of stream.
  IMAStreamRequest *request;
  if (kStreamType == StreamTypeLive) {
    // Live stream request. Replace the asset key with your value.
    request = [[IMALiveStreamRequest alloc] initWithAssetKey:kLiveStreamAssetKey
                                                 networkCode:kNetworkCode
                                          adDisplayContainer:self.adDisplayContainer
                                                videoDisplay:self.imaVideoDisplay
                                                 userContext:nil];
  } else {
    // VOD request. Replace the content source ID and video ID with your values.
    request = [[IMAVODStreamRequest alloc] initWithContentSourceID:kVODContentSourceID
                                                           videoID:kVODVideoID
                                                       networkCode:kNetworkCode
                                                adDisplayContainer:self.adDisplayContainer
                                                      videoDisplay:self.imaVideoDisplay
                                                       userContext:nil];
  }
  [self.adsLoader requestStreamWithRequest:request];
}

سویفت

@IBAction func onPlayButtonTouch(_ sender: Any) {
  requestStream()
  playButton.isHidden = true
}

func requestStream() {
  // Create a stream request. Use one of "Livestream request" or "VOD request".
  if ViewController.requestType == StreamType.live {
    // Livestream request.
    let request = IMALiveStreamRequest(
      assetKey: ViewController.assetKey,
      networkCode: ViewController.networkCode,
      adDisplayContainer: adDisplayContainer!,
      videoDisplay: imaVideoDisplay,
      userContext: nil)
    adsLoader?.requestStream(with: request)
  } else {
    // VOD stream request.
    let request = IMAVODStreamRequest(
      contentSourceID: ViewController.contentSourceID,
      videoID: ViewController.videoID,
      networkCode: ViewController.networkCode,
      adDisplayContainer: adDisplayContainer!,
      videoDisplay: imaVideoDisplay,
      userContext: nil)
    adsLoader?.requestStream(with: request)
  }
}

به رویدادهای بارگذاری جریان گوش دهید

کلاس IMAAdsLoader در صورت موفقیت‌آمیز بودن مقداردهی اولیه یا شکست درخواست استریم، متدهای IMAAdsLoaderDelegate را فراخوانی می‌کند.

در متد نماینده adsLoadedWithData ، IMAStreamManagerDelegate خود را تنظیم کنید. مدیر جریان را مقداردهی اولیه کنید. با مقداردهی اولیه، مدیر جریان شروع به پخش می‌کند.

در متد delegate failedWithErrorData ، خطا را ثبت کنید. در صورت تمایل، می‌توانید جریان پشتیبان را پخش کنید. به بهترین شیوه‌های DAI مراجعه کنید.

هدف-سی

- (void)adsLoader:(IMAAdsLoader *)loader adsLoadedWithData:(IMAAdsLoadedData *)adsLoadedData {
  NSLog(@"Stream created with: %@.", adsLoadedData.streamManager.streamId);
  self.streamManager = adsLoadedData.streamManager;
  self.streamManager.delegate = self;
  [self.streamManager initializeWithAdsRenderingSettings:nil];
}

- (void)adsLoader:(IMAAdsLoader *)loader failedWithErrorData:(IMAAdLoadingErrorData *)adErrorData {
  // Log the error and play the content.
  NSLog(@"AdsLoader error, code:%ld, message: %@", adErrorData.adError.code,
        adErrorData.adError.message);
  [self.videoPlayer play];
}

سویفت

func adsLoader(_ loader: IMAAdsLoader, adsLoadedWith adsLoadedData: IMAAdsLoadedData) {
  print("DAI stream loaded. Stream session ID: \(adsLoadedData.streamManager!.streamId!)")
  streamManager = adsLoadedData.streamManager!
  streamManager!.delegate = self
  streamManager!.initialize(with: nil)
}

func adsLoader(_ loader: IMAAdsLoader, failedWith adErrorData: IMAAdLoadingErrorData) {
  print("Error loading DAI stream. Error message: \(adErrorData.adError.message!)")
  // Play the backup stream.
  videoPlayer.play()
}

به رویدادهای تبلیغاتی گوش دهید

IMAStreamManager متدهای IMAStreamManagerDelegate را برای ارسال رویدادها و خطاهای استریم به برنامه شما فراخوانی می‌کند.

برای این مثال، رویدادهای تبلیغ اصلی را در کنسول ثبت کنید:

هدف-سی

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdEvent:(IMAAdEvent *)event {
  NSLog(@"Ad event (%@).", event.typeString);
  switch (event.type) {
    case kIMAAdEvent_STARTED: {
      // Log extended data.
      NSString *extendedAdPodInfo = [[NSString alloc]
          initWithFormat:@"Showing ad %ld/%ld, bumper: %@, title: %@, description: %@, contentType:"
                         @"%@, pod index: %ld, time offset: %lf, max duration: %lf.",
                         (long)event.ad.adPodInfo.adPosition, (long)event.ad.adPodInfo.totalAds,
                         event.ad.adPodInfo.isBumper ? @"YES" : @"NO", event.ad.adTitle,
                         event.ad.adDescription, event.ad.contentType,
                         (long)event.ad.adPodInfo.podIndex, event.ad.adPodInfo.timeOffset,
                         event.ad.adPodInfo.maxDuration];

      NSLog(@"%@", extendedAdPodInfo);
      break;
    }
    case kIMAAdEvent_AD_BREAK_STARTED: {
      NSLog(@"Ad break started");
      break;
    }
    case kIMAAdEvent_AD_BREAK_ENDED: {
      NSLog(@"Ad break ended");
      break;
    }
    case kIMAAdEvent_AD_PERIOD_STARTED: {
      NSLog(@"Ad period started");
      break;
    }
    case kIMAAdEvent_AD_PERIOD_ENDED: {
      NSLog(@"Ad period ended");
      break;
    }
    default:
      break;
  }
}

- (void)streamManager:(IMAStreamManager *)streamManager didReceiveAdError:(IMAAdError *)error {
  NSLog(@"StreamManager error with type: %ld\ncode: %ld\nmessage: %@", error.type, error.code,
        error.message);
  [self.videoPlayer play];
}

سویفت

func streamManager(_ streamManager: IMAStreamManager, didReceive event: IMAAdEvent) {
  print("Ad event \(event.typeString).")
  switch event.type {
  case IMAAdEventType.STARTED:
    // Log extended data.
    if let ad = event.ad {
      let extendedAdPodInfo = String(
        format: "Showing ad %zd/%zd, bumper: %@, title: %@, "
          + "description: %@, contentType:%@, pod index: %zd, "
          + "time offset: %lf, max duration: %lf.",
        ad.adPodInfo.adPosition,
        ad.adPodInfo.totalAds,
        ad.adPodInfo.isBumper ? "YES" : "NO",
        ad.adTitle,
        ad.adDescription,
        ad.contentType,
        ad.adPodInfo.podIndex,
        ad.adPodInfo.timeOffset,
        ad.adPodInfo.maxDuration)

      print("\(extendedAdPodInfo)")
    }
    break
  case IMAAdEventType.AD_BREAK_STARTED:
    print("Ad break started.")
    break
  case IMAAdEventType.AD_BREAK_ENDED:
    print("Ad break ended.")
    break
  case IMAAdEventType.AD_PERIOD_STARTED:
    print("Ad period started.")
    break
  case IMAAdEventType.AD_PERIOD_ENDED:
    print("Ad period ended.")
    break
  default:
    break
  }
}

func streamManager(_ streamManager: IMAStreamManager, didReceive error: IMAAdError) {
  print("StreamManager error with type: \(error.type)")
  print("code: \(error.code)")
  print("message: \(error.message ?? "Unknown Error")")
}

برنامه خود را اجرا کنید. در صورت موفقیت، درخواست و پخش جریان‌های Google DAI را با IMA SDK انجام دهید. برای کسب اطلاعات بیشتر در مورد ویژگی‌های پیشرفته‌تر SDK، به سایر راهنماهای فهرست شده در نوار کناری سمت چپ یا نمونه‌های موجود در GitHub مراجعه کنید.