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

繼承方法

Object clone()

建立並傳回此物件的副本。

boolean equals(Object obj)

指出是否有其他物件「等於」這個。

void finalize()

在垃圾收集作業時,垃圾收集器會呼叫該物件上的 判斷物件沒有其他參照

final Class<?> getClass()

傳回此 Object 的執行階段類別。

int hashCode()

傳回該物件的雜湊碼值。

final void notify()

喚醒目前等待這個物件的 監控功能

final void notifyAll()

喚醒所有等待此物件監控器的執行緒。

String toString()

傳回該物件的字串表示法。

final void wait(long timeoutMillis, int nanos)

讓目前的執行緒等待,直到遭到喚醒為止。 通知中斷, 是否經過一定的即時效能

final void wait(long timeoutMillis)

讓目前的執行緒等待,直到遭到喚醒為止。 通知中斷, 是否經過一定的即時效能

final void wait()

讓目前的執行緒等待,直到遭到喚醒為止。 通知受到干擾

公用方法

擷取 AndJoinCustomAudience

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