GFPSDK

https://naver.github.io/nam-sdk-ios
Admin
GFPSDK is NAVER's advertising mediation and delivery framework for iOS that enables mobile...
Tokens:221,265
Snippets:1,815
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### start() method signature

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadmanager/start%28%29

The method signature for starting advertisement playback.

```swift
func start()
```

--------------------------------

### setup(withPublisherCd:target:configuration:completionHandler:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Aconfiguration%3Acompletionhandler%3A%29

Initializes the GFP ad manager with a completion handler. This method should be called once at app launch. It registers all providers installed via CocoaPods and initializes them. Errors are reported in the completion handler's error parameter.

```APIDOC
## setup(withPublisherCd:target:configuration:completionHandler:)

### Description
Initializes the GFP ad manager. This method should be called once at app launch. It registers all providers installed via CocoaPods and initializes them. Errors are reported in the completion handler's error parameter.

### Method
Type Method

### Signature
```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)
```

### Parameters
- **publisherCd** (String?) - Optional - 광고 퍼블리셔 Code (Ad publisher code)
- **target** ((any GFPAdManagerDelegate)?) - Optional - Limited Ad Tracking 스테이터스 조회 Delegate (Delegate for querying Limited Ad Tracking status)
- **configuration** (GFPAdConfiguration?) - Optional - 광고 관련 설정 옵션 (Ad-related configuration options)
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - 초기화 결과 확인 handler (Handler to check initialization result)

### Notes
- This method should be called only once at app load time.
- Initialization time may vary by provider (e.g., IMA takes about 1-2 seconds).
- Ads from providers not initialized here will not be processed regardless of server responses.
- Errors are reported in the completion handler's error parameter.
```

--------------------------------

### func start(with: Bool)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadschedulemanager

Starts the video ad schedule with the specified option.

```APIDOC
## func start(with: Bool)

### Description
Starts the video ad schedule with the specified option.

### Method
start(with: Bool)

### Parameters
- **with** (Bool) - Required - A boolean value indicating whether to start with a specific option.

```

--------------------------------

### setup(withPublisherCd:serviceCd:target:) async - async version

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Aservicecd%3Atarget%3Acompletionhandler%3A%29

Async version of the setup method. Returns GFPError? instead of using a completion handler.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?
) async -> GFPError?
```

--------------------------------

### setup(withPublisherCd:serviceCd:target:configuration:completionHandler:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Aservicecd%3Atarget%3Aconfiguration%3Acompletionhandler%3A%29

GFPAdManager의 setup 메서드로 광고 매니저를 초기화합니다. publisherCd, serviceCd, target, configuration, completionHandler 파라미터를 사용하며, 비동기 변형도 제공됩니다.

```APIDOC
## setup(withPublisherCd:serviceCd:target:configuration:completionHandler:)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로 부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
class func setup

### Signature
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)

### Parameters
- **publisherCd** (String?) - 광고 퍼블리셔 Code
- **serviceCd** (String?) - 발급 받은 Service Code (optional)
- **target** ((any GFPAdManagerDelegate)?) - Limited Ad Tracking 스테이터스 조회 Delegate
- **configuration** (GFPAdConfiguration?) - 광고 관련 설정 옵션
- **completionHandler** (GFPAdManagerCompletionHandler) - 초기화 결과 확인 handler

### Async Variant
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?
) async -> GFPError?

### Return Value (Async)
- **GFPError?** - 초기화 결과 오류 (nil이면 성공)

```

--------------------------------

### setup(withPublisherCd:target:configuration:) async

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Aconfiguration%3Acompletionhandler%3A%29

Async variant of the setup method that returns an optional GFPError. It initializes the GFP ad manager with the same parameters but without a completion handler, instead returning an error if initialization fails.

```APIDOC
## setup(withPublisherCd:target:configuration:) async

### Description
Async variant of the setup method that returns an optional GFPError. It initializes the GFP ad manager with the same parameters but without a completion handler, instead returning an error if initialization fails.

### Method
Type Method (async)

### Signature
```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?
) async -> GFPError?
```

### Parameters
- **publisherCd** (String?) - Optional - 광고 퍼블리셔 Code (Ad publisher code)
- **target** ((any GFPAdManagerDelegate)?) - Optional - Limited Ad Tracking 스테이터스 조회 Delegate (Delegate for querying Limited Ad Tracking status)
- **configuration** (GFPAdConfiguration?) - Optional - 광고 관련 설정 옵션 (Ad-related configuration options)

### Return Value
- **GFPError?** - Optional - Returns an error if initialization fails, otherwise nil.

### Notes
- This method should be called only once at app load time.
- Initialization time may vary by provider (e.g., IMA takes about 1-2 seconds).
- Ads from providers not initialized here will not be processed regardless of server responses.
```

--------------------------------

### Async setup variant

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Aconfiguration%3Acompletionhandler%3A%29

Async version of setup that returns an optional GFPError. Use with Swift concurrency to await the initialization result.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?
) async -> GFPError?
```

--------------------------------

### GFPBundle.setup()

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpbundle

Performs setup operations for the GFPBundle.

```APIDOC
## GFPBundle.setup()

### Description
Performs setup operations for the GFPBundle.

### Declaration
```swift
func setup()
```

### Parameters
None.

### Return Value
Void.
```

--------------------------------

### class func setup(withPublisherCd: String?, serviceCd: String?, target: (any GFPAdManagerDelegate)?, configuration: GFPAdConfiguration?, completionHandler: GFPAdManagerCompletionHandler)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager

Initializes the ad manager with publisher code, service code, delegate, configuration, and completion handler.

```APIDOC
## class func setup(withPublisherCd: String?, serviceCd: String?, target: (any GFPAdManagerDelegate)?, configuration: GFPAdConfiguration?, completionHandler: GFPAdManagerCompletionHandler)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로 부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
class func

### Endpoint
GFPAdManager.setup(withPublisherCd:serviceCd:target:configuration:completionHandler:)

### Parameters
#### Parameters
- **publisherCd** (String?) - Optional - The publisher code.
- **serviceCd** (String?) - Optional - The service code.
- **target** (any GFPAdManagerDelegate?) - Optional - The delegate object.
- **configuration** (GFPAdConfiguration?) - Optional - The ad configuration.
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - The completion handler to call when initialization finishes.

### Response
#### Success Response
No return value.

#### Response Example
```swift
GFPAdManager.setup(withPublisherCd: "publisher", serviceCd: "service", target: self, configuration: config) { error in
    // handle error
}
```
```

--------------------------------

### var startOffset: TimeInterval { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadscheduleparam/startoffset

Instance property representing the start offset of an ad schedule parameter.

```APIDOC
## var startOffset: TimeInterval { get set }

### Description
Instance property representing the start offset of an ad schedule parameter.

### Declaration
```swift
var startOffset: TimeInterval { get set }
```

### Parameters
- **startOffset** (TimeInterval) - The start offset value.
```

--------------------------------

### class func setup(withPublisherCd: String?, serviceCd: String?, target: (any GFPAdManagerDelegate)?, completionHandler: GFPAdManagerCompletionHandler)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager

Initializes the ad manager with publisher code, service code, delegate, and completion handler.

```APIDOC
## class func setup(withPublisherCd: String?, serviceCd: String?, target: (any GFPAdManagerDelegate)?, completionHandler: GFPAdManagerCompletionHandler)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로 부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
class func

### Endpoint
GFPAdManager.setup(withPublisherCd:serviceCd:target:completionHandler:)

### Parameters
#### Parameters
- **publisherCd** (String?) - Optional - The publisher code.
- **serviceCd** (String?) - Optional - The service code.
- **target** (any GFPAdManagerDelegate?) - Optional - The delegate object.
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - The completion handler to call when initialization finishes.

### Response
#### Success Response
No return value.

#### Response Example
```swift
GFPAdManager.setup(withPublisherCd: "publisher", serviceCd: "service", target: self) { error in
    // handle error
}
```
```

--------------------------------

### class func setup(withPublisherCd: String?, target: (any GFPAdManagerDelegate)?, configuration: GFPAdConfiguration?, completionHandler: GFPAdManagerCompletionHandler)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager

Initializes the ad manager with publisher code, delegate, configuration, and completion handler.

```APIDOC
## class func setup(withPublisherCd: String?, target: (any GFPAdManagerDelegate)?, configuration: GFPAdConfiguration?, completionHandler: GFPAdManagerCompletionHandler)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로 부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
class func

### Endpoint
GFPAdManager.setup(withPublisherCd:target:configuration:completionHandler:)

### Parameters
#### Parameters
- **publisherCd** (String?) - Optional - The publisher code.
- **target** (any GFPAdManagerDelegate?) - Optional - The delegate object.
- **configuration** (GFPAdConfiguration?) - Optional - The ad configuration.
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - The completion handler to call when initialization finishes.

### Response
#### Success Response
No return value.

#### Response Example
```swift
GFPAdManager.setup(withPublisherCd: "publisher", target: self, configuration: config) { error in
    // handle error
}
```
```

--------------------------------

### class func setup(withPublisherCd: String?, target: (any GFPAdManagerDelegate)?, completionHandler: GFPAdManagerCompletionHandler)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager

Initializes the ad manager with publisher code, delegate, and completion handler.

```APIDOC
## class func setup(withPublisherCd: String?, target: (any GFPAdManagerDelegate)?, completionHandler: GFPAdManagerCompletionHandler)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로 부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
class func

### Endpoint
GFPAdManager.setup(withPublisherCd:target:completionHandler:)

### Parameters
#### Parameters
- **publisherCd** (String?) - Optional - The publisher code.
- **target** (any GFPAdManagerDelegate?) - Optional - The delegate object.
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - The completion handler to call when initialization finishes.

### Response
#### Success Response
No return value.

#### Response Example
```swift
GFPAdManager.setup(withPublisherCd: "publisher", target: self) { error in
    // handle error
}
```
```

--------------------------------

### var size: CGSize { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpwaterfalladsize/size

Gets the size of the waterfall ad size object.

```APIDOC
## var size: CGSize { get }

### Description
Gets the size of the waterfall ad size object.

### Declaration
`var size: CGSize { get }`

### Parameters
None.

### Return Value
A `CGSize` value representing the size of the ad.

### Discussion
This property provides the size of the waterfall ad size instance. It is read-only and returns the size as a `CGSize` structure.
```

--------------------------------

### var responseSize: GFPAdInfoSize { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadadaptorparam/responsesize

Gets the response size of the ad adaptor parameter.

```APIDOC
## var responseSize: GFPAdInfoSize { get }

### Description
Gets the response size of the ad adaptor parameter.

### Property
`var responseSize: GFPAdInfoSize { get }`

### Return Value
- **GFPAdInfoSize** - The response size of the ad adaptor parameter.
```

--------------------------------

### startPos

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpspannableoption/startpos

Instance property that specifies the start position of emphasized text. The start position is 1.

```APIDOC
## startPos

### Description
Instance property that specifies the start position of emphasized text. The start position is 1.

### Declaration
```swift
let startPos: Int
```

### Parameters
None

### Return Value
- **startPos** (Int) - The start position of the emphasized text.
```

--------------------------------

### setup(withPublisherCd:target:completionHandler:) synchronous method

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Acompletionhandler%3A%29

Initializes the ad manager using a completion handler to return the result.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)
```

--------------------------------

### var idfv: String? { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpcoreconfig/idfv

Gets the identifier for vendor (IDFV) as an optional string. This property is read-only.

```APIDOC
## var idfv: String? { get }

### Description
Gets the identifier for vendor (IDFV) as an optional string. This property is read-only.

### Declaration
```swift
var idfv: String? { get }
```

### Return Value
An optional string representing the identifier for vendor (IDFV).
```

--------------------------------

### var bgColorAlpha: Float { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativestyledetailinfo/bgcoloralpha

Gets the alpha value of the background color for the native style detail info.

```APIDOC
## var bgColorAlpha: Float { get }

### Description
Gets the alpha value of the background color for the native style detail info.

### Declaration
```swift
var bgColorAlpha: Float { get }
```

### Parameters
None

### Return Value
- **Float** - The alpha value of the background color.

### Discussion
This property is read-only and provides the alpha component of the background color used in the native style detail info.
```

--------------------------------

### setup(withPublisherCd:target:completionHandler:) asynchronous method

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Acompletionhandler%3A%29

Initializes the ad manager using Swift concurrency, returning a GFPError if initialization fails.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?
) async -> GFPError?
```

--------------------------------

### var borderColor: UIColor? { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativestyledetailinfo/bordercolor

Gets the border color of the badge. This property is get-only and returns an optional UIColor.

```APIDOC
## var borderColor: UIColor? { get }

### Description
Returns the border color of the badge as an optional UIColor.

### Declaration
```swift
var borderColor: UIColor? { get }
```

### Parameters
None

### Return Value
- **borderColor** (UIColor?) - The border color of the badge, or nil if not set.
```

--------------------------------

### setup(withPublisherCd:serviceCd:target:completionHandler:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Aservicecd%3Atarget%3Acompletionhandler%3A%29

광고 매니저를 초기화하는 메서드입니다. publisherCd, serviceCd, target, completionHandler를 사용하여 초기화를 수행합니다.

```APIDOC
## setup(withPublisherCd:serviceCd:target:completionHandler:)

### Description
광고 매니저를 초기화 합니다. GFP를 통해 광고를 받아올 광고 provider 등록할 필요 없이, cocoapods 등록한 provider 별로 초기화가 이루어 집니다. provider에 따라 초기화에 시간이 오래 걸릴 수 있으므로 어플리케이션 로드시점 한번만 호출해주시면 됩니다. (eg. IMA는 구글 문서기준 약 1~2초 소요) 여기서 초기화되지 않은 provider로부터의 광고는 이후 서버로부터의 응답결과와 관계없이 처리되지 않습니다. 오류결과는 completionHandler의 error 에서 확인해 주세요.

### Method
setup

### Endpoint
setup(withPublisherCd:serviceCd:target:completionHandler:)

### Parameters
- **publisherCd** (String?) - Required - 광고 퍼블리셔 Code
- **serviceCd** (String?) - Optional - 발급 받은 Service Code
- **target** (any GFPAdManagerDelegate?) - Required - Limited Ad Tracking 스테이터스 조회 Delegate
- **completionHandler** (GFPAdManagerCompletionHandler) - Required - 초기화 결과 확인 handler

### Request Example
```swift
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)
```

### Response
#### Success Response
- **error** (GFPError?) - 초기화 결과 오류 (nil이면 성공)

#### Response Example
```swift
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?
) async -> GFPError?
```
```

