已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入

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<ObjectException> callback)

删除之前的注册。

static MeasurementManager get(Context context)

用于创建 MeasurementManager 实例的工厂方法。

void getMeasurementApiStatus(Executor executor, OutcomeReceiver<IntegerException> callback)

可获取 Measurement API 状态。

void registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<ObjectException> callback)

注册归因来源(点击或观看)。

void registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

在应用环境中注册归因来源(点击或观看)。

void registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<ObjectException> callback)

注册触发器(转化)。

void registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

根据网站情境注册归因来源(点击或观看)。

void registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

从网站上下文注册归因触发器(点击或观看)。

继承的方法

Object clone()

创建并返回此对象的副本。

boolean equals(Object obj)

指示某个其他对象是否“等于”这个。

void finalize()

垃圾回收时,由垃圾回收器针对对象调用 确定没有对对象的更多引用。

final Class<?> getClass()

返回此 Object 的运行时类。

int hashCode()

返回对象的哈希代码值。

final void notify()

唤醒正在等待此对象的 监控。

final void notifyAll()

唤醒正在等待此对象的监控器的所有线程。

String toString()

返回对象的字符串表示。

final void wait(long timeoutMillis, int nanos)

导致当前线程处于等待状态,直到其被唤醒,这通常是 通知中断,或者直到 经过了一定量的实时。

final void wait(long timeoutMillis)

导致当前线程处于等待状态,直到其被唤醒,这通常是 通知中断,或者直到 经过了一定量的实时。

final void wait()

导致当前线程处于等待状态,直到其被唤醒,这通常是 通知中断

常量

MEASUREMENT_API_STATE_DISABLED

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public static final int MEASUREMENT_API_STATE_DISABLED

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

常量值: 0 (0x00000000)

MEASUREMENT_API_STATE_ENABLED

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public static final int MEASUREMENT_API_STATE_ENABLED

此状态表示 Measurement API 已启用。

常量值: 1 次 (0x00000001)

公共方法

deleteRegistrations

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void deleteRegistrations (DeletionRequest deletionRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

删除之前的注册。如果删除成功,则使用 null 来调用回调函数的 OutcomeReceiver.onResult(R)。如果失败,则会返回 Exception。 通过回调的 OutcomeReceiver#onError 发送。成功和失败 对提供的 Executor 执行反馈。

参数
deletionRequest DeletionRequest:删除数据的请求。 此值不能为 null

executor Executor:要运行回调的执行器。 此值不能为 null。 回调和监听器事件通过此 Executor,可让您轻松控制要 。要通过 可以使用 Context.getMainExecutor()。 否则,请提供分派给相应线程的 Executor

callback OutcomeReceiver:用于异步通知 API 结果。 此值不能为 null

get

已在 API 级别 34 中引入
也已在广告服务扩展 6 中引入
public static MeasurementManager get (Context context)

用于创建 MeasurementManager 实例的工厂方法。

参数
context Context:要使用的 Context 此值不能为 null

返回
MeasurementManager MeasurementManager 实例 此值不能为 null

getMeasurementApiStatus

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void getMeasurementApiStatus (Executor executor, 
                OutcomeReceiver<IntegerException> callback)

可获取 Measurement API 状态。

回调的 Integer 值为 MeasurementApiState 之一。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
executor Executor:回调用于调度结果。 此值不能为 null。 回调和监听器事件通过此 Executor,可让您轻松控制要 。要通过 可以使用 Context.getMainExecutor()。 否则,请提供分派给相应线程的 Executor

callback OutcomeReceiver:用于异步通知 API 结果。 此值不能为 null

注册来源

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void registerSource (Uri attributionSource, 
                InputEvent inputEvent, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

注册归因来源(点击或观看)。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
attributionSource Uri:平台会向此 URI 发出请求以提取元数据 与归因来源相关联。源元数据存储在设备上,因此 以便与未来的触发器匹配。 此值不能为 null

inputEvent InputEventInputEvent 对象(如果是点击事件)或 null(如果是观看) 事件)。

executor Executor:回调用于调度结果。 此值可以为 null。 回调和监听器事件通过此 Executor,可让您轻松控制要 。要通过 可以使用 Context.getMainExecutor()。 否则,请提供分派给相应线程的 Executor

callback OutcomeReceiver:用于异步通知 API 结果。 此值可以为 null

抛出
IllegalArgumentException 如果 attributionSource 的架构不是 HTTPS

注册来源

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

在应用环境中注册归因来源(点击或观看)。此 API 不会处理 任何重定向,都应随请求提供所有注册网址。
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request SourceRegistrationRequest:应用来源注册请求 此值不能为 null

executor Executor:供回调用来调度结果 此值可以为 null。 回调和监听器事件通过此 Executor,可让您轻松控制要 。要通过 可以使用 Context.getMainExecutor()。 否则,请提供分派给相应线程的 Executor

callback OutcomeReceiver:用于异步通知 API 结果 此值可以为 null

注册触发器

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void registerTrigger (Uri trigger, 
                Executor executor, 
                OutcomeReceiver<ObjectException> 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

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void registerWebSource (WebSourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

根据网站情境注册归因来源(点击或观看)。此 API 不会处理任何 重定向,则所有注册网址都应随请求一起提供。至少为以下项之一: 必须提供 appDestination 或 webDestination 参数。如果注册 调用成功时,系统会使用 null 调用 callbackOutcomeReceiver#onResult。在 如果失败,则通过 callbackOutcomeReceiver.onError(E) 发送 Exception。成功和失败反馈都会根据提供的 Executor
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request WebSourceRegistrationRequest:来源注册请求 此值不能为 null

executor Executor:回调用于调度结果。 此值可以为 null

callback OutcomeReceiver:用于异步通知 API 结果。 此值可以为 null

注册 WebTrigger

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void registerWebTrigger (WebTriggerRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

从网站上下文注册归因触发器(点击或观看)。此 API 不会处理 任何重定向,都应随请求提供所有注册网址。如果注册 调用成功时,系统会使用 null 调用 callbackOutcomeReceiver#onResult。在 如果失败,则通过 callbackOutcomeReceiver.onError(E) 发送 Exception。成功和失败反馈都会根据提供的 Executor
需要 AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

参数
request WebTriggerRegistrationRequest:触发器注册请求 此值不能为 null

executor Executor:供回调用来调度结果 此值可以为 null

callback OutcomeReceiver:用于异步通知 API 结果 此值可以为 null