FrequencyCapFilters (Filtros de frequência)

public final class FrequencyCapFilters
extends Object implements Parcelable

java.lang.Object
   ↳ android.adservices.common.FrequencyCapFilters


É um contêiner dos filtros de anúncio com base em limites de frequência.

Não é possível associar mais de 20 filtros de limite de frequência a um único anúncio.

Os filtros de limites de frequência combinam um tipo de evento com uma lista de objetos KeyedFrequencyCap. para definir um conjunto de filtros de anúncios. Se um desses limites de frequência for excedido em um anúncio, o anúncio vai ser removido do grupo de anúncios enviado para a função de lances de uma adtech do comprador.

Resumo

Classes aninhadas

class FrequencyCapFilters.Builder

Builder para criar objetos FrequencyCapFilters

Constantes

int AD_EVENT_TYPE_CLICK

int AD_EVENT_TYPE_IMPRESSION

int AD_EVENT_TYPE_VIEW

int AD_EVENT_TYPE_WIN

O tipo de evento de anúncio Win é preenchido automaticamente no serviço Protected Audience para qualquer anúncio vencedor retornado da seleção de anúncios da API Protected Audience.

Constantes herdadas

Campos

public static final Creator<FrequencyCapFilters> CREATOR

Métodos públicos

boolean equals(Object o)

Confere se os objetos FrequencyCapFilters contêm as mesmas informações.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_CLICK.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_IMPRESSION.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_VIEW.

List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_WIN.

int hashCode()

Retorna o hash dos dados do objeto FrequencyCapFilters.

String toString()

Retorna uma representação em string do objeto.

void writeToParcel(Parcel dest, int flags)

Nivela esse objeto em um Parcel.

Métodos herdados

Constantes

AD_EVENT_TYPE_CLICK

public static final int AD_EVENT_TYPE_CLICK

Valor constante: 3 (0x00000003)

AD_EVENT_TYPE_IMPRESSION

public static final int AD_EVENT_TYPE_IMPRESSION

Valor constante: 1 (0x00000001)

VISUALIZAÇÃO_DO_EVENTO_DE_ANÚNCIO

public static final int AD_EVENT_TYPE_VIEW

Valor constante: 2 (0x00000002)

AD_EVENT_TYPE_VITÓRIA

public static final int AD_EVENT_TYPE_WIN

O tipo de evento de anúncio Win é preenchido automaticamente no serviço Protected Audience para qualquer anúncio vencedor retornado da seleção de anúncios da API Protected Audience.

Ele não deve ser usado para atualizar manualmente um histograma de contador de anúncios.

Valor da constante: 0 (0x00000000)

Campos

Métodos públicos

equals

public boolean equals (Object o)

Confere se os objetos FrequencyCapFilters contêm as mesmas informações.

Parâmetros
o Object: o objeto de referência para comparação.

Retorna
boolean true, se esse objeto for o mesmo que o argumento obj. Caso contrário, false.

getKeyedFrequencyCapsForClickEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForClickEvents ()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_CLICK.

Esses limites de frequência se aplicam a eventos que estão relacionados a um clique quando interpretado por um adtech. Os eventos de clique são contados quando a API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) é invocada com o tipo de evento AD_EVENT_TYPE_CLICK.

Retorna
List<KeyedFrequencyCap> Esse valor não pode ser null.

getKeyedFrequencyCapsForImpressionEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForImpressionEvents ()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_IMPRESSION.

Esses limites de frequência se aplicam a eventos que se correlacionam com uma impressão quando interpretado por um adtech.

Observe que os eventos não são contados automaticamente ao chamar AdSelectionManager.reportImpression(ReportImpressionRequest, Executor, OutcomeReceiver). Em vez disso, o tipo de evento AD_EVENT_TYPE_IMPRESSION precisa atualizados usando a API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver).

Retorna
List<KeyedFrequencyCap> Esse valor não pode ser null.

getKeyedFrequencyCapsForViewEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForViewEvents ()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_VIEW.

Esses limites de frequência se aplicam a eventos que se correlacionam com uma visualização interpretada por uma adtech. Os eventos de visualização são contados quando a API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver) é invocada com o tipo de evento AD_EVENT_TYPE_VIEW.

Retorna
List<KeyedFrequencyCap> Esse valor não pode ser null.

getKeyedFrequencyCapsForWinEvents

public List<KeyedFrequencyCap> getKeyedFrequencyCapsForWinEvents ()

Recebe a lista de objetos KeyedFrequencyCap que serão filtrados no tipo de evento AD_EVENT_TYPE_WIN.

Esses limites de frequência se aplicam a eventos para anúncios que foram selecionados como vencedores Os anúncios vencedores são usados para incrementar automaticamente as chaves de contador associadas na tipo de evento vencedor.

O tipo de evento AD_EVENT_TYPE_WIN não pode ser atualizado manualmente usando o evento API AdSelectionManager.updateAdCounterHistogram(UpdateAdCounterHistogramRequest, Executor, OutcomeReceiver).

Retorna
List<KeyedFrequencyCap> Esse valor não pode ser null.

hashCode

public int hashCode ()

Retorna o hash dos dados do objeto FrequencyCapFilters.

Retorna
int um valor de código hash para esse objeto.

toString

public String toString ()

Retorna uma representação em string do objeto. Em geral, o método toString retorna uma string que "representa textualmente" esse objeto. O resultado precisa ser uma representação concisa, mas informativa e de fácil leitura para uma pessoa. Recomendamos que todas as subclasses substituam esse método.

O método toString da classe Object retorna uma string que consiste no nome da classe de que o objeto é uma instância, o caractere de arroba "@" e a representação hexadecimal não assinada do código hash do objeto. Em outras palavras, esse método retorna uma string igual ao valor de:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Retorna
String uma representação em string do objeto.

writeToParcel

public void writeToParcel (Parcel dest, 
                int flags)

Nivela esse objeto em um Parcel.

Parâmetros
dest Parcel: este valor não pode ser null.

flags int: outras sinalizações sobre como o objeto precisa ser criado. Pode ser 0 ou Parcelable.PARCELABLE_WRITE_RETURN_VALUE. O valor é 0 ou uma combinação de Parcelable.PARCELABLE_WRITE_RETURN_VALUE e android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES