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 已启用。

公共方法

void deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<Object, Exception> callback)

删除先前的注册。
static MeasurementManager get(Context context)

用于创建 MeasurementManager 实例的工厂方法。
void getMeasurementApiStatus(Executor executor, OutcomeReceiver<Integer, Exception> callback)

获取 Measurement API 状态。
void registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<Object, Exception> callback)

注册归因来源（点击或浏览）。
void registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)

从应用上下文注册归因来源（点击或浏览）。
void registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<Object, Exception> callback)

注册触发器（转化）。
void registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)

从网络上下文注册归因来源（点击或浏览）。
void registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<Object, Exception> callback)

从网络上下文注册归因触发器（点击或浏览）。

继承的方法

常量

MEASUREMENT_API_STATE_DISABLED

添加于 API 级别 34
也适用于 Ad Services Extensions 4
public static final int MEASUREMENT_API_STATE_DISABLED

此状态表示 Measurement API 不可用。调用它们将导致 UnsupportedOperationException。

常量值：0 (0x00000000)

MEASUREMENT_API_STATE_ENABLED

添加于 API 级别 34
也适用于 Ad Services Extensions 4
public static final int MEASUREMENT_API_STATE_ENABLED

此状态表示 Measurement API 已启用。

常量值：1 (0x00000001)

公共方法

deleteRegistrations

public void deleteRegistrations (DeletionRequest deletionRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> callback)

删除先前的注册。如果删除成功，将调用回调的 OutcomeReceiver.onResult(R) 并传递 null。如果失败，将通过回调的 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。

registerSource

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

registerSource

public void registerSource (SourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> callback)

从应用上下文注册归因来源（点击或浏览）。此 API 不会处理任何重定向，所有注册 URL 都应随请求提供。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request SourceRegistrationRequest：应用来源注册请求。此值不能为 null。
executor Executor：由回调用于分派结果。此值可以为 null。回调和监听器事件通过此 Executor 分派，提供了一种轻松控制使用哪个线程的方法。要通过应用程序的主线程分派事件，可以使用 Context.getMainExecutor()。否则，提供一个分派到适当线程的 Executor。
callback OutcomeReceiver：旨在异步通知 API 结果。此值可以为 null。

registerTrigger

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

registerWebSource

public void registerWebSource (WebSourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> callback)

从网络上下文注册归因来源（点击或浏览）。此 API 不会处理任何重定向，所有注册 URL 都应随请求提供。必须提供 appDestination 或 webDestination 参数中的至少一个。如果注册成功，将调用 callback 的 OutcomeReceiver#onResult 并传递 null。如果失败，将通过 callback 的 OutcomeReceiver.onError(E) 发送 Exception。成功和失败的反馈都将在提供的 Executor 上执行。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request WebSourceRegistrationRequest：来源注册请求。此值不能为 null。
executor Executor：由回调用于分派结果。此值可以为 null。
callback OutcomeReceiver：旨在异步通知 API 结果。此值可以为 null。

registerWebTrigger

public void registerWebTrigger (WebTriggerRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> callback)

从网络上下文注册归因触发器（点击或浏览）。此 API 不会处理任何重定向，所有注册 URL 都应随请求提供。如果注册成功，将调用 callback 的 OutcomeReceiver#onResult 并传递 null。如果失败，将通过 callback 的 OutcomeReceiver.onError(E) 发送 Exception。成功和失败的反馈都将在提供的 Executor 上执行。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request WebTriggerRegistrationRequest：触发器注册请求。此值不能为 null。
executor Executor：由回调用于分派结果。此值可以为 null。
callback OutcomeReceiver：旨在异步通知 API 结果。此值可以为 null。