com.pubmatic.sdk.common.utility

Class POBAdvertisingIdClient

java.lang.Object

com.pubmatic.sdk.common.utility.POBAdvertisingIdClient

public class POBAdvertisingIdClient
extends java.lang.Object

AdvertisingIdClient class is used to manage Advertising info from google ads

Method Summary

Modifier and Type	Method and Description
static POBAdvertisingIdClient	getInstance(android.content.Context context) Returns the single instance of the POBAdvertisingIdClient, create if not already created.
java.lang.String	getStoredAdvertisingId() Returns the Android advertisement id if saved in local storage else returns given androidAid.
boolean	getStoredLMTState() Returns the Android advertisement id if saved in local storage else returns given state.
protected boolean	isReadyToUpdate()
protected void	saveAndroidAid(java.lang.String androidAid) Save the Android advertisement id in local storage for further use.
protected void	saveLMTState(boolean state) Save the Android advertisement id in local storage for further use.
boolean	updateAAID() This API update the Android Advertising ID info & LMT state in background and saves in shared preference for next immediate Ad request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static POBAdvertisingIdClient getInstance(@NonNull
                                                 android.content.Context context)

Returns the single instance of the POBAdvertisingIdClient, create if not already created.

Parameters:

context - Valid application context

Returns:

Single instance of the POBAdvertisingIdClient

updateAAID

public boolean updateAAID()

This API update the Android Advertising ID info & LMT state in background and saves in shared preference for next immediate Ad request. This call is asynchronous. Please ensure the manifest has mentioned below permission (For Apps target API level set to 33): com.google.android.gms.permission.AD_ID

Returns:

Returns true if the request for update is success and return false if any pending request is in progress.

isReadyToUpdate

protected boolean isReadyToUpdate()

Returns:

Returns true if POBAdvertisingIdClient is ready to accept request to update the AAID. Returns false if any pending request is in progress.

saveAndroidAid

protected void saveAndroidAid(@NonNull
                              java.lang.String androidAid)

Save the Android advertisement id in local storage for further use.

saveLMTState

protected void saveLMTState(boolean state)

Save the Android advertisement id in local storage for further use.

getStoredAdvertisingId

@Nullable
public java.lang.String getStoredAdvertisingId()

Returns the Android advertisement id if saved in local storage else returns given androidAid.

getStoredLMTState

public boolean getStoredLMTState()

Returns the Android advertisement id if saved in local storage else returns given state.