logo
0
0
WeChat Login
docs(readme): 展示标准调用与 GameApp 快捷调用两种用法

GameFrameX Logo

Game Frame X Advertisement (CSJ / 穿山甲)

Version License Documentation

獨立遊戲前後端一體化解決方案 · 獨立遊戲開發者的圓夢大使

📖 文檔🚀 快速開始💬 QQ群


🌐 語言: English | 简体中文 | 繁體中文 | 日本語 | 한국어


項目簡介

Game Frame X 廣告系統的穿山甲(CSJ/Pangle)平台適配器。為 iOS 和 Android 應用提供基於字節跳動穿山甲廣告 SDK 的激勵影片廣告整合。

功能特性

  • 基於穿山甲(CSJ/Pangle)SDK 的激勵影片廣告支援
  • 原生 iOS 和 Android 平台支援
  • IL2CPP 程式碼裁剪保護
  • 條件編譯(UNITY_IOSUNITY_ANDROID
  • 與 Game Frame X 廣告元件無縫整合

架構概覽

本套件是 Game Frame X 廣告核心 BaseAdvertisementManager適配器實現。透過 Unity Inspector 設定 AdvertisementComponent 後,自動發現並載入。

類別說明
CSJAdvertisementManager激勵影片廣告管理器 — 載入、展示及生命週期管理
CSJAdvertisementConfig廣告配置,包含 appId 和 adUnitId 欄位
CSJBridgeiOS/Android 原生平台呼叫橋接
CSJNativeMessageHandler原生訊息回調處理器
GameFrameXAdvertisementCSJCroppingHelperIL2CPP link.xml 替代方案 — 保留類型引用

快速開始

安裝

  1. 安裝廣告核心套件
  2. 透過 Unity Package Manager (UPM) 新增本適配器:
{
  "dependencies": {
    "com.gameframex.unity.advertisement": "https://github.com/GameFrameX/com.gameframex.unity.advertisement.git",
    "com.gameframex.unity.advertisement.csj": "https://github.com/gameframex/com.gameframex.unity.advertisement.csj.git"
  }
}

或在 Unity Package Manager 視窗中透過 git URL 新增。

使用範例

在 Unity Inspector 中設定:將 AdvertisementComponent 新增到 GameObject,然後在實作類型下拉選單中選擇 CSJAdvertisementManager

using GameFrameX.Advertisement.Runtime;

// 標準方式:透過 GameEntry(不依賴 com.gameframex.unity.entry)
var adComponent = GameEntry.GetComponent<AdvertisementComponent>();

// 設定伺服器端驗證資料(可選)
adComponent.SetExtraData("userId", player.UserId);

// 播放激勵影片廣告
var option = new AdvertisementPlayOption
{
    OnSuccess    = (data) => Debug.Log("廣告展示成功"),
    OnFail       = (err) => Debug.LogError($"廣告展示失敗: {err}"),
    OnShowResult = (watched) =>
    {
        if (watched)
        {
            // 發放獎勵
        }
    },
};
adComponent.Play(option);

// 快捷方式:透過 GameApp(需要 com.gameframex.unity.entry)
GameApp.Advertisement.SetExtraData("userId", player.UserId);
var option2 = new AdvertisementPlayOption
{
    OnSuccess    = (data) => Debug.Log("廣告展示成功"),
    OnFail       = (err) => Debug.LogError($"廣告展示失敗: {err}"),
    OnShowResult = (watched) =>
    {
        if (watched)
        {
            // 發放獎勵
        }
    },
};
GameApp.Advertisement.Play(option2);

平台支援

平台支援
iOS
Android
WebGL
Standalone

需要 UNITY_IOSUNITY_ANDROID 腳本巨集定義。

文檔與資源

社區與支援

更新日誌

v1.0.0

  • 初始發佈
  • 支援穿山甲(CSJ/Pangle)平台激勵影片廣告
  • IL2CPP 裁剪保護

開源協議

本專案基於 MIT 授權Apache 授權 2.0 雙重授權。