CustomAudience

public final class CustomAudience
继承自 Object 实现 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()

返回自定义受众参与广告选择过程时用于获取出价逻辑的目标 URI。
AdTechIdentifier getBuyer()

买家通过“buyerexample.com”形式的域名进行标识。
Uri getDailyUpdateUri()

此 URI 指向买家运营的服务器，该服务器托管了用于设备端广告选择过程的更新的出价数据和广告元数据。
Instant (瞬间) getExpirationTime()

过期时间一过，自定义受众便不再有资格进行每日广告/出价数据更新或参与广告选择过程。
String (字符串) getName()

自定义受众的名称是在创建 CustomAudience 对象时由所有者和买家提供的任意字符串。
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

public Instant getActivationTime ()

在创建 CustomAudience 对象时，可以选择设置未来的激活时间，以实现延迟激活。如果未设置此字段，则 CustomAudience 将在加入时激活。

例如，针对流失用户的自定义受众可能直到达到不活跃阈值时才会激活，届时自定义受众的广告将参与广告选择过程，从而可能将流失用户重定向回原始所有者应用。

最大延迟激活时间为初次创建后的 60 天。

如果指定，激活时间必须早于过期时间。

返回
Instant (瞬间) 时间戳 Instant，截断到毫秒，在此之后自定义受众处于活动状态。此值可以为 null。

getAds

public List<AdData> getAds ()

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

如果未指定，或者提供了空列表，则 CustomAudience 将不会参与广告选择，直到通过每日更新为自定义受众提供有效的广告列表。

返回
List<AdData> 一个 List 包含 AdData 对象，表示当前由自定义受众投放的广告。此值不能为空 (null)。

getBiddingLogicUri

public Uri getBiddingLogicUri ()

返回自定义受众参与广告选择过程时用于获取出价逻辑的目标 URI。该 URI 必须使用 HTTPS。

返回
Uri 用于获取买家出价逻辑的 URI。此值不能为空 (null)。

getBuyer

public AdTechIdentifier getBuyer ()

买家通过“buyerexample.com”形式的域名进行标识。

返回
AdTechIdentifier 一个 AdTechIdentifier 包含自定义受众买家的域名。此值不能为空 (null)。

getDailyUpdateUri

public Uri getDailyUpdateUri ()

此 URI 指向买家运营的服务器，该服务器托管了用于设备端广告选择过程的更新的出价数据和广告元数据。该 URI 必须使用 HTTPS。

返回
Uri 自定义受众的每日更新 URI。此值不能为空 (null)。

getExpirationTime

public Instant getExpirationTime ()

过期时间一过，自定义受众便不再有资格进行每日广告/出价数据更新或参与广告选择过程。然后，自定义受众将在下次每日更新时从内存中删除。

如果在创建 CustomAudience 时未提供过期时间，则默认在激活后 60 天过期。

最大过期时间为初次激活后的 60 天。

返回
Instant (瞬间) 时间戳 Instant，截断到毫秒，在此之后自定义受众应被移除。此值可以为 null。

getName

public String getName ()

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

返回
String (字符串) 自定义受众的 String 名称。此值不能为空 (null)。

getTrustedBiddingData

public TrustedBiddingData getTrustedBiddingData ()

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

如果未指定，则 CustomAudience 将不会参与广告选择，直到通过每日更新为自定义受众提供可信出价数据。

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

getUserBiddingSignals

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。值为 0 或 Parcelable.PARCELABLE_WRITE_RETURN_VALUE 和 android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES 的组合。