ReportEventRequest
public class ReportEventRequest
继承 Object
java.lang.Object | |
↳ | android.adservices.adselection.ReportEventRequest |
包装报告广告事件所需参数的请求对象。
摘要
嵌套类 | |
---|---|
类 |
ReportEventRequest.Builder
|
常量 | |
---|---|
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)
。此数据将以 POST 请求的形式附加到 registerAdBeacon
中注册的 reportingUri
。
UTF-8
格式的 String#getBytes()
大小应小于 64KB。
返回值 | |
---|---|
String |
此值不能为 null 。 |
getInputEvent
public InputEvent getInputEvent ()
返回与用户互动关联的输入事件。
此字段可以为 null
,表示一个 view 事件,或具有一个 InputEvent
对象,表示一个 click 事件。
返回值 | |
---|---|
InputEvent |
getKey
public String getKey ()
返回事件键,即要报告的广告事件类型。
此字段将用于在广告选择后提取与 registerAdBeacon
中注册的 eventKey
关联的 reportingUri
。
此字段应与 registerAdBeacon
中注册的 eventKey
完全匹配。registerAdBeacon
的具体详细信息可在 AdSelectionManager#reportImpression
的文档中找到。
事件键(使用 String#getBytes()
检查其字节数组时)的 UTF-8
格式大小不应超过 40 字节。任何超出此限制的键在 registerAdBeacon
调用期间都不会被注册。
返回值 | |
---|---|
String |
此值不能为 null 。 |
getReportingDestinations
public int getReportingDestinations ()
返回要报告到的报告目标(买方、卖方或两者)的位域。
要创建此位域,请在每个要报告到的 reportingDestination
之间放置 |
位运算符。例如,若仅向买方报告,将 reportingDestinations 字段设置为 FLAG_REPORTING_DESTINATION_BUYER
;若仅向卖方报告,将 reportingDestinations 字段设置为 FLAG_REPORTING_DESTINATION_SELLER
;若同时向买方和卖方报告,将 reportingDestinations 字段设置为 FLAG_REPORTING_DESTINATION_BUYER
| FLAG_REPORTING_DESTINATION_SELLER
返回值 | |
---|---|
int |
该值可以是 0 或 FLAG_REPORTING_DESTINATION_SELLER 和 FLAG_REPORTING_DESTINATION_BUYER 的组合。 |