Usercentrics

https://docs.usercentrics.com
Admin
Usercentrics is a Consent Management Platform (CMP) that helps publishers manage user consent for...
Tokens:686,175
Snippets:5,416
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Get Predefined UI (Kotlin)

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/usercentrics-ui/index.html#objects

Kotlin example for creating and loading the predefined UI. The load callback provides a userResponse for handling consent and dismissing the UI.

```kotlin
val usercentricsView = UsercentricsPredefinedUI(context, <UsercentricsUISettings>)
usercentricsView.load { userResponse ->
    // Handle consent response
    // Dismiss PredefinedUI
}
```

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

### Response for GET /widgets/{widgetUuid}

Source: https://docs.usercentrics.com/#/preference-manager-api

Example response from the GET /widgets/{widgetUuid} endpoint. Contains the widget configuration including uuid, doubleOptIn, hidden, translations for title/description/additionalNote, and topics with options. The response is truncated with '............' placeholders for brevity.

```json
{
  "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd", 
  "doubleOptIn": false,
  "hidden": false,
  "title": {
    "de": "Präferenzen für Marketingkommunikation",
    "en": "Marketing communication preferences"
  },
  "description": {
    "de": "Hier können Sie Ihre Präferenzen für unsere Marketingmitteilungen angeben",
    "en": "Here you can specify your preferences on our marketing communications"
  },
  "additionalNote": {
    "de": null,
    "en": null
  },
  "topics": [
    {
      "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
      "required": false,
      "selectType": "multi_checkbox",
      "order": 0,
      "title": {
        "de": "Newsletter-Themen",
        "en": "Newsletter Topics"
      },
      "description": {
        "de": "Welche Art von Newslettern möchten Sie von uns erhalten?",
        "en": "What kind of newsletters would you want to receive from us?"
      },
      "options": [
        {
          "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
          "order": 0,
          "default": false,
          "title": {
            "de": "Modetrends",
            "en": "Fashion trends"
          }
        },
        {
        ............
        }
      ]
    },
    {
      ............
    }
  ]
}
```

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

### Install SDK with npm

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/index.html

Install the @usercentrics/cmp-browser-sdk package using npm.

```bash
npm install @usercentrics/cmp-browser-sdk --save

```

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

### CocoaPods install command

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/getting_started/install/index.html#android

Run this command in the root directory of your project to install the pod.

```bash
pod install

```

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

### Use UC_SDK namespace to initialize and handle UI layers

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/index.html

Access SDK methods and constants via the UC_SDK namespace. Initialize with your settings ID, then use UC.init() to get initial UI values and retrieve categories and settings. The example shows how to handle different UI layers based on the initial variant.

```javascript
const UC = new UC_SDK.default('YOUR_USERCENTRICS_SETTINGS_ID');  
  
UC.init().then((initialUIValues) => {  
  // getCategories() returns all categories' and data processing services' information  
  const categories = UC.getCategories();  
  // getSettings() returns all Usercentrics settings you need for your custom solution  
  const settings = UC.getSettings();  
  
  if (initialUIValues.variant === UC_SDK.UI_VARIANT.DEFAULT) {  
    switch (initialUIValues.initialLayer) {  
      case UC_SDK.UI_LAYER.FIRST_LAYER:  
        // Show first layer (i.e. privacy banner)  
        return;  
      case UC_SDK.UI_LAYER.PRIVACY_BUTTON:  
        // Show privacy button  
        return;  
      case UC_SDK.UI_LAYER.NONE:  
      default:  
        // Show nothing  
        return;  
    }  
  }  
});

```

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

### Example console output for CMP_SHOWN event

Source: https://docs.usercentrics.com/#/optimizely-ab-test

Example console output when the CMP_SHOWN event is fired, showing the source, type, and variant values.

```text
TEST: source => FIRST_LAYER TEST: type => CMP_SHOWN TEST: Variant => variant1
```

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

### init

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/classes/default.html#acceptAllForTCF

Initializes the SDK.

```APIDOC
## init()

### Description
Initializes the SDK.
```

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

