Skip to content

Latest commit

 

History

History

YMNativeAdS-iOS

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

有米iOS原生广告开源API接口使用说明

1. 前言

欢迎您使用有米iOS原生广告开源API接口,请您参照此文档步骤来使用开源API接口,或可以参考我们的Demo程序源码来使用开源API接口。

以下几点注意事项,请仔细阅读:

  1. 一个应用APPID只能使用在单个APP内,不能多个APP重复使用。
  2. 嵌入完成,将获取到测试广告,如果测试没问题,需要到有米开发者后台审核上传应用进行审核,审核通过后方可获得正式广告,并且产生正常收益。
  3. 每个应用可以创建多个广告位,广告位可以设定不同的广告图片尺寸,具体可以登录 有米开发者后台 查看。
  4. 在使用开源API接口的同时,需要您在自己的应用中开辟出适合的位置,并设置好正确的广告逻辑。iOS版的API接口已经封装好了相应的逻辑,您也可以直接使用。

2. 使用说明

2.1 使用CocoaPods导入项目

  1. 在你的项目的根目录中新建一个 Podfile 文件,添加内容如下:
pod 'nativead', '~>1.1.0'
  1. 终端命令行(使用 cd 命令)进入到您的iOS项目的根目录中,执行如下命令安装或更新:
// 还没有安装过有米原生广告时,使用安装命令
pod install

// 从旧版本有米原生广告升级到新版本有米原生广告时,使用更新命令
pod update nativead
  1. 安装/更新完成之后,点击目录中的 .xcworkplace文件来打开项目,接下来你就可以在项目中使用有米原生广告了。

ps:除了使用CocoaPods导入项目,你也可以下载本目录下 YMNativeAd 目录(均为源码),将 YMNativeAd 目录拷贝到自己的项目中即可使用。

2.2 代码使用

2.2.1 初始化广告实例并发起广告请求

// YMNativeAd是源码包的头文件,整个交互基本都是由本类来处理

YMNativeAd   *_nativeAd;      // 广告实例 (YMNativeAd是libCode源码包的头文件,整个交互基本都是由本类来处理)
NSArray      *_adArray;       // 广告数组(UMNDataModel实例集合)
UMNDataModel *_currentAd;     // 当前展示的ad(方便接口调用)

if (!_nativeAd) {

    // 初始化广告实例,设置开发者应用APPID和广告位ID
    _nativeAd = [[YMNativeAd alloc]initWithAppId:@"320a6cd3b8d2c4e0" slotId:@"7746"];

    //(可选)设置广告请求时附带的可选参数,有利于提高广告填充
    [_nativeAd setContTitle:@"广告位的标题" contKw:@"广告位的关键字"];

    // (必须)设置广告请求代理block,需要在interface头部设定属性中添加代理 YMNativeAdDelegate
    _nativeAd.delegate = self; 
}

// 拉取广告
[_nativeAd loadAd];

2.2.2 处理广告请求结果

#pragma mark -YMNvativeDelegate

/**
 获取广告成功后的回调

 @param nativeAdArray 返回的广告数组UMNDataModel
 */
- (void)ymNativeAdSuccessToLoad:(NSArray *)nativeAdArray{
    _adArray = nativeAdArray;                             //返回广告array,默认只返回一个
    UMNDataModel *dataModel = [_adArray objectAtIndex:0]; //获取广告model,然后自定义view展示model属性
    [self showAdView];
}

/**
 获取广告失败后的回调

 @param error 对应的错误代码
 */
- (void)ymNativeAdFailedToLoad:(NSError *)error{
    NSLog(@"%@",error);
} 

2.2.3 展示广告(展示广告时必须调用展示效果接口)

在广告展示时,调用有米的展示广告接口以完成展示效果记录发送

e.g.

/*
 展示原生广告,开发者获取广告model,自定义view样式并展示
 */
- (void)showAdView{
    if (_adArray) {
        UMNDataModel *dataModel = [_adArray objectAtIndex:0];//获取model
        _currentAd = dataModel;
		
        // 开发者可以在这里自定义UI展示广告
        NSLog(@"adname:%@",_currentAd.name);//广告名

        // 展示广告 调用展示效果记录发送接口
        [_nativeAd showAd:_currentAd callBackBlock:^(NSError *error) {
        if (error) {
            NSLog(@"%@",error);
   	}else{
            NSLog(@"展示有效");
    	}
	}];
    }
}

2.2.4 点击广告

在用户点击广告时,

  1. 先调用点击效果记录发送接口
  2. 再调用广告打开接口

e.g.

- (void)viewTapped:(UITapGestureRecognizer *)gr {
    // 调用点击效果记录发送接口
    [_nativeAd clickAd:_currentAd callBackBlock:^(NSError *error) {
        if (error) {
            NSLog(@"%@",error);
        }else{
            NSLog(@"点击有效");
        }
    }];

    // 跳转到广告落地页(AppStore页面或者指定的URIScheme,本接口已封装好实际跳转逻辑)
    [_nativeAd clickAdOpenAppStoreVC:_currentAd];
}

2.2.5 到此接入完毕,有任何问题请联系有米客服。