Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace vungle

Index

Type aliases

AdConfig

AdConfig: { incentivizedFields?: IncentivizedFields; muted?: boolean; ordinal?: Number; orientation?: OrientationType }
en

Config of Interstitial and rewarded ads

zh

插屏和奖励广告的配置

Type declaration

  • Optional incentivizedFields?: IncentivizedFields
    en

    Incentivized alert dialog that displays when a user prematurely closes a rewarded ad experience.

    zh

    用户终止观看奖励广告时的弹窗信息

  • Optional muted?: boolean
    en

    audio settings, set true to mute ads

    zh

    静音设置

  • Optional ordinal?: Number
    en

    Video should start with its audio settings based on the value specified.

    zh

    如果您从Vungle收到顺序数据报告,请使用此字段传递中介顺序。这是一个整数,指示此广告在游戏会话中的显示顺序(例如,如果已经在该会话中显示了两个广告,然后将来自Vungle的该广告显示为第三,则传递“ 3”)。

  • Optional orientation?: OrientationType
    en

    Ads Orientation

    zh

    广告方向

BannerConfig

BannerConfig: { adSize?: AdSize; muted?: boolean }
en

Config of Banner and MREC

zh

Banner和MREC广告的配置

Type declaration

  • Optional adSize?: AdSize
    en

    Size of Banner or MREC

    zh

    Banner或MREC广告的大小

  • Optional muted?: boolean
    en

    audio settings, set true to mute ads

    zh

    静音设置

IncentivizedFields

IncentivizedFields: { body?: string; close?: string; keepWatching?: string; title?: string; userID?: string }
en

Incentivized alert dialog that displays when a user prematurely closes a rewarded ad experience.

zh

用户终止观看奖励广告时的弹窗信息

Type declaration

  • Optional body?: string
    en

    dialog body

    zh

    弹窗提示正文

  • Optional close?: string
    en

    title for the close button text of the alert dialog

    zh

    结束观看按钮的文字

  • Optional keepWatching?: string
    en

    title for the close button text of the alert dialog

    zh

    继续观看按钮的文字

  • Optional title?: string
    en

    dialog title

    zh

    弹窗提示中的标题

  • Optional userID?: string
    en

    user ID

    zh

    用户ID

InitCallback

InitCallback: { onError?: (error: string) => void; onSuccess?: () => void }
en

SDK initialization Callbacks

zh

SDK初始化回调

Type declaration

  • Optional onError?: (error: string) => void
    en

    SDK has failed to initialize

    zh

    SDK初始化失败

      • (error: string): void
      • Parameters

        • error: string

        Returns void

  • Optional onSuccess?: () => void
    en

    SDK has successfully initialized

    zh

    SDK初始化成功

      • (): void
      • Returns void

LoadAdCallback

LoadAdCallback: { onAdLoad?: (placementId: string) => void; onError?: (placementId: string, error: string) => void }
en

Ads Load Callbacks

zh

广告加载回调

Type declaration

  • Optional onAdLoad?: (placementId: string) => void
    en

    Ad has been successfully loaded for the placement

    zh

    广告加载成功

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onError?: (placementId: string, error: string) => void
    en

    Ad has failed to load for the placement

    zh

    广告加载失败

      • (placementId: string, error: string): void
      • Parameters

        • placementId: string
        • error: string

        Returns void

PlayAdCallback

PlayAdCallback: { creativeId?: (creativeId: string) => void; onAdClick?: (placementId: string) => void; onAdEnd?: (placementId: string) => void; onAdLeftApplication?: (placementId: string) => void; onAdRewarded?: (placementId: string) => void; onAdStart?: (placementId: string) => void; onAdViewed?: (placementId: string) => void; onAdWillClose?: (placementId: string) => void; onAdWillShow?: (placementId: string) => void; onError?: (placementId: string, error: string) => void }
en

Ads Play Callbacks

zh

广告播放回调

Type declaration

  • Optional creativeId?: (creativeId: string) => void
    en

    Vungle creative ID to be displayed

    zh

    当前广告的Creative ID

      • (creativeId: string): void
      • Parameters

        • creativeId: string

        Returns void

  • Optional onAdClick?: (placementId: string) => void
    en

    User clicked on ad

    zh

    用户点击广告

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdEnd?: (placementId: string) => void
    en

    Ad experience ended

    zh

    广告结束

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdLeftApplication?: (placementId: string) => void
    en

    User has left app during an ad experience

    zh

    用户在广告播放过程中退出APP

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdRewarded?: (placementId: string) => void
    en

    User earned reward for watching an rewarded ad

    zh

    用户获得奖励

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdStart?: (placementId: string) => void
    en

    Ad experience started

    zh

    广告开始播放

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdViewed?: (placementId: string) => void
    en

    Ad has rendered

    zh

    广告已渲染

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdWillClose?: (placementId: string) => void
    en

    For IOS only: SDK is about to close an ad

    zh

    只用于IOS:广告即将关闭

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onAdWillShow?: (placementId: string) => void
    en

    For IOS only: SDK is about to play a video ad

    zh

    只用于IOS:广告即将播放

      • (placementId: string): void
      • Parameters

        • placementId: string

        Returns void

  • Optional onError?: (placementId: string, error: string) => void
    en

    Ad failed to play

    zh

    广告播放失败

      • (placementId: string, error: string): void
      • Parameters

        • placementId: string
        • error: string

        Returns void

Setting

Setting: { minimumDiskSpaceForAd?: number; minimumDiskSpaceForInit?: number; restrictAndroidID?: boolean; setPublishIDFV?: boolean }
en

Initialization Settings

zh

广告初始化设置

Type declaration

  • Optional minimumDiskSpaceForAd?: number
    en

    limits for available space(megabyte) on a user’s device before ads fetching .

    zh

    广告播放时需要的最小存储空间,单位为MB

  • Optional minimumDiskSpaceForInit?: number
    en

    limits for available space(megabyte) on a user’s device before the Vungle SDK initializes

    zh

    SDK初始化时需要的最小存储空间,单位为MB

  • Optional restrictAndroidID?: boolean
    en

    For Android only: Set true to opt out for Android ID collection by SDK or false (default) to opt in

    zh

    只用于Android:设置为True来禁止Vungle SDK获取Android ID

  • Optional setPublishIDFV?: boolean
    en

    For IOS only: set false to prevent passing the IDFV from the device to the SDK

    zh

    只用于IOS:设置为False来禁止Vungle SDK获取IDFV

VungleCallbacks

VungleCallbacks: { init?: InitCallback; load?: LoadAdCallback; play?: PlayAdCallback }
en

Callbacks

zh

回调函数

Type declaration

Variables

Const vungleCallbacks

vungleCallbacks: VungleCallbacks

Const vungleService

vungleService: VungleAd = getVungleService()

Functions

getVungleService

Generated using TypeDoc