Proxy
OneTrust SDK Public Methods for setting up Proxy configuration for OneTrust network calls
Existing
Setting up delegate for the Proxy configuration
Set this delegate in order to customize configurations with regards to OT SDK business logic like setting up Proxy configuration for OneTrust network calls.
OTPublishersHeadlessSDK.shared.customConfigurator
Implementing and providing custom URL for replacing specific OneTrust network call
Conform to this method to provide proxy domain URL for a supported proxy type.
When conformed to this method, we will be hitting the proxy domain provided when required, instead of the actual URL configured within OneTrust.
Parameters:
- type: The type of Proxy URLs support by OT SDK.
CustomConfigurator.getProxyDomain(for:) -> URL?
Return:
- A proxy domain for the proxy type.
Proxy Type for Consent Logging network call
Proxy for the URL used for logging consent.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.logConsent(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.logConsent(URL)
Proxy Type for downloading banner logo network call
Proxy for the URL used for downloading banner logo.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.bannerLogo(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.bannerLogo(URL)
Proxy Type for downloading preference center logo network call
Proxy for the URL used for downloading preference center logo.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.pcLogo(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.pcLogo(URL)
Proxy Type for downloading App Tracking Transparency Pre Prompt logo network call
Proxy for the URL used for downloading ATT pre prompt logo.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.attPrePromptLogo(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.attPrePromptLogo(URL)
Proxy Type for downloading App Tracking Transparency Post Prompt logo network call
Proxy for the URL used for downloading ATT post prompt logo.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.attPostPromptLogo(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.attPostPromptLogo(URL)
Proxy Type for downloading Age Gate Prompt logo network call
Proxy for the URL used for downloading Age Gate Prompt logo.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.ageGateLogo(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.ageGateLogo(URL)
New (starting 202504.1.0)
Proxy Type for downloading Banner data via CMP API
Proxy for the URL used for downloading Banner data via CMP API.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.cmpBanner(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.cmpBanner(URL)
Proxy Type for downloading Preferences data via CMP API
Proxy for the URL used for downloading Banner data via CMP API.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.cmpPreferences(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.cmpPreferences(URL)
Proxy Type for downloading Vendors data via CMP API
Proxy for the URL used for downloading Preference Center data via CMP API
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.cmpVendors(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.cmpVendors(URL)
Proxy Type for downloading Vendors data via Cmp Api
Proxy for the URL used for downloading Vendors data via CMP API.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.cmpVendors(URL)
will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.cmpVendors(URL)
Proxy Type for downloading Universal Center Purposes data via CMP API
Proxy for the URL used for downloading Vendors data via CMP API.
Implementing CustomConfigurator.getProxyDomain(for:)
and providing a custom URL for ProxyType.cmpUCPurposes(URL
) will make sure OneTrust uses the passed in URL instead of the url that is configured within the SDK.
ProxyType.cmpUCPurposes(URL)
Reading consent associated with Age Gate permission prompt.
Returns the value stored in OT SDK that is associated with the passed in key.
Parameter
key
: The key for which the value has to be returned.
OTPublishersHeadlessSDK.shared.getAgeGatePromptValue() -> Int
Deprecated (starting 202504.1.0)
Proxy for the URL used for downloading OneTrust SDK data via App Worker
ProxyType.sdkDataDownload(URL)
Deprecation Message: The applications can use the new Cmp Api Proxy Types for fetching respective OneTrust Screens related data (banner/preference center/vendor).
Proxy for the URL used for downloading IAB Vendors data
ProxyType.iabVendors(URL)
Deprecation Message:The applications can use the new Cmp Api Vendors Proxy type for fetching all the vendor information.
Proxy for the URL used for downloading Google Vendors data
ProxyType.googleVendors(URL)
Deprecation Message: The applications can use the new Cmp Api Vendors Proxy type for fetching all the vendor information.
Proxy for the URL used for downloading General Vendors data
ProxyType.generalVendors(URL)
Deprecation Message: The applications can use the new Cmp Api Vendors Proxy type for fetching all the vendor information.
Updated 3 days ago