ReportInteractionRequest

public class ReportInteractionRequest
extends Object

java.lang.Object
↳	android.adservices.adselection.ReportInteractionRequest

Request object wrapping the required arguments needed to report an interaction.

Summary

Constants
`int`	`FLAG_REPORTING_DESTINATION_BUYER`
`int`	`FLAG_REPORTING_DESTINATION_SELLER`

Public constructors
`ReportInteractionRequest(long adSelectionId, String interactionKey, String interactionData, int reportingDestinations)`

Public methods
`long`	`getAdSelectionId()` Returns the adSelectionId, the primary identifier of an ad selection process.
`String`	`getInteractionData()` Returns the interaction data.
`String`	`getInteractionKey()` Returns the interaction key, the type of interaction to be reported.
`int`	`getReportingDestinations()` Returns the bitfield of reporting destinations to report to (buyer, seller, or both).

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

FLAG_REPORTING_DESTINATION_BUYER

Added in Android UpsideDownCake Privacy Sandbox

public static final int FLAG_REPORTING_DESTINATION_BUYER

Constant Value: 2 (0x00000002)

FLAG_REPORTING_DESTINATION_SELLER

Added in Android UpsideDownCake Privacy Sandbox

public static final int FLAG_REPORTING_DESTINATION_SELLER

Constant Value: 1 (0x00000001)

Public constructors

ReportInteractionRequest

Added in Android UpsideDownCake Privacy Sandbox

public ReportInteractionRequest (long adSelectionId, 
                String interactionKey, 
                String interactionData, 
                int reportingDestinations)

Parameters
`adSelectionId`	`long`
`interactionKey`	`String`: This value cannot be `null`.
`interactionData`	`String`: This value cannot be `null`.
`reportingDestinations`	`int`: Value is either `0` or a combination of `FLAG_REPORTING_DESTINATION_SELLER`, and `FLAG_REPORTING_DESTINATION_BUYER`

Public methods

getAdSelectionId

Added in Android UpsideDownCake Privacy Sandbox

public long getAdSelectionId ()

Returns the adSelectionId, the primary identifier of an ad selection process.

Returns
`long`

getInteractionData

Added in Android UpsideDownCake Privacy Sandbox

public String getInteractionData ()

Returns the interaction data.

After ad selection, this data is generated by the caller, and will be attached in a POST request to the interactionReportingUri registered in registerAdBeacon.

Returns
`String`	This value cannot be `null`.

getInteractionKey

Added in Android UpsideDownCake Privacy Sandbox

public String getInteractionKey ()

Returns the interaction key, the type of interaction to be reported.

This will be used to fetch the interactionReportingUri associated with the interactionKey registered in registerAdBeacon after ad selection.

Returns
`String`	This value cannot be `null`.

getReportingDestinations

Added in Android UpsideDownCake Privacy Sandbox

public int getReportingDestinations ()

Returns the bitfield of reporting destinations to report to (buyer, seller, or both).

To create this bitfield, place an | bitwise operator between each reportingDestination to be reported to. For example to only report to buyer, set the reportingDestinations field to FLAG_REPORTING_DESTINATION_BUYER To only report to seller, set the reportingDestinations field to FLAG_REPORTING_DESTINATION_SELLER To report to both buyers and sellers, set the reportingDestinations field to FLAG_REPORTING_DESTINATION_BUYER | FLAG_REPORTING_DESTINATION_SELLER

Returns
`int`	Value is either `0` or a combination of `FLAG_REPORTING_DESTINATION_SELLER`, and `FLAG_REPORTING_DESTINATION_BUYER`