DeletionRequest


public class DeletionRequest
extends Object

java.lang.Object
   ↳ android.adservices.measurement.DeletionRequest


This class was deprecated in API level 37.
The Rubidium (Rb) Measurement APIs, including those in android.adservices.measurement, are being deprecated. There are no direct replacement APIs for the Measurement APIs. Developers currently using these APIs should cease integration, as calls to these APIs will be rejected in upcoming Android releases as part of a soft removal process. Please refer to the official Privacy Sandbox developer documentation and announcements for more details on this deprecation and the future roadmap of Privacy Sandbox on Android: https://privacysandbox.com/news/update-on-plans-for-privacy-sandbox-technologies/

Deletion Request.

Summary

Nested classes

class DeletionRequest.Builder

This class was deprecated in API level 37. See DeletionRequest for the deprecation details. 

Constants

int DELETION_MODE_ALL

Deletion mode to delete all data associated with the selected records.

int DELETION_MODE_EXCLUDE_INTERNAL_DATA

Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records.

int MATCH_BEHAVIOR_DELETE

Match behavior option to delete the supplied params (Origin/Domains).

int MATCH_BEHAVIOR_PRESERVE

Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else.

Public methods

int getDeletionMode()

Get the deletion mode.

List<Uri> getDomainUris()

Get the list of domain URIs.

Instant getEnd()

Get the end of the deletion range.

int getMatchBehavior()

Get the match behavior.

List<Uri> getOriginUris()

Get the list of origin URIs.

Instant getStart()

Get the start of the deletion range.

Inherited methods

Constants

DELETION_MODE_ALL

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public static final int DELETION_MODE_ALL

Deletion mode to delete all data associated with the selected records.

Constant Value: 0 (0x00000000)

DELETION_MODE_EXCLUDE_INTERNAL_DATA

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public static final int DELETION_MODE_EXCLUDE_INTERNAL_DATA

Deletion mode to delete all data except the internal data (e.g. rate limits) for the selected records.

Constant Value: 1 (0x00000001)

MATCH_BEHAVIOR_DELETE

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public static final int MATCH_BEHAVIOR_DELETE

Match behavior option to delete the supplied params (Origin/Domains).

Constant Value: 0 (0x00000000)

MATCH_BEHAVIOR_PRESERVE

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public static final int MATCH_BEHAVIOR_PRESERVE

Match behavior option to preserve the supplied params (Origin/Domains) and delete everything else.

Constant Value: 1 (0x00000001)

Public methods

getDeletionMode

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public int getDeletionMode ()

Get the deletion mode.

Returns
int Value is one of the following:

getDomainUris

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public List<Uri> getDomainUris ()

Get the list of domain URIs.

Returns
List<Uri> This value cannot be null.

getEnd

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public Instant getEnd ()

Get the end of the deletion range.

Returns
Instant This value cannot be null.

getMatchBehavior

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public int getMatchBehavior ()

Get the match behavior.

Returns
int Value is one of the following:

getOriginUris

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public List<Uri> getOriginUris ()

Get the list of origin URIs.

Returns
List<Uri> This value cannot be null.

getStart

Added in API level 34
Also in Ad Services Extensions 4
Deprecated in API level 37
public Instant getStart ()

Get the start of the deletion range.

Returns
Instant This value cannot be null.