Versions Compared

Version Old Version 6 New Version Current
Changes made by

Robert Apikyan

Robert Apikyan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
stylenone

Prerequisites

  1. https://refinery89.atlassian.net/wiki/x/A4DVSQ

  2. https://refinery89.atlassian.net/wiki/x/BgDOSQiOS Get Started

  3. iOS Manual Implementation

The SDK provides a universal way to display advertisements inside the cell of scrollable controls, such as UITableView and UICollectionView.

Info

We need you to edit your item Layout, so it has a wrapper/holder for the Ads.
Keep in mind this wrapper/holder could be expanded or contracted, so make sure your layout adapts to this changes, this size changes in the layout will be limited by the ad configurations that your technical account manager can edit.

This is because we can not edit your data for adding new items to the adapter, so we take the existing item views and add the ads to them. You can customize which items have ads when you create the configuration for the infinite scroll.

...

Adding the wrapper to the item

The adContainer adWrapper will play the role of a wrapper inside the UITableViewCell’s cell's contentView.

Code Block
languageswift
class InfScrlViewCell: UITableViewCell {

    let label = UILabel()
    // This is the wrapper
    let adContaineradWrapper:UIView = {
        let view = UIView()
        // Specify the item ad tag here
        view.accessibilityLabel = "infiniteScroll_ad_wrapper_tag"
        return view
    }()
    
    override init(style: UITableViewCell.CellStyle, reuseIdentifier: String?) {
        super.init(style: style, reuseIdentifier: reuseIdentifier)
        contentView.addSubview(label)
        // Added the wrapper to the item
        contentView.addSubview(adContaineradWrapper)
        // Setup the constraints
        ...
    }
    ...
}

...

Code Block
languageswift
import UIKit
import R89SDK

class CollectionViewInfiniteScrollViewControllerViewController: UIViewController, UICollectionViewDataSource, UICollectionViewDelegateFlowLayout {
 
    var collectionView: UICollectionView!
    ...
    override func viewDidLoad() {
        super.viewDidLoad()
        // Configure the collection view layout
        let layout = UICollectionViewFlowLayout()
        layout.scrollDirection = .vertical
        layout.estimatedItemSize = UICollectionViewFlowLayout.automaticSize
        // Configure the collection view
        collectionView = UICollectionView(frame: .zero, collectionViewLayout: layout)
        collectionView.dataSource = self
        collectionView.delegate = self
        collectionView.register(DynamicHeightCollectionViewCell.self, forCellWithReuseIdentifier: "cell")
        // Add constraints to fill the view
        collectionView.translatesAutoresizingMaskIntoConstraints = false
        view.addSubview(collectionView)
        NSLayoutConstraint.activate([
            collectionView.topAnchor.constraint(equalTo: view.safeAreaLayoutGuide.topAnchor),
            collectionView.leadingAnchor.constraint(equalTo: view.leadingAnchor),
            collectionView.trailingAnchor.constraint(equalTo: view.trailingAnchor),
            collectionView.bottomAnchor.constraint(equalTo: view.safeAreaLayoutGuide.bottomAnchor)
        ])
    }
    ...
}

Adding the wrapper to the item

The adContainer adWrapper will play the role of a wrapper inside the UICollectionView’s cell’s contentView.

Code Block
languageswift
class DynamicHeightCollectionViewCell:  UICollectionViewCell {
    
    let label = UILabel()
    
    let adContaineradWrapper: UIView = {
        let view = UIView()
        // Specify the item ad tag here
        view.accessibilityLabel = "infiniteScroll_ad_wrapper_tag"
        return view
    }()
    
    override init(frame: CGRect) {
        super.init(frame: frame)
        contentView.addSubview(label)
        // Added the wrapper to the item
        contentView.addSubview(adWrapper)
        // Setup the constraints
        ...
    }
    ...
}

Show the Ads

Code Block
languageswift
import UIKit
import R89SDK

class ViewController: UIViewController, UICollectionViewDataSource, UICollectionViewDelegateFlowLayout {
 
    var collectionView: UICollectionView!
    ...
    override func viewDidLoad() {
        super.viewDidLoad()
        // Configure the collection view layout
        ...
        let infiniteScrollConfigId = ConfigBuilder.companion.INFINITE_SCROLL_TEST_R89_CONFIG_ID
        RefineryAdFactory.shared.createInfiniteScroll(
          configurationID: infiniteScrollConfigId,
          scrollView: self.collectionView,
          scrollItemAdWrapperTag: "infiniteScroll_ad_wrapper_tag",
          lifecycleCallbacks: nil)
    }
    ...
}
Info

