Thanks for non-commercial open source development authorization by JetBrains.
穿山甲 Flutter SDK
`pangle_flutter`是一款集成了字节跳动穿山甲 Android 和 iOS SDK的 Flutter 插件。
## 目录 * [版本迁移](#版本迁移) * [使用文档](#使用文档) * [集成步骤](#集成步骤) * [交流](#交流) 原生平台相关范例： - [Android Demo](https://github.com/bytedance/pangle-sdk-demo) - [iOS Demo](https://github.com/bytedance/Bytedance-UnionAD) ## 版本迁移 > 1. 不再需要传入isExpress参数 > 2. BannerView, FeedView, SplashView均需要包一层限制大小的Widget, 可选Container, SizeBox, AspectRatio, Expanded等 > 3. BannerView, FeedView, SplashView的控制点击实现变动，可参考example进行更改。 ## SDK对应版本 - 已经内部依赖相关sdk，无需额外导入。如需替换新的sdk，请自行fork本项目更改依赖。 [[Android] 5.0+](https://www.pangle.cn/union/media/union/download/log?id=4) [[iOS] 5.0+](https://www.pangle.cn/union/media/union/download/log?id=16) 注：如果出现高版本不兼容问题，可联系我升级适配，或者使用上面指定版本。 ## 官方文档（需要登陆） - [Pangle Android SDK（Only support China traffic）](https://www.pangle.cn/union/media/union/download/detail?id=4&osType=android) - [Pangle iOS SDK](https://www.pangle.cn/union/media/union/download/detail?id=16&osType=ios) ## 使用文档 - [参数文档](DOC_PROPERTY.md) ## 范例截图
## 集成步骤
### 1. 添加yaml依赖
```yaml
dependencies:
# 添加依赖
pangle_flutter: latest
```
### 2. Android和iOS额外配置
- [基本配置入口](SETUP.md)
- iOS版本依赖配置
本项目默认集成`Ads-CN`， 如果你是国内APP，无需额外配置；~~如果你是海外APP，请参照如下配置：(已移除)~~
- 使用说明
支持开屏广告、激励视频、全屏视频（新模板渲染插屏广告）、模板渲染信息流、模板渲染插屏、模板渲染Banner。（如有自渲染广告位请联系我，或提交Feature request）
### 1. 信息流广告
### 2. iOS使用纯OC开发的项目导入该模块
1. 创建一个Swift文件，名称随意
2. 根据提示选择`Create Bridging Header`。如果没有提示，请自行搜索如何创建。
## 使用说明
### 1. 初始化
```dart
import 'package:pangle_flutter/pangle_flutter.dart';
/// 如果在runApp方法调用之前初始化，加入下面这句代码
WidgetsFlutterBinding.ensureInitialized();
/// 初始化，未列出所有参数
/// [kAppId] 申请穿山甲广告位后得到的appID
await pangle.init(
iOS: IOSConfig(appId: kAppId),
android: AndroidConfig(appId: kAppId),
);
```
### 2. 开屏广告
```dart
/// 全屏类型
/// [kSplashId] 开屏广告ID, 对应Android的CodeId，对应iOS的slotID
await pangle.loadSplashAd(
iOS: IOSSplashConfig(slotId: kSplashId, isExpress: false),
android: AndroidSplashConfig(slotId: kSplashId, isExpress: false),
);
/// 自定义类型
/// AndroidViewSurface支持
@override
void initState() {
super.initState();
SplashView.platform = SurfaceAndroidSplashView(hybridComposition: false);
}
/// 同Widget类用法
SplashView(
iOS: IOSSplashConfig(slotId: kSplashId, isExpress: false),
android: AndroidSplashConfig(slotId: kSplashId, isExpress: false),
backgroundColor: Colors.white,
/// 广告展示
onShow: (){},
/// 广告获取失败
onError: (int code, String message){},
/// 广告被点击
onClick: (){},
/// 广告已结束
onClose: (){},
);
```
### 3. 激励视频广告
```dart
/// [kRewardedVideoId] 激励视频广告ID, 对应Android的CodeId，对应iOS的slotID
pangle.loadRewardVideoAd(
iOS: IOSRewardedVideoConfig(slotId: kRewardedVideoId),
android: AndroidRewardedVideoConfig(slotId: kRewardedVideoId),
);
```
### 4. Banner广告
基本覆盖了原生回调事件，现在点击右上角关闭[ x ]按钮，需要开发者手动移除，不再自动移除Item。
```dart
/// AndroidViewSurface支持
@override
void initState() {
super.initState();
BannerView.platform = AndroidBannerView(hybridComposition: false);
}
/// Banner通过PlatformView实现，使用方法同Widget
/// [kBannerId] Banner广告ID, 对应Android的CodeId，对应iOS的slotID
BannerView(
iOS: IOSBannerAdConfig(slotId: kBannerId),
android: AndroidBannerAdConfig(slotId: kBannerId),
// 还有其他回调，具体可导入查看
),
// 必须限定范围大小，可用Expaned,Container,SizeBox,AspectRatio等
Container(
height: 260,
child: BannerView(
iOS: IOSBannerConfig(
slotId: kBannerExpressId600x260,
expressSize: PangleExpressSize(width: 600, height: 260),
),
android: AndroidBannerConfig(
slotId: kBannerExpressId600x260,
expressSize: PangleExpressSize(width: 600, height: 260),
),
onBannerViewCreated: (BannerViewController controller){
// 传入[Rect.zero]与[]均为无额外点击区域
controller.addTouchableBounds([Rect.zero]);
// 清空额外点击区域
controller.clearTouchableBounds();
},
onClick: () {},
),
),
```
### 5. 信息流广告
基本覆盖了原生回调事件，现在点击右上角关闭[ x ]按钮，需要开发者手动移除，不再自动移除Item。
- 获取信息流数据
```dart
/// 信息流实现逻辑
/// 首先进行网络请求，得到信息流数据
///
/// PangleFeedAd相应字段:
/// [code] 响应码，0成功，-1失败
/// [message] 错误时，调试信息
/// [count] 获得信息流数量，一般同上面传入的count，最终结果以此count为主
/// [data] (string list) 用于展示信息流广告的键id
PangleFeedAd feedAd = await pangle.loadFeedAd(
iOS: IOSFeedAdConfig(slotId: kFeedId, count: 2),
android: AndroidFeedAdConfig(slotId: kFeedId, count: 2),
);
```
- 加载数据
```dart
/// AndroidViewSurface支持
@override
void initState() {
super.initState();
FeedView.platform = AndroidFeedView(hybridComposition: false);
}
/// 使用方法
/// 你的数据模型
class Item {
/// 添加字段
final String feedId;
}
final items =