Configuration JSON

Parameters listed below can be used to set AATKit configuration.

string alternativeBundleID - The fake bundle ID for testing purposes.

bool shouldReportMetricsUsingAlternativeBundleID - If used together with alternativeBundleID allows to set if the same fake bundle ID should be used in reporting.

string initialRules - Allows setting of ad rules that will be used before real rules from the server are downloaded.

bool shouldCacheRules - Allows the AATKit to preserve last downloaded ad rules when the application is closed.

bool shouldSkipRules - Allows to enable skipping of networks without TCF2 consent (as long as TCF2-compatibile CMP is used). This feature is disabled by default.

number testModeAccountID - Enables AATKit test ads that should be for testing - only during development.

boolean consentRequired - Specifies whether or not the user's consent is required to display personalized ads.

boolean useGeoLocation - Specify whether or not to allow AddApptr, and ad networks used in its SDK, the tracking of geo data.

number platform - (Android Only) Specifies the platform. Android by default. Takes values listed below:

  • RNAatkit.Platform_Android

  • RNAatkit.Platform_Huawei

JSON consent - Specifies the detailed consent for GDPR. This JSON object can contain these parameters:

  • number type - Specifies the detailed GDPR consent type. Takes values listed below:

    • RNAatkit.ConsentType_SimpleConsent

    • RNAatkit.ConsentType_ManagedCMPGoogle

    • RNAatkit.ConsentType_ManagedCMPOgury

    • RNAatkit.ConsentType_Vendor

  • number nonIABConsent - If the type is set as RNAatkit.ConsentType_SimpleConsent, specifies the status of GDPR consent for non-IAB partners. Takes values listed below:

    • RNAatkit.SimpleConsent_Obtained - Consent has been granted by the user.

    • RNAatkit.SimpleConsent_Withheld - Consent has been declined by the user.

  • string assetKeyCMPOgury - If the type is set as RNAatkit.ConsentType_ManagedCMPOgury, specifies the application asset key.

  • array vendorConsentObtainedNetworks - If the type is set as RNAatkit.ConsentType_Vendor, defines which networks should have consent set as obtained. AATKit will set consent as withheld for another networks.

  • array noConsentNetworkStopSet - Allows to set the networks that will not be requested if they do not have the TCF2 consent. If this parameter is not set, AATKit will use its default list. It works only if rule skipping feature is enabled using shouldSkipRules parameter.

  • boolean consentForAddapptr - If the type is set as RNAatkit.ConsentType_Vendor, defines if consent is given for AddApptr.

  • number showIfNeededSetting - determines how the showConsentDialogIfNeeded function should behave. ShowIfNeededSetting_ServerSideControl by default. Takes values listed below:

    • ShowIfNeededSetting_Always

    • ShowIfNeededSetting_Never

    • ShowIfNeededSetting_ServerSideControl

Example of the consent JSON:

{
    ...
    consent: {
        type: RNAatkit.ConsentType_SimpleConsent,
        nonIABConsent: RNAatkit.SimpleConsent_Obtained
    }
}

Last updated