CustomAudienceManager

public class CustomAudienceManager
extends Object

java.lang.Object
   ↳ android.adservices.customaudience.CustomAudienceManager

CustomAudienceManager には、アプリと広告 SDK で、カスタム オーディエンスへの参加やそこからの脱退を行うための API が用意されています。

まとめ

パブリック メソッド

static CustomAudienceManager get(Context context)

CustomAudienceManager のインスタンスを作成するためのファクトリ メソッド。

TestCustomAudienceManager getTestCustomAudienceManager()

テストを有効にする API を使用してサービスを作成する
void joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

指定された CustomAudience にユーザーを追加します。

void leaveCustomAudience(LeaveCustomAudienceRequest leaveCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

既存の CustomAudience データ（ownerPackageName、buyer、name で識別）を削除して、カスタム オーディエンスからユーザーを削除しようとします。

継承されるメソッド

パブリック メソッド

get

public static CustomAudienceManager get (Context context)

CustomAudienceManager のインスタンスを作成するためのファクトリ メソッド。

パラメータ
context Context: 使用する Context。この値が null になることはありません。
戻り値
CustomAudienceManager CustomAudienceManager インスタンス。この値が null になることはありません。

getTestCustomAudienceManager

public TestCustomAudienceManager getTestCustomAudienceManager ()

テストを有効にする API を使用してサービスを作成する

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

JoinCustomAudience

public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

指定された CustomAudience にユーザーを追加します。

ownerPackageName、buyer、name の同じ組み合わせでユーザーをカスタム オーディエンスに登録しようとすると、既存のカスタム オーディエンスの情報（広告データのリストなど）が上書きされます。

広告リストは、毎日のバックグラウンド取得ジョブによって完全に上書きされる可能性があります。

次の場合、この呼び出しは SecurityException で失敗します。

  1. ownerPackageName がアプリのパッケージ名を呼び出していない、または
  2. 購入者に API の使用許可がない。

次の場合、この呼び出しは IllegalArgumentException で失敗します。

  1. 呼び出し元のアプリが保存容量の上限を超えている、または
  2. 指定された CustomAudience 内の URI パラメータが、CustomAudience 購入者で認証されていない。

呼び出し元パッケージが許可されたレート制限を超えて、スロットリングされている場合、この呼び出しは LimitExceededException で失敗します。

内部サービスエラーが発生した場合、この呼び出しは IllegalStateException で失敗します。
必須: AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

パラメータ
joinCustomAudienceRequest JoinCustomAudienceRequest: この値を null にすることはできません。
executor Executor: この値を null にすることはできません。
receiver OutcomeReceiver: この値を null にすることはできません。

LeaveCustomAudience

public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

既存の CustomAudience データ（ownerPackageName、buyer、name で識別される）を削除して、カスタム オーディエンスからユーザーを削除しようとします。

次の場合、この呼び出しは SecurityException で失敗します。

  1. ownerPackageName がアプリのパッケージ名を呼び出していない、または
  2. 購入者に API の使用許可がない。

呼び出し元パッケージが許可されたレート制限を超えて、スロットリングされている場合、この呼び出しは LimitExceededException で失敗します。

この呼び出しは、指定したカスタム オーディエンスがデバイス上のストレージに存在したかどうかを呼び出し元に通知しません。つまり、購入者が参加していないカスタム オーディエンスから離れようとすると、通知なく失敗します。
必須: AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE

パラメータ
leaveCustomAudienceRequest LeaveCustomAudienceRequest: この値を null にすることはできません。
executor Executor: この値を null にすることはできません。
receiver OutcomeReceiver: この値を null にすることはできません。