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

AdData

public final class AdData
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.common.AdData


表示广告选择和呈现所需的广告专属数据。

摘要

嵌套类

class AdData.Builder

AdData 对象的构建器。 

继承的常量

字段

public static final Creator<AdData> CREATOR

公共方法

boolean equals(Object o)

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

Set<Integer> getAdCounterKeys()

获取用于统计事件的那组键。

AdFilters getAdFilters()

获取与广告关联的所有 AdFilters

String getAdRenderId()

获取用于参与服务器竞价的广告呈现 ID。

String getMetadata()

获取在广告选择流程中使用的买方广告元数据。

Uri getRenderUri()

获取指向广告呈现素材资源的 URI。

int hashCode()

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

String toString()

返回对象的字符串表示。

void writeToParcel(Parcel dest, int flags)

将此对象展平为 Parcel。

继承的方法

字段

CREATOR

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

公共方法

equals

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

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

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

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

getAdCounterKeys

public Set<Integer> getAdCounterKeys ()

获取用于统计事件的那组键。

一个广告最多可以关联 10 个广告计数器键。

键和每个键的数量会用于在广告选择过程中进行频次上限过滤,以阻止关联的广告提交至出价环节。

请注意,在自定义受众群体的每日更新期间,这些键可能会随同自定义受众群体的广告和其他出价数据一起被覆盖。

返回
Set<Integer> 此值不能为 null

getAdFilters

public AdFilters getAdFilters ()

获取与广告关联的所有 AdFilters

如果达到或超出这些过滤条件,则系统会排除关联的广告,使其无法参与广告选择。这些过滤条件是可选的,null 意味着不对此广告应用任何过滤条件。

返回
AdFilters

getAdRenderId

public String getAdRenderId ()

获取用于参与服务器竞价的广告呈现 ID。

收到服务器竞价请求时,系统会针对每个 AdData 收集广告呈现 ID。

任何没有广告呈现 ID 的 AdData 都将无法参与服务器端竞价。

返回
String 此值可以是 null

getMetadata

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

获取在广告选择流程中使用的买方广告元数据。

元数据应是已序列化为字符串的有效 JSON 对象。元数据表示广告专有出价信息,将在广告选择期间的出价生成过程中使用,也将用于买方 JavaScript 逻辑(在隔离的执行环境中执行)。

如果元数据不是买方 JS 可使用的有效 JSON 对象,广告就不符合广告选择条件。

返回
String 此值不能为 null

getRenderUri

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

获取指向广告呈现素材资源的 URI。URI 必须使用 HTTPS。

返回
Uri 此值不能为 null

hashCode

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

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

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

toString

API 级别 34 中引入
public String toString ()

返回对象的字符串表示。通常,toString 方法会返回一个“以文本形式表示”此对象的字符串。结果应该是一个简洁但信息丰富,并且便于阅读的字符串表示。建议所有子类都覆盖此方法。

ObjecttoString 方法会返回一个字符串,其中包含类的名称(相应对象是此类的实例)、字符“@”,以及此对象哈希代码的无符号十六进制表示。也就是说,此方法所返回的字符串等于以下公式的值:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

返回值
String 对象的字符串表示。

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 的组合