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

CustomAudience

public final class CustomAudience
extends Object implements Parcelable

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


表示自定义受众群体参与广告选择所必需的信息。

自定义受众群体是具有相似兴趣的用户的抽象分组。此类是设备上存储的一些数据的集合,在投放定位到一个自定义受众群体的广告时,需要使用这些数据。

摘要

嵌套类

class CustomAudience.Builder

CustomAudience 对象的构建器。 

继承的常量

字段

public static final Creator<CustomAudience> CREATOR

公共方法

boolean equals(Object o)

检查两个 CustomAudience 对象是否包含相同的信息。

Instant getActivationTime()

创建 CustomAudience 对象时,可以在 以便延迟激活。

List<AdData> getAds()

AdData 对象列表是将要屏蔽的广告 此 CustomAudience 投放的广告。

Uri getBiddingLogicUri()

返回在自定义受众群体参与 广告选择流程。

AdTechIdentifier getBuyer()

买方通过格式为“buyerexample.com”的域名进行标识。

Uri getDailyUpdateUri()

此 URI 指向由买方运营的服务器,服务器中托管着更新后的出价数据和广告元数据 以便在设备端广告选择流程中使用。

Instant getExpirationTime()

一旦到期时间已过,自定义受众群体就不再符合每日使用的条件 广告/出价数据更新或参与广告选择流程。

String getName()

自定义受众群体的名称是所有者和买方在创建受众群体时提供的任意字符串 CustomAudience 对象的 ID。

TrustedBiddingData getTrustedBiddingData()

可信出价数据包含一个指向可信服务器的 URI,供买方出价数据 以及用于向服务器查询的键的列表。

AdSelectionSignals getUserBiddingSignals()

用户出价信号由买方选择性提供,由买方提供 广告选择期间在隔离的执行环境中进行的 JavaScript。

int hashCode()

返回 CustomAudience 对象数据的哈希值。

void writeToParcel(Parcel dest, int flags)

将此对象展平为 Parcel。

继承的方法

字段

CREATOR

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public static final Creator<CustomAudience> CREATOR

公共方法

equals

API 级别 34 中引入
public boolean equals (Object o)

检查两个 CustomAudience 对象是否包含相同的信息。

参数
o Object:用来进行比较的参照对象。

返回值
boolean 如果此对象与 obj 参数相同,则返回 true;否则返回 false

getActivationTime

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

创建 CustomAudience 对象时,可将可选启用时间设置为将来的时间,以便提供延迟启用。如果未设置此字段,则 CustomAudience 将在加入时启用。

例如,已流失的用户的自定义受众群体可能一直没有启用,直到已经达到处于非活跃状态的阈值时才启用,此时自定义受众群体的广告将参与广告选择流程,并有可能将已流失的用户重定向至原先的所有者应用。

最长的启用延迟时间为自初始创建之日起 60 天。

如果已指定,则启用时间必须要早于到期时间。

返回
Instant 时间戳 Instant(截断至毫秒),之后自定义 受众群体有效 此值可以为 null

getAds

已在 API 级别 34 中引入
也已在广告服务扩展 4 中引入
public List<AdData> getAds ()

AdData 对象列表是广告选择流程中此 CustomAudience 将投放的广告的完整列表。

如果未指定,或提供了空列表,在通过自定义受众群体的每日更新提供有效的广告列表之前,CustomAudience 不会参与广告选择。

返回
List<AdData> AdData 对象的 List,表示当前由 自定义受众群体 此值不能为 null

getBiddingLogicUri

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

返回在自定义受众群体参与广告选择流程时用于提取出价逻辑的目标 URI。URI 必须使用 HTTPS。

返回
Uri 用于提取买方出价逻辑的 URI 此值不能为 null

getBuyer

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

买方通过格式为“buyerexample.com”的域名进行标识。

返回
AdTechIdentifier 包含自定义受众群体的买方网域的 AdTechIdentifier 此值不能为 null

getDailyUpdateUri

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

此 URI 指向由买方运营的服务器,服务器中托管着更新后的出价数据和广告元数据,在设备上的广告选择流程中需要使用这些数据。URI 必须使用 HTTPS。

返回
Uri 自定义受众群体的每日更新 URI 此值不能为 null

getExpirationTime

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

一旦到期时间已过,自定义受众群体就不再符合每日广告/出价数据更新或参与广告选择流程的条件。然后,系统会在下一次每日更新前从内存中删除自定义受众群体。

如果在创建 CustomAudience 时未提供到期时间,那么过期时间将默认为启用后 60 天。

最长的过期时间为自初始启用之日起 60 天。

返回
Instant 时间戳 Instant(截断至毫秒),之后自定义 受众群体应移除 此值可以为 null

getName

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

自定义受众群体的名称是所有者和买方在创建 CustomAudience 对象时提供的任意字符串。

返回
String 自定义受众群体的字符串名称 此值不能为 null

getTrustedBiddingData

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

可信出价数据包含一个指向用于提取买方出价数据的可信服务器的 URI,以及一个用于向该服务器查询的键的列表。请注意,这些键是任意标识符,仅用于在广告选择期间向可信服务器查询买方的出价逻辑。

如果未指定,在通过自定义受众群体的每日更新提供可信出价数据之前,CustomAudience 将不会参与广告选择。

返回
TrustedBiddingData 包含自定义受众群体的可信出价的 TrustedBiddingData 对象 数据 此值可以为 null

getUserBiddingSignals

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

用户出价信号由买方选择性提供,在广告选择期间由买方提供的 JavaScript 在隔离的执行环境中使用。

如果用户出价信号不是买方 JS 可使用的有效 JSON 对象,自定义受众群体就不符合广告选择条件。

如果未指定,在通过自定义受众群体的每日更新提供用户出价信号之前,CustomAudience 不会参与广告选择。

返回
AdSelectionSignals 一个 AdSelectionSignals 对象,表示针对 自定义受众群体 此值可以为 null

hashCode

API 级别 34 中引入
public int hashCode ()

返回 CustomAudience 对象数据的哈希值。

返回值
int 此对象的哈希代码值。

writeToParcel

API 级别 34 中引入
public void writeToParcel (Parcel dest, 
                int flags)

将此对象扁平化为 Parcel。

参数
dest Parcel:此值不能为 null

flags int:关于如何写入对象的其他标志。可为 0 或 Parcelable.PARCELABLE_WRITE_RETURN_VALUE。 值为 0Parcelable.PARCELABLE_WRITE_RETURN_VALUE 和 android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES 的组合