flutter_pangle_ads 2.7.0 copy "flutter_pangle_ads: ^2.7.0" to clipboard
flutter_pangle_ads: ^2.7.0 copied to clipboard

一款优质的 Flutter 广告插件(字节跳动、穿山甲)

logo

一款优质的 Flutter 广告插件(字节跳动、巨量引擎、穿山甲)

插件特点 #

  • 🔨 接入简单快速(封装原生端配置,仅需引入即可开始)
  • 📡 事件统一返回(将原生端各种重要回调事件统一返回,方便业务处理和埋点统计等需求)
  • 🎁 注重优化体验(无闪烁 Logo 开屏、iOS 开屏防止事件穿透、权限申请、隐私跟踪申请、信息流自动适配宽高等)
  • 🏆 极客代码封装(原生端代码不凑合,两端统一基础框架、广告事件封装抽象、易扩展新广告形式、方便开发个性化需求)

支持功能 #

  • ✅ 开屏广告
  • ✅ 新插屏广告
    • ✅ 半屏
    • ✅ 全屏
  • ✅ 激励视频
    • ✅ 普通激励
    • ✅ 进阶激励
  • ✅ Banner
  • ✅ 信息流
  • ✅ 全屏视频(已废弃)
  • 🔲 Draw 贴片视频

下载体验 #

回复 穿山甲体验

入门使用 #

引入依赖 #

dependencies:
  flutter_pangle_ads: ^2.7.0

初始化广告 #

// 导包
import 'package:flutter_pangle_ads/flutter_pangle_ads.dart';
/// [appId] 应用ID
FlutterPangleAds.initAd(appId);

个性化广告开关 #

/// 不调用默认为开,'1'打开,'0'关闭
FlutterPangleAds.setUserExtData(personalAdsType: '1');

开屏广告 #

  • 全屏
/// [posId] 广告位 id
FlutterPangleAds.showSplashAd(posId);
/// [posId] 广告位 id
/// [logo] 如果传值则展示底部logo,不传不展示,则全屏展示
/// [timeout] 加载超时时间
FlutterPangleAds.showSplashAd(
  posId,
  logo: 'flutterads_logo',
  timeout: 3.5,
);

新插屏广告 #

/// [posId] 广告位 id
FlutterPangleAds.showFullScreenVideoAd(AdsConfig.newInterstitialId);

激励视频 #

/// [posId] 广告位 id
/// [customData] 设置服务端验证的自定义信息
/// [userId] 设置服务端验证的用户信息
FlutterPangleAds.showRewardVideoAd(
    AdsConfig.rewardVideoId,
    customData: 'customData',
    userId: 'userId',
);
/// [posId] 广告位 id
/// [width] 创建 Banner 广告位时选择的宽度,默认值是 300
/// [height] 创建 Banner 广告位时选择的高度,默认值是 150
/// [interval] 广告轮播间隔,0 或[30~120]之间的数字,单位为 s,默认为 0 不轮播
/// [show] 是否显示广告
/// [autoClose] 是否自动关闭,一般是在用户点击不感兴趣之后的操作
AdBannerWidget(
  posId: AdsConfig.bannerId,
  width: 300,
  height: 150,
  interval: 30,
  show: true,
  autoClose: true,
);

Banner 广告外部需要嵌套一个带有约束布局的 Widget,如:AspectRatio、SizedBox、Container 等,示例如下:

  • 嵌套 SizedBox (推荐)
SizedBox(
  width: 300,
  height: 150,
  child: AdBannerWidget(
    posId: AdsConfig.bannerId,
    width: 300,
    height: 150,
    interval: 30,
    show: true,
  ),
)

信息流 #

  • 获取信息流广告列表
/// [posId] 广告位 id
/// [width] 宽度
/// [height] 高度
/// [count] 获取广告数量,建议 1~3 个
List<int> feedAdList = await FlutterPangleAds.loadFeedAd(
    AdsConfig.feedId,
    width: 375,
    height: 128,
    count: 3,
  );
  • 清除信息流广告列表

当你的广告不再需要时,请一定执行清除操作

/// [list] 信息流广告 id 列表
bool result = await FlutterPangleAds.clearFeedAd(feedAdList);
  • 页面中展示信息流广告
/// Feed 信息流广告组件
/// [posId]返回的广告 id,这里不是广告位id
/// [width]组件的宽度
/// [height]组件的高度
/// [show]是否显示
AdFeedWidget(
    posId: '${feedAdList[0]}',
    width: 375,
    height: 128,
    show: true,
  )

widthheight 需要根据你新建广告位的模板来设置

旧插屏广告(已废弃) #

建议使用新插屏

