REST Resource: floodlightGroups

Recurso: FloodlightGroup

Um único grupo do Floodlight.

Representação JSON
{
  "name": string,
  "floodlightGroupId": string,
  "displayName": string,
  "webTagType": enum (WebTagType),
  "lookbackWindow": {
    object (LookbackWindow)
  },
  "customVariables": {
    object
  },
  "activeViewConfig": {
    object (ActiveViewVideoViewabilityMetricConfig)
  }
}
Campos
name

string

Apenas saída. O nome do recurso do grupo do Floodlight.

floodlightGroupId

string (int64 format)

Apenas saída. O ID exclusivo do grupo do Floodlight. Atribuído pelo sistema.

displayName

string

Obrigatório. O nome de exibição do grupo do Floodlight.

webTagType

enum (WebTagType)

Obrigatório. É o tipo de tag da Web ativado no grupo do Floodlight.

lookbackWindow

object (LookbackWindow)

Obrigatório. A janela de lookback do grupo do Floodlight. Tanto clickDays quanto impressionDays são obrigatórios. Os valores aceitáveis para as duas opções são de 0 a 90, inclusive.

customVariables

object (Struct format)

Variáveis personalizadas definidas pelo usuário e que pertencem ao grupo do Floodlight. Use variáveis personalizadas do Floodlight para criar dados de relatórios sob medida para suas necessidades comerciais. As variáveis personalizadas do Floodlight usam as chaves U1=, U2=, entre outras, e recebem qualquer valor transmitido a elas. Elas podem ser usadas para acompanhar praticamente qualquer tipo de dado que você coletar sobre os clientes, como gênero de filme que o cliente compra, o país para o qual o item é enviado e assim por diante.

Não é permitido usar variáveis personalizadas do Floodlight para transmitir dados que possam ser usados ou reconhecidos como informações de identificação pessoal (PII).

Exemplo: customVariables { fields { "U1": value { numberValue: 123.4 }, "U2": value { stringValue: "MyVariable2" }, "U3": value { stringValue: "MyVariable3" } } }

Os valores aceitáveis para as chaves são de "U1" a "U100", inclusive. Os valores de string precisam ter menos de 64 caracteres e não podem conter os seguintes caracteres: "<>.

activeViewConfig

object (ActiveViewVideoViewabilityMetricConfig)

Configuração da métrica de visibilidade de vídeos do Active View para o grupo do Floodlight.

WebTagType

Os tipos possíveis de tags da Web para um grupo do Floodlight.

Enums
WEB_TAG_TYPE_UNSPECIFIED O valor do tipo não está especificado ou é desconhecido nesta versão.
WEB_TAG_TYPE_NONE Nenhum tipo de tag.
WEB_TAG_TYPE_IMAGE Tag de imagem.
WEB_TAG_TYPE_DYNAMIC Tag dinâmica.

LookbackWindow

Especifica quantos dias no passado devem ser analisados para determinar se uma conversão precisa ser registrada.

Representação JSON
{
  "clickDays": integer,
  "impressionDays": integer
}
Campos
clickDays

integer

Janela de lookback, em dias, desde a última vez em que determinado usuário clicou em um de seus anúncios.

impressionDays

integer

Janela de lookback, em dias, desde a última vez que um determinado usuário visualizou um de seus anúncios.

ActiveViewVideoViewabilityMetricConfig

Configuração para métricas personalizadas de visibilidade de vídeos do Active View.

Representação JSON
{
  "displayName": string,
  "minimumViewability": enum (VideoViewabilityPercent),
  "minimumVolume": enum (VideoVolumePercent),
  "minimumDuration": enum (VideoDurationSeconds),
  "minimumQuartile": enum (VideoDurationQuartile)
}
Campos
displayName

string

Obrigatório. O nome de exibição da métrica personalizada.

minimumViewability

enum (VideoViewabilityPercent)

Obrigatório. É a porcentagem mínima de pixels do anúncio em vídeo visíveis na tela para que uma impressão seja registrada.

minimumVolume

enum (VideoVolumePercent)

