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)

2 つの 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 で追加
Ad Services Extensions 4 にも追加 
public static final Creator<CustomAudience> CREATOR

パブリック メソッド

次と等しい

API レベル 34 で追加されました 
public boolean equals (Object o)

2 つの 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> 現在カスタム オーディエンスによって配信されている広告を表す AdData オブジェクトの List。この値が 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 の組み合わせのいずれかです。