KeyedFrequencyCap

public final class KeyedFrequencyCap
extends Object implements Parcelable

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


Um limite de frequência para uma chave específica de contador de anúncios.

Os limites de frequência definem a taxa máxima de ocorrência de um evento em um determinado intervalo de tempo. Se o limite de frequência for excedido, o anúncio associado será filtrado da seleção de anúncios.

Resumo

Classes aninhadas

class KeyedFrequencyCap.Builder

Builder para criar objetos KeyedFrequencyCap

Constantes herdadas

Campos

public static final Creator<KeyedFrequencyCap> CREATOR

Métodos públicos

boolean equals(Object o)

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

int getAdCounterKey()

Retorna a chave do contador de anúncios à qual o limite de frequência é aplicado.

Duration getInterval()

Retorna o intervalo, como uma Duration que será truncada para o segundo mais próximo, em que o limite de frequência é calculado.

int getMaxCount()

Retorna a contagem máxima de ocorrências de eventos permitidas em um determinado intervalo de tempo.

int hashCode()

Retorna o hash dos dados do objeto KeyedFrequencyCap.

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

Campos

Métodos públicos

equals

public boolean equals (Object o)

Confere se os objetos KeyedFrequencyCap 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, retorna false.

getAdCounterKey

public int getAdCounterKey ()

Retorna a chave do contador de anúncios à qual o limite de frequência é aplicado.

A chave do contador de anúncios é definida por uma adtech e é uma string arbitrária que define todos os critérios que podem ter sido contados e mantidos anteriormente no dispositivo. Se a contagem no dispositivo exceder a contagem máxima dentro de um determinado intervalo de tempo, significa que o limite de frequência foi excedido.

Retorna
int Esse valor não pode ser null.

getInterval

public Duration getInterval ()

Retorna o intervalo, como uma Duration que será truncada para o segundo mais próximo, em que o limite de frequência é calculado.

Quando esse limite de frequência é calculado, o número de eventos persistidos é contado no intervalo de tempo mais recente. Se a contagem de eventos correspondentes que ocorrerem anteriormente para uma adtech for maior que o número retornado por getMaxCount(), significa que o limite de frequência foi excedido e o anúncio não estará qualificado para a seleção.

Retorna
Duration Esse valor não pode ser null.

getMaxCount

public int getMaxCount ()

Retorna a contagem máxima de ocorrências de eventos permitidas em um determinado intervalo de tempo.

Se houver mais eventos correspondentes à chave do contador de anúncios e ao tipo de evento de anúncio contado no dispositivo dentro do intervalo de tempo definido por getInterval(), significa que o limite de frequência foi excedido e o anúncio não será qualificado para seleção.

Por exemplo, um anúncio que especifica um filtro para uma contagem máxima de dois em uma hora não estará qualificado para a seleção se o evento tiver sido contado duas ou mais vezes na hora anterior ao processo de seleção.

Retorna
int

hashCode

public int hashCode ()

Retorna o hash dos dados do objeto KeyedFrequencyCap.

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