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 getBiddingLogicUrl()

當自訂目標對象參與廣告選擇程序時,回傳用於擷取出價邏輯的目標網址。

String getBuyer()

以「buyerexample.com」的格式依網域辨識買家。

Uri getDailyUpdateUrl()

此網址會指向買家營運的伺服器,代管要於裝置端廣告選擇程序中使用的更新出價資料和廣告中繼資料。

Instant getExpirationTime()

超過有效期限後,自訂目標對象就不再符合資格,無法取得每日廣告/出價資料更新或參加廣告選擇程序。

String getName()

自訂目標對象的名稱是擁有者和買家在建立 CustomAudience 物件時提供的不透明字串。

String getOwner()

回傳代表自訂目標對象擁有者應用程式的字串,或傳回空值以代表呼叫應用程式。

TrustedBiddingData getTrustedBiddingData()

受信任的出價資料由指向提供買家出價資料的受信任伺服器,以及向伺服器查詢的索引鍵清單組成。

String getUserBiddingSignals()

使用者出價信號是由買家提供,以在廣告選擇期間,於獨立的執行環境中由買家提供的 JavaScript 消耗。

int hashCode()

回傳 CustomAudience 物件資料的雜湊。

void writeToParcel(Parcel dest, int flags)

壓平合併此物件並加入至 Parcel。

沿用的方法

欄位

公用方法

等於

public boolean equals (Object o)

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

參數
o Object:要用來比較的參照物件。

回傳
boolean 如果此物件與 obj 引數相同,會傳回 true,否則傳回 false

getActivationTime

public Instant getActivationTime ()

建立 CustomAudience 物件時,可設定未來的啟用時間以完成延遲啟用。舉例來說,很久沒有使用的使用者可能會在達到閒置的門檻時才會啟用,此時自訂目標對象的廣告將參與廣告選擇程序,因此可能會將很久沒有使用的使用者重新導向至原始擁有者的應用程式。

啟用的最長延遲時間為初次建立後一年 (365 天)。

回傳
Instant 時間戳記 (縮短至毫秒),之後自訂目標對象為已啟用。 這個值可以是 null

getAds

public List<AdData> getAds ()

AdData 物件清單會列出此 CustomAudience 在廣告選擇程序期間放送的完整廣告清單。

回傳
List<AdData> 代表自訂目標對象目前放送廣告的 List 個物件 (共 AdData 個) 此值不能為 null

getBiddingLogicUrl

public Uri getBiddingLogicUrl ()

當自訂目標對象參與廣告選擇程序時,回傳用於擷取出價邏輯的目標網址。網址必須使用 HTTPS。

回傳
Uri 此值不能為 null

getBuyer

public String getBuyer ()

以「buyerexample.com」的格式依網域辨識買家。

回傳
String 包含自訂目標對象買家網域的字串 此值不能為 null

getDailyUpdateUrl

public Uri getDailyUpdateUrl ()

此網址會指向買家營運的伺服器,代管要於裝置端廣告選擇程序中使用的更新出價資料和廣告中繼資料。網址必須使用 HTTPS。

回傳
Uri 自訂目標對象的每日更新網址 此值不能為 null

getExpirationTime

public Instant getExpirationTime ()

超過有效期限後,自訂目標對象就不再符合資格,無法取得每日廣告/出價資料更新或參加廣告選擇程序。之後,自訂目標對象會在下次每日更新時從記憶體中刪除。

建立 CustomAudience 時,如果沒有提供到期時間,則到期時間會預設為啟用後的 60 天。

到期時間最長為初次啟動後的一年 (365 天)。

回傳
Instant 時間戳記 (縮短至毫秒),之後自訂目標對象就會移除; 這個值可以是 null

getName

public String getName ()

自訂目標對象的名稱是擁有者和買家在建立 CustomAudience 物件時提供的不透明字串。

回傳
String 自訂目標對象的字串名稱 此值不能為 null

getOwner

public String getOwner ()

回傳代表自訂目標對象擁有者應用程式的字串,或傳回空值以代表呼叫應用程式。

值的格式為 <應用程式 UID>-<套件名稱>。

回傳
String

getTrustedBiddingData

public TrustedBiddingData getTrustedBiddingData ()

受信任的出價資料由指向提供買家出價資料的受信任伺服器,以及向伺服器查詢的索引鍵清單組成。請注意,自訂目標對象和廣告選擇 API 中的索引鍵不透明。

回傳
TrustedBiddingData 包含自訂目標對象受信任出價資料的 TrustedBiddingData 物件 這個值可以是 null

getUserBiddingSignals

public String getUserBiddingSignals ()

使用者出價信號是由買家提供,以在廣告選擇期間,於獨立的執行環境中由買家提供的 JavaScript 消耗。這些信號應以字串中序列化的有效 JSON 物件表示。

如果使用者出價信號不是有效的 JSON 物件,無法由買家的 JS 消耗,那麼自訂目標對象將不符合廣告選擇的資格。

回傳
String JSON 字串,代表自訂目標對象的使用者出價信號 這個值可以是 null

hashCode

public int hashCode ()

回傳 CustomAudience 物件資料的雜湊。

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

writeToParcel

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