--------------------------------

### videoAdWasStarted(_:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadaptordelegate/videoadwasstarted%28_%3A%29

Required delegate method called when a video ad starts. Implement this method to handle the start of a video ad.

```APIDOC
## videoAdWasStarted(_:)

### Description
Called when a video ad starts. This is a required method of the GFPVideoAdaptorDelegate protocol.

### Method
Instance Method

### Declaration
```swift
func videoAdWasStarted(_ videoAdaptor: any GFPAdAdaptor & GFPVideoAdapting)
```

### Parameters
- **videoAdaptor** (any GFPAdAdaptor & GFPVideoAdapting) - The video adaptor that started the ad.

### Requirements
- **Required** - This method must be implemented by conforming types.

```

--------------------------------

### rewardedAdManager(_:didStart:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfprewardedadmanagerdelegate/rewardedadmanager%28_%3Adidstart%3A%29

Required delegate method that is called when a rewarded ad starts. Implement this method to handle the start event.

```APIDOC
## rewardedAdManager(_:didStart:)

### Description
Called when a rewarded ad starts. This is a required method of the GFPRewardedAdManagerDelegate protocol.

### Method Signature
```swift
func rewardedAdManager(
    _ manager: GFPRewardedAdManager,
    didStart rewardedAd: GFPRewardedAd
)
```

### Parameters
- **manager** (GFPRewardedAdManager) - The manager that started the rewarded ad.
- **rewardedAd** (GFPRewardedAd) - The rewarded ad that started.

### Requirements
- This method is required for conforming to the GFPRewardedAdManagerDelegate protocol.
```

--------------------------------

### init(provider:baseInfo:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadqoeinfo/init%28provider%3Abaseinfo%3A%29

Initializes a GFPVideoAdQoeInfo instance with a provider string and a base info object.

```APIDOC
## init(provider:baseInfo:)

### Description
Initializes a GFPVideoAdQoeInfo instance with a provider string and a base info object.

### Method
Initializer

### Signature
```
init(
    provider aProvider: String,
    baseInfo aBaseInfo: GFPVideoAdQoeBaseInfo
)
```

### Parameters
- **aProvider** (String) - The provider string.
- **aBaseInfo** (GFPVideoAdQoeBaseInfo) - The base info object.

```

--------------------------------

### var responseSize: GFPAdInfoSize? { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadinfo/responsesize

Gets the response size of the ad. This property is read-only and returns an optional GFPAdInfoSize value.

```APIDOC
## var responseSize: GFPAdInfoSize? { get }

### Description
Gets the response size of the ad. This property is read-only and returns an optional GFPAdInfoSize value.

### Declaration
```swift
var responseSize: GFPAdInfoSize? { get }
```

### Parameters
None

### Return Value
- **GFPAdInfoSize?** - The response size of the ad, or nil if not available.
```

--------------------------------

### interstitialAdManager(_:didStart:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpinterstitialadmanagerdelegate/interstitialadmanager%28_%3Adidstart%3A%29

Required delegate method that is called when an interstitial ad starts. Implement this method to handle the start of an interstitial ad.

```APIDOC
## interstitialAdManager(_:didStart:)

### Description
Called when an interstitial ad starts. This is a required method of the GFPInterstitialAdManagerDelegate protocol.

### Method
Delegate method

### Declaration
```swift
func interstitialAdManager(
    _ manager: GFPInterstitialAdManager,
    didStart interstitialAd: GFPInterstitialAd
)
```

### Parameters
- **manager** (GFPInterstitialAdManager) - The manager that manages the interstitial ad.
- **interstitialAd** (GFPInterstitialAd) - The interstitial ad that started.

### Availability
Required
```

--------------------------------

### init(provider:baseInfo:playerInfo:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadqoeinfo/init%28provider%3Abaseinfo%3Aplayerinfo%3A%29

Initializes a GFPVideoAdQoeInfo instance with the specified provider, base information, and player information.

```APIDOC
## init(provider:baseInfo:playerInfo:)

### Description
Initializes a GFPVideoAdQoeInfo instance with the provided provider, base information, and player information.

### Method
Initializer

### Parameters
- **provider** (String) - Required - The provider identifier.
- **baseInfo** (GFPVideoAdQoeBaseInfo) - Required - The base QOE information.
- **playerInfo** (GFPVideoAdQoePlayerInfo) - Required - The player QOE information.

### Request Example
```swift
let qoeInfo = GFPVideoAdQoeInfo(
    provider: "provider",
    baseInfo: baseInfo,
    playerInfo: playerInfo
)
```
```

--------------------------------

### var gender: GFPUserParamGenderType { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpuserparam/gender

