API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加
概要: メソッド | 継承されるメソッド

CustomAudienceManager

public class CustomAudienceManager
extends Object

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

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

概要

パブリック メソッド

void fetchAndJoinCustomAudience(FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)

fetchUri から取得した CustomAudience にユーザーを追加します。

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)

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

継承されるメソッド

パブリック メソッド

fetchAndJoinCustomAudience

public void fetchAndJoinCustomAudience (FetchAndJoinCustomAudienceRequest fetchAndJoinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

fetchUri から取得した CustomAudience にユーザーを追加します。

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

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

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

  1. ownerPackageName がアプリのパッケージ名を呼び出していない
  2. 購入者に API の使用権限がありません。

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

  1. 呼び出し元アプリケーションによってストレージ上限を超えている、または
  2. 指定された CustomAudience 内の URI パラメータは、 CustomAudience の購入者。

この呼び出しは、呼び出し元のパッケージがLimitExceededException スロットリングされます。

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

パラメータ
fetchAndJoinCustomAudienceRequest FetchAndJoinCustomAudienceRequest: この値を null にすることはできません。
executor Executor: この値を null にすることはできません。 コールバック イベントとリスナー イベントは、この Executor: どのスレッドを表示するかを簡単に制御できます。 分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、 作成する場合は、 Context.getMainExecutor()。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。
receiver OutcomeReceiver: この値を null にすることはできません。

get

API レベル 34 で追加されました。
Ad Services Extensions 6 にも追加されました。 
public static CustomAudienceManager get (Context context)

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

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

getTestCustomAudienceManager

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
public TestCustomAudienceManager getTestCustomAudienceManager ()

テスト対応 API を使用してサービスを作成する

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

JoinCustomAudience

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
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 にすることはできません。 コールバック イベントとリスナー イベントは、この Executor: どのスレッドを表示するかを簡単に制御できます。 分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、 作成する場合は、 Context.getMainExecutor()。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。
receiver OutcomeReceiver: この値を null にすることはできません。

LeaveCustomAudience

API レベル 34 で追加されました。
Ad Services Extensions 4 にも追加 
public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<Object, Exception> receiver)

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

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

  1. ownerPackageName がアプリのパッケージ名を呼び出していないおよび/または
  2. 購入者に API の使用権限がありません。

この呼び出しは、呼び出し元のパッケージがLimitExceededException スロットリングされます。

この呼び出しでは、指定されたカスタム オーディエンスが存在するかどうかは呼び出し元に通知されません。 オンデバイスストレージです言い換えると、購入者が離脱しようとしても通知なしで失敗します。 未参加のカスタム オーディエンスです。
AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE が必要です

パラメータ
leaveCustomAudienceRequest LeaveCustomAudienceRequest: この値を null にすることはできません。
executor Executor: この値を null にすることはできません。 コールバック イベントとリスナー イベントは、この Executor: どのスレッドを表示するかを簡単に制御できます。 分析できますアプリケーションのメインスレッドを介してイベントをディスパッチするには、 作成する場合は、 Context.getMainExecutor()。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。
receiver OutcomeReceiver: この値を null にすることはできません。