Summary: Nested Classes | Constants | Methods | Inherited Methods

ReportEventRequest

Kotlin |Java

public class ReportEventRequest
extends Object

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

Request object wrapping the required arguments needed to report an ad event.

Summary

Nested classes
`class`	`ReportEventRequest.Builder` Builder for `ReportEventRequest` objects.

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

Public methods
`long`	`getAdSelectionId()` Returns the adSelectionId, the primary identifier of an ad selection process.
`String`	`getData()` Returns the ad event data.
`InputEvent`	`getInputEvent()` Returns the input event associated with the user interaction.
`String`	`getKey()` Returns the event key, the type of ad event 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 Ad Services Extensions 8

public static final int FLAG_REPORTING_DESTINATION_BUYER

Constant Value: 2 (0x00000002)

FLAG_REPORTING_DESTINATION_SELLER

Added in Ad Services Extensions 8

public static final int FLAG_REPORTING_DESTINATION_SELLER

Constant Value: 1 (0x00000001)

Public methods

getAdSelectionId

Added in Ad Services Extensions 8

public long getAdSelectionId ()

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

Returns
`long`

getData

Added in Ad Services Extensions 8

public String getData ()

Returns the ad event data.

After ad selection, this data is generated by the caller. The caller can then call AdSelectionManager.reportEvent(ReportEventRequest, Executor, OutcomeReceiver). This data will be attached in a POST request to the reportingUri registered in registerAdBeacon.

The size of String#getBytes() in UTF-8 format should be below 64KB.

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

getInputEvent

Added in Ad Services Extensions 10

public InputEvent getInputEvent ()

Returns the input event associated with the user interaction.

This field is either null, representing a view event, or has an InputEvent object, representing a click event.

Returns
`InputEvent`

getKey

Added in Ad Services Extensions 8

public String getKey ()

Returns the event key, the type of ad event to be reported.

This field will be used to fetch the reportingUri associated with the eventKey registered in registerAdBeacon after ad selection.

This field should be an exact match to the eventKey registered in registerAdBeacon. Specific details about registerAdBeacon can be found at the documentation of AdSelectionManager#reportImpression

The event key (when inspecting its byte array with String#getBytes()) in UTF-8 format should not exceed 40 bytes. Any key exceeding this limit will not be registered during the registerAdBeacon call.

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

getReportingDestinations

Added in Ad Services Extensions 8

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`

ReportEventRequest

Summary

Nested classes

Constants

Public methods

Inherited methods

Constants

FLAG_REPORTING_DESTINATION_BUYER

FLAG_REPORTING_DESTINATION_SELLER

Public methods

getAdSelectionId

getData

getInputEvent

getKey

getReportingDestinations