public final class InMobiSdk
extends java.lang.Object
As part of the General Data Protection Regulation ("GDPR") publishers who collect data on their apps, are required to have a legal basis for collecting and processing the personal data of users in the European Economic Area ("EEA"). Please ensure that you obtain appropriate consent from the user before making ad requests to InMobi for Europe and indicate the same by following our recommended SDK implementation. Please do not pass any demographics information of a user; if you do not have user consent from such user in Europe.
Modifier and Type | Class and Description |
---|---|
static class |
InMobiSdk.AgeGroup |
static class |
InMobiSdk.Education |
static class |
InMobiSdk.Gender |
static class |
InMobiSdk.LogLevel |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
IM_GDPR_CONSENT_AVAILABLE
Populate this key to consentObject with boolean value.
|
static java.lang.String |
IM_GDPR_CONSENT_GDPR_APPLIES
Key to populate GDPR applies values according to IAB norms.
|
static java.lang.String |
IM_GDPR_CONSENT_IAB
Key to populate consent with respect to IAB norms.
|
Constructor and Description |
---|
InMobiSdk() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
getToken()
Get a token for Advanced Bidding
|
static java.lang.String |
getToken(java.util.Map<java.lang.String,java.lang.String> extras,
java.lang.String keywords)
Get a token for Advanced Bidding
|
static java.lang.String |
getVersion()
Use this to get the version of the SDK.
|
static java.lang.String |
init(android.content.Context context,
java.lang.String accountId)
Deprecated.
|
static java.lang.String |
init(android.content.Context context,
java.lang.String accountId,
org.json.JSONObject consentObject)
Deprecated.
|
static void |
init(android.content.Context context,
java.lang.String accountId,
org.json.JSONObject consentObject,
SdkInitializationListener sdkInitializationListener)
Initialize the sdk.
|
static void |
setAge(int age)
Set the user's age for targeting purposes.
|
static void |
setAgeGroup(InMobiSdk.AgeGroup group)
Set the user's age group for targeting purposes.
|
static void |
setApplicationMuted(boolean muted)
Inform SDK if any media which is rendered by SDK should be played muted.
|
static void |
setAreaCode(java.lang.String areaCode)
Set the area code for targeting purposes.
|
static void |
setEducation(InMobiSdk.Education education)
Set the educational qualifications of the user for targeting purposes.
|
static void |
setGender(InMobiSdk.Gender gender)
Set the user's gender for targeting purposes.
|
static void |
setInterests(java.lang.String interests)
Set the user's interest areas for targeting purposes.
|
static void |
setLanguage(java.lang.String language)
Set the language for targeting purposes.
|
static void |
setLocation(android.location.Location location)
Set the user's location for targeting purposes.
|
static void |
setLocationWithCityStateCountry(java.lang.String city,
java.lang.String state,
java.lang.String country)
Set specific location parameters for targeting purposes.
|
static void |
setLogLevel(InMobiSdk.LogLevel logLevel)
Control the verbosity of the logs printed by the Ads SDK.
|
static void |
setPostalCode(java.lang.String postalCode)
Set the postal code for targeting purposes.
|
static void |
setPublisherProvidedUnifiedId(org.json.JSONObject jsonObject)
Set Unified ID procured from vendors directly.
|
static void |
setYearOfBirth(int yearOfBirth)
Set the user's year of birth for targeting purposes.
|
static void |
updateGDPRConsent(org.json.JSONObject consentObject)
Update user's GDPR consent.
|
public static final java.lang.String IM_GDPR_CONSENT_AVAILABLE
public static final java.lang.String IM_GDPR_CONSENT_IAB
public static final java.lang.String IM_GDPR_CONSENT_GDPR_APPLIES
@Deprecated public static java.lang.String init(android.content.Context context, java.lang.String accountId)
init(Context, String, JSONObject, SdkInitializationListener)
instead.
Initialize the sdk. This must be called before any other API for the SDK is used.
context
- Represents the application contextaccountId
- Represents the accountId of the publisherInitializationStatus#SUCCESS
if successful,
otherwise either of InitializationStatus#INVALID_ACCOUNT_ID
or
InitializationStatus#UNKNOWN_ERROR
@Deprecated public static java.lang.String init(android.content.Context context, java.lang.String accountId, org.json.JSONObject consentObject)
init(Context, String, JSONObject, SdkInitializationListener)
instead.
Initialize the sdk. This must be called before any other API for the SDK is used.
context
- Represents the application contextaccountId
- Represents the accountId of the publisherconsentObject
- InMobi relies on the publishers to obtain explicit consent from users for continuing business activities in EU as per GDPR.
Consent object allows publishers to indicate consent status as obtained from the users for InMobi services to function appropriately.InitializationStatus#SUCCESS
if successful,
otherwise either of InitializationStatus#INVALID_ACCOUNT_ID
or
InitializationStatus#UNKNOWN_ERROR
public static void init(android.content.Context context, java.lang.String accountId, org.json.JSONObject consentObject, SdkInitializationListener sdkInitializationListener)
context
- Represents the application contextaccountId
- Represents the accountId of the publisherconsentObject
- InMobi relies on the publishers to obtain explicit consent from users for continuing business activities in EU as per GDPR.
Consent object allows publishers to indicate consent status as obtained from the users for InMobi services to function appropriately.sdkInitializationListener
- Represents a listener object to provide callback when SDK initialization process is completepublic static void updateGDPRConsent(org.json.JSONObject consentObject)
consentObject
- public static void setApplicationMuted(boolean muted)
muted
- public static java.lang.String getVersion()
public static void setLogLevel(InMobiSdk.LogLevel logLevel)
logLevel
- choose from InMobiSdk.LogLevel.DEBUG
, or InMobiSdk.LogLevel.NONE
public static void setAge(int age)
age
- public static void setAgeGroup(InMobiSdk.AgeGroup group)
group
- public static void setAreaCode(java.lang.String areaCode)
areaCode
- public static void setPostalCode(java.lang.String postalCode)
postalCode
- public static void setLocationWithCityStateCountry(java.lang.String city, java.lang.String state, java.lang.String country)
city
- state
- country
- public static void setYearOfBirth(int yearOfBirth)
yearOfBirth
- public static void setGender(InMobiSdk.Gender gender)
gender
- public static void setEducation(InMobiSdk.Education education)
education
- public static void setLanguage(java.lang.String language)
language
- public static void setInterests(java.lang.String interests)
interests
- public static void setLocation(android.location.Location location)
location
- public static java.lang.String getToken()
public static java.lang.String getToken(java.util.Map<java.lang.String,java.lang.String> extras, java.lang.String keywords)
extras
- Represents the extraskeywords
- Represents the keywordspublic static void setPublisherProvidedUnifiedId(org.json.JSONObject jsonObject)
jsonObject
- Represents the unified id json blob.