onemore 鸿蒙对接文档

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.APP_TRACKING_CONSENT",
        "reason": "$string:reason",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        }
      },
      {
        "name": "ohos.permission.ACCELEROMETER",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        }
      },
      {
        "name": "ohos.permission.GYROSCOPE",
        "usedScene": {
          "abilities": [
            "EntryAbility"
          ],
          "when": "inuse"
        }
      },
      {
        "name": "ohos.permission.GET_NETWORK_INFO"
      },
      {
        "name": "ohos.permission.INTERNET"
      }
    ]
  }
}

{
  "module": {
    "querySchemes": [
      "weixin",
      "alipay",
      "store"
    ]
  }
}

{
  "dependencies": {
    "@onemore/sdk": "file:../onemore.har"
  }
}

import { ONEMORE_VERSION } from '@onemore/sdk'

console.info('onemore version=', ONEMORE_VERSION)

import { OnemoreSdk, type OnemoreConfig } from '@onemore/sdk'

const onemoreConfig: OnemoreConfig = {
  appId: '<your-onemore-app-id>',
  appKey: '<your-onemore-app-key>',
  oaid: '<optional-oaid>',
  platformOptions: {
    ads_kit: {
      adOptions: {
        tagForUnderAgeOfPromise: -1
      }
    }
  }
}

OnemoreSdk.bootstrap(this.context, {
  windowStage,
  config: onemoreConfig
})

OnemoreSdk.setDebug(true)

await OnemoreSdk.init(onemoreConfig)

await OnemoreSdk.setUserId('<your-user-id>')

import { OnemoreAdType, OnemoreOrientation, OnemoreSdk } from '@onemore/sdk'

const ad = await OnemoreSdk.load({
  slotId: 'your_onemore_slot_id',
  adType: OnemoreAdType.SPLASH,
  orientation: OnemoreOrientation.AUTO
})

import { OnemoreAdType, OnemoreSdk, OnemoreSplashView } from '@onemore/sdk'

const ad = await OnemoreSdk.load({
  slotId: '<your-onemore-slot-id>',
  adType: OnemoreAdType.SPLASH,
  extendInfo: {
    scene: 'launch',
    traceId: '<trace-id>'
  }
})

// 在页面中挂载开屏 View，由 View 承接真实展示、点击、关闭等展示态回调
OnemoreSplashView(ad)

import {
  OnemoreAdType,
  OnemoreInterstitialView,
  OnemoreLoadedAd,
  OnemoreSdk,
  OnemoreShowListener
} from '@onemore/sdk'

let loadedAd: OnemoreLoadedAd | undefined
let showOverlay = false

// aboutToAppear 中先调用一次
OnemoreSdk.setUiContext(this.getUIContext())

loadedAd = await OnemoreSdk.load({
  slotId: '<your-onemore-slot-id>',
  adType: OnemoreAdType.INTERSTITIAL,
  extendInfo: {
    scene: 'interstitial',
    traceId: '<trace-id>'
  }
})

const networkName = OnemoreSdk.getAdNetworkName(loadedAd.adId)
const shouldMountOverlay = networkName === 'yimeng' || networkName === 'ads_kit'

if (shouldMountOverlay) {
  showOverlay = true
  // build() 里：
  // if (showOverlay && loadedAd) {
  //   OnemoreInterstitialView(
  //     loadedAd,
  //     () => {},
  //     () => {},
  //     () => { showOverlay = false }
  //   )
  // }
}

const showListener: OnemoreShowListener = {
  onShow: () => {},
  onClick: () => {},
  onClose: () => { showOverlay = false },
  onFail: () => { showOverlay = false }
}

await OnemoreSdk.show(loadedAd, undefined, showListener)

import { OnemoreAdType, OnemoreSdk, OnemoreBannerView } from '@onemore/sdk'

const ad = await OnemoreSdk.load({
  slotId: '<your-onemore-slot-id>',
  adType: OnemoreAdType.BANNER,
  width: 360,
  height: 57
})

await OnemoreSdk.show(ad)
// 在页面内业务自行决定 banner 的挂载位置
OnemoreBannerView(ad, onShow, onClick, onClose)

const ad = await OnemoreSdk.load({
  slotId: '<your-onemore-slot-id>',
  adType: OnemoreAdType.FEED,
  extendInfo: {
    scene: 'feed'
  },
  width: 360,
  height: 220
})

interface OnemoreConfig {
  appId: string
  appKey: string
  extendInfo?: Record<string, Object>
  oaid?: string
  platformOptions?: {
    ads_kit?: {
      adOptions?: {
        tagForUnderAgeOfPromise?: number
      }
    }
  }
}

interface OnemoreConfig {
  appId: string
  appKey: string
  extendInfo?: Record<string, Object>
  oaid?: string
  platformOptions?: {
    ads_kit?: {
      adOptions?: {
        tagForUnderAgeOfPromise?: number
      }
    }
  }
}

const onemoreConfig: OnemoreConfig = {
  appId: '<your-onemore-app-id>',
  appKey: '<your-onemore-app-key>',
  oaid: '<optional-oaid>',
  platformOptions: {
    ads_kit: {
      adOptions: {
        tagForUnderAgeOfPromise: -1
      }
    }
  }
}

interface OnemoreAdSlot {
  slotId: string
  adType: OnemoreAdType
  width?: number
  height?: number
  extendInfo?: Record<string, Object>
}

const ad = await OnemoreSdk.load({
  slotId: '<your-onemore-slot-id>',
  adType: OnemoreAdType.REWARD,
  adListener: {
    onAdLoaded: (adInfo) => {},
    onAdShow: (adInfo) => {},
    onAdClick: (adInfo) => {},
    onAdClose: (adInfo) => {},
    onAdReward: (adInfo) => {},
    onAdLoadFailed: (adError) => {}
  }
})