### getActiveLanguage example

Source: https://docs.usercentrics.com/#/cmp-v2-ui-api

Gets the active language selected by the user. Returns a language code like 'en'.

```javascript
UC_UI.getActiveLanguage(); // returns "en"
```

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

### General Methods

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/classes/default.html#enterFullscreenAmp

General methods for SDK initialization, settings retrieval, and user actions.

```APIDOC
## areAllConsentsAccepted

### Description
Return if the user accepted all consents.

### Method
Function

### Signature
`areAllConsentsAccepted(): boolean`

### Returns
boolean
```

```APIDOC
## changeLanguage

### Description
Change the language. All upcoming SDK calls will return information in this language (e.g. getSettings(), getCategories(), getTCFData(), ...). Pay attention that the language needs to be set up in your Usercentrics Admin Interface before!

### Method
Function

### Signature
`changeLanguage(language: string): Promise<void>`

### Parameters
- **language** (string) - Required - The language to switch to (ISO 639-1 code)

### Returns
Promise<void>
```

```APIDOC
## getAriaLabels

### Description
Retrieve aria labels.

### Method
Function

### Signature
`getAriaLabels(): LegacyAriaLabelsTranslations`

### Returns
LegacyAriaLabelsTranslations
```

```APIDOC
## getControllerId

### Description
Retrieve the controllerId, that's generated for the user.

### Method
Function

### Signature
`getControllerId(): string`

### Returns
string
```

```APIDOC
## getSettings

### Description
Retrieve all settings.

### Method
Function

### Signature
`getSettings(): Settings`

### Returns
Settings
```

```APIDOC
## getSettingsCore

### Description
Retrieve settings Core.

### Method
Function

### Signature
`getSettingsCore(): Core`

### Returns
Core
```

```APIDOC
## getSettingsData

### Description
Retrieve settings Data.

### Method
Function

### Signature
`getSettingsData(): Maybe<Data>`

### Returns
Maybe<Data>
```

```APIDOC
## getSettingsLabels

### Description
Retrieve settings Labels.

### Method
Function

### Signature
`getSettingsLabels(): Labels`

### Returns
Labels
```

```APIDOC
## getSettingsUI

### Description
Retrieve settings Data.

### Method
Function

### Signature
`getSettingsUI(): Maybe<UI>`

### Returns
Maybe<UI>
```

```APIDOC
## init

### Description
Initializes the Usercentrics framework. This method _must_ be called when loading your website. The return value defines which UI layer & variant you should initially show for your users.

### Method
Function

### Signature
`init(): Promise<InitialUIValues>`

### Returns
Promise<InitialUIValues>
```

```APIDOC
## saveUserActionPerformed

### Description
Set user action performed. Only needed if a user action is performed without the need for an explicit consent (e.g. CCPA first layer implementation).

### Method
Function

### Signature
`saveUserActionPerformed(): Promise<void>`

### Returns
Promise<void>
```

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

### GET /preferences/history - example response

Source: https://docs.usercentrics.com/#/preference-manager-api

Example JSON response from the history endpoint. Shows a history event with fields such as preferenceUuid, submittedAt, widgetUuid, topicUuid, language, topicTitleEn, topicTitleTranslated, answers, author, and changeType. The example illustrates a change made to the German translation, adding 'Wöchentlich' (Weekly) to the topic 'Frequenz' (Frequency).

```json
[
   {
    "preferenceUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "submittedAt": "2024-01-01T00:00:00.001Z",
    "widgetUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "language": "de",
    "topicTitleEn": "Frequency",
    "topicTitleTranslated": "Frequenz",
    "answers": [
      {
        "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "en": "Weekly",
        "translated": "Wöchentlich"
      }
    ],
    "author": "user@company.com",
    "changeType": "Added"
  },
  {
  ........
  }
]
```

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

### init(): Promise<void>

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/interfaces/TCFOptions.html#areAllVendorsAccepted

Initializes the CMP SDK.

```APIDOC
## init(): Promise<void>

### Description
Initializes the CMP SDK.

### Returns
Promise<void>
```

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

