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

カスタム オーディエンスが広告選択プロセスに参加したときに入札ロジックを取得するために使用されるターゲット URL を返します。

String getBuyer()

購入者は「buyerexample.com」という形式のドメインによって識別されます。

Uri getDailyUpdateUrl()

この URL は、デバイス上の広告選択プロセスで使用される最新の入札データと広告メタデータをホストする購入者運営のサーバーを指します。

Instant getExpirationTime()

有効期限を過ぎると、カスタム オーディエンスは、広告データや入札データの日次更新や、広告選択プロセスへの参加の対象から外れます。

String getName()

このカスタム オーディエンスの名前は、CustomAudience オブジェクトの作成時にオーナーと購入者が指定する不透明な文字列です。

String getOwner()

カスタム オーディエンスのオーナー アプリケーションを表す String、または呼び出し元アプリケーションを表す null を返します。

TrustedBiddingData getTrustedBiddingData()

信頼できる入札データは、購入者の入札データの信頼できるサーバーを指す URL と、サーバーへのクエリに使用するキーのリストで構成されます。

String getUserBiddingSignals()

ユーザー入札シグナルは、購入者によって提供され、隔離された実行環境での広告選択中に購入者提供の JavaScript で処理されます。

int hashCode()

CustomAudience オブジェクトのデータのハッシュを返します。

void writeToParcel(Parcel dest, int flags)

このオブジェクトを Parcel にフラット化します。

継承されるメソッド

フィールド

パブリック メソッド

equals

public boolean equals (Object o)

2 つの CustomAudience オブジェクトに同じ情報が含まれているかどうかを確認します。

パラメータ
o Object: 比較対象の参照オブジェクト。

戻り値
boolean このオブジェクトが obj 引数と同じである場合は true、それ以外の場合は false

getActivationTime

public Instant getActivationTime ()

CustomAudience オブジェクトの作成時に、遅延有効化を実現するために、有効化時刻を未来に設定することができます。たとえば、失効したユーザーのカスタム オーディエンスは、非アクティブのしきい値に達するまでアクティブにならないことがあり、その時点でカスタム オーディエンスの広告が広告選択プロセスに参加し、失効したユーザーを元のオーナー アプリケーションに転送する可能性があります。

有効化の最大遅延は、最初の作成から 1 年(365 日)です。

戻り値
Instant ミリ秒未満切り捨てのタイムスタンプであり、これ以降はカスタム オーディエンスがアクティブになります。この値は null の場合があります。

getAds

public List<AdData> getAds ()

この AdData オブジェクトのリストは、広告選択プロセス中にこの CustomAudience によって配信される広告の完全なリストです。

戻り値
List<AdData> 現在カスタム オーディエンスによって提供されている広告を表す AdData オブジェクトの List です。この値が null になることはありません。

getBiddingLogicUrl

public Uri getBiddingLogicUrl ()

カスタム オーディエンスが広告選択プロセスに参加したときに入札ロジックを取得するために使用されるターゲット URL を返します。URL には必ず HTTPS が使用されます。

戻り値
Uri この値が null になることはありません。

getBuyer

public String getBuyer ()

購入者は「buyerexample.com」という形式のドメインによって識別されます。

戻り値
String カスタム オーディエンスの購入者のドメインを含む文字列。この値が null になることはありません。

getDailyUpdateUrl

public Uri getDailyUpdateUrl ()

この URL は、デバイス上の広告選択プロセスで使用される最新の入札データと広告メタデータをホストする購入者運営のサーバーを指します。URL には必ず HTTPS が使用されます。

戻り値
Uri カスタム オーディエンスの日次更新 URL です。この値が null になることはありません。

getExpirationTime

public Instant getExpirationTime ()

有効期限を過ぎると、カスタム オーディエンスは、広告データや入札データの日次更新や、広告選択プロセスへの参加の対象から外れます。カスタム オーディエンスは、次回の日次更新の際にメモリから削除されます。

CustomAudience の作成時に有効期限が指定されていない場合は、期限は有効化から 60 日に設定されます。

最大有効期限は、最初の有効化から 1 年(365 日)です。

戻り値
Instant ミリ秒未満切り捨てのタイムスタンプであり、これ以降はカスタム オーディエンスを削除する必要があります。この値は null の場合があります。

getName

public String getName ()

このカスタム オーディエンスの名前は、CustomAudience オブジェクトの作成時にオーナーと購入者が指定する不透明な文字列です。

戻り値
String カスタム オーディエンスの名前(String)。この値が null になることはありません。

getOwner

public String getOwner ()

カスタム オーディエンスのオーナー アプリケーションを表す String、または呼び出し元アプリケーションを表す null を返します。

値の形式は <アプリの UID>-<パッケージ名> にする必要があります。

戻り値
String

getTrustedBiddingData

public TrustedBiddingData getTrustedBiddingData ()

信頼できる入札データは、購入者の入札データの信頼できるサーバーを指す URL と、サーバーへのクエリに使用するキーのリストで構成されます。これらのキーは、カスタム オーディエンスと広告選択 API に対しては不透明です。

戻り値
TrustedBiddingData カスタム オーディエンスの信頼できる入札データを含む TrustedBiddingData オブジェクト。この値は null の場合があります。

getUserBiddingSignals

public String getUserBiddingSignals ()

ユーザー入札シグナルは、購入者によって提供され、隔離された実行環境での広告選択中に購入者提供の JavaScript で処理されます。これらのシグナルは、文字列にシリアル化された有効な JSON オブジェクトとして表す必要があります。

ユーザーの入札シグナルが、購入者の JS で処理できる有効な JSON オブジェクトでない場合、カスタム オーディエンスは広告選択の対象となりません。

戻り値
String カスタム オーディエンスのユーザー入札シグナルを表す JSON String。この値は 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 です。値は、0 か、Parcelable.PARCELABLE_WRITE_RETURN_VALUE と android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES の組み合わせのいずれかです。