Settings Configuration

info

Settings Overview: This page covers all configuration settings available in the Teads SDK for Android, organized by placement type and use case.

TeadsSDK

Name	Type	Field/Method	Description
sdkVersion	String	Field	Current TeadsSDK Version value in semver format (read-only)
testMode	Boolean	Field	Test mode flag. Set to true to activate test mode [All placements], false to deactivate. Prevents operational actions such as reporting and billing and increases logging level visibility [Feed, Recommendations]
testLocation	String?	Field	Test location for Geo simulation (country code, e.g., "us"). Causes all requests [Feed, Recommendations] to include the "location" param
isCrashMonitoringEnabled	Boolean	Field	Controls whether crash monitoring is enabled for the Teads SDK [Media, Media Native]. When enabled, the SDK will collect and report crash information. True by default
configure(applicationContext: Context, appKey: String)	Unit	Method	Initialize the Teads SDK [Feed, Recommendations]. Call this in Application.onCreate to increase launch speed and load ads faster.
isSDKConfigured(): Boolean	Boolean	Method	Checks whether the SDK was already initialized.
setIronSourceIntegration()	Unit	Method	Sets IronSource integration for publisher apps running on Aura platform. Must be called BEFORE configure().
createPlacement<PlacementType>(context: Context, config: Any, delegate: TeadsAdPlacementEventsDelegate?)	PlacementType	Method	Generic method to create ad placements ((Feed, Media, MediaNative, Recommendations)) based on their config type.
createInReadPlacement(context: Context, pid: Int, placementSettings: AdPlacementSettings)	TeadsInReadAdPlacement	Method	Creates a legacy inRead placement - Teads flagship format that positions video ads within editorial content.
createNativePlacement(context: Context, pid: Int, placementSettings: AdPlacementSettings)	TeadsNativeAdPlacement	Method	Creates a legacy inFeed Native placement - ads placed between feed content that mimic page look & feel.
createPrebidPlacement(context: Context, placementSettings: AdPlacementSettings)	TeadsPrebidAdPlacement	Method	Creates a PrebidAdPlacement that wraps a legacy inRead placement with prebid capabilities.

TeadsAdPlacementMedia

Configuration	Type	Description
pid	Int	Publisher ID from your publisher manager
articleUrl	Uri?	URL of the article where the ad will be displayed. Provides context for brand safety purposes
enableValidationTool	Boolean	Enable the Validation Tool mode for testing and debugging ad placements

TeadsAdPlacementMediaNative

Configuration	Type	Description
pid	Int	Publisher ID from your publisher manager
articleUrl	Uri?	URL of the article where the ad will be displayed. Provides context for brand safety purposes
mediaScale	MediaScale?	Set how the MediaView fits on its container. Works for images only on inFeed native creatives. Options: CENTER_CROP (default), CENTER_INSIDE

TeadsAdPlacementFeed

Name	Type	Field/Method	Description
articleUrl	Uri	Field	URL of the article where the feed will be displayed
widgetId	String	Field	Widget identifier
installationKey	String	Field	Installation key for your app
widgetIndex	Int	Field	Index of the widget in the feed
userId	String?	Field	Optional user identifier for personalization
darkMode	Boolean	Field	Enable dark mode theme for the feed widget
testDisplay	Boolean	Field	Enable test display mode for debugging
extId	String?	Field	Optional external identifier
extSecondaryId	String?	Field	Optional secondary external identifier
obPubImpl	String?	Field	Optional publisher implementation identifier
handleExploreMore(activity: Activity, onExploreMoreDismissed: Runnable)	Unit	Static Method	This method allows apps developers to handle explore more functionality.

TeadsAdPlacementRecommendations

Name	Type	Field/Method	Description
articleUrl	Uri	Field	URL of the article for which recommendations will be fetched
widgetId	String	Field	Widget identifier
widgetIndex	Int	Field	Index of the widget (default: 0)
getUrl(rec: OBRecommendation): String?	String?	Static Method	Maps the given recommendation to the redirect URL for paid recommendations or original URL for organic ones. For organic recommendations, click registration is handled automatically.
getAdChoicesURL(): String	String	Static Method	Returns the URL to open in external browser when user taps on ad choices logo. Contains Advertiser ID param required for Ad Choices opt-out compliance.
setTestRTB(isTestRTB: Boolean)	Unit	Static Method	Activates/deactivates RTB recommendations simulation. When true, forces every response to include at least 1 RTB recommendation.
configureViewabilityPerListingFor(viewGroup: ViewGroup, rec: OBRecommendation)	Unit	Static Method	Configures viewability monitoring on a per-listing basis for regular widgets. SDK will monitor and report viewability events automatically.
configureViewabilityPerListingFor(outbrainRecContainer: OBFrameLayout, rec: OBRecommendation)	Unit	Static Method	Configures viewability monitoring on a per-listing basis for regular widgets using OBFrameLayout container.

TeadsMediationSettings

Name	Type	Field/Method	Description
enableDebug()	Unit	Method	Enable debug logging.
enableLocation()	Unit	Method	Enable location.
useLightEndScreen()	Unit	Method	Allow Teads SDK to display the end screen with light color.
userConsent(subjectGdpr: String, consent: String, tcfVersion: TCFVersion, cmpSdkId: Int)	Unit	Method	The GDPR consent and status, should match the IAB specifications.
setUsPrivacy(usPrivacy: String)	Unit	Method	The CCPA consent string, should match the IAB specifications.
setGppConsent(consent: String, sectionIds: String)	Unit	Method	The GPP consent and applicable section ids, should match the IAB specifications.
disableCrashMonitoring()	Unit	Method	Disable crash monitoring that collects crashes on Teads SDK by default.
hideBrowserUrl()	Unit	Method	Hide the website url in the internal browser only. The url is visible by default.
toolBarBackgroundColor(color: int)	Unit	Method	Set the given toolbar background color on the browser.
pageSlotUrl(url: String)	Unit	Method	Provide context for brand safety purposes.
enableValidationMode()	Unit	Method	Enable the Validation Tool mode.
addPlacementExtra(key: String, value: String)	Unit	Method	Add the given extra to your placement settings data.
addExtra(key: String, value: String)	Unit	Method	Add the given extra to your request settings data.
setMediationListenerKey(key: Int)	Unit	Method	Used to retrieve the TeadsAdapterListener.
setMediaScale(mediaScale: MediaScale)	Unit	Method	Set how the MediaView fits on its container. Works for images only on inFeed native creatives.

MediaScale Enum Values

Value	Description
CENTER_CROP	Scales the image uniformly (maintaining the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view
CENTER_INSIDE	Scales the image uniformly (maintaining the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view

Best Practices

Production Settings

• Remove enableValidationMode() before production
• Remove testing configurations in production builds
• Ensure proper privacy consent is configured
• Set appropriate url for brand safety
• Use production placement IDs and installation keys

Testing Settings

• Use enableValidationMode() for integration testing
• Use testing configurations for development and debugging
• Test with different privacy consent scenarios
• Verify settings work across all placement types
• Use test placement IDs and installation keys

Performance Optimization

• Initialize SDK early in application lifecycle
• Use appropriate placement lifecycle management
• Monitor memory usage and performance

Related Documentation

• Integration Guide - Complete integration steps
• Privacy Guide - Privacy and compliance information
• Validation Tool - Testing and validation
• Troubleshooting Guide - Common issues and solutions