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

CustomAudienceManager

public class CustomAudienceManager
extends Object

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


CustomAudienceManager 提供應用程式和 ad-SDK 使用的 API 以加入/退出自訂目標對象。

摘要

公用方法

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

將使用者新增至從 fetchUri 擷取的 CustomAudience

static CustomAudienceManager get(Context context)

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

TestCustomAudienceManager getTestCustomAudienceManager()

使用測試啟用 API 建立服務

void joinCustomAudience(JoinCustomAudienceRequest joinCustomAudienceRequest, Executor executor, OutcomeReceiver<ObjectException> receiver)

將使用者新增至指定的 CustomAudience

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

嘗試刪除自訂目標對象的使用者,方法是刪除以 ownerPackageNamebuyername 識別的任何現有 CustomAudience 資料。

繼承方法

公用方法

FetchAnd 加入 CustomAudience

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

將使用者新增至從 fetchUri 擷取的 CustomAudience

如果嘗試為使用者註冊含有相同 ownerPackageNamebuyername 組合的自訂目標對象,會導致現有自訂目標對象的資訊遭到覆寫,包括廣告資料清單。

請注意,每日背景擷取工作可能會完全覆寫廣告清單。

如果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

加入 CustomAudience

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void joinCustomAudience (JoinCustomAudienceRequest joinCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

將使用者新增至指定的 CustomAudience

如果嘗試為使用者註冊含有相同 ownerPackageNamebuyername 組合的自訂目標對象,會導致現有自訂目標對象的資訊遭到覆寫,包括廣告資料清單。

請注意,每日背景擷取工作可能會完全覆寫廣告清單。

如果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

離開自訂目標對象

已新增至 API 級別 34
Ad Services Extensions 4 也已納入
public void leaveCustomAudience (LeaveCustomAudienceRequest leaveCustomAudienceRequest, 
                Executor executor, 
                OutcomeReceiver<ObjectException> receiver)

嘗試刪除自訂目標對象的使用者,方法是刪除以 ownerPackageNamebuyername 識別的任何現有 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