自訂目標對像管理工具

public class CustomAudienceManager
extends Object

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


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

摘要

公用方法

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 資料,從自訂目標對像中移除使用者。

繼承方法

公用方法

領取

public static CustomAudienceManager get (Context context)

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

參數
context Context:要使用的這個值的 Context 不得為 null

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

getTestCustomAudienceManager

public TestCustomAudienceManager getTestCustomAudienceManager ()

使用啟用測試功能的 API 建立服務

傳回
TestCustomAudienceManager 此值不能為 null

加入自訂目標對象

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
receiver OutcomeReceiver:此值不能為 null

deCustomAudience

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
receiver OutcomeReceiver:此值不能為 null