MeasurementManager
public
class
MeasurementManager
extends Object
java.lang.Object | |
↳ | android.adservices.measurement.MeasurementManager |
MeasurementManager 提供用于管理来源和触发器注册的 API。
总结
常量 | |
---|---|
int |
MEASUREMENT_API_STATE_DISABLED
此状态表示 Measurement API 不可用。 |
int |
MEASUREMENT_API_STATE_ENABLED
此状态表示 Measurement API 已启用。 |
继承的方法 | |
---|---|
常量
MEASUREMENT_API_STATE_DISABLED
public static final int MEASUREMENT_API_STATE_DISABLED
此状态表示 Measurement API 不可用。调用这些 API 将导致 UnsupportedOperationException
。
常量值: 0 (0x00000000)
MEASUREMENT_API_STATE_ENABLED
public static final int MEASUREMENT_API_STATE_ENABLED
此状态表示 Measurement API 已启用。
常量值: 1 (0x00000001)
公共方法
deleteRegistration
public void deleteRegistrations (DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)
删除之前的注册。如果删除成功,则使用 null 来调用回调的 OutcomeReceiver.onResult(R)
。如果失败了,系统将通过回调的 OutcomeReceiver#onError
发送 Exception
。成功和失败反馈都会对提供的 Executor
执行。
参数 | |
---|---|
deletionRequest |
DeletionRequest :删除数据的请求。此值不能为 null 。 |
executor |
Executor :要运行回调的执行器。此值不能为 null 。
回调和监听器事件通过此 Executor 进行分派,从而提供了一种简单的方法来控制使用哪个线程。如需通过应用的主线程分派事件,您可以使用 Context.getMainExecutor() 。
否则,请提供可分派给适当线程的 Executor 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。
此值不能为 null 。 |
get
public static MeasurementManager get (Context context)
用于创建 MeasurementManager 实例的工厂方法。
参数 | |
---|---|
context |
Context :要使用的 Context 。此值不能为 null 。 |
开球回攻次数 | |
---|---|
MeasurementManager |
MeasurementManager 实例。此值不能为 null 。 |
getMeasurementApiStatus
public void getMeasurementApiStatus (Executor executor, OutcomeReceiver<Integer, Exception> callback)
获取 Measurement API 状态。
回调的 Integer
值为 MeasurementApiState
之一。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
executor |
Executor :供回调用来分派结果。
此值不能为 null 。
回调和监听器事件通过此 Executor 进行分派,从而提供了一种简单的方法来控制使用哪个线程。如需通过应用的主线程分派事件,您可以使用 Context.getMainExecutor() 。
否则,请提供可分派给适当线程的 Executor 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。
此值不能为 null 。 |
注册源
public void registerSource (Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)
注册归因来源(点击或观看)。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
attributionSource |
Uri :平台会向此 URI 发出请求,以便获取与归因来源关联的元数据。源元数据存储在设备上,因此可以与未来的触发器匹配。
此值不能为 null 。 |
inputEvent |
InputEvent :InputEvent 对象(如果是点击事件)或 null(如果是视图事件)。 |
executor |
Executor :供回调用来分派结果。
此值可以为 null 。
回调和监听器事件通过此 Executor 进行分派,从而提供了一种简单的方法来控制使用哪个线程。如需通过应用的主线程分派事件,您可以使用 Context.getMainExecutor() 。
否则,请提供可分派给适当线程的 Executor 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。
此值可以为 null 。 |
抛出 | |
---|---|
IllegalArgumentException |
如果 attributionSource 的架构不是 HTTPS |
注册源
public void registerSource (SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
从应用上下文注册归因来源(点击或查看)。此 API 不会处理任何重定向,所有注册网址都应随请求提供。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
request |
SourceRegistrationRequest :应用来源注册请求。此值不能为 null 。 |
executor |
Executor :回调用于分派结果。此值可为 null 。
回调和监听器事件通过此 Executor 进行分派,从而提供了一种简单的方法来控制使用哪个线程。如需通过应用的主线程分派事件,您可以使用 Context.getMainExecutor() 。
否则,请提供可分派给适当线程的 Executor 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。此值可为 null 。 |
注册触发器
public void registerTrigger (Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)
注册触发器(转化)。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
trigger |
Uri :API 会向此 URI 发出请求,以提取与触发器关联的元数据。触发器元数据存储在设备上,可以在归因过程中与来源进行匹配。
此值不能为 null 。 |
executor |
Executor :供回调用来分派结果。
此值可以为 null 。
回调和监听器事件通过此 Executor 进行分派,从而提供了一种简单的方法来控制使用哪个线程。如需通过应用的主线程分派事件,您可以使用 Context.getMainExecutor() 。
否则,请提供可分派给适当线程的 Executor 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。
此值可以为 null 。 |
抛出 | |
---|---|
IllegalArgumentException |
如果 trigger 的架构不是 HTTPS |
注册 WebSource
public void registerWebSource (WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
从网站上下文注册归因来源(点击或观看)。此 API 不会处理任何重定向,所有注册网址都应随请求提供。至少需要提供 appDestination 或 webDestination 参数之一。如果注册成功,则系统会使用 null 调用 callback
的 OutcomeReceiver#onResult
。如果失败,则通过 callback
的 OutcomeReceiver.onError(E)
发送 Exception
。成功和失败反馈都会对提供的 Executor
执行。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
request |
WebSourceRegistrationRequest :来源注册请求。此值不能为 null 。 |
executor |
Executor :供回调用来分派结果。
此值可以为 null 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。
此值可以为 null 。 |
注册 WebTrigger
public void registerWebTrigger (WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)
从网站上下文注册归因触发器(点击或观看)。此 API 不会处理任何重定向,所有注册网址都应随请求提供。如果注册成功,则系统会使用 null 调用 callback
的 OutcomeReceiver#onResult
。如果失败,则通过 callback
的 OutcomeReceiver.onError(E)
发送 Exception
。成功和失败反馈都会对提供的 Executor
执行。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION
参数 | |
---|---|
request |
WebTriggerRegistrationRequest :触发器注册请求。此值不能为 null 。 |
executor |
Executor :回调用于分派结果。此值可为 null 。 |
callback |
OutcomeReceiver :用于异步通知 API 结果。此值可为 null 。 |