已新增至 API 級別 34
Ad Services Extensions 4 也已納入

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

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public static final int MEASUREMENT_API_STATE_DISABLED

這個狀態表示 Measurement API 無法使用。叫用這些 API 會導致出現 UnsupportedOperationException

常數值:0 (0x00000000)

MEASUREMENT_API_STATE_ENABLED

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public static final int MEASUREMENT_API_STATE_ENABLED

這個狀態表示 Measurement API 已啟用。

常數值:1 (0x00000001)

公用方法

刪除註冊

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void deleteRegistrations (DeletionRequest deletionRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

刪除先前的註冊作業。如果刪除成功,系統會叫用回呼的 OutcomeReceiver.onResult(R),並設為空值。如果失敗,系統會透過回呼的 OutcomeReceiver#onError 傳送 Exception。成功和失敗意見回饋都會在提供的 Executor 上執行。

參數
deletionRequest DeletionRequest:刪除資料的要求。此值不能為 null

executor Executor:執行回呼的執行程式。此值不能為 null。 回呼和事件監聽器會透過這個 Executor 分派,讓您輕鬆控制使用哪一個執行緒。如要透過應用程式的主要執行緒進行事件分派,可以使用 Context.getMainExecutor()。否則,請提供會傳送至適當執行緒的 Executor

callback OutcomeReceiver:用來以非同步方式通知 API 結果。 此值不能為 null

get

已新增至 API 級別 34
Ad Services Extensions 6 也已納入
public static MeasurementManager get (Context context)

建立 MeasurementManager 執行個體的工廠方法。

參數
context Context:要使用的 Context 不能為 null

傳回
MeasurementManager MeasurementManager 執行個體 此值不能為 null

getMeasurementApi 狀態

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
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

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void registerSource (Uri attributionSource, 
                InputEvent inputEvent, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

登錄歸因來源 (點按或瀏覽)。
需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

參數
attributionSource Uri:平台會向這個 URI 發出要求,擷取與歸因來源相關聯的中繼資料。來源中繼資料會儲存在裝置上,以便與日後的觸發條件進行比對。此值不能為 null

inputEvent InputEventInputEvent 物件 (用於點擊事件) 或 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 不會處理任何重新導向,所有註冊網址都必須在要求中提供。
需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

參數
request SourceRegistrationRequest:應用程式來源登錄要求 此值不能為 null

executor Executor:回呼用於傳送結果 這個值可以是 null。 回呼和事件監聽器會透過這個 Executor 分派,讓您輕鬆控制使用哪一個執行緒。如要透過應用程式的主要執行緒進行事件分派,可以使用 Context.getMainExecutor()。否則,請提供會傳送至適當執行緒的 Executor

callback OutcomeReceiver:用來以非同步方式通知 API 結果 這個值可以是 null

RegisterTrigger

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
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

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void registerWebSource (WebSourceRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

從網頁內容中登錄歸因來源(點擊或瀏覽)。這個 API 不會處理任何重新導向,所有註冊網址都必須在要求中提供。必須提供至少一個 appDestination 或 webDestination 參數。如果註冊成功,叫用 callbackOutcomeReceiver#onResult 會以空值。如果失敗,系統會透過 callbackOutcomeReceiver.onError(E) 傳送 Exception。成功和失敗意見回饋都會在提供的 Executor 上執行。
需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

參數
request WebSourceRegistrationRequest:來源登錄要求 此值不能為 null

executor Executor:用於回呼傳送結果。這個值可以是 null

callback OutcomeReceiver:用來以非同步方式通知 API 結果。 這個值可以是 null

RegisterWebTrigger

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void registerWebTrigger (WebTriggerRegistrationRequest request, 
                Executor executor, 
                OutcomeReceiver<ObjectException> callback)

從網頁內容中登錄歸因觸發條件(點擊或瀏覽)。這個 API 不會處理任何重新導向,所有註冊網址都必須在要求中提供。如果註冊成功,叫用 callbackOutcomeReceiver#onResult 會以空值。如果失敗,系統會透過 callbackOutcomeReceiver.onError(E) 傳送 Exception。成功和失敗意見回饋都會在提供的 Executor 上執行。
需求:AdServicesPermissions.ACCESS_ADSERVICES_ATTRIBUTION

參數
request WebTriggerRegistrationRequest:觸發事件登錄要求 此值不能為 null

executor Executor:回呼用於傳送結果 這個值可以是 null

callback OutcomeReceiver:用來以非同步方式通知 API 結果 這個值可以是 null