Flutter字节跳动广告插件bytedance_pangolin的使用

Flutter字节跳动广告插件bytedance_pangolin的使用

本插件是基于flutter3.0版本基础开发的，低版本请搜索Pangolin插件使用， 本插件是基于Pangolin插件的基础上开发改造的，由于Pangolin作者很久没更新了（好像是去某大厂修福报没空搞业余了），所以我自己重新开发，后续会随时更新维护，欢迎大家多提bug。

前言

⚠️ 在使用本插件前请认真，仔细阅读穿山甲官方文档。本插件将尽量保留 SDK 内容和各 API 相关内容，如出现在官方文档以外报错信息可以留言 issue,或通过文末联系方式联系作者（注明来意）。针对你可能会遇到的问题，在使用过程中可以先查阅 Pangolin 报错及其解决方案。

公告

再次提醒，本插件基于flutter3.0开发的，低版本请勿使用。

简介

bytedance_pangolin 是一款 Flutter 插件，集成了字节跳动旗下的广告平台——穿山甲的 Android 和 iOS 的 SDK，方便开发者直接在 Flutter 层面调用相关方法。

版本信息

插件开发环境相关

Flutter

Flutter (Channel stable, v3.0.4, on Mac OS X 12.4 (21F79), locale zh-Hans-CN)

Dart

Dart VM version: 2.17.5

Platform

Xcode - develop for iOS and macOS (Xcode 13.4.1)

Android Studio Chipmunk | 2021.2.1 Patch 1

穿山甲

iOS - cocoapods lastest version
Android - implementation 'com.pangle.cn:ads-sdk-pro:4.4.0.9'

安装

在 pubspec.yaml 文件中添加以下依赖：

dependencies:
  bytedance_pangolin: ^0.0.1

环境配置

使用前请确认您以根据穿山甲的官方文档中的步骤进行了相应的依赖添加，权限获取以及参数配置

Android

在 Android 端你可能需要简单的四个小步骤导入穿山甲 SDK 具体步骤已为你写好请戳 👉 Pangolin Android 集成手册

iOS

pod install

穿山甲平台

在使用之前必须确认您在穿山甲平台的控制台已经注册了自己 app 所对应的应用以及对应广告类型的代码位，由于穿山甲包含多种类型的广告和功能请务必确认你在插件中注册的和你在平台注册的一一对应。

开始使用

初始化（register）

调用穿山甲 SDK 的第一步是对 SDK 的初始化

final _bytedancePangolinPlugin = Pangolin.BytedancePangolin();

await _bytedancePangolinPlugin
        .register(
            appId: "5073083",
            useTextureView: true,
            appName: "tgame",
            allowShowNotify: true,
            allowShowPageWhenScreenLock: true,
            debug: true,
            supportMultiProcess: true)
        .then((value) {
       // do
    });

参数说明

注意以上参数大部分针对 Android 端，iOS 端由于穿山甲 SDK 本身的原因并没有过多的参数配置，有用的参数仅为 appId，appName。

加载开屏广告

_bytedancePangolinPlugin.loadSplashAd(mCodeId:"887343401", debug: false);

参数说明

加载激励视频

激励视频的原生接入相对复杂，但是我已经给各位留好了接口，只需简单的几步就可以加载到你的激励视频

⚠️ 使用前请确认您已在穿山甲平台的控制台建立了你的激励视频广告 id。

await _bytedancePangolinPlugin.loadRewardAd(
    isHorizontal: false,
    debug: true,
    mCodeId: "945344872",
    supportDeepLink: true,
    rewardName: "金币",
    rewardAmount: 2,
    isExpress: true,
    expressViewAcceptedSizeH: 500,
    expressViewAcceptedSizeW: 500,
    userID: "user123",
    mediaExtra: "media_extra");

参数说明

激励视频回调监听

在合适的位置注册你的监听，保证用户看完广告时接收到我给你的回调信息，并做下一步处理

Pangolin.pangolinResponseEventHandler.listen((value)
    {
      if(value is Pangolin.RewardResponse)
        {
          print("激励视频回调：${value.rewardVerify}");
          print("激励视频回调：${value.rewardName}");
          print("激励视频回调：${value.rewardAmount}");
        }
      else
        {
          print("回调类型不符合");
        }
    });

参数说明

激励视频关闭监听：如果你收到了一个回调，并且rewardName == rewardVideo Close说明是一个激励视频关闭的回调，详见 example

激励视频的具体使用参见项目目录下 Example

加载 Banner 广告

await _bytedancePangolinPlugin.loadBannerAd(
    mCodeId: "949248774",
    supportDeepLink: true,
    expressViewWidth: 320,
    expressViewHeight: 50,
    isCarousel: true,
    interval: 40,
    topMargin: 50);

参数说明

以上参数在创建代码位时都可以进行自定义设置，请确保在代码中填写的实际值和创建代码位时一致。

手动关闭 Banner 广告（Android）

_bytedancePangolinPlugin.removeBannerAd();

该方法提供给 Android 用户，在关闭界面时手动调用，关闭 Banner 广告

加载插屏广告（iOS）

await _bytedancePangolinPlugin.loadInterstitialAd(
    mCodeId: "945344417", expressViewWidth: 600, expressViewHeight: 600);