The gender property allows getting and setting the user's gender. It is of type GFPUserParamGenderType.

```APIDOC
## var gender: GFPUserParamGenderType { get set }

### Description
성별 (Gender)

### Declaration
```swift
var gender: GFPUserParamGenderType { get set }
```

### Parameters
- **gender** (GFPUserParamGenderType) - The gender value to set or the current gender value.
```

--------------------------------

### init()

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadplayersetting

Initializes a new GFPVideoAdPlayerSetting instance.

```APIDOC
## init()

### Description
Initializes a new GFPVideoAdPlayerSetting instance.

### Syntax
```swift
init()
```
```

--------------------------------

### var apsParam: GFPAPSAdParam? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadparam/apsparam

An instance property that gets or sets the Amazon header bidding parameters for the ad request.

```APIDOC
## var apsParam: GFPAPSAdParam? { get set }

### Description
Amazon 헤더 비딩 파라미터. (Amazon header bidding parameters.)

### Declaration
```swift
var apsParam: GFPAPSAdParam? { get set }
```

### Parameters
- **apsParam** (GFPAPSAdParam?) - Optional - The Amazon header bidding parameters to set or the current value.
```

--------------------------------

### init()

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadplayersetting/init%28%29

Creates a new GFPVideoAdPlayerSetting instance using a convenience override initializer.

```APIDOC
## init()

### Description
Creates a new instance of GFPVideoAdPlayerSetting.

### Declaration
```
convenience override init()
```

```

--------------------------------

### init(action:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadplayersetting/init%28action%3A%29

Creates a GFPVideoAdPlayerSetting instance with the given video background action type.

```APIDOC
## init(action:)

### Description
Creates a GFPVideoAdPlayerSetting instance with the specified video background action type.

### Declaration
swift
convenience init(action aAction: GFPVideoBackgroundActionType)


### Parameters
- **aAction** (GFPVideoBackgroundActionType) - The video background action type to set for the player setting.

### Discussion
Use this initializer to configure the player setting with a specific background action behavior, such as how the video behaves when the app is backgrounded.
```

--------------------------------

### Setup with completion handler

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Atarget%3Aconfiguration%3Acompletionhandler%3A%29

Initializes the ad manager with a completion handler to check the result. Call once at app launch. Errors are provided in the handler's error parameter.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    target: (any GFPAdManagerDelegate)?,
    configuration: GFPAdConfiguration?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)
```

--------------------------------

### videoAdManagerDidStartAd(_:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadmanagerdelegate/videoadmanagerdidstartad%28_%3A%29

Optional delegate method called when video ad playback starts. Implement this method to handle the start of video ad playback.

```APIDOC
## videoAdManagerDidStartAd(_:)

### Description
Called when video ad playback starts.

### Method
Delegate method (optional)

### Declaration
```swift
optional func videoAdManagerDidStartAd(_ videoAdManager: GFPVideoAdManager)
```

### Parameters
- **videoAdManager** (GFPVideoAdManager) - The video ad manager instance.

### Required
This method is marked as Required in the documentation, indicating it must be implemented by the delegate.

```

--------------------------------

### rewardedAdStarted(_:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfprewardedaddelegate/rewardedadstarted%28_%3A%29

Required delegate method that notifies the delegate when a rewarded ad starts playing. Implement this method to handle the start of a rewarded ad.

```APIDOC
## rewardedAdStarted(_:)

### Description
Required delegate method that is called when a rewarded ad starts. Implement this method to respond to the start of a rewarded ad.

### Method
Instance Method

### Declaration
func rewardedAdStarted(_ rewardedAd: GFPRewardedAd!)

### Parameters
- **rewardedAd** (GFPRewardedAd!) - The rewarded ad object that started.

### Required
Yes
```

--------------------------------

### init(dict: [AnyHashable : Any])

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativestyleinfo

Initializes a GFPNativeStyleInfo instance with a dictionary.

```APIDOC
## init(dict: [AnyHashable : Any])

### Description
Initializes a GFPNativeStyleInfo instance with a dictionary.

### Method
Initializer

### Parameters
- **dict** ([AnyHashable : Any]) - Required - The dictionary containing style information.

### Response
No return value.
```

--------------------------------

### var richInfo: GFPNativeRichInfo? { get }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativemediaextensioninfo/richinfo

Gets the rich media information for the native ad extension. Returns nil if no rich info is available.

```APIDOC
## var richInfo: GFPNativeRichInfo? { get }

### Description
Gets the rich media information for the native ad extension. Returns nil if no rich info is available.

### Declaration
```swift
var richInfo: GFPNativeRichInfo? { get }
```

### Parameters
None

### Return Value
- **GFPNativeRichInfo?** - The rich media information, or nil if not available.
```

--------------------------------

### init(dict:link:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativemediainfo

Initializes a GFPNativeMediaInfo instance with a dictionary and link information.

```APIDOC
## init(dict:link:)

### Description
Initializes a GFPNativeMediaInfo instance with a dictionary and link information.

### Method
init

### Parameters
- **dict** ([AnyHashable : Any]) - Required - The dictionary containing media information.
- **link** (GFPNativeLinkInfo) - Required - The link information associated with the media.

### Return Value
A new GFPNativeMediaInfo instance.
```

--------------------------------

### var adProviderConfigList: [GFPAdProviderSetting] { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadconfiguration/adproviderconfiglist

Instance property to get or set the list of ad provider settings for test mode configuration.

```APIDOC
## var adProviderConfigList: [GFPAdProviderSetting] { get set }

### Description
Instance property that holds an array of GFPAdProviderSetting objects, used to configure test mode settings per ad provider.

### Declaration
swift
var adProviderConfigList: [GFPAdProviderSetting] { get set }


### Parameters
- **adProviderConfigList** ([GFPAdProviderSetting]) - The list of ad provider settings. This property is gettable and settable.

### Discussion
This property allows you to set test mode configurations for each ad provider. Assign an array of GFPAdProviderSetting instances to enable or disable test mode for specific providers.
```

--------------------------------

### var customParam: [String : String]? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadconfiguration/customparam

Sets or gets the global additional parameters. The dictionary keys and values must be strings.

```APIDOC
## var customParam: [String : String]? { get set }

### Description
전역 추가 파라미터를 설정하거나 가져옵니다. 추가 파라미터 사전의 키/값은 모두 문자열 타입이어야 합니다.

### Declaration
```swift
var customParam: [String : String]? { get set }
```

### Parameters
- **customParam** ([String : String]?) - Optional - 전역 추가 파라미터 사전. 키와 값은 모두 문자열이어야 합니다.
```

--------------------------------

### init(audioSetting:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadplayersetting/init%28audiosetting%3A%29

Convenience initializer that creates a GFPVideoAdPlayerSetting with the given audio setting type.

```APIDOC
## init(audioSetting:)

### Description
Creates a GFPVideoAdPlayerSetting instance with the specified audio setting type.

### Declaration
convenience init(audioSetting aType: GFPVideoAudioSettingType)

### Parameters
- **aType** (GFPVideoAudioSettingType) - The audio setting type to apply to the video ad player.

### Return Value
A new GFPVideoAdPlayerSetting instance.

### Availability
Available in GFPSDK.
```

--------------------------------

### var remindAd: GFPRemindAd? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnonlinearadview/remindad

Gets or sets the remind ad associated with the non-linear ad view. This property is available on the main actor.

```APIDOC
## Property: remindAd

### Description
Gets or sets the remind ad associated with the non-linear ad view. This property is available on the main actor.

### Declaration
```swift
@MainActor
var remindAd: GFPRemindAd? { get set }
```

### Parameters
- **remindAd** (GFPRemindAd?) - The remind ad to set, or nil to clear.

### Return Value
- **GFPRemindAd?** - The current remind ad, or nil if none is set.

### Discussion
This property allows you to assign a GFPRemindAd instance to the non-linear ad view. It is marked with @MainActor, so access must occur on the main thread.
```

--------------------------------

### var interstitialAdRequestTimeout: TimeInterval { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadconfiguration/interstitialadrequesttimeout

A property that sets or gets the timeout duration for interstitial ad requests. The default value is 60 seconds.

```APIDOC
## var interstitialAdRequestTimeout: TimeInterval { get set }

### Description
Sets or gets the timeout interval for interstitial ad requests. The default value is 60 seconds (kGFPDefaultInterstitialAdRequestTimeout).

### Declaration
```swift
var interstitialAdRequestTimeout: TimeInterval { get set }
```

### Parameters
- **value** (TimeInterval) - The timeout duration in seconds. Default is 60 seconds.

### Return Value
- **TimeInterval** - The current timeout duration in seconds.

### Discussion
Use this property to customize the timeout for interstitial ad requests. The default value is 60 seconds.
```

--------------------------------

### init(rootViewController:hostMeta:layoutType:webViewOptions:clickDelegate:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpbannercontext/init%28rootviewcontroller%3Ahostmeta%3Alayouttype%3Awebviewoptions%3Aclickdelegate%3A%29

Initializes a GFPBannerContext with the provided parameters. Use this to configure a banner ad context before presenting it.

```APIDOC
## init(rootViewController:hostMeta:layoutType:webViewOptions:clickDelegate:)

### Description
Initializes a GFPBannerContext instance with the given root view controller, host metadata, layout type, web view options, and click delegate.

### Method
Initializer

### Signature
```swift
init(
    rootViewController: UIViewController?,
    hostMeta: [String : String],
    layoutType: GFPBannerViewLayoutType,
    webViewOptions: GFPAdBannerWebViewOptions?,
    clickDelegate: (any GFPS2SAdClickDelegate)?
)
```