Your infiniteScrollConfigId will be provided to you during onboarding process by email, you can also retrieve them from the web interface after login.

They can be many or none depending on your requests, if you need one or more please request them to your account manager or technical account manager.

Not a UITableView or UIControllerView

Get infinite scroll ID

When not using a UITableView or UIControllerView we need to create the infinite scroll manually and use the returned id to show ads for each cell position.

Code Block
languageswift
   let infiniteScrollConfigId = ConfigBuilder.companion.INFINITE_SCROLL_TEST_R89_CONFIG_ID
   let infiniteScrollId = RefineryAdFactory.shared.createManualInfiniteScroll(
        configurationID: infiniteScrollConfigId,
        lifecycleCallbacks: nil)
Info

Your infiniteScrollConfigId will be provided to you during onboarding process by email, you can also retrieve them from the web interface after login.

They can be many or none depending on your requests, if you need one or more please request them to your account manager or technical account manager.

Adding the wrapper to the item

Code Block
languageswift
class ManualInfScrollViewCell: UIView {

    let label = UILabel()
    let adWrapper = UIView()
    .addSubview(adContainer..
    override init(frame: CGRect) {
        super.init(frame: frame)
        addSubview(label)
        // Added the wrapper to the item
        addSubview(adWrapper)
        // Setup the constraints
        ...
    }
    ...
}

Show ads in the item

Then in each cell, you will need to get the wrapper instance adWrapper and use it to request the ad for the cell position.

Code Block
languageswift
let cellPosition = manualInfScrollViewCell.getPosition() 
let adWrapper = manualInfScrollViewCell.adWrapper

RefineryAdFactory.shared.getInfiniteScrollAdForIndex(
  infiniteScrollId: infiniteScrollId,
  itemIndex: Int32(cellPosition),
  itemAdWrapper: adWrapper,
  childAdLifecycle: nil
)
Note

Careful on the implementation ofRefineryAdFactory.shared.getInfiniteScrollAdForIndex()method.

This needs to be implemented according to your implementation of the infinite scroll.
If you have paginated content this position needs to account for that

EX: 20 items per page so first 20 items go from 0 to 19 and the first item of the second page is not 0 is 20

formula beeing -> pageItemIndex + (pageSize*currentPage)

so first item position of first page is 0 + (20*0)

item 0 plus 20 multiplied by the current page index, so page 1 has index 0

and first item position of the second page is 0 + (20*1)

item 0 plus 20 multiplied by the current page index, so page 2 has index 1

second item first page would be 1 + (20*0) = 1

second item second page would be 1 + (20*1) = 21

and so on

Lifecycle events

You can subscribe to these events with the same method but passing a new object as a parameter. Details about this object can be found in the Reference.

Code Block
languageswift
import UIKit
import R89SDK

// 1. Extend from the InfiniteScrollEventListener
class InfiniteScrollLifecycleListener: InfiniteScrollEventListener {
    ...
    override func onAdItemLoaded(itemIdInData: Int32) {
        // Ad has been loaded for the position
    }
    ...
}

class ViewController: UIViewController, UICollectionViewDataSource, UICollectionViewDelegateFlowLayout {
 
    var collectionView: UICollectionView!
    ...
    override func viewDidLoad() {
        super.viewDidLoad()
        // Configure the collection view layout
        ...
        let infiniteScrollConfigId = ConfigBuilder.companion.INFINITE_SCROLL_TEST_R89_CONFIG_ID
        RefineryAdFactory.shared.createInfiniteScroll(
          configurationID: infiniteScrollConfigId,
          scrollView: self.collectionView,
          scrollItemAdWrapperTag: "infiniteScroll_ad_wrapper_tag",
          // 2. Pass the InfiniteScrollLifecycleListener instance via lifecycleCallbacks
          lifecycleCallbacks: InfiniteScrollLifecycleListener())
    }
    ...
}

The same lifecycleCallbacks parameter is available for the createInfiniteScrolland createManualInfiniteScroll methods.

While using the manual approach additionally ad lifecycle methods could be observed for each cell/item providing the BannerEventListener’s instance to getInfiniteScrollAdForIndex method in the following way

Code Block
languageswift
// 1. Extend from the BannerEventListener
private class BannerLifecycleListener : BannerEventListener {
    ...
    override func onLoaded() {
        // Ad has been loaded
    }
    ...
}

...
RefineryAdFactory.shared.getInfiniteScrollAdForIndex(
  infiniteScrollId: infiniteScrollId,
  itemIndex: Int32(cellPosition),
  itemAdWrapper: adWrapper,
  childAdLifecycle: BannerLifecycleListener()
)
...