Skip to content

PreRollCodingGuide

Akiyoshi Takao edited this page Nov 14, 2019 · 1 revision

広告を表示する

実装の流れ

  1. 管理画面から発行されるsidを指定してモジュールを登録します。

    AMoAdNativePreRoll.prepareAd(sid:sid)
  2. 広告分析情報を作成する。

let reportId = "ABCD" 
let analytics = AMoAdAnalytics(reportId: reportId)
analytics.publisherParam = ["key1": "value1", "key2": "value2"]
  1. 広告を画面に表示する。
     AMoAdNativePreRoll.renderAd(sid: sid,
                                 tag: self.tag,
                                view: self.view,
                           analytics: analytics,
               isFullscreenClickable: false,
                          completion: nil)

実装例

ViewController.swift

import UIKit
import AMoAd
import SnapKit

class ViewController: UIViewController {
  
  let sid: String = "管理画面から取得したプリロール広告のsidを指定してください"
  let tag = "任意の文字列を設定してください"
  
  override func viewDidLoad() {
    super.viewDidLoad()

    // [SDK] 広告分析情報を生成する
    //   => ご利用の際は担当営業までお問い合わせください。利用しない場合は、nilを指定してください。
    let reportId = "ABCD" // レポートを細分化するためのID
    let analytics = AMoAdAnalytics(reportId: reportId)
    analytics.publisherParam = ["key1": "value1", "key2": "value2"]


    // [SDK] 広告準備
    AMoAdNativePreRoll.prepareAd(sid: sid)

    // [SDK] プリロール広告を描画する
    AMoAdNativePreRoll.renderAd(sid: sid,
                                tag: self.tag,
                               view: self.view,
                          analytics: analytics,
                  isFullscreenClickable: false)
    { (_, _, _, result) in
      switch result {
      case .success:
        // 広告を受信
      case .failure:
        // 広告の受信に失敗
      case .empty:
        // 空広告を受信
      @unknown default:
        break
      }
    }
  }

  override func willTransition(to newCollection: UITraitCollection, with coordinator: UIViewControllerTransitionCoordinator) {
    super.willTransition(to: newCollection, with: coordinator)

    // [SDK] 再レイアウトする
    AMoAdNativePreRoll.layoutAd(sid: self.sid, tag: self.tag)
  }
  
}

API詳細

NativePreRollクラス

prepareAd関数

管理画面から発行されるsidに紐づく広告情報を登録します。

パラメータ名 Type required Value
sid String 管理画面から発行されるsidを設定してください

renderAd関数

広告を画面に表示する。

パラメータ名 Type required Value
sid String 管理画面から発行されるsidを設定してください
tag String 同じsidを複数のViwで使用する場合,一意に管理する為に使用する任意の文字列
containerView UIView 広告を乗せるビュー
analytics AMoAdAnalytics 広告分析用データ
isFullscreenClickable Bool 全画面クリックを可能とするかどうか
completion (String, String, UIView, AMoAdResult) -> () コールバック

Analyticsクラス

constructor

広告レポートIDを設定します。

パラメータ名 Type Value
reportId String 広告レポートID

メンバー変数

広告分析情報を設定します。

変数名 Type Value
publisherParam [String : String] 任意のKey & Value

補足情報

ロギング・トレース機能について