/// [posId] 广告位 id
/// [width] 请求模板广告素材的尺寸宽度(对应 expressViewWidth 参数)
/// [height] 请求模板广告素材的尺寸高度(对应 expressViewWidth 参数)
FlutterPangleAds.showInterstitialAd(
    AdsConfig.interstitialId,
    width: 300,
    height: 300,
);

设置广告事件监听 #

FlutterPangleAds.onEventListener((event) {
  // 普通广告事件
  String _adEvent = 'adId:${event.adId} action:${event.action}';
  if (event is AdErrorEvent) {
    // 错误事件
    _adEvent += ' errCode:${event.errCode} errMsg:${event.errMsg}';
  } else if (event is AdRewardEvent) {
    // 激励事件
        _adEvent +=
            'rewardType:${event.rewardType} rewardVerify:${event.rewardVerify} rewardAmount:${event.rewardAmount} rewardName:${event.rewardName} errCode:${event.errCode} errMsg:${event.errMsg} customData:${event.customData} userId:${event.userId}';
  }
  // 测试关闭 Banner(会员场景)
  if (event.action == AdEventAction.onAdClosed &&
      event.adId == AdsConfig.bannerId02) {
    _adEvent += '仅会员可以关闭广告';
  }
  print('onEventListener:$_adEvent');
});

事件列表 #

事件 说明
onAdLoaded 广告加载成功
onAdPresent 广告填充
onAdExposure 广告曝光
onAdClosed 广告关闭(开屏计时结束或者用户点击关闭)
onAdClicked 广告点击
onAdSkip 广告跳过
onAdComplete 广告播放或计时完毕
onAdError 广告错误
onAdReward 获得广告激励

这里做了统一的抽象,iOS 和 Android 原生 SDK 名称不同,如果觉得对应不上,可以提 Issues(一定要加上 log 截图)

其他配置 #

信任HTTP请求(仅 iOS) #

苹果公司在iOS9中升级了应用网络通信安全策略,默认推荐开发者使用HTTPS协议来进行网络通信,并限制HTTP协议的请求。为了避免出现无法拉取到广告的情况,我们推荐开发者在info.plist文件中增加如下配置来实现广告的网络访问

  • 修改 info.plist
<key>NSAppTransportSecurity</key>
<dict>
  <key>NSAllowsArbitraryLoads</key>
  <true/>
</dict>

信任HTTP请求

请求应用跟踪透明度授权(仅 iOS) #

此步骤必须要做,不然上架审核时候会被拒绝

bool result = await FlutterPangleAds.requestIDFA;
  • 修改 info.plist
<key>NSUserTrackingUsageDescription</key>
<string>为了向您提供更优质、安全的个性化服务及内容,需要您允许使用相关权限</string>

请求应用跟踪透明度授权

  • 效果

预览效果

动态请求权限(仅 Android) #

bool result = await FlutterPangleAds.requestPermissionIfNecessary;

原生 SDK 版本更新方法 #

如果是大版本,我会第一时间适配更新,小版本可以自己更新,方法如下:

  • Android

    方法1:可以给我提 Issues 提示我更新,此插件版本号 x.y.z,会更新 z 版本迭代

    方法2:可以自己指定版本,方法如下:

// build.gradle(android.app)
android{
  configurations.all {
      resolutionStrategy {
          force 'com.pangle.cn:ads-sdk-pro:版本号'
      }
  }
}
  • iOS

    自己手动更新,自己的项目根目录下执行即可

// 可在 ios/Podfile.lock 中查看 SDK 当前版本
cd ios
rm -rf Podfile.lock
pod repo update
pod install

分支说明 #

分支 说明
develop 开发分支,接受 PR
master 稳定分支,空安全
1x 已不更新,非空安全

更新日志 #

查看 Releases 版本日志

遇到问题 #

如果你遇到问题请提 Issues 给我(提问前建议先搜索尝试,没有再提问)

支持开源 #

  • 开源不易,需要花费大量休息时间加班熬夜来维护,你可以通过下方二维码赞赏支持我。
coffee
  • 用爱发电,给本项目点个免费的 Star ⭐️ 也是非常好的支持。

FlutterAds 广告插件系列 #

插件 描述
flutter_qq_ads 腾讯广告、广点通、优量汇 Flutter 广告插件
flutter_pangle_ads 字节跳动、巨量引擎、穿山甲 Flutter 广告插件
flutter_gromore_ads 字节跳动、巨量引擎、穿山甲、Gromore 聚合 Flutter 广告插件
34
likes
0
pub points
74%
popularity

Publisher

unverified uploader

一款优质的 Flutter 广告插件(字节跳动、穿山甲)

Homepage

License

unknown (LICENSE)

Dependencies

flutter

More

Packages that depend on flutter_pangle_ads