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

CustomAudienceManager

public class CustomAudienceManager
extends Object

java.lang.Object
   ↳ android.adservices.customaudience.CustomAudienceManager


CustomAudienceManager 为应用和广告 SDK 提供用于加入/退出自定义受众群体的 API。

摘要

公共方法

void fetchAndJoinCustomAudience(FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

将用户添加到从 fetchUri 提取的 CustomAudience

static CustomAudienceManager get(Context context)

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

TestCustomAudienceManager getTestCustomAudienceManager()

使用可启用测试的 API 创建服务

void joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

将用户添加到给定的 CustomAudience

void leaveCustomAudience(LeaveCustomAudienceRequest leaveCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

尝试通过删除任何现有的 CustomAudience 数据(由 ownerPackageNamebuyername 标识)来从自定义受众群体中移除用户。

继承的方法

公共方法

fetchAndJoinCustomAudience

public void fetchAndJoinCustomAudience (FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

将用户添加到从 fetchUri 提取的 CustomAudience

如果尝试使用相同的 ownerPackageNamebuyername 组合将用户注册为自定义受众群体,会导致现有自定义受众群体的 包括广告数据列表在内的各类信息。

请注意,每日后台提取作业可能会完全覆盖广告列表。

如果出现以下情况,此调用将失败并显示 SecurityException

  1. ownerPackageName 未调用应用的软件包名称,并且/或者
  2. 买方无权使用该 API。

如果出现以下情况,此调用将失败并显示 IllegalArgumentException

  1. 调用方应用已超出存储空间限制,并且/或者
  2. 给定 CustomAudience 中的任何 URI 参数均未通过 CustomAudience买方。

如果调用的软件包超出了LimitExceededException 允许的速率限制并被节流。

如果发生内部服务错误,此调用将失败并显示 IllegalStateException 错误。
需要 AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

参数
fetchAndJoinCustomAudienceRequest FetchAndJoinCustomAudienceRequest:此值不能为 null

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

receiver OutcomeReceiver:此值不能为 null

get

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

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

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

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

getTestCustomAudienceManager

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public TestCustomAudienceManager getTestCustomAudienceManager ()

使用可启用测试的 API 创建服务

返回
TestCustomAudienceManager 此值不能为 null

联接 CustomAudience

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

将用户添加到给定的 CustomAudience

如果尝试使用相同的 ownerPackageNamebuyername 组合将用户注册为自定义受众群体,会导致现有自定义受众群体的 包括广告数据列表在内的各类信息。

请注意,每日后台提取作业可能会完全覆盖广告列表。

如果出现以下情况,此调用将失败并显示 SecurityException

  1. ownerPackageName 未调用应用的软件包名称,并且/或者
  2. 买方无权使用该 API。

如果出现以下情况,此调用将失败并显示 IllegalArgumentException

  1. 调用方应用已超出存储空间限制,并且/或者
  2. 给定 CustomAudience 中的任何 URI 参数均未通过 CustomAudience买方。

如果调用的软件包超出了LimitExceededException 允许的速率限制并被节流。

如果发生内部服务错误,此调用将失败并显示 IllegalStateException 错误。
需要 AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

参数
joinCustomAudienceRequest JoinCustomAudienceRequest:此值不能为 null

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

receiver OutcomeReceiver:此值不能为 null

退出自定义受众群体

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

尝试通过删除任何现有的 CustomAudience 数据(由 ownerPackageNamebuyername 标识)来从自定义受众群体中移除用户。

如果出现以下情况,此调用将失败并显示 SecurityException

  1. ownerPackageName 未调用应用的软件包名称;和/或
  2. 买方无权使用该 API。

如果调用的软件包超出了LimitExceededException 允许的速率限制并被节流。

此调用不会通知调用方,指定的自定义受众群体是否存在于 设备端存储。也就是说,如果买方试图退出 未加入的自定义受众群体。
需要 AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

参数
leaveCustomAudienceRequest LeaveCustomAudienceRequest:此值不能为 null

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

receiver OutcomeReceiver:此值不能为 null