### Parameters
- **rootViewController** (UIViewController?) - Optional - The root view controller used for presenting the banner.
- **hostMeta** ([String : String]) - Required - Metadata about the host, provided as a dictionary of string keys and values.
- **layoutType** (GFPBannerViewLayoutType) - Required - The layout type for the banner view.
- **webViewOptions** (GFPAdBannerWebViewOptions?) - Optional - Options for configuring the web view used by the banner.
- **clickDelegate** ((any GFPS2SAdClickDelegate)?) - Optional - A delegate to handle click events, conforming to GFPS2SAdClickDelegate.
```

--------------------------------

### init(action: GFPVideoBackgroundActionType, audioSetting: GFPVideoAudioSettingType)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadplayersetting

Initializes a GFPVideoAdPlayerSetting with specified background action and audio setting.

```APIDOC
## init(action: GFPVideoBackgroundActionType, audioSetting: GFPVideoAudioSettingType)

### Description
Initializes a GFPVideoAdPlayerSetting with specified background action and audio setting.

### Parameters
- **action** (GFPVideoBackgroundActionType) - The background action type.
- **audioSetting** (GFPVideoAudioSettingType) - The audio setting.

### Syntax
```swift
init(action: GFPVideoBackgroundActionType, audioSetting: GFPVideoAudioSettingType)
```
```

--------------------------------

### var renderType: String? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadadaptor/rendertype

The renderType property is a String? that can be read and written. It is used to get or set the render type for the ad adaptor.

```APIDOC
## var renderType: String? { get set }

### Description
Gets or sets the render type as an optional String.

### Declaration
```swift
var renderType: String? { get set }
```

### Parameters
None.

### Return Value
An optional String representing the render type.

### Discussion
This property is settable, allowing the render type to be updated.
```

--------------------------------

### var attachmentInfo: GFPAdAttachmentInfo { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadadaptor/attachmentinfo

A property that gets or sets the attachment information for the ad adaptor. This property is of type GFPAdAttachmentInfo and is both readable and writable.

```APIDOC
## var attachmentInfo: GFPAdAttachmentInfo { get set }

### Description
Gets or sets the attachment information for the ad adaptor. This property is of type GFPAdAttachmentInfo and is both readable and writable.

### Declaration
```swift
var attachmentInfo: GFPAdAttachmentInfo { get set }
```

### Parameters
None

### Return Value
GFPAdAttachmentInfo - The attachment information associated with the ad adaptor.

### Discussion
Use this property to access or modify the attachment information for the ad adaptor. The property is mutable, allowing both get and set operations.
```

--------------------------------

### init?(dictionary: [AnyHashable : Any]?, link: GFPNativeLinkInfo)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpnativemediaextensioninfo

Initializes a GFPNativeMediaExtensionInfo instance with a dictionary and link information.

```APIDOC
## init?(dictionary: [AnyHashable : Any]?, link: GFPNativeLinkInfo)

### Description
Initializes a GFPNativeMediaExtensionInfo instance with a dictionary and link information.

### Method
init

### Parameters
- **dictionary** ([AnyHashable : Any]?) - Optional - The dictionary containing media extension data.
- **link** (GFPNativeLinkInfo) - Required - The link information associated with the media extension.

### Return Value
An optional GFPNativeMediaExtensionInfo instance.
```

--------------------------------

### init(bundle:size:lightModeName:darkModeName:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpcustomasset

Initializes a GFPCustomAsset with a bundle, size, and light/dark mode image names.

```APIDOC
## init(bundle:size:lightModeName:darkModeName:)

### Description
Initializes a GFPCustomAsset with a bundle, size, and light/dark mode image names.

### Method
init

### Parameters
- **bundle** (Bundle?) - Optional - The bundle containing the image resources.
- **size** (CGSize) - Required - The size of the asset.
- **lightModeName** (String) - Required - The image name for light mode.
- **darkModeName** (String) - Required - The image name for dark mode.

### Return Value
A new GFPCustomAsset instance.
```

--------------------------------

### var volume: Float { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadapting/volume

A required instance property that gets or sets the current volume of the video player. The volume is represented as a Float value.

```APIDOC
## var volume: Float { get set }

### Description
A required instance property that gets or sets the current volume of the video player. The volume is represented as a Float value.

### Declaration
```swift
var volume: Float { get set }
```

### Property Value
- **volume** (Float) - The current volume level. The range is typically 0.0 (muted) to 1.0 (maximum volume).

### Discussion
This property is part of the GFPVideoAdapting protocol and must be implemented by conforming types. It allows the host application to control the audio volume of the video being adapted.
```

--------------------------------

### var userID: String? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpuserparam/userid

The userID property of GFPUserParam allows getting and setting the user identification value within the service. It is an optional String.

```APIDOC
## var userID: String? { get set }

### Description
서비스내 유저 식별 값 (User identification value within the service)

### Declaration
```swift
var userID: String? { get set }
```

### Parameters
None

