library-core/com.naver.gfpsdk.properties/UserPropertiesBuilder

UserPropertiesBuilder

class UserPropertiesBuilder

Builder class for configuring user properties used in ad targeting. This class allows setting various user attributes and preferences for personalized ad delivery. Note: Contact NAM admin before using these properties.

Properties

Link copied to clipboard

Functions

Link copied to clipboard
fun addCustomParam(key: String, value: String): UserPropertiesBuilder

Adds a single custom parameter. Note: AdParam settings take precedence over these parameters.

Link copied to clipboard
fun build(): UserProperties

Builds and returns a UserProperties instance with the configured settings.

Link copied to clipboard
fun childDirectedTreatment(tagForChildDirectedTreatment: Boolean?): UserPropertiesBuilder

Sets the child-directed treatment flag (COPPA compliance).

fun childDirectedTreatment(tagForChildDirectedTreatment: String?): UserPropertiesBuilder

Sets the child-directed treatment flag using a string value.

Link copied to clipboard
fun country(country: String): UserPropertiesBuilder

Sets the user's country code.

Link copied to clipboard
fun gender(gender: GenderType): UserPropertiesBuilder

Sets the user's gender information.

Link copied to clipboard
fun id(id: String): UserPropertiesBuilder

Sets the service user ID for error log tracking.

Link copied to clipboard
fun language(language: String): UserPropertiesBuilder

Sets the user's language code.

Link copied to clipboard
fun setContentId(contentId: String): UserPropertiesBuilder

Sets the content ID for targeted advertising.

Link copied to clipboard
fun setCustomParam(customParam: Map<String, String>): UserPropertiesBuilder

Sets multiple custom parameters at once. Note: AdParam settings take precedence over these parameters.

Link copied to clipboard
fun setDisableAdId(disableAdId: Boolean): UserPropertiesBuilder

Sets whether to disable ADID usage regardless of privacy policies.

Link copied to clipboard
fun underAgeOfConsent(tagForUnderAgeOfConsent: Boolean?): UserPropertiesBuilder

Sets the under age of consent flag (CCPA/PDPA compliance).

fun underAgeOfConsent(tagForUnderAgeOfConsent: String?): UserPropertiesBuilder

Sets the under age of consent flag using a string value.

Link copied to clipboard
fun yob(yob: Int): UserPropertiesBuilder

Sets the user's year of birth.