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 物件的結構。

TrustedBiddingData getTrustedBiddingData()

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

AdSelectionSignals getUserBiddingSignals()

使用者出價信號是由買方選擇性提供,用於買方提供的信號 隔離執行環境中的廣告選擇期間的 JavaScript。

int hashCode()

傳回 CustomAudience 物件資料的雜湊。

void writeToParcel(Parcel dest, int flags)

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

繼承方法

欄位

CREATOR

已加至 API 級別 34
也已納入 Ad Services Extensions 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
也已納入 Ad Services Extensions 4
public Instant getActivationTime ()

建立 CustomAudience 物件時,可選擇設定未來的啟用時間,從而延後啟用。如果不設定這個欄位,則會在加入時啟用 CustomAudience

舉例來說,很久沒有使用的使用者可能會在達到閒置的門檻時才會啟用,此時自訂目標對象的廣告將參與廣告選擇程序,因此可能會將很久沒有使用的使用者重新導向至原始擁有者的應用程式。

啟用延遲時間最長為從初始建立算起 60 天。

指定時,啟用時間必須早於到期時間。

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

getAds

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public List<AdData> getAds ()

這個 AdData 物件清單是一份完整的廣告清單,當中會列出此 CustomAudience 在廣告選擇程序中提供的所有廣告。

如未指定或提供空白清單,CustomAudience 將不會參與廣告選擇流程,而是透過自訂目標對象的每日更新作業,提供有效的廣告清單。

傳回
List<AdData> AdDataList 物件,代表目前由 自訂目標對象 此值不能為 null

getBiddingLogicUri

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public Uri getBiddingLogicUri ()

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

傳回
Uri 用於擷取買方出價邏輯的 URI 此值不能為 null

getBuyer

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public AdTechIdentifier getBuyer ()

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

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

getDailyUpdateUri

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public Uri getDailyUpdateUri ()

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

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

getExpirationTime

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public Instant getExpirationTime ()

有效期限過後,自訂目標對象的每日廣告/出價資料就會停止更新,自訂目標對象也將不再參與廣告選擇程序。之後,自訂目標對象會在下次每日更新時從記憶體中刪除。

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

有效期限為從初次啟用起算的 60 天。

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

getName

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public String getName ()

自訂目標對象的名稱是擁有者和買方在建立 CustomAudience 物件時提供的任意字串。

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

getTrustedBiddingData

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public TrustedBiddingData getTrustedBiddingData ()

受信任的出價資料包含指向受信任伺服器 (提供買方出價資料) 的 URI,以及用於向伺服器查詢的索引鍵清單。請注意,金鑰是任意 ID,只會在廣告選取期間,用於查詢受信任伺服器尋找買家的出價邏輯。

如未指定,CustomAudience 會透過自訂目標對象的每日更新提供可靠的出價資料,之後才能參與廣告選擇。

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

getUserBiddingSignals

已加至 API 級別 34
也已納入 Ad Services Extensions 4
public AdSelectionSignals getUserBiddingSignals ()

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

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

如未指定,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