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。

繼承方法

欄位

創作者

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public static final Creator<AdData> CREATOR

公用方法

等於

已在 API 級別 34 中新增。
public boolean equals (Object o)

檢查兩個 AdData 物件是否包含相同的資訊。

參數
o Object：要用來比較的參照物件。
傳回
boolean 如果此物件與 obj 引數相同，會傳回 true，否則傳回 false。

getAdCounterKey

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
Ad Services Extensions 4 也已納入 
public String getMetadata ()

取得廣告選擇程序期間使用的買家廣告中繼資料。

中繼資料必須是以字串序列化的有效 JSON 物件。中繼資料代表廣告專屬的出價資訊，會在廣告選擇期間用於產生出價，並在買方 JavaScript 邏輯中使用。買方 JavaScript 邏輯是在獨立的執行環境中執行。

如果中繼資料不是買家 JS 可消耗的有效 JSON 物件，廣告就不符合廣告選擇的資格。

傳回
String 此值不能為 null。

getRenderUri

已新增至 API 級別 34
Ad Services Extensions 4 也已納入 
public Uri getRenderUri ()

取得指向廣告算繪素材資源的 URI。URI 必須採用 HTTPS。

傳回
Uri 此值不能為 null。

hashCode

已在 API 級別 34 中新增。
public int hashCode ()

傳回 AdData 物件資料的雜湊。

傳回
int 此物件的雜湊碼值。

toString

已在 API 級別 34 中新增。
public String toString ()

傳回該物件的字串表示法。一般來說，toString 方法會「以文字方式代表」這個物件的字串。顯示的結果應簡明扼要，並提供方便使用者閱讀的豐富資訊。建議所有子類別都覆寫此方法。

類別 Object 的 toString 方法會傳回一個字串，當中包含由物件為執行個體的類別名稱、標誌字元「@」，以及物件雜湊程式碼的未簽署十六進位表示法。換句話說，此方法會傳回等於下列值的字串：

 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。值可以是 0 或 Parcelable.PARCELABLE_WRITE_RETURN_VALUE 的組合，以及 android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES