CustomAudienceManager

public class CustomAudienceManager
extends Object

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

CustomAudienceManager 提供 API，供应用和广告 SDK 加入/离开自定义受众群体。

摘要

公开方法

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

将用户添加到从 fetchUri 提取的 CustomAudience 中。
static CustomAudienceManager get(Context context)

用于创建 CustomAudienceManager 实例的工厂方法。
TestCustomAudienceManager getTestCustomAudienceManager()

创建一个包含测试启用 API 的服务
void joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

将用户添加到给定的 CustomAudience 中。
void leaveCustomAudience(LeaveCustomAudienceRequest leaveCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

尝试通过删除由 ownerPackageName、buyer 和 name 标识的现有 CustomAudience 数据，将用户从自定义受众群体中移除。

继承的方法

公开方法

fetchAndJoinCustomAudience

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

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

尝试使用相同的 ownerPackageName、buyer 和 name 组合为自定义受众群体注册用户，将导致现有自定义受众群体的信息被覆盖，包括广告数据列表。

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

如果出现以下情况，此调用会失败并抛出 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

public static CustomAudienceManager get (Context context)

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

参数
context Context：要使用的 Context 此值不能为 null。
返回
CustomAudienceManager CustomAudienceManager 实例 此值不能为 null。

getTestCustomAudienceManager

public TestCustomAudienceManager getTestCustomAudienceManager ()

创建一个包含测试启用 API 的服务

返回
TestCustomAudienceManager 此值不能为 null。

joinCustomAudience

public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

将用户添加到给定的 CustomAudience 中。

尝试使用相同的 ownerPackageName、buyer 和 name 组合为自定义受众群体注册用户，将导致现有自定义受众群体的信息被覆盖，包括广告数据列表。

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

如果出现以下情况，此调用会失败并抛出 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。

leaveCustomAudience

public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

尝试通过删除由 ownerPackageName、buyer 和 name 标识的现有 CustomAudience 数据，将用户从自定义受众群体中移除。

如果出现以下情况，此调用会失败并抛出 SecurityException：

  1. ownerPackageName 不是调用应用的软件包名称；和/或
  2. 购买方无权使用此 API。

如果调用软件包超出允许的速率限制并受到限制，此调用会失败并抛出 LimitExceededException。

此调用不会告知调用方指定的自定义受众群体是否存在于设备端存储空间中。换句话说，当购买方尝试离开未加入的自定义受众群体时，此调用会静默失败。
需要 AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

参数
leaveCustomAudienceRequest LeaveCustomAudienceRequest：此值不能为 null。
executor Executor：此值不能为 null。回调和监听器事件通过此 Executor 分派，从而轻松控制使用哪个线程。如需通过应用的主线程分派事件，您可以使用 Context.getMainExecutor()。否则，请提供一个分派到相应线程的 Executor。
receiver OutcomeReceiver：此值不能为 null。