interface OnemoreAdInfo {
  adId?: string
  slotId?: string
  adType?: OnemoreAdType
  networkName?: string
  networkSlotId?: string
  ecpm?: number
  raw?: Record<string, Object> | string
  getAdSourceInfo(): OnemoreAdSourceInfo | undefined
  getAdConfig(): OnemoreAdConfigInfo | undefined
  getAdPrice(): OnemoreAdPriceInfo | undefined
  getAdStatusInfo(): OnemoreAdStatusInfo | undefined
}

onAdLoaded: (adInfo) => {
  console.info('胜出平台', adInfo?.networkName)
  console.info('平台广告位', adInfo?.networkSlotId)
  console.info('胜出价格', adInfo?.ecpm)
}

interface OnemoreAdPriceInfo {
  ecpm?: number
  publisherRevenue?: number
  currency?: string
  precision?: string
}

interface OnemoreAdSourceInfo {
  showId?: string
  placementPlatform?: string
  placementId?: string
  placementPlatformId?: string
  extInfo?: string | Record<string, Object>
}

onAdShow: (adInfo) => {
  const sourceInfo = adInfo?.getAdSourceInfo()
  console.info('winner=', adInfo?.networkName, adInfo?.networkSlotId)
  console.info('ecpm=', adInfo?.ecpm)
  console.info('placementPlatform=', sourceInfo?.placementPlatform)
  console.info('placementId=', sourceInfo?.placementId)
  console.info('priceInfo=', JSON.stringify(adInfo?.getAdPrice?.()))
  console.info('sourceInfo=', JSON.stringify(sourceInfo))
}

import { OnemoreGameBridge } from '@onemore/sdk'

const gameBridge = new OnemoreGameBridge((eventJson: string): void => {
  // 转发给 Unity SendMessage、Cocos JSB 或其他引擎消息通道
  console.info(eventJson)
})

await gameBridge.invoke(JSON.stringify({
  action: 'load',
  requestId: 'reward-1',
  slotId: 'game_reward',
  adType: 'reward',
  orientation: 'landscape'
}))

await gameBridge.invoke(JSON.stringify({
  action: 'show',
  requestId: 'reward-1'
}))

// entryability/EntryAbility.ets
import { UIAbility } from '@kit.AbilityKit'
import { window } from '@kit.ArkUI'
import { OnemoreConfig, OnemoreSdk } from '@onemore/sdk'

export default class EntryAbility extends UIAbility {
  onWindowStageCreate(windowStage: window.WindowStage): void {
    const config: OnemoreConfig = {
      appId: '<your-onemore-app-id>',
      appKey: '<your-onemore-app-key>'
    }

    OnemoreSdk.bootstrap(this.context, {
      windowStage: windowStage,
      config: config
    })
    OnemoreSdk.setDebug(true)

    void OnemoreSdk.init(config).then((): void => {
      // 初始化成功后再通知游戏引擎开放广告入口。
      console.info('[game.ad] onemore ready')
    }).catch((error: Error): void => {
      console.error(`[game.ad] onemore init failed: ${error.message}`)
    })

    windowStage.loadContent('pages/GamePage')
  }
}

// pages/GamePage.ets
import {
  OnemoreGameAdOverlay,
  OnemoreGameBridge,
  OnemoreSdk
} from '@onemore/sdk'

interface GameAdEvent {
  requestId: string
  event: string
  adId?: string
  networkName?: string
  code?: number
  message?: string
}

@Entry
@Component
struct GamePage {
  @State private showAdOverlay: boolean = false
  @State private activeRequestId: string = ''

  private readonly gameBridge: OnemoreGameBridge = new OnemoreGameBridge(
    (eventJson: string): void => this.onBridgeEvent(eventJson)
  )

  aboutToAppear(): void {
    OnemoreSdk.setUiContext(this.getUIContext())
  }

  /** Unity/Cocos/NAPI 插件把游戏侧 JSON 命令转发到这里。 */
  async onEngineAdCommand(commandJson: string): Promise<string> {
    return this.gameBridge.invoke(commandJson)
  }

  private onBridgeEvent(eventJson: string): void {
    const event = JSON.parse(eventJson) as GameAdEvent

    // 无论事件类型如何，都先原样转发给游戏线程。
    this.sendEventToGameEngine(eventJson)

    if (event.event === 'view_required') {
      this.activeRequestId = event.requestId
      this.showAdOverlay = true
      return
    }

    if (event.event === 'reward') {
      // 游戏层按 requestId 做幂等发奖；不要根据 close/show 成功推断奖励。
      return
    }

    if (event.event === 'close' || event.event === 'ad_failed' || event.event === 'show_failed') {
      if (this.activeRequestId === event.requestId) {
        this.showAdOverlay = false
        this.activeRequestId = ''
      }
      void this.gameBridge.invoke(JSON.stringify({
        action: 'destroy',
        requestId: event.requestId
      }))
    }
  }

  private sendEventToGameEngine(eventJson: string): void {
    // Unity：转给 C# 回调或 SendMessage。
    // Cocos：转给 JSB/TS 事件监听器。
    // NAPI/XComponent：通过项目已有的 native 消息通道转发。
    console.info(`[game.ad.event] ${eventJson}`)
  }

  build(): void {
    Stack() {
      // 替换为项目实际的 Unity/Cocos/XComponent 游戏画布。
      Column() {
        Text('Game Surface')
      }
      .width('100%')
      .height('100%')

      if (this.showAdOverlay && this.activeRequestId.length > 0) {
        OnemoreGameAdOverlay(this.gameBridge, this.activeRequestId)
      }
    }
    .width('100%')
    .height('100%')
  }
}

OnemoreSdk.setDebug(true)