Менеджер защищенных сигналов
public class ProtectedSignalsManager
extends Object
java.lang.Объект | |
↳ | android.adservices.signals.ProtectedSignalsManager |
ProtectedSignalsManager предоставляет API для приложений и рекламных SDK для управления их защищенными сигналами.
Краткое содержание
Публичные методы | |
---|---|
static ProtectedSignalsManager | get ( Context context) Фабричный метод для создания экземпляра ProtectedSignalsManager. |
void | updateSignals ( UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver < Object , Exception > receiver) API updateSignals получит JSON из URI, который описывает, какие сигналы нужно добавить или удалить. |
Унаследованные методы | |
---|---|
Публичные методы
получать
public static ProtectedSignalsManager get (Context context)
Фабричный метод для создания экземпляра ProtectedSignalsManager.
Параметры | |
---|---|
context | Context : используемый Context . Это значение не может быть null . |
Возврат | |
---|---|
ProtectedSignalsManager | Экземпляр ProtectedSignalsManager . Это значение не может быть null . |
обновлениесигналы
public void updateSignals (UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
API updateSignals получит JSON из URI, который описывает, какие сигналы нужно добавить или удалить. Этот API также позволяет зарегистрировать конечную точку кодировщика. Конечная точка используется для загрузки логики кодирования, которая позволяет кодировать сигналы.
Ключи верхнего уровня для JSON должны соответствовать одной из 5 команд:
«put» — добавляет новый сигнал, перезаписывая любые существующие сигналы с тем же ключом. Значением для этого является объект JSON, где ключи представляют собой строки в базе 64, соответствующие вводимому ключу, а значения представляют собой строку в базе 64, соответствующую вставляемому значению.
«append» — добавляет новый сигнал/сигналы к временному ряду сигналов, удаляя самые старые сигналы, чтобы освободить место для новых, если размер ряда превышает заданный максимум. Значением для этого является объект JSON, где ключи представляют собой строки в кодировке Base 64, соответствующие ключу, к которому нужно добавить, а значения — это объекты с двумя полями: «values» и «maxSignals» . «Значения» — это список строк в базе 64, соответствующих значениям сигналов, которые нужно добавить к временному ряду. «maxSignals» — это максимальное количество значений, разрешенных в этой временной серии. Если текущее количество сигналов, связанных с ключом, превышает maxSignals, самые старые сигналы будут удалены. Обратите внимание, что вы можете добавить к ключу, добавленному командой put. Это не значит, что добавление большего количества значений, чем максимальное, приведет к сбою.
«put_if_not_present» — добавляет новый сигнал только в том случае, если нет существующих сигналов с таким же ключом. Значением для этого является объект JSON, где ключи представляют собой строки в базе 64, соответствующие вводимому ключу, а значения представляют собой строку в базе 64, соответствующую вставляемому значению.
"remove" - Удаляет сигнал для ключа. Значением этого параметра является список строк в базе 64, соответствующих ключам сигналов, которые следует удалить.
«update_encoder» — предоставляет действие для обновления конечной точки и URI, который можно использовать для получения логики кодирования. Подключом для предоставления действия обновления является «действие», и в настоящее время поддерживаются следующие значения:
- «РЕГИСТРАЦИЯ»: регистрирует конечную точку кодировщика, если она указана впервые, или перезаписывает существующую с новой предоставленной конечной точкой. Для действия «РЕГИСТРАЦИЯ» необходимо предоставить «конечную точку».
Подключом для предоставления конечной точки кодировщика является «конечная точка», а значением является строка URI для конечной точки.
Ключом можно управлять только одной командой в формате JSON. Если две команды попытаются работать с одним и тем же ключом, этот метод выполнит IllegalArgumentException
Этот вызов завершается с ошибкой SecurityException
, если
-
ownerPackageName
не вызывает имя пакета приложения и/или - покупатель не имеет права использовать API.
Этот вызов завершается с ошибкой IllegalArgumentException
, если
- JSON, полученный с сервера, недействителен.
- Предоставленный URI недействителен.
Этот вызов завершается с ошибкой LimitExceededException
если вызывающий пакет превышает допустимые пределы скорости и регулируется.
Этот вызов завершается с ошибкой IllegalStateException
, если возникает внутренняя ошибка службы.
Требуется AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
.
Параметры | |
---|---|
updateSignalsRequest | UpdateSignalsRequest : это значение не может быть null . |
executor | Executor : Это значение не может быть null . События обратного вызова и прослушивателя отправляются через этот Executor , предоставляя простой способ контролировать, какой поток используется. Чтобы отправлять события через основной поток вашего приложения, вы можете использовать Context.getMainExecutor() . В противном случае предоставьте Executor , который отправляет данные в соответствующий поток. |
receiver | OutcomeReceiver : это значение не может быть null . |