### Return Value
- **userID** (String?) - The user identification value, or nil if not set.

### Discussion
This property is part of the GFPUserParam class. It can be read and written to set or retrieve the user identifier.
```

--------------------------------

### init(provider:placementType:duration:skipOffset:mediaWidth:mediaHeight:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpvideoadqoeinfo/init%28provider%3Aplacementtype%3Aduration%3Askipoffset%3Amediawidth%3Amediaheight%3A%29

Initializes a GFPVideoAdQoeInfo instance with the specified QOE parameters. Use this initializer to create a QOE info object for video ad quality measurement.

```APIDOC
## init(provider:placementType:duration:skipOffset:mediaWidth:mediaHeight:)

### Description
Initializes a GFPVideoAdQoeInfo instance with the provided QOE parameters.

### Declaration
```swift
init(
    provider: String,
    placementType: String,
    duration: TimeInterval,
    skipOffset: TimeInterval,
    mediaWidth: Int,
    mediaHeight: Int
)
```

### Parameters
- **provider** (String) - The provider of the video ad.
- **placementType** (String) - The placement type of the video ad.
- **duration** (TimeInterval) - The duration of the video ad.
- **skipOffset** (TimeInterval) - The skip offset of the video ad.
- **mediaWidth** (Int) - The width of the media.
- **mediaHeight** (Int) - The height of the media.

### Return Value
An initialized GFPVideoAdQoeInfo instance.
```

--------------------------------

### var webViewOptions: GFPAdBannerWebViewOptions? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpbannercontext/webviewoptions

Instance property to get or set the web view options for a banner ad context. The type is optional GFPAdBannerWebViewOptions.

```APIDOC
## Property: webViewOptions

### Description
Instance property to get or set the web view options for a banner ad context. The type is optional GFPAdBannerWebViewOptions.

### Declaration
```swift
var webViewOptions: GFPAdBannerWebViewOptions? { get set }
```

### Parameters
- **webViewOptions** (GFPAdBannerWebViewOptions?) - The web view options to set, or nil to clear.

### Return Value
- **GFPAdBannerWebViewOptions?** - The current web view options, or nil if not set.

```

--------------------------------

### init(size:type:)

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpbanneradsize/init%28size%3Atype%3A%29

Creates a GFPBannerAdSize with the given size and type.

```APIDOC
## init(size:type:)

### Description
Initializes a GFPBannerAdSize instance with a custom size and banner size type.

### Method
Initializer

### Signature
```
init(
    size: CGSize,
    type: GFPBannerSizeType
)
```

### Parameters
- **size** (CGSize) - The size of the banner ad.
- **type** (GFPBannerSizeType) - The type of the banner ad size.

```

--------------------------------

### setup(withPublisherCd:serviceCd:target:completionHandler:) - completion handler version

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadmanager/setup%28withpublishercd%3Aservicecd%3Atarget%3Acompletionhandler%3A%29

Initializes the ad manager with a completion handler. Call once at app launch. Providers not initialized here will not process ads. Check errors in the completionHandler's error.

```swift
class func setup(
    withPublisherCd publisherCd: String?,
    serviceCd: String?,
    target: (any GFPAdManagerDelegate)?,
    completionHandler: @escaping GFPAdManagerCompletionHandler
)
```

--------------------------------

### var customUserParam: [String : String]? { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadparam/customuserparam

Sets or gets additional parameters for ad requests. The dictionary keys and values must be of type String.

```APIDOC
## var customUserParam: [String : String]? { get set }

### Description
Sets or gets additional parameters for ad requests. All keys and values in the dictionary must be strings.

### Declaration
```swift
var customUserParam: [String : String]? { get set }
```

### Parameters
- **customUserParam** ([String : String]?) - Optional - A dictionary of additional parameters. Keys and values must be strings.

### Discussion
Use this property to pass custom parameters to the ad server. Ensure that both keys and values are of type String.
```

--------------------------------

### var adParam: GFPAdParam { get set }

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpadloader/adparam

The adParam property of GFPAdLoader allows getting and setting the ad parameters used for loading ads. It is of type GFPAdParam.

```APIDOC
## var adParam: GFPAdParam { get set }

### Description
Gets or sets the ad parameters for the GFPAdLoader instance.

### Declaration
```swift
var adParam: GFPAdParam { get set }
```

### Parameters
None

### Return Value
- **adParam** (GFPAdParam) - The ad parameters object.

### Discussion
Use this property to configure ad parameters before loading ads with the GFPAdLoader.
```

--------------------------------

### GFPBundle.init()

Source: https://naver.github.io/nam-sdk-ios/documentation/gfpsdk/gfpbundle

Initializes a new instance of GFPBundle.

```APIDOC
## GFPBundle.init()

### Description
Initializes a new instance of GFPBundle.

### Declaration
```swift
init()
```

### Parameters
None.

### Return Value
A new GFPBundle instance.
```
Tokens:
Raw