library-core/com.naver.gfpsdk

Package-level declarations

Types

A listener for receiving notifications during the lifecycle of an ad such as banner or native or native simple ad.

class AdMuteFeedback(muteUrl: String, code: String, val description: String, @StringRes val descriptionResId: Int)

Class representing feedback information for ad mute actions. Contains tracking URL, code, and description for ad mute events.

AdMuteFeedbacksProvider

interface AdMuteFeedbacksProvider

Interface for providing ad mute feedback information. Used to provide feedback options when users mute ads.

AdParam

class AdParam : Serializable

Class representing parameters for ad requests. Contains various parameters needed for ad targeting and customization.

AdStyleOption

interface AdStyleOption

A class used to get style information of native ad.

BannerAdListener

open class BannerAdListener

Banner Ad exclusive listener for receiving notifications during the lifecycle of an banner ad.

BannerAdMediator

class BannerAdMediator : AdMediator<T1, T2>

Mediator class specifically designed for banner ads.

BannerViewLayoutType

enum BannerViewLayoutType

Enumeration defining different layout types for banner views.

BaseInStreamAdManager

abstract class BaseInStreamAdManager( context: Context, adParamArg: AdParam, adVideoPlayer: AdVideoPlayer, adContainer: FrameLayout?, linearAdType: LinearAdType = LinearAdType.PRE_ROLL, playTimeOffsetMillis: Long = 0) : GfpVideoAd

Base class for managing in-stream video ads. Handles the lifecycle and events of video ads, including loading, playing, and tracking.

BaseRemindTextAdView

interface BaseRemindTextAdView : GfpNonLinearAdView

Common text non-linear (remind text in NAM) ad.

ContentType

enum ContentType

A type of Video (linear) and Non-linear Ad

EventTrackingStatType

enum EventTrackingStatType

Event tracking state type

ExpandableAdEvent

interface ExpandableAdEvent

Event of the nda richmedia expandable ad

GenderType

enum GenderType

Enumeration representing gender codes for user properties.

Gfp

class Gfp

A class that fetch build phase and configure some api

GfpAd

interface GfpAd

GfpAd interface is a common interface implemented by all GFP ad class.

GfpAdChoicesData

sealed interface GfpAdChoicesData

Sealed interface for ad choices data. Represents different types of ad choices information including privacy and mute feedback.

GfpAdChoicesView

class GfpAdChoicesView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

View class for displaying ad choices (opt-out) icon. Used in FAN (Facebook Audience Network) and NDA (Native Display Ad) modules. This view allows users to opt out of personalized advertising.

GfpAdLoader

class GfpAdLoader(unifiedAdApi: UnifiedAdApi) : GfpAdLoaderBase

An object for requesting ads such as banner, native, native simple. Provides functionality to configure and build ad requests.

GfpAdLoaderBase

open class GfpAdLoaderBase

A base class for a GfpAdLoader.

GfpAdMuteView

open class GfpAdMuteView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

GfpApsAdParam

open class GfpApsAdParam : Serializable

Only for APS (Amazon header bidding), please set parameter with this

GfpBannerAd

interface GfpBannerAd : GfpAd

GfpBannerAd interface is a common interface implemented by all banner ad.

GfpBannerAdOptions

open class GfpBannerAdOptions

A class used to configure banner ad requests.

GfpBannerAdSize

open class GfpBannerAdSize : Serializable

The size of a banner ad.

GfpBannerAdView

class GfpBannerAdView : GfpBannerAdViewBase

The View to display banner ads for use with this SDK.

GfpBannerAdViewBase

abstract class GfpBannerAdViewBase : RelativeLayout, GfpBannerAd

A base class for GfpBannerAdView.

GfpContentInfo

data class GfpContentInfo(val sourceType: String, val sourceSubType: String, val sourceId: String) : Parcelable

GfpDedupeManager

open class GfpDedupeManager

Internal manager class for handling ad deduplication.

GfpError

data class GfpError(val errorType: GfpErrorType, val errorSubCode: String, val errorMessage: String, val stat: EventTrackingStatType) : Parcelable

Error information about why an ad operation failed.

GfpErrorSubType

class GfpErrorSubType

Ad error sub code.

GfpErrorType

enum GfpErrorType

Error types.

GfpInitializer

class GfpInitializer : NasInitializer

GfpInterstitialAd

abstract class GfpInterstitialAd : GfpAd

The GfpInterstitialAd interface represent a interstitial ad.

GfpInterstitialAdManager

open class GfpInterstitialAdManager : GfpInterstitialAd

Manager class for handling interstitial ads.

GfpInterstitialAdOptions

class GfpInterstitialAdOptions(val theme: GfpTheme?)

A class used to configure interstitial ad requests.

GfpLanguage

enum GfpLanguage : Enum<GfpLanguage>

Enumeration representing supported languages for the SDK. Provides functionality for locale management and string localization.

GfpMediaData

interface GfpMediaData

Provides media data.

GfpMediaType

enum GfpMediaType : Enum<GfpMediaType>

The type of media content drawn in the GfpMediaView.

GfpMediaView

open class GfpMediaView : FrameLayout

View for displaying native advanced ad media content.

GfpNativeAd

abstract class GfpNativeAd : GfpAd, NativeAssetProvider

The GfpNativeAd represents ad metadata to allow you to construct custom ad views.

GfpNativeAdOptions

class GfpNativeAdOptions( val theme: GfpTheme?, val adChoicesPlacement: Int, val richMediaPaddingInDp: Rect, activateObservingOnBackground: Boolean, hasMediaView: Boolean, enableMediaBackgroundBlur: Boolean, enableMediaOverlayDim: Boolean, enableCustomAdChoices: Boolean, val videoOptions: GfpNativeVideoOptions) : GfpNativeAdOptionsBase

A class used to configure native ad requests.

GfpNativeAdOptionsBase

interface GfpNativeAdOptionsBase

Base interface for native ad options configuration. Defines common options and settings for native ad display and behavior.

GfpNativeAdView

class GfpNativeAdView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout, ViewExtensions

View class for displaying native ads. After loading, call {@link #setNativeAd(GfpNativeAd)} to attach each asset to the page.

GfpNativeSimpleAd

abstract class GfpNativeSimpleAd : GfpAd, NativeSimpleAssetProvider

The GfpNativeSimpleAd interface represent a native simple ad.

GfpNativeSimpleAdOptions

open class GfpNativeSimpleAdOptions

A class used to configure native simple ad requests.

GfpNativeSimpleAdView

class GfpNativeSimpleAdView @JvmOverloads constructor( context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout, ViewExtensions

Ad view for Native Simple ad To attach ad to page, should call setNativeSimpleAd after loading.

GfpNonLinearAdView

interface GfpNonLinearAdView

Common non-linear (banner or text) ad view in video ad.

GfpResponseInfo

class GfpResponseInfo

Information about an ad response.

GfpRewardedAd

abstract class GfpRewardedAd : GfpAd

The GfpRewardedAd interface represent a rewarded ad.

GfpRewardedAdManager

class GfpRewardedAdManager(context: Context, initAdParam: AdParam) : GfpRewardedAdManagerBase

GfpRewardedAdManagerBase

abstract class GfpRewardedAdManagerBase : GfpRewardedAd

Base manager class for handling rewarded ads.

GfpRewardedAdOptions

class GfpRewardedAdOptions(builder: GfpRewardedAdOptions.Builder)

GfpRewardItem

open class GfpRewardItem

A class that describes a reward credited to a user for interacting with a rewarded ad.

GfpSdk

object GfpSdk

Class contains logic that applies to the GFP SDK as a whole.

GfpTheme

sealed interface GfpTheme

Represents the theme of the app. May be one of ResolvedTheme.SYSTEM, ResolvedTheme.LIGHT, ResolvedTheme.DARK, LazyTheme.

GfpVideoAd

interface GfpVideoAd : GfpAd

GfpVideoAd interface represent a video ad.

GfpVideoAdOptions

open class GfpVideoAdOptions

A class used to configure video ad requests.

GfpVideoAdQoeInfo

open class GfpVideoAdQoeInfo

QoE object for tracking in video ad

GfpVideoAdQoeListener

interface GfpVideoAdQoeListener

Interface for tracking Quality of Experience (QoE) metrics in video ad events.

GfpVideoAdScheduleManager

class GfpVideoAdScheduleManager( context: Context, adScheduleParam: VideoAdScheduleParam, adParam: AdParam, adVideoPlayer: AdVideoPlayer, adContainer: FrameLayout)

Manager class for handling video ad scheduling and playback. Controls the lifecycle of video ads, including loading, playing, and managing ad breaks.

HostParam

open class HostParam : Serializable

Meta data (string key/value) for banner ad.

Image

interface Image

A native ad image asset.

InterstitialAdListener

open class InterstitialAdListener

Listener interface for receiving interstitial ad events.

LabelOption

interface LabelOption

A class used to render label asset of native ad.

LazyTheme

class LazyTheme(resolver: LazyTheme.Resolver) : GfpTheme

Represents the theme that is determined to be lazy. This theme type allows for dynamic theme resolution through a resolver.

LinearAdType

enum LinearAdType

Enumeration defining the position of video ads (LinearAd) in content.

NonLinearAdInfo

sealed class NonLinearAdInfo

NonLinearViewStatusType

enum NonLinearViewStatusType

Status in NonLinearView

PrivacyUrlProvider

interface PrivacyUrlProvider

Interface for providing privacy URL information. Used to provide URLs for privacy-related content.

RemindTextAdViewAttributes

open class RemindTextAdViewAttributes

Attributes for RemindTextAdView

ResolvedImage

open class ResolvedImage( drawable: Drawable?, uri: Uri, scale: Double, width: Int, height: Int, requiredWidth: Int = width, requiredHeight: Int = height) : Image

ResolvedTheme

enum ResolvedTheme : Enum<ResolvedTheme> , GfpTheme

Represents the resolved theme. This enum defines the possible theme values that can be used in the app.

RewardedAdListener

open class RewardedAdListener

Listener interface for receiving rewarded ad events.

UnifiedAdApi

class UnifiedAdApi

Unified API class for handling different types of ads (banner, native, native simple).

UnifiedAdMediator