### Get Scan Configuration Response

Source: https://docs.usercentrics.com/#/partner-configure-cmp-via-api

Example response for the scanConfiguration query. Shows httpRequestInjections as null for domains without query parameter injection.

```json
{
  "data": {
    "scanConfiguration": {
      "configurationId": "scan-cfg-xyz",
      "domainScanConfigurations": [
        {
          "domainUrl": "https://mywebsite.com",
          "domainScanConfigurationIdentifier": "dom-cfg-abc",
          "httpRequestInjections": {
            "queryParameters": [{ "key": "utm_source", "value": "test" }],
            "scope": "AllPages"
          }
        },
        {
          "domainUrl": "https://mywebsite.com/blog",
          "domainScanConfigurationIdentifier": "dom-cfg-def",
          "httpRequestInjections": null
        }
      ]
    }
  }
}
```

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

### Usercentrics.isReady (Kotlin)

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#interaction-analytics_1

Kotlin example for checking SDK readiness and retrieving CMP and TCF data.

```APIDOC
## Usercentrics.isReady

### Description
Checks if the Usercentrics SDK is ready and provides access to CMP and TCF data.

### Method
isReady

### Parameters
- **onSuccess** (lambda) - Required - Called when the SDK is ready.
- **onFailure** (lambda) - Required - Called with an error if the SDK fails to initialize.

### Request Example
```kotlin
Usercentrics.isReady({

    // CMP Data
    val data = Usercentrics.instance.getCMPData()
    val settings = data.settings
    val tcfSettings = settings.tcf2

    // TCF Data
    Usercentrics.instance.getTCFData() { tcfData ->
        val purposes = tcfData.purposes
        val specialPurposes = tcfData.specialPurposes
        val features = tcfData.features
        val specialFeatures = tcfData.specialFeatures
        val stacks = tcfData.stacks
        val vendors = tcfData.vendors

        // TCString
        val tcString = tcfData.tcString
    }

}, { error ->
    // Handle non-localized error
})
```

### Response
#### Success Response
- **status** (object) - The readiness status.

#### Error Response
- **error** (object) - The error object.

```

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

### Get preferences response for /preferences/my

Source: https://docs.usercentrics.com/#/preference-manager-api

Example and response for the GET /preferences/my endpoint. The response contains a set of preference objects with fields like uuid, widgetId, pending, answers, and timestamps. The 'pending' flag is true when the DoubleOptIn feature is active and preferences are not yet confirmed.

```json
[
  {
    "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "widgetId": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "pending": false,
       "answers": [
      {
        "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "topicAnswerUuids": [
          "1234abcd-22bb-33cc-44dd-12345678abcd",
          "1234abcd-22bb-33cc-44dd-12345678abcd"
        ]
      },
      {
        ..............
      }
    ],
    "createdAt": "2024-01-01T00:00:00",
    "updatedAt": "2024-01-01T00:00:00",
    "expiresAt": "2024-01-01T00:00:00"
  }
]
```

```json
[
  {
    "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "widgetId": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "pending": false,
       "answers": [
      {
        "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "topicAnswerUuids": [
          "1234abcd-22bb-33cc-44dd-12345678abcd",
          "1234abcd-22bb-33cc-44dd-12345678abcd"
        ]
      },
      {
        ..............
      }
    ],
    "createdAt": "2024-01-01T00:00:00",
    "updatedAt": "2024-01-01T00:00:00",
    "expiresAt": "2024-01-01T00:00:00"
  }
]
```

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

### Response for Creating Settings

Source: https://docs.usercentrics.com/#/partner-api

Example response from the setting mutation, returning the settingsId and language.

```json
{
  "data": {
    "setting": {
      "settingsId": "HkvOYLyME"
      "language": "en"
    }
  }
}
```

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

### Get Predefined UI (Swift)

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/usercentrics-ui/index.html#objects

Swift example for presenting the predefined UI. The completion handler receives a UsercentricsConsentUserResponse, where you handle the consent response and dismiss the UI.

