MeasurementManager

public class MeasurementManager
extends Object

java.lang.Object
   ↳ android.adservices.measurement.MeasurementManager


MeasurementManager は、ソースとトリガーの登録を管理するための API を提供します。

まとめ

定数

int MEASUREMENT_API_STATE_DISABLED

この状態は、Measurement API が利用できないことを示します。

int MEASUREMENT_API_STATE_ENABLED

この状態は、Measurement API が有効であることを示します。

パブリック メソッド

void deleteRegistrations(DeletionRequest deletionRequest, Executor executor, OutcomeReceiver<ObjectException> callback)

以前の登録を削除します。

static MeasurementManager get(Context context)

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

void getMeasurementApiStatus(Executor executor, OutcomeReceiver<IntegerException> callback)

Measurement API のステータスを取得します。

void registerSource(Uri attributionSource, InputEvent inputEvent, Executor executor, OutcomeReceiver<ObjectException> callback)

アトリビューション ソース(クリックまたはビュー)を登録します。

void registerSource(SourceRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

アプリのコンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。

void registerTrigger(Uri trigger, Executor executor, OutcomeReceiver<ObjectException> callback)

トリガー(コンバージョン)を登録します。

void registerWebSource(WebSourceRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

ウェブ コンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。

void registerWebTrigger(WebTriggerRegistrationRequest request, Executor executor, OutcomeReceiver<ObjectException> callback)

ウェブ コンテキストからアトリビューション トリガー(クリックまたはビュー)を登録します。

継承されるメソッド

定数

MEASUREMENT_API_STATE_DISABLED

public static final int MEASUREMENT_API_STATE_DISABLED

この状態は、Measurement API が利用できないことを示します。これらの呼び出しは UnsupportedOperationException になります。

定数値: 0 (0x00000000)

MEASUREMENT_API_STATE_ENABLED

public static final int MEASUREMENT_API_STATE_ENABLED

この状態は、Measurement API が有効であることを示します。

定数値: 1 (0x00000001)

パブリック メソッド

deleteRegistrations

public void deleteRegistrations (DeletionRequest deletionRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

以前の登録を削除する。削除に成功すると、コールバックの OutcomeReceiver.onResult(R) が null で呼び出されます。失敗した場合は、コールバックの OutcomeReceiver#onError を介して Exception が送信されます。成功と失敗の両方のフィードバックが、指定された Executor に対して実行されます。

パラメータ
deletionRequest DeletionRequest: データ削除リクエスト。この値が null になることはありません。

executor Executor: コールバックを実行するエグゼキュータ。 この値が null になることはありません。 コールバック イベントとリスナー イベントは、この Executor を介してディスパッチされるため、使用されるスレッドを簡単に制御できます。アプリのメインスレッドからイベントをディスパッチするには、Context.getMainExecutor() を使用します。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。

callback OutcomeReceiver: API の結果を非同期で通知します。 この値が null になることはありません。

get

public static MeasurementManager get (Context context)

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

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

戻り値
MeasurementManager MeasurementManager インスタンス。この値が null になることはありません。

getMeasurementApiStatus

public void getMeasurementApiStatus (Executor executor, 
                OutcomeReceiver<IntegerException> callback)

Measurement API のステータスを取得します。

コールバックの Integer 値は MeasurementApiState のいずれかです。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値が null になることはありません。 コールバック イベントとリスナー イベントは、この Executor を介してディスパッチされるため、使用されるスレッドを簡単に制御できます。アプリのメインスレッドからイベントをディスパッチするには、Context.getMainExecutor() を使用します。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。

callback OutcomeReceiver: API の結果を非同期で通知します。 この値が null になることはありません。

registerSource

public void registerSource (Uri attributionSource, 
                InputEvent inputEvent, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

アトリビューション ソース(クリックまたはビュー)を登録します。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
attributionSource Uri: プラットフォームは、アトリビューション ソースに関連付けられたメタデータを取得するために、この URI に対してリクエストを発行します。ソース メタデータはデバイスに保存されるため、将来のトリガーに一致させることができます。この値が null になることはありません。

inputEvent InputEvent: InputEvent オブジェクト(クリック イベントの場合)または null(ビューイベントの場合)のいずれか。

executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値は null の場合があります。コールバック イベントとリスナー イベントは、この Executor を介してディスパッチされるため、使用されるスレッドを簡単に制御できます。アプリのメインスレッドからイベントをディスパッチするには、Context.getMainExecutor() を使用します。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。

callback OutcomeReceiver: API の結果を非同期で通知します。この値は null であっても構いません。

例外
IllegalArgumentException attributionSource のスキームが HTTPS でない場合

registerSource

public void registerSource (SourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

アプリのコンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。この API はリダイレクトを処理しません。リクエストですべての登録 URL を指定する必要があります。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
request SourceRegistrationRequest: アプリソース登録リクエスト。この値が null になることはありません。

executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値は null の場合があります。コールバック イベントとリスナー イベントは、この Executor を介してディスパッチされるため、使用されるスレッドを簡単に制御できます。アプリのメインスレッドからイベントをディスパッチするには、Context.getMainExecutor() を使用します。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。

callback OutcomeReceiver: API の結果を非同期で通知します。この値は null の場合があります。

registerTrigger

public void registerTrigger (Uri trigger, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

トリガー(コンバージョン)を登録します。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
trigger Uri: API は、トリガーに関連付けられたメタデータを取得するために、この URI に対してリクエストを発行します。トリガー メタデータはデバイス上に保存され、アトリビューション プロセス中にソースと照合できます。この値が null になることはありません。

executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値は null の場合があります。コールバック イベントとリスナー イベントは、この Executor を介してディスパッチされるため、使用されるスレッドを簡単に制御できます。アプリのメインスレッドからイベントをディスパッチするには、Context.getMainExecutor() を使用します。 それ以外の場合は、適切なスレッドにディスパッチする Executor を提供します。

callback OutcomeReceiver: API の結果を非同期で通知します。この値は null であっても構いません。

例外
IllegalArgumentException trigger のスキームが HTTPS でない場合

registerWebSource

public void registerWebSource (WebSourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

ウェブ コンテキストからアトリビューション ソース(クリックまたはビュー)を登録します。この API はリダイレクトを処理しません。リクエストですべての登録 URL を指定する必要があります。appDestination パラメータまたは webDestination パラメータのうち少なくとも 1 つを指定する必要があります。登録が成功すると、callbackOutcomeReceiver#onResult が null で呼び出されます。失敗した場合、ExceptioncallbackOutcomeReceiver.onError(E) を介して送信されます。成功と失敗の両方のフィードバックが、指定された Executor に対して実行されます。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
request WebSourceRegistrationRequest: ソース登録リクエスト。この値が null になることはありません。

executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値は null であっても構いません。

callback OutcomeReceiver: API の結果を非同期で通知します。 この値は null であっても構いません。

registerWebTrigger

public void registerWebTrigger (WebTriggerRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

ウェブ コンテキストからアトリビューション トリガー(クリックまたはビュー)を登録します。この API はリダイレクトを処理しません。リクエストですべての登録 URL を指定する必要があります。登録が成功すると、callbackOutcomeReceiver#onResult が null で呼び出されます。失敗した場合、ExceptioncallbackOutcomeReceiver.onError(E) を介して送信されます。成功と失敗の両方のフィードバックが、指定された Executor に対して実行されます。
必須: AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

パラメータ
request WebTriggerRegistrationRequest: トリガー登録リクエスト。この値が null になることはありません。

executor Executor: 結果をディスパッチするためにコールバックで使用されます。この値は null の場合があります。

callback OutcomeReceiver: API の結果を非同期で通知します。この値は null の場合があります。