Obrigatório. A porcentagem mínima do volume do anúncio em vídeo necessária para que uma impressão seja registrada.

minimumDuration

enum (VideoDurationSeconds)

É a duração mínima visível do vídeo (em segundos) para que uma impressão seja registrada.

É necessário especificar minimumDuration, minimumQuartile ou ambos. Se ambos forem especificados, uma impressão atenderá aos critérios da métrica se um dos requisitos for atendido (o que acontecer primeiro).

minimumQuartile

enum (VideoDurationQuartile)

É a duração mínima visível do vídeo necessária, com base nos quartis de vídeo, para que uma impressão seja registrada.

É necessário especificar minimumDuration, minimumQuartile ou ambos. Se ambos forem especificados, uma impressão atenderá aos critérios da métrica se um dos requisitos for atendido (o que acontecer primeiro).

VideoViewabilityPercent

Possíveis valores percentuais dos pixels visíveis de um anúncio em vídeo.

Enums
VIEWABILITY_PERCENT_UNSPECIFIED O valor não foi especificado ou é desconhecido nesta versão.
VIEWABILITY_PERCENT_0 0% visível.
VIEWABILITY_PERCENT_25 25% visível.
VIEWABILITY_PERCENT_50 50% visível.
VIEWABILITY_PERCENT_75 75% visível.
VIEWABILITY_PERCENT_100 100% visível.

VideoVolumePercent

Possíveis valores percentuais do volume de reprodução de um anúncio em vídeo.

Enums
VIDEO_VOLUME_PERCENT_UNSPECIFIED O valor não foi especificado ou é desconhecido nesta versão.
VIDEO_VOLUME_PERCENT_0 0% volume.
VIDEO_VOLUME_PERCENT_10 10% volume.

VideoDurationSeconds

São os valores possíveis em segundos da duração visível de um anúncio em vídeo.

Enums
VIDEO_DURATION_UNSPECIFIED O valor não foi especificado ou é desconhecido nesta versão.
VIDEO_DURATION_SECONDS_NONE Nenhum valor de duração.
VIDEO_DURATION_SECONDS_0 0 segundo.
VIDEO_DURATION_SECONDS_1 1 segundo
VIDEO_DURATION_SECONDS_2 2 segundos.
VIDEO_DURATION_SECONDS_3 3 segundos.
VIDEO_DURATION_SECONDS_4 4 segundos.
VIDEO_DURATION_SECONDS_5 5 segundos.
VIDEO_DURATION_SECONDS_6 6 segundos.
VIDEO_DURATION_SECONDS_7 7 segundos.
VIDEO_DURATION_SECONDS_8 8 segundos.
VIDEO_DURATION_SECONDS_9 9 segundos.
VIDEO_DURATION_SECONDS_10 10 segundos.
VIDEO_DURATION_SECONDS_11 11 segundos
VIDEO_DURATION_SECONDS_12 12 segundos.
VIDEO_DURATION_SECONDS_13 13 segundos
VIDEO_DURATION_SECONDS_14 14 segundos.
VIDEO_DURATION_SECONDS_15 15 segundos.
VIDEO_DURATION_SECONDS_30 30 segundos.
VIDEO_DURATION_SECONDS_45 45 segundos.
VIDEO_DURATION_SECONDS_60 60 segundos.

VideoDurationQuartile

Possíveis valores quartis da duração visível de um anúncio em vídeo.

Enums
VIDEO_DURATION_QUARTILE_UNSPECIFIED O valor não foi especificado ou é desconhecido nesta versão.
VIDEO_DURATION_QUARTILE_NONE Nenhum valor de quartil.
VIDEO_DURATION_QUARTILE_FIRST Primeiro quartil.
VIDEO_DURATION_QUARTILE_SECOND Segundo quartil (ponto médio).
VIDEO_DURATION_QUARTILE_THIRD Terceiro quartil.
VIDEO_DURATION_QUARTILE_FOURTH Quarto quartil (conclusão).

Métodos

get

Recebe um grupo do Floodlight.

patch

Atualiza um grupo do Floodlight existente.