报告事件请求

public class ReportEventRequest
extends Object

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


用于封装报告广告事件所需实参的请求对象。

摘要

嵌套类

class ReportEventRequest.Builder

ReportEventRequest 对象的构建器。 

常量

int FLAG_REPORTING_DESTINATION_BUYER

int FLAG_REPORTING_DESTINATION_SELLER

公共方法

long getAdSelectionId()

返回 adSelectionId,也就是广告选择流程的主要标识符。

String getData()

返回广告事件数据。

InputEvent getInputEvent()

返回与用户互动相关的输入事件。

String getKey()

返回事件键,也就是要报告的广告事件类型。

int getReportingDestinations()

返回报告目的地的位字段(买方和/或卖方)。

继承的方法

常量

FLAG_REPORTING_DESTINATION_BUYER

public static final int FLAG_REPORTING_DESTINATION_BUYER

常量值: 2 次 (0x00000002)

FLAG_REPORTING_DESTINATION_SELLER

public static final int FLAG_REPORTING_DESTINATION_SELLER

常量值: 1 次 (0x00000001)

公共方法

getAdSelectionId

public long getAdSelectionId ()

返回 adSelectionId,也就是广告选择流程的主要标识符。

返回
long

getData

public String getData ()

返回广告事件数据。

广告选择完成后,此数据由调用方生成。然后,调用方可以调用 AdSelectionManager.reportEvent(ReportEventRequest, Executor, OutcomeReceiver)。这些数据将附加到在 registerAdBeacon 中注册的 reportingUri 的 POST 请求中。

UTF-8 格式的 String#getBytes() 的大小应低于 64KB。

返回
String 此值不能为 null

getInputEvent

public InputEvent getInputEvent ()

返回与用户互动相关的输入事件。

此字段是 null(表示浏览事件)或 InputEvent 对象(表示点击事件)。

返回
InputEvent

getKey

public String getKey ()

返回事件键,也就是要报告的广告事件类型。

此字段将用于在广告选择完成后提取与在 registerAdBeacon 中注册的 eventKey 相关联的 reportingUri

此字段应与在 registerAdBeacon 中注册的 eventKey 完全匹配。有关registerAdBeacon的具体详情,请参阅 AdSelectionManager#reportImpression 的文档

UTF-8 格式的事件键(使用 String#getBytes() 检查其字节数组时)不应超过 40 个字节。任何超出此限制的密钥都不会被注册 在 registerAdBeacon 调用期间触发。

返回
String 此值不能为 null

getReportingDestinations

public int getReportingDestinations ()

返回报告目的地的位字段(买方和/或卖方)。

如需创建此位字段,请在作为报告目的地的每个 reportingDestination 之间放置一个 | 按位运算符。例如,要仅向买方报告,可将 reportDestinations 字段设置为 FLAG_REPORTING_DESTINATION_BUYER,以便仅报告至 将 reportingDestinations 字段设置为 FLAG_REPORTING_DESTINATION_SELLER, 同时向买方和卖方报告,请将 reportingDestinations 字段设置为 FLAG_REPORTING_DESTINATION_BUYER |FLAG_REPORTING_DESTINATION_SELLER

返回
int 值为 0 或者 FLAG_REPORTING_DESTINATION_SELLERFLAG_REPORTING_DESTINATION_BUYER 的组合