```swift
UsercentricsUserInterface.getPredefinedUI(settings: <UsercentricsUISettings>) { <UsercentricsConsentUserResponse> in
    // Handle consent response
    // Dismiss PredefinedUI
}
```

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

### init

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/classes/default.html#saveTCFDataAmp

Initializes the CMP.

```APIDOC
## [SDK] init(): Promise<void>

### Description
Initializes the CMP.

### Method
init

### Returns
Promise<void>
```

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

### Apply consent with predefined UI (Banner API v1) - Swift/iOS

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/apply_consent/apply-consent/index.html#apply-consent-to-each-service

Deprecated Banner API v1 example. Shows how to apply consent and dismiss the CMP after the user responds. Removed starting v2.3.0.

```swift
var usercentricsUI: UIViewController?
usercentricsUI = UsercentricsUserInterface.getPredefinedUI { userResponse in
    // Apply Consent
    self.applyConsent(with: userResponse.consents)

    // Dismiss CMP
    usercentricsUI.dismiss(animated: true, completion: nil)
}

// Present CMP
self.present(usercentricsUI, animated: true, completion: nil)
```

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

### init

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/classes/default.html#constructor

Initializes the CMP SDK.

```APIDOC
## init

### Description
Initializes the CMP SDK.

### Method
init
```

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

### Usercentrics.isReady (Kotlin, Non-IAB)

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#interaction-analytics_1

Kotlin example for checking SDK readiness and retrieving CMP data for non-IAB sources.

```APIDOC
## Usercentrics.isReady (Non-IAB)

### Description
Checks if the Usercentrics SDK is ready and provides access to CMP data for non-IAB sources.

### Method
isReady

### Parameters
- **onSuccess** (lambda) - Required - Called when the SDK is ready.
- **onFailure** (lambda) - Required - Called with an error if the SDK fails to initialize.

### Request Example
```kotlin
Usercentrics.isReady({

    val data = Usercentrics.instance.getCMPData()
    val settings = data.settings
    val services = data.services
    val categories = data.categories

}, { error ->
    // Handle non-localized error
})
```

### Response
#### Success Response
- **status** (object) - The readiness status.

#### Error Response
- **error** (object) - The error object.

```

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

### getConsents

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/usercentrics-core#usercentricsserviceconsent

Returns the list of services with consent choices.

### Method
GET (SDK method)

### Endpoint
N/A - SDK method

### Parameters
None

### Request Example
```swift
// Swift
getConsents()
```

### Response
#### Success Response
- **consents** ([UsercentricsServiceConsent]) - List of Services with consent choices.

### Response Example
```swift
let consents = UsercentricsCore.shared.getConsents()
```

```APIDOC
## getConsents

### Description
Returns the list of services with consent choices.

### Method
GET (SDK method)

### Endpoint
N/A - SDK method

### Parameters
None

### Request Example
```swift
// Swift
getConsents()
```

### Response
#### Success Response
- **consents** ([UsercentricsServiceConsent]) - List of Services with consent choices.

### Response Example
```swift
let consents = UsercentricsCore.shared.getConsents()
```
```

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

### GET /preferences response JSON

Source: https://docs.usercentrics.com/#/preference-manager-api

Example response from the /preferences endpoint. Contains a single preference object with widget details, answers, and timestamps. The response includes translated topic and answer names based on the requested language.

```json
[
  {
    "widgetName": "Kommunikationspräferenzen",
    "widgetUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "answers": [
      {
        "topicName": "Newsletter-Themen",
        "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "topicAnswerUuids": [
          {
            "answerUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
            "answerName": "Neuigkeiten von Marken"
          },
          {
            "answerUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
            "answerName": "Verkäufe und Angebote"
          }
        ]
      },
      {
        "topicName": "Häufigkeit",
        "topicUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
        "topicAnswerUuids": [
          {
            "answerUuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
            "answerName": "Monatlich"
          }
        ]
      }
    ],
    "uuid": "1234abcd-22bb-33cc-44dd-12345678abcd",
    "pending": false,
    "createdAt": "2024-01-01T00:00:00",
    "updatedAt": "2024-01-01T00:00:00",
    "expiresAt": "2025-01-01T00:00:00"
  }
]
```

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

### init

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/interfaces/TCFOptions.html#getTCString

Initializes the TCF options.

```APIDOC
## init(): Promise<void>

### Description
Initializes the TCF options.

### Parameters
None.

### Returns
- Promise<void>
```

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

### Cross-domain consent sharing setup

Source: https://docs.usercentrics.com/#/browser-ui

Complete example showing how to set the cross-domain consent sharing iframe location before loading the Usercentrics CMP script. Place this script on all domains, including the main domain, and ensure the cross-domain-bridge.html file is reachable at the specified URL.

```html
<html>
<head>
<script>
    window.UC_UI_DOMAINS = {
        crossDomainConsentSharingIFrame: 'https://mywebshop.com/cross-domain-bridge.html',
    };
</script>
<script id="usercentrics-cmp" data-settings-id="XXXXXXXX" src="https://app.usercentrics.eu/browser-ui/latest/loader.js" async></script>
</head>
<body>
</body>
</html>
```

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

### loadSettings()

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/classes/default.html#acceptAllServices

Loads legacy settings.

```APIDOC
## loadSettings()

### Description
Loads legacy settings.

### Method
loadSettings()

### Returns
Promise<LegacySettings>
```

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

### Performance preconnect and preload for SDP

Source: https://docs.usercentrics.com/#/smart-data-protector

Add these statements at the top of your <head> section to improve performance.

```html
<link rel="preconnect" href="//privacy-proxy.usercentrics.eu">
<link rel="preload" href="//privacy-proxy.usercentrics.eu/latest/uc-block.bundle.js" as="script">
```

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

### getConsents - Get user consent settings

Source: https://docs.usercentrics.com/#/frontend-javascript-api

Calls usercentrics.getConsents() to get the Privacy Settings of the user for one or all Services. The parameter is a String Service Template Id (e.g., "BJ59EidsWQ") and is optional. Returns an array of objects containing the status of consent (true/false). The example shows two calls: one without arguments to receive all Privacy Settings, and one with a Service Template Id to receive only the setting for Google Tag Manager.

```javascript
//receive all Privacy Settings (Service Templates)
usercentrics.getConsents();

//receive only the Privacy Setting for Google Tag Manager
usercentrics.getConsents("BJ59EidsWQ");
```

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

### Create BannerSettings with style settings (C#)

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/unity/customization/index.html#second-layer-style-settings

Creates a BannerSettings instance with GeneralStyleSettings, FirstLayerStyleSettings, and SecondLayerStyleSettings. Use this to customize banner elements programmatically.

```csharp
var bannerSettings = BannerSettings(generalStyleSettings: new GeneralStyleSettings(),
                                    firstLayerStyleSettings: new FirstLayerStyleSettings(),
                                    secondLayerStyleSettings: new SecondLayerStyleSettings());

```

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

### Dart/Flutter: Get IAB TCF 2.0 Data

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#action-delegates_2

Dart/Flutter example for retrieving IAB TCF 2.0 data. Uses Usercentrics.cmpData and Usercentrics.tcfData. Provides CMP data (settings, tcf2) and TCF data (purposes, specialPurposes, features, specialFeatures, stacks, vendors, tcString). Handles non-localized errors via catch block.

```dart
try {
  final data = await Usercentrics.cmpData;
  final settings = data.settings;
  final tcfSettings = settings.tcf2;

  // TCF Data
  final tcfData = await Usercentrics.tcfData;
  final tcString = tcfData.tcString;
  final purposes = tcfData.purposes;
  final specialPurposes = tcfData.specialPurposes;
  final features = tcfData.features;
  final specialFeatures = tcfData.specialFeatures;
  final stacks = tcfData.stacks;
  final vendors = tcfData.vendors;

  // TODO - Add TCString property

} catch (error) {
    // Handle non-localized error
}

```

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

### Kotlin: Get IAB TCF 2.0 Data

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#action-delegates_2

Kotlin example for retrieving IAB TCF 2.0 data. Requires Usercentrics to be ready. Provides CMP data (settings, tcf2) and TCF data (purposes, specialPurposes, features, specialFeatures, stacks, vendors, tcString). Handles non-localized errors via error callback.

```kotlin
Usercentrics.isReady({

    // CMP Data
    val data = Usercentrics.instance.getCMPData()
    val settings = data.settings
    val tcfSettings = settings.tcf2

    // TCF Data
    Usercentrics.instance.getTCFData() { tcfData ->
        val purposes = tcfData.purposes
        val specialPurposes = tcfData.specialPurposes
        val features = tcfData.features
        val specialFeatures = tcfData.specialFeatures
        val stacks = tcfData.stacks
        val vendors = tcfData.vendors

        // TCString
        val tcString = tcfData.tcString
    }

}, { error ->
    // Handle non-localized error
})

```

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

### Usercentrics.Instance.Initialize

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/unity/apis/index.html#event

Configures and initializes the Usercentrics SDK after app launch. Accepts success and error callbacks.

```APIDOC
## Usercentrics.Instance.Initialize

### Description
Called to configure and initialize Usercentrics after app launch.

### Method
Initialize

### Parameters
- **onSuccess** (Action<UsercentricsReadyStatus>) - Required - Callback invoked on successful initialization, receiving a UsercentricsReadyStatus object.
- **onError** (Action<string>) - Required - Callback invoked on failure, receiving a non-localized error message.

### Request Example
```csharp
Usercentrics.Instance.Initialize(
    (usercentricsReadyStatus) =>
    {
        // Success: Returns UsercentricsReadyStatus object
    },
    (errorMessage) =>
    {
        // Failure: Returns non-localized error
    }
);
```

### Response
#### Success Response
- **usercentricsReadyStatus** (UsercentricsReadyStatus) - The status of the initialization.

#### Error Response
- **errorMessage** (string) - A non-localized error message.
```

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

### Swift: Get IAB TCF 2.0 Data

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#action-delegates_2

Swift example for retrieving IAB TCF 2.0 data. Requires UsercentricsCore to be ready. Provides CMP data (settings, tcf2) and TCF data (purposes, specialPurposes, features, specialFeatures, stacks, vendors, tcString). Handles non-localized errors via onFailure closure.

```swift
UsercentricsCore.isReady { status in

    // CMP Data
    let data = UsercentricsCore.shared.getCMPData()
    let settings = data.settings
    let tcfSettings = settings.tcf2

    // TCF Data
    UsercentricsCore.shared.getTCFData() { tcfData in
        let purposes = tcfData.purposes
        let specialPurposes = tcfData.specialPurposes
        let features = tcfData.features
        let specialFeatures = tcfData.specialFeatures
        let stacks = tcfData.stacks
        let vendors = tcfData.vendors

        // TCString
        let tcString = tcfData.tcString
    }

} onFailure: { error in
    // Handle non-localized error
}

```

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

### init

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/interfaces/TCFOptions.html#consensuSubdomain

Initializes the TCF implementation.

```APIDOC
## init(): Promise<void>

### Description
Initializes the TCF consent management.

### Returns
Promise<void>
```

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

### TypeScript/React Native: Get IAB TCF 2.0 Data

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/collect_consent/build_own_ui/index.html#action-delegates_2

TypeScript/React Native example for retrieving IAB TCF 2.0 data. Uses Usercentrics.getCMPData() and Usercentrics.getTCFData(). Provides CMP data (settings, tcf2) and TCF data (purposes, specialPurposes, features, specialFeatures, stacks, vendors, tcString). Handles non-localized errors via catch block.

```typescript
try {
  const data = await Usercentrics.getCMPData();
  const settings = data.settings;
  const tcfSettings = settings.tcf2;

  // TCF Data
  const tcfData = await Usercentrics.getTCFData();
  const purposes = tcfData.purposes;
  const specialPurposes = tcfData.specialPurposes;
  const features = tcfData.features;
  const specialFeatures = tcfData.specialFeatures;
  const stacks = tcfData.stacks;
  const vendors = tcfData.vendors;

  // TCString
  const tcString = tcfData.tcString;

} catch (error) {
    // Handle non-localized error
}

```

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

### Console log output for ACCEPT_ALL event

Source: https://docs.usercentrics.com/#/kameleoon-ab-test

Example console output when the ACCEPT_ALL event is fired. Shows the source, type, and variant values logged by the event listener.

```text
TEST: source => FIRST_LAYER
TEST: type => ACCEPT_ALL
TEST: Variant => variant1
```

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

### Install Usercentrics via CocoaPods

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/getting_started/install/index.html#react-native

Add the UsercentricsUI or Usercentrics pod to your Podfile, then run pod install to install the dependency.

```ruby
platform :ios, '11.0'
use_frameworks!  

pod 'UsercentricsUI', '2.11.3'

```

```ruby
platform :ios, '11.0'
use_frameworks!  

pod 'Usercentrics', '2.11.3'

```

```bash
pod install

```

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

### isReady

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/api/usercentrics-core/index.html#changelanguage

Checks if the SDK is ready and provides a status to determine the next action (show CMP banner or apply consent).

```APIDOC
## UsercentricsCore.isReady

### Description
Checks if the SDK is ready and provides a status to determine the next action (show CMP banner or apply consent).

### Method
isReady

### Parameters
- **status** (UsercentricsReadyStatus) - Required - Provides information needed to know what action to take next.
- **error** (Error) - Required - Error object with non-localized description.

### Code Example (Swift)
```swift
UsercentricsCore.isReady { <UsercentricsReadyStatus> in
    // Handle status
} onFailure: { <Error> in
    // Handle error
}
```

### Code Example (Kotlin)
```kotlin
Usercentrics.isReady({
    // Handle status
}, {
    // Handle error
})
```
```

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

### Install UsercentricsUI via CocoaPods

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/tv/install/index.html#installing-the-tv-sdk

Add the UsercentricsUI pod to your Podfile for tvOS 11.0 or higher, then run pod install from the project root to install the dependency.

```ruby
platform :tvos, '11.0'
use_frameworks!  

pod 'UsercentricsUI', '2.11.3'

```

```bash
pod install

```

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

### Get services full info with UC.getServicesFullInfo

Source: https://docs.usercentrics.com/cmp_browser_sdk/3.10.0/index.html

Use UC.getServicesFullInfo() after UC.init() to retrieve all services with their complete information, fetching the aggregator if necessary. Returns a Promise<Service[]>.

```javascript
UC.init().then((initialUIValues) => {  
            // getServicesFullInfo() returns all services with their complete information  
            const servicesFull = UC.getServicesFullInfo()  
            servicesFull.then(info => {  
                console.log("FULL INFO", info)  
            });  
... });
```

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

### Initialize

Source: https://docs.usercentrics.com/cmp_in_app_sdk/latest/unity/apis/index.html#consent-listener

Initializes the Usercentrics SDK with success and error callbacks.

```APIDOC
## Initialize

### Description
Called to configure and initialize Usercentrics after app launch.

### Method
Initialize

### Parameters
- **callback** (Action<UsercentricsReadyStatus>) - Required - Success callback returning UsercentricsReadyStatus object.
- **errorCallback** (Action<string>) - Required - Failure callback returning non-localized error message.

### Request Example
```csharp
Usercentrics.Instance.Initialize(
    (usercentricsReadyStatus) =>
    {
        // Success: Returns UsercentricsReadyStatus object
    },
    (errorMessage) =>
    {
        // Failure: Returns non-localized error
    }
);
```
```

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

### Show First Layer with UC_UI.showFirstLayer

Source: https://docs.usercentrics.com/#/cmp-v2-ui-api

Programmatically shows the First Layer. No parameters are required and nothing is returned.

```javascript
UC_UI.showFirstLayer();
```
Tokens:
Raw