ProtectedSignalsManager
public
class
ProtectedSignalsManager
extends Object
java.lang.Object | |
↳ | android.adservices.signals.ProtectedSignalsManager |
ProtectedSignalsManager udostępnia interfejsy API dla aplikacji i pakietów SDK do wyświetlania reklam, które umożliwiają zarządzanie zabezpieczonymi sygnałami.
Podsumowanie
Metody publiczne | |
---|---|
static
ProtectedSignalsManager
|
get(Context context)
Fabryczna metoda tworzenia instancji ProtectedSignalsManager. |
void
|
updateSignals(UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
Interfejs updateSignals API pobierze z identyfikatora URI dane w formacie JSON określające, które sygnały należy dodać lub usunąć. |
Metody dziedziczone | |
---|---|
Metody publiczne
odbierz
public static ProtectedSignalsManager get (Context context)
Metoda fabryczna służąca do tworzenia instancji ProtectedSignalsManager.
Parametry | |
---|---|
context |
Context : Context do użycia
Ta wartość nie może być null . |
Zwroty | |
---|---|
ProtectedSignalsManager |
wystąpienie ProtectedSignalsManager
Ta wartość nie może być null . |
zaktualizuj sygnały
public void updateSignals (UpdateSignalsRequest updateSignalsRequest, Executor executor, OutcomeReceiver<Object, Exception> receiver)
Interfejs updateSignals API pobierze z identyfikatora URI kod JSON opisujący, które sygnały należy dodać lub usunąć. Ten interfejs API umożliwia też rejestrowanie punktu końcowego kodera. Punkt końcowy służy do pobierania logiki kodowania, która umożliwia kodowanie sygnałów.
Klucze najwyższego poziomu w pliku JSON muszą odpowiadać jednemu z tych 5 poleceń:
„put” – dodaje nowy sygnał, zastępując wszystkie istniejące sygnały o tym samym kluczu. Jego wartością jest obiekt JSON, w którym klucze to ciągi znaków w standardzie Base64 odpowiadające kluczowi, dla którego ma zostać wykonana operacja put, a wartości to ciągi znaków w standardzie Base64 odpowiadające wartościom, które mają zostać zapisane.
„append” (dołączanie) – dołącza nowe sygnały do serii czasowych sygnałów, usuwając najstarsze sygnały, aby zrobić miejsce dla nowych, jeśli rozmiar serii przekroczy podany limit. Jego wartością jest obiekt JSON, w którym klucze to ciągi znaków w standardzie Base64 odpowiadające kluczowi do dołączenia, a wartości to obiekty z 2 polami: „values” i „maxSignals”. „values” to lista ciągów w formacie Base64 odpowiadających wartościom sygnału, które mają zostać dołączone do serii czasowej. „maxSignals” to maksymalna liczba wartości dozwolonych w tej serii czasowej. Jeśli obecna liczba sygnałów powiązanych z kluczem przekroczy wartość maxSignals, najstarsze sygnały zostaną usunięte. Pamiętaj, że możesz dodawać elementy do klucza dodanego za pomocą instrukcji put. Dodanie większej liczby wartości niż maksymalna liczba wartości nie spowoduje niepowodzenia.
„put_if_not_present” – dodaje nowy sygnał tylko wtedy, gdy nie ma żadnych sygnałów z tym samym kluczem. Wartość tego obiektu jest obiektem JSON, w którym klucze są ciągami 64 podstaw odpowiadającymi kluczowi, dla którego ma zostać umieszczony klucz, a wartości to ciąg znaków w formacie base64 odpowiadający wartości do umieszczenia.
„remove” (usuń) – usuwa sygnał dla klucza. Wartością jest lista ciągów w formacie 64 odpowiadających kluczom sygnałów, które należy usunąć.
„update_encoder” – zawiera działanie służące do aktualizowania punktu końcowego oraz identyfikator URI, którego można użyć do pobrania logiki kodowania. Podklucz, który umożliwia określenie działania aktualizacji, to „action”. Obecnie obsługiwane wartości to:
- „REGISTER”: rejestruje punkt końcowy kodera, jeśli jest podawany po raz pierwszy, lub zastępuje istniejący punkt końcowy nowo podanym. Podanie wartości „endpoint” jest wymagane w przypadku działania „REGISTER”.
Podklucz do udostępniania punktu końcowego kodera to „endpoint”, a wartość to ciąg znaków URI punktu końcowego.
Klucz może być obsługiwany tylko przez 1 polecenie na plik JSON. Jeśli 2 polecenia spróbują wykonać działanie na tym samym kluczu, ta metoda użyje IllegalArgumentException
To wywołanie zakończy się niepowodzeniem z kodem błędu SecurityException
, jeśli:
ownerPackageName
nie wywołuje nazwy pakietu aplikacji lub- kupujący nie ma uprawnień do korzystania z interfejsu API.
To wywołanie zakończy się niepowodzeniem z błędem IllegalArgumentException
, jeśli:
- Dane w formacie JSON pobrane z serwera są nieprawidłowe.
- Podany identyfikator URI jest nieprawidłowy.
To wywołanie zakończy się niepowodzeniem (LimitExceededException
), jeśli pakiet połączeń przekroczy dozwolone limity szybkości i zostanie ograniczony.
To wywołanie zakończy się niepowodzeniem i pojawi się IllegalStateException
, jeśli wystąpi wewnętrzny błąd usługi.
Wymaga AdServicesPermissions.ACCESS_ADSERVICES_CUSTOM_AUDIENCE
Parametry | |
---|---|
updateSignalsRequest |
UpdateSignalsRequest : ta wartość nie może być null . |
executor |
Executor : ta wartość nie może być typu null .
Zdarzenia wywołania zwrotnego i detektora są wysyłane za pomocą tego Executor , co ułatwia kontrolowanie, który wątek jest używany. Aby wysyłać zdarzenia za pomocą głównego wątku aplikacji, możesz użyć funkcji Context.getMainExecutor() .
W przeciwnym razie podaj Executor , który wysyła dane do odpowiedniego wątku. |
receiver |
OutcomeReceiver : ta wartość nie może być null . |