Parâmetros de URL da tag de anúncio VAST

Parâmetros de URL da tag de anúncio VAST

Os URLs das tags de anúncio VAST são usados pelo player para recuperar anúncios em vídeo e áudio. É possível montar URLs das tags de anúncio VAST manualmente ou usar os parâmetros abaixo para modificar um URL existente. Depois teste-os com o VAST Suite Inspector (em inglês). Use estas tags de exemplo para revisão e teste.

Requisitos gerais para URLs

  • Protocolo: as tags de anúncio VAST são compatíveis tanto com http quanto com https. Os URLs de rastreamento de impressões seguem as configurações SSL atuais e retornam http ou https. Cliques e rastreamento de cliques usam http porque redirecionam de outra página.
  • Domínio: o uso de domínios dinâmicos, criados por meio da macro de correspondência de padrão ou de qualquer outro método dinâmico, não é permitido e vai resultar em erro.
  • Tráfego em tempo real: os URLs de tag de anúncio para streaming de vídeo ao vivo precisam ter /live no caminho. Isso garante a capacidade de lidar com os grandes volumes de tráfego em que todos os intervalos de anúncio são exibidos ao mesmo tempo.

Exemplo de uma tag de anúncio VAST

Exemplo de URL de tag de anúncio VAST com parâmetros e valores atribuídos:

https://securepubads.g.doubleclick.net/gampad/ads?env=vp&gdfp_req=1&output=vast&iu=/1234/video-demo&sz=400x300&unviewed_position_start=1&ciu_szs=728x90,300x250

 favoritoIr para um parâmetro específico na lista

aconp
ad_rule
ad_type
addtl_consent
afvsz
allcues
an
ciu_szs
correlator
cmsid
cust_params
description_url
env
excl_cat
gdfp_req
gdpr
gdpr_consent
hl

iabexcl
idtype
ipd
ipe
is_lat
iu
lip
ltd
max_ad_duration
min_ad_duration
mridx
msid
nofb
npa
omid_p
output
plcmt
pmad

pmnd
pmxd
pod
pp
ppt
ppid
ppos
ppsj
ptpl
ptpln
pubf
pvid
pvid_s
pvtf
rdid
rdp
scor
sdk_apis

sdmax
sid
ssss
sz
tfcd
trt
unviewed_position_start
url
vad_type
vconp
vid
vid_d
vpa
vpi
vpmute
vpos
wta

Parâmetro Detalhes
aconp

(áudio contínuo)

Recomendado pelas diretrizes de avaliação de áudio do MRC (em inglês)

O parâmetro de áudio contínuo aceita um valor constante que indica se o player exibirá conteúdo em áudio continuamente.

Deixe esse parâmetro indefinido se for desconhecido.

Exemplo de uso

Áudio contínuo ATIVADO:
aconp=2

Áudio contínuo DESATIVADO:
aconp=1

ad_rule

(regra de anúncio)

O parâmetro regra de anúncio aceita um valor constante que indica se a resposta precisa retornar um criativo VAST ou uma regra de anúncio.

A configuração padrão das regras de anúncio depende de uma configuração de rede do Ad Manager. É possível substituir a configuração de tags de anúncio específicas com os exemplos abaixo.

Exemplo de uso

Solicitação de criativo VAST:
ad_rule=0

Solicitação de regras de anúncio (VMAP):
ad_rule=1

Requisito

Obrigatório Obrigatório para regras de anúncio em vídeo

ad_type

(tipo de anúncio)

Os parâmetros de tipo de anúncio aceitam um valor constante que indica os tipos de anúncio que precisam ser retornados para a solicitação.

Esse parâmetro só é obrigatório para anúncios em áudio.

Quando ad_type é definido como audio ou audio_video, é necessário definir o parâmetro vpmute como 0.

Exemplos de uso

Permite apenas anúncios em áudio:
ad_type=audio

Permite anúncios em vídeo puláveis e não puláveis:
ad_type=video

Permite anúncios em áudio e em vídeo:
ad_type=audio_video
Esse valor permite que os dois formatos concorram, mas apenas um vai ser veiculado.

O tipo de anúncio audio_video tem como finalidade ser usado somente para a veiculação de criativos de vídeo em conteúdo de áudio compatível com a reprodução de anúncios em vídeo ou criativos em áudio em players de vídeo in-stream para conteúdo que possa ser "audível" por natureza. Por exemplo, streaming de esportes, videocasts, notícias etc. Leia mais sobre áudio em conteúdo de vídeo.

Permite apenas anúncios em vídeo puláveis:
ad_type=skippablevideo

Permite apenas anúncios em vídeo não puláveis:
ad_type=standardvideo

Requisito

Obrigatório Obrigatório para anúncios em áudio

afvsz

(tamanhos de anúncios não lineares)

O parâmetro tamanhos de anúncios não lineares aceita um valor constante que precisa ser uma lista separada por vírgulas de tamanhos de anúncios não lineares que podem ser exibidos no espaço do anúncio em vídeo.

Esses tamanhos precisam ser um dos seguintes:

  • 200 x 200
  • 250 x 250
  • 300 x 250
  • 336 x 280
  • 450 x 50
  • 468 x 60
  • 480 x 90
  • 729 x 90

Ao usar o SDK do IMA, esse campo será substituído e preenchido com todos os tamanhos compatíveis que se enquadrem em nonLinearAdSlotWidth e nonLinearAdSlotHeight.

Esse parâmetro poderá ficar vazio ou não ser incluído quando não houver tamanhos não lineares compatíveis.

Exemplo de uso

Todos os tamanhos são compatíveis:
afvsz=200x200,250x250,300x250,336x280,
450x50,468x60,480x90,728x90

A largura máxima é 250:
afvsz=200x200,250x250

A altura máxima é 60:
afvsz=450x50,468x60

A largura máxima é 100:
//empty; no values supported

 

Requisito

Obrigatório Necessário para anúncios em vídeo não lineares quando o SDK do IMA não for usado

allcues

(todos os pontos de inserção)

Este parâmetro aceita valores variáveis, que são uma lista separada por vírgulas de pontos de inserção, em milésimos de segundo. Para cada valor, o Ad Manager retorna um intervalo de anúncio.

Os parâmetros vid_d e allcues são usados para veicular anúncios intermediários sem processamento de conteúdo. Também são necessárias regras de anúncio para retornar anúncios intermediários.

Se inserções com base em tempo são usadas nas suas regras (por exemplo, "A cada N segundos" ou "Em horários fixos"), então aquelas definidas na regra do anúncio são usadas, e as inserções transmitidas por allcues são ignoradas. Os anúncios intermediários exigem duração, então o parâmetro vid_d ainda precisa ser transmitido.

Exemplo de uso

Pontos de inserção em 10 e 20 segundos:
allcues=10000,20000

ciu_szs

(tamanhos de complementares)

O parâmetro tamanhos de complementares aceita valores variáveis que são uma lista separada por vírgulas de tamanhos de anúncios complementares.

Valores separados por barra vertical (|) indicam um local do anúncio de vários tamanhos.

Exemplo de uso

ciu_szs=728x90,300x250

Tamanhos com um local para vários tamanhos:
ciu_szs=728x90,300x200|300x250

cmsid

(ID da origem do conteúdo)

vid

(ID do vídeo)

Os parâmetros ID da origem do conteúdo e ID do vídeo aceitam valores variáveis.

A fim de segmentar anúncios para conteúdo em vídeo, a tag de vídeo principal precisa incluir ambos.

O cmsid é um número exclusivo a cada origem do conteúdo. Para localizá-lo no Ad Manager, clique em Vídeo e depois Origens de conteúdo e no nome da origem.

O vid é uma string ou um número de identificação de um determinado vídeo. Esse ID é atribuído pelo CMS que hospeda seu conteúdo. Para localizá-lo no Ad Manager, clique em Vídeo e depois Conteúdo e especifique o conteúdo do vídeo.

Exemplo de uso

cmsid=[value]&vid=[value]

Se você criar uma tag para a Inserção de anúncios dinâmicos com vídeo on demand, use as macros que inserem dinamicamente a origem do conteúdo e o ID do vídeo adequados.

Exemplo: cmsid=%%CMS_ID%%&vid=%%VIDEO_ID%%

Requisito

Obrigatório Obrigatório para segmentação de conteúdo em vídeo

correlator

(correlação)

O parâmetro correlator aceita valores variáveis compartilhados por diversas solicitações originadas da mesma visualização de página. Ele é usado para implementar exclusões competitivas, inclusive em ambientes sem cookies.

Se o SDK do IMA for usado, o valor de correlação será definido automaticamente. Se o player tentar definir esse valor, o SDK irá substituí-lo pelo próprio valor.

Se o SDK do IMA não for usado, confirme se você o definiu como um valor verdadeiramente aleatório, positivo e inteiro que não seja reutilizado por várias visualizações de página.

Exemplo de uso

correlator=4345645667

Requisito

Obrigatório Obrigatório para Web e apps

recomendado Recomendado para monetização programática

cust_params

(parâmetros de chave-valor personalizados)

Os parâmetros personalizados aceitam valores variáveis que representem pares de chave-valor. Eles possibilitam que você defina uma segmentação específica, como informações demográficas, determinadas posições em uma página ou, ainda, páginas em particular.

Exemplo de uso

Veja exemplos de como adicionar pares de chave-valor.

description_url

(URL de descrição)

O parâmetro de URL da descrição aceita um valor variável que descreva o vídeo exibido na página. Geralmente, é a página com o player, mas também pode ser uma com a descrição em texto do vídeo.

O valor de description_url precisa ser codificado para URL nos players de vídeo de páginas da Web e dispositivos OTT e smart TVs. Já no caso dos players em apps para dispositivos móveis, ele não pode ter essa codificação.

Esse parâmetro não é definido automaticamente pelo SDK do IMA. Ele precisa ser inserido manualmente.

Exemplo de uso

Codificado para URL:
description_url=
https%3A%2F%2Fwww.sample.com%2Fgolf.html

Não codificado:
description_url=
https://www.sample.com/golf.html

Requisito

Obrigatório Obrigatório para Web, apps e Ad Exchange

recomendado Recomendado para monetização programática

env

(ambiente)

O parâmetro ambiente aceita um valor constante que indica uma solicitação in-stream ou que a solicitação é especificamente de um player de vídeo.

Os valores possíveis são instream, que pode ser usado para anúncios em vídeo e áudio, ou vp, que só pode ser usado para anúncios em vídeo.

Exemplo de uso

Vídeo e/ou áudio:
env=instream

Somente vídeo:
env=vp

Requisito

Obrigatório Obrigatório para Web e apps

excl_cat

(categoria de exclusão)

O parâmetro de exclusão da categoria aceita valores variáveis e é usado para impedir que os itens de linha com o rótulo de exclusão em questão sejam qualificados para uma determinada solicitação de anúncio. Esse parâmetro funciona com cust_params.

Exemplo de uso

&cust_params=excl_cat%3Dairline_excl_label%7C

gdfp_req

(indicador do esquema do Ad Manager)

O parâmetro indicador do esquema do Ad Manager aceita um valor constante que indica que o usuário está no esquema do Ad Manager.

Exemplo de uso

gdfp_req=1

Requisito

Obrigatório Obrigatório para Web e apps

gdpr

(GDPR)

O parâmetro do GDPR aceita valores constantes e é usado por editores que querem fazer a integração com o TCF v2.0 do IAB. As solicitações VAST diretas não leem automaticamente os valores, mas são aceitas quando adicionadas às tags de anúncio.

Somente 0 e 1 são valores válidos para esse parâmetro, em que 0 significa que o GDPR não se aplica e 1 indica que ele é aplicável. Se o GDPR for aplicável, vai ser necessário fornecer uma string de TC válida usando o parâmetro gdpr_consent.

Saiba mais sobre os valores passados para esse parâmetro nas diretrizes gerais sobre a implementação da estrutura ou na seção String de TC da especificação do TCF v2.0 do IAB.

Exemplo de uso

O GDPR é aplicável:
gdpr=1

O GDPR não se aplica:
gdpr=0

hl

(idioma)

O parâmetro aceita um valor constante usado para solicitar anúncios em um idioma específico e para definir o idioma da seleção de anúncios e da renderização dos anúncios em vídeo na alocação dinâmica para vídeo no Ad Exchange ou no Google AdSense.

O valor desse parâmetro pode ser qualquer código ISO 639-1 (duas letras) ou ISO 639-2 (três letras). Veja a lista de códigos válidos.

Se omitido, o valor padrão será qualquer idioma com segmentação de anúncios por idioma no Ad Exchange.

Exemplo de uso

hl=it

Requisito

recomendado Recomendado para monetização programática

iabexcl

(URL de exclusão do IAB)

O parâmetro de URL iabexcl aceita uma lista de categorias separada por vírgulas.

Exemplo de uso

iabexcl=3,14,527 exclui "caminhões comerciais", "veículos off-road" e "Rúgbi".

Saiba mais sobre a taxonomia de conteúdo do IAB.

ipd

(domínio do parceiro de inventário)

O parâmetro de domínio do parceiro de inventário aceita valores variáveis que precisam ser definidos nas declarações de inventorypartnerdomain no arquivo app-ads.txt (ou ads.txt) do editor. 

O parâmetro inventorypartnerdomain é uma Especificação do IAB que ajuda os editores a designar o domínio de um parceiro de compartilhamento de inventário para validação de ads.txt/app-ads.txt.

A declaração IPD é especialmente importante em casos de uso de compartilhamento de inventário em que o inventário de anúncios de origem de uma solicitação pode ser propriedade de outro parceiro (o parceiro de compartilhamento de inventário).

Saiba mais sobre o ads.txt/app-ads.txt e os parceiros de compartilhamento de inventário.

ipe

(entidade da impressão com ping)

O parâmetro da entidade da impressão com ping aceita um valor constante que é usado para indicar pings de impressão e conversões com origem no servidor, não no cliente.

Exemplo de uso

Beacon do servidor (SSB, na sigla em inglês):
ipe=ssb

iu

(bloco de anúncios)

O parâmetro bloco de anúncios aceita um valor variável que precisa ser definido como o bloco de anúncios atual, no seguinte formato:

/network_id/.../ad_unit

Exemplo de uso

iu=/6062/videodemo

Requisito

Obrigatório Obrigatório para Web e apps

lip

(última posição no conjunto)

O parâmetro última posição no conjunto aceita um valor constante que indica uma solicitação da última posição em um conjunto.

Esse parâmetro é usado somente para conjuntos padrão.

Exemplo de uso

lip=true

ltd

(anúncios limitados)

O parâmetro anúncios limitados aceita um valor constante que indica a possibilidade de veicular anúncios de forma limitada caso o usuário não autorize o uso de cookies ou de outros identificadores locais.

Aviso

Diferente de outros parâmetros de URL, a definição como ltd=1 muda o comportamento do SDK do IMA para tratar a solicitação como sem ID e não permitir o armazenamento.

Exemplo de uso

ltd=1

min_ad_duration

(duração mínima do anúncio)

max_ad_duration

(duração máxima do anúncio)

Os parâmetros de duração de anúncio aceitam valores variáveis que, reunidos, especificam o intervalo de duração a que um anúncio precisa corresponder, em milissegundos.

Use esse parâmetro para limitar a duração do anúncio individual para solicitações de conjunto único e conjunto otimizado.

Exemplo de uso

min_ad_duration=15000&max_ad_duration=30000

mridx

(número do anúncio intermediário)

O parâmetro número do anúncio intermediário aceita um valor variável que indica o número ordinal do anúncio intermediário, como "anúncio intermediário 1", "anúncio intermediário 2" etc.

Exemplo de uso

mridx=2

msid

(ID do app)

an

(nome do app)

Os parâmetros ID e nome do app aceitam valores variáveis a serem aplicados a solicitações enviadas de apps para dispositivos móveis e dispositivos de smart TV, porque eles são obrigatórios para a maioria dos anúncios em vídeo programáticos.

O SDK do IMA vai preencher automaticamente os dois parâmetros, mas eles precisarão ser especificados manualmente em chamadas VAST diretas (ambientes sem SDK).

Embora o nome do app seja legível por humanos, o SDK não consegue acessar o ID do app no iOS e no tvOS. Nesses casos, o parâmetro msid não é enviado, e o SDK envia o pacote de apps pelo parâmetro an.

Exemplo de uso

msid=com.package.publisher&an=sample%20app

Os IDs dos app são nomeados e formatados de maneira diferente em cada app store. Consulte as diretrizes do IAB para a identificação de apps ou exemplos de identificadores exclusivos comuns.

Para plataformas sem app store, o IAB recomenda que os editores usem o seguinte formato de ID: com.publisher.deviceplatform

Requisito

Obrigatório Os dois parâmetros são obrigatórios para apps

recomendado Recomendado para monetização programática

nofb

(substituto desativado)

O parâmetro substituto desativado aceita um valor constante para indicar que a solicitação de anúncio não pode retornar uma playlist de anúncios substitutos de vídeo.

Exemplo de uso

Substitutos desativados:
nofb=1

npa

(anúncio não personalizado)

O parâmetro anúncios não personalizados aceita um valor constante para indicar que a solicitação de anúncio precisa ser tratada como não personalizada.

É necessário definir especificamente npa=1 ou incluir npa (sem um valor definido) para marcar a solicitação como não personalizada. As solicitações de anúncios que não têm esse parâmetro ou estão definidas como npa=0 terão como padrão anúncios personalizados.

Exemplo de uso

Anúncios não personalizados:
npa=1

omid_p

(Nome do parceiro OMID)

O parâmetro do nome do parceiro OMID aceita um valor variável que indica o nome do parceiro que integra a medição de OMID e a versão do parceiro.

Esse parâmetro só é aplicável a editores que querem fazer a medição do Active View ao usar o SDK do Open Measurement (SDK do OM). Ele não deve ser usado com o SDK do IMA, já que é configurado automaticamente.

Para indicar a compatibilidade com OMID ao usar a biblioteca de acesso programático (PAL, na sigla em inglês), é preciso usar as APIs omidPartnerName e omidPartnerVersion para definir o nome e a versão do parceiro. Quando você não estiver usando PAL ou IMA, vai ser preciso definir os parâmetros omid_p e sdk_apis (as APIs compatíveis, que também podem incluir outras APIs separadas por vírgula).

Exemplo de uso

Ao usar a PAL:
request.omidPartnerName = 'examplepartnername'
request.omidPartnerVersion = '1.0.0.0'

Quando não estiver usando PAL:
omid_p=examplepartnername/1.0.0.0&sdk_apis=7

output

(formato de saída do anúncio)

O parâmetro formato de saída aceita um valor constante que precisa ser definido como o formato de saída do anúncio.

Use output=vast para a versão do VAST padrão configurada para a rede. Para tags de anúncio ou partes específicas do site, solicite versões específicas do VAST ou do VMAP.

Caso seu player de vídeo use o SDK do IMA, o parâmetro de resposta da solicitação de anúncio em vídeo sempre será definido como output=xml_vast4. Isso não representa um risco de confiabilidade, porque o SDK é compatível com todas as versões do VAST que podem ser exibidas por qualquer servidor de anúncios de terceiros.

Use output=vmap para retornar a versão padrão do VMAP (por exemplo, VMAP 1) ativada para a rede. Se quiser retornar o VAST no VMAP, use xml_vmap1_vast3 ou xml_vmap1_vast4 para especificar a versão do VAST.

Exemplo de uso

A configuração do VAST padrão da rede:
output=vast

VAST 4:
output=xml_vast4

A configuração do VMAP padrão da rede:
output=vmap

VMAP 1:
output=xml_vmap1

VMAP 1 que retorna VAST 4:
output=xml_vmap1_vast4

Requisito

Obrigatório Obrigatório para Web e apps

plcmt

(posição)

O parâmetro de posição aceita um valor constante que é usado para indicar se o inventário in-stream foi declarado como in-stream ou complementar, de acordo com a orientação nas especificações do IAB.

No caso de solicitações que não são in-stream, esse campo é preenchido automaticamente para compradores com base no formato de inventário declarado e substitui qualquer declaração de conteúdo in-stream ou complementar.

Exemplo de uso

Solicitação in-stream:
plcmt=1

Solicitação de conteúdo complementar:
plcmt=2

Requisito

Obrigatório Obrigatório para Web e monetização programática

pmad

(máximo de anúncios no conjunto)

O parâmetro máximo de anúncios no conjunto aceita um valor variável que indica o número máximo de anúncios em um conjunto.

Esse parâmetro é específico para conjuntos otimizados, que estão disponíveis para os editores com um pacote de vídeo avançado. Não o use para VMAP (quando ad_rule=1).

Exemplo de uso

pmad=4

pmnd

(duração mínima do conjunto)

pmxd

(duração máxima do conjunto)

Os parâmetros de duração de conjunto aceitam valores variáveis que, reunidos, especificam o intervalo de duração a que um conjunto precisa corresponder, em milissegundos.

Esses parâmetros são usados para solicitar múltiplos anúncios. Eles são específicos para conjuntos otimizados, que estão disponíveis para os editores com um pacote de vídeo avançado. Não os use para VMAP (quando ad_rule=1).

Exemplo de uso

pmnd=0&pmxd=60000

pod

(número do conjunto)

O parâmetro número do conjunto aceita um valor variável que representa o número ordinal do conjunto em um vídeo, como "conjunto 1", "conjunto 2" etc.

Exemplo de uso

pod=3

Requisito

Obrigatório Obrigatório para o funcionamento correto de exclusões competitivas, limites de frequência e recursos relacionados

pp

(perfil do criativo)

O parâmetro perfil do criativo aceita um valor variável que controle quais criativos se qualificam para veiculação com base na configuração definida em um perfil de criativo em áudio e em vídeo.

Exemplo de uso

pp=creative_profile

Requisito

recomendado Recomendado para monetização programática

ppt

(tratamento de privacidade do editor)

O parâmetro "Tratamento de privacidade do editor" aceita um valor constante que é usado para indicar se a personalização de anúncios deve ser desativada para a solicitação de anúncio.

Saiba mais sobre o tratamento de privacidade do editor.

Exemplo de uso

Desative a personalização de anúncios:
ppt=1

ppid

(identificador fornecido pelo editor)

O parâmetro identificador fornecido pelo editor (PPID) aceita um valor variável do identificador usado no limite de frequência, na segmentação, na segmentação de audiência, na rotação sequencial de anúncios e em outros controles de exibição de anúncios com base no público-alvo em dispositivos.

Exemplo de uso

ppid=12JD92JD8078S8J29SDOAKC0EF230337

ppos

(posição no conjunto)

O parâmetro posição no conjunto aceita um valor variável que representa a posição em um conjunto, como "posição 1", "posição 2" etc.

Esse parâmetro é válido apenas para conjuntos padrão e só é necessário para o preenchimento automático dos complementares.

Exemplo de uso

ppos=2

Requisito

Obrigatório Obrigatório para o funcionamento correto de exclusões competitivas, limites de frequência e recursos relacionados

ppsj

(JSON dos indicadores fornecidos pelo editor)

O parâmetro JSON de indicadores fornecidos pelo editor aceita um objeto JSON codificado em base64 com dados de público-alvo e contextuais fornecidos pelo editor para melhorar a monetização programática.

Saiba mais sobre os indicadores fornecidos pelo editor e as taxonomias compatíveis.

Confira detalhes dos pares de chave-valor JSON válidos na
amostra do SDK do IMA para HTML5.

Exemplo de uso

Objeto JSON:
{
  "PublisherProvidedTaxonomySignals": [{
     "taxonomy": "IAB_AUDIENCE_1_1",
     "values": ["6", "284"]
  }]
}

Valor codificado em base64:
eyJQdWJsaXNoZXJQcm92aWRlZFRheG9ub215U2lnbmFscyI6W3s
idGF4b25vbXkiOiJJQUJfQVVESUVOQ0VfMV8xIiwidmFsdWVzIj
pbIjEiLCIyODQiXX1dfQ

ptpl

(ID do modelo de intervalo de anúncio)

ptpln

(nome do modelo de intervalo de anúncio)

O ID e o nome do modelo de intervalo de anúncio aceitam valores de variáveis e indicam qual modelo de intervalo de anúncio precisa da solicitação de conjunto otimizado. Os modelos de intervalo de anúncio permitem configurar quais espaços de anúncio (personalizados ou não) precisam ser incluídos em um intervalo de anúncio e em que ordem eles vão ser veiculados.

Apenas um dos dois parâmetros (nome ou ID) é obrigatório para solicitar um modelo de intervalo de anúncio.

Exemplo de uso

Saiba mais detalhes sobre como configurar e solicitar modelos de intervalos de anúncio aqui.
 
pubf

(preços mínimos públicos nas tags do Ad Exchange)

pvtf

(preços mínimos públicos nas tags do Ad Exchange)

pubf é o equivalente de google_ad_public_floor, e pvtf equivale a google_ad_private_floor. Eles são usados para adicionar preços mínimos a tags do Ad Exchange.

Exemplo de uso

pubf=123
pvtf=123

pvid

(ID do conjunto de apps)

pvid_s

(Escopo do conjunto de apps)

Os valores de ID do conjunto de apps são necessários para a monetização quando os usuários desativam a personalização em dispositivos Android.

O parâmetro pvid aceita um valor variável que é definido como o ID do conjunto de apps Android, e o parâmetro pvid_s aceita um valor constante que representa o escopo do ID do conjunto de apps (scope_app ou scope_developer).

Embora o SDK do IMA/PAL passe automaticamente esse campo, os editores com implementações que não são do SDK precisam chamar o SDK do conjunto de apps e transmitir esses parâmetros manualmente na solicitação de anúncio.

Consulte a documentação do Android sobre como recuperar o ID do conjunto de apps.

Exemplo de uso

pvid=[AppSetID_value]
pvid_s=scope_app

Requisito

Obrigatório Obrigatório para apps

recomendado Recomendado para monetização programática

rdid
idtype
is_lat

(identificadores de dispositivo redefiníveis)

Os identificadores redefiníveis de dispositivo aceitam valores variáveis.

Com aplicativos integrados (não na Web ou Web para dispositivos móveis), o SDK transmite identificadores redefiníveis de dispositivo para segmentar os usuários em suas solicitações de stream com os parâmetros para rdid, idtype e is_lat. Em streams SSB, é necessário transmitir esses parâmetros como explícitos, assim como faria em uma solicitação de anúncio do lado do cliente. Saiba mais sobre os identificadores de dispositivos.

Quase todos os anúncios de vídeo programáticos requerem a presença desses valores.

Aviso

A partir do iOS 14.5, a Apple descontinuou o indicador LAT. Como alternativa, o Google conta com a presença de um IDFA diferente de zero para indicar que o usuário consentiu com o rastreamento em versões do iOS compatíveis com o App Tracking Transparency. Assim um UserAgent válido que indique a versão correta do SO é necessário.

Exemplo de uso

Veja exemplos detalhados de identificadores redefiníveis de dispositivo.

Requisito

Obrigatório Obrigatório para apps

recomendado Recomendado para monetização programática

rdp

(restringir o processamento de dados)

O parâmetro processamento de dados restrito aceita um valor constante para indicar que a solicitação de anúncio precisa restringir o processamento de dados.

É necessário definir especificamente rdp=1 ou incluir rdp (sem um valor definido) para restringir o processamento de dados. As solicitações de anúncios que não tiverem esse parâmetro ou que forem definidas como rdp=0 não serão restringidas, a menos que a configuração de rede Restringir o processamento de dados esteja ativada.

Exemplo de uso

rdp=1

scor

(correlator de stream)

O parâmetro correlator de stream aceita valores variáveis que precisam ser números inteiros gerados para cada stream de vídeo. O número precisa ser o mesmo dentro de um stream e único dentro de uma visualização de página. Ele é usado para exclusões competitivas, limites de frequência e recursos relacionados caso um usuário assista a vários vídeos na mesma página.

Exemplo de uso

scor=17

Requisito

Obrigatório Obrigatório para o funcionamento correto de exclusões competitivas, limites de frequência e recursos relacionados.

sdk_apis

(framework da API do SDK)

O parâmetro de framework da API do SDK aceita uma lista separada por vírgulas de valores inteiros constantes, que indicam todos os frameworks da API compatíveis com o player.

Veja uma lista de possíveis valores de framework da API.

Esse parâmetro é compatível com as APIs na biblioteca de acesso programático (PAL, na sigla em inglês) para editores que não usam o SDK do IMA. O SDK do IMA substitui a definição por valores compatíveis com ele.

Exemplo de uso

sdk_apis=2,7,9

sdmax

(duração máxima de anúncios puláveis)

O parâmetro de solicitação de anúncio sdmax (duração máxima do anúncio pulável) aceita um valor variável que permite aos editores especificar a duração máxima desejada para os anúncios puláveis.

A duração em milissegundos representa o limite máximo permitido para a duração dos criativos de vídeo/áudio puláveis para essa solicitação de anúncio específica.

Use sdmax de forma independente para anúncios puláveis ou em combinação com o parâmetro max_ad_duration atual para definir durações máximas diferentes para anúncios puláveis e não puláveis.

Exemplo de uso

Usando as seguintes configurações:

  • max_ad_duration = 15.000 (15 segundos)
  • sdmax = 45.000 (45 segundos)

Para os seguintes criativos:

  • Criativo A: não pulável. 30 s
  • Criativo B: pulável. 30 s

Resulta em:

  • O criativo A será filtrado porque não é pulável e a duração dele ultrapassa o limite máximo de (não puláveis).
  • O criativo B não será filtrado porque, embora sua duração ultrapasse max_ad_duration, ele é pulável, e a duração não excede o máximo de puláveis.
sid

(ID da sessão)

O parâmetro ID da sessão aceita um valor variável que é um identificador de publicidade com proteção de privacidade usado apenas para fins de limite de frequência.

O ID de sessão é compatível com solicitações de vídeo in-stream de smart TVs e inventário de vídeo in-stream de dispositivos móveis de apps. No momento, ele não é compatível com a Web.

De acordo com as diretrizes de identificadores de publicidade (IFA) do IAB (sigla e página em inglês), esse parâmetro precisa ser preenchido no formato UUID. Saiba mais sobre identificadores de dispositivos redefiníveis para segmentação de usuários.

Para desativar a transmissão do ID da sessão, defina sid=0.

Exemplo de uso

123e4567-e89b-12d3-a456-426614174000

Requisito

recomendado Recomendado para monetização programática

ssss

(origem de agrupamento do lado do servidor)

O parâmetro de origem de agrupamento do lado do servidor aceita um valor constante que precisa ser definido como um valor reconhecido e fornecido pelo Google para o fornecedor da tecnologia de agrupamento de vídeos.

Os fornecedores que usam integrações de servidor para servidor com o Google recebem esse valor do Google e podem fornecê-lo a você. Entre em contato com seu gerente de contas do Google em caso de dúvidas sobre o valor a ser definido para esse parâmetro.

Exemplo de uso

ssss=mystitcher

Requisito

Obrigatório Obrigatório para implementações do lado do servidor

sz

(tamanho)

O parâmetro tamanho aceita valores variáveis que precisam ser definidos como o tamanho do espaço de anúncio em vídeo principal.

Tamanhos diferentes devem ser separados pelo caractere da barra vertical (|).

Não inclua "v" após o tamanho.

Exemplo de uso

sz=400x300

Requisito

Obrigatório Obrigatório para Web e apps

Esse parâmetro é opcional caso apenas ad_type=audio seja solicitado.

tfcd

(tag para "feito para crianças")

O parâmetro feito para crianças aceita um valor constante que marca a solicitação de anúncio com a tag de tratamento para direcionamento a crianças.

Exemplo de uso

tfcd=1

trt

(tipo de tráfego)

O parâmetro do tipo de tráfego aceita um valor constante que funciona para solicitar tráfego comprado ou orgânico.

O SDK do IMA não preencherá um valor padrão se o parâmetro do tipo de tráfego não estiver presente em uma solicitação. Nesses casos, o servidor fornece um valor padrão 0 (tráfego indefinido).

Exemplo de uso

Solicitação de tráfego comprado:
trt=1

Solicitação de tráfego orgânico:
trt=2

unviewed_position_start

(impressões atrasadas)

O parâmetro impressões atrasadas aceita um valor constante para indicar as impressões atrasadas do vídeo.

Exemplo de uso

unviewed_position_start=1

Requisito

Obrigatório Obrigatório para Web e apps

url

(URL)

O parâmetro URL aceita um valor variável que precisa ser definido como o URL completo de que a solicitação é enviada. Esse valor é necessário para ajudar compradores a identificar e entender o contexto da origem da solicitação. Na medida do possível, esse valor deve ser dinamicamente preenchido na solicitação de anúncio.

Em uma página da Web, é o URL da página que exibe o player de vídeo. Se você usa o SDK do IMA, o valor do URL é definido automaticamente. Se o player definir esse valor, o SDK do IMA vai respeitar o valor definido.

Em um app (para dispositivos móveis ou smart TV), esse valor precisa ser definido como um URL que representa mais precisamente o inventário de vídeo ou áudio monetizado. Por exemplo, se o usuário está assistindo a um vídeo em um app para dispositivos móveis que também está disponível em um URL equivalente para computador.*

O valor desse parâmetro precisa ser codificado.

Exemplo de uso

url=https%3A%2F%2Fwww.videoad.com%2Fgolf.html

* Para apps, se não for possível definir esse parâmetro como um valor de URL variável, é recomendável definir com o seguinte padrão:
url=https%3A%2F%2F<app/bundleid>.adsenseformobileapps.com

Requisito

Obrigatório Obrigatório para Web e apps

recomendado Recomendado para monetização programática

vad_type

(tipo de anúncio em vídeo)

O parâmetro tipo de anúncio em vídeo aceita um valor constante que indica se o retorno será um anúncio não linear ou um anúncio linear.

Exemplo de uso

Retornar um anúncio linear:
vad_type=linear

Retornar um anúncio não linear:
vad_type=nonlinear

vid_d

(duração do vídeo)

Este parâmetro aceita um valor variável que especifica a duração do conteúdo, em segundos.

Os parâmetros vid_d e allcues são usados para veicular anúncios intermediários sem processamento de conteúdo. Também são necessárias regras de anúncio para retornar anúncios intermediários.

Exemplo de uso

Duração do conteúdo do vídeo de 90.000 segundos (25 horas):
vid_d=90000

vconp

(vídeo contínuo)

Recomendado pelas diretrizes de avaliação de vídeo do MRC (em inglês)

O parâmetro de vídeo contínuo aceita um valor constante que indica se o player exibirá conteúdo em vídeo continuamente, como uma transmissão de TV.

Esse parâmetro deverá ser deixado indefinido se for desconhecido.

Exemplo de uso

Exibição contínua ATIVADA:
vconp=2

Exibição contínua DESATIVADA:
vconp=1

vpa

(reprodução de vídeo automática)

Recomendado por MRC Diretrizes de avaliação de vídeos

O parâmetro reprodução de vídeo automática aceita um valor constante que indica se o conteúdo do vídeo em um anúncio começa por reprodução automática ou por clique.

Os valores possíveis são click, se a página aguardar uma ação do usuário, ou auto, se o vídeo for reproduzido automaticamente.

Esse parâmetro deverá ser deixado indefinido se for desconhecido.

Exemplo de uso

Reprodução automática:
vpa=auto

Clique para ver:
vpa=click

Requisito

recomendado Recomendado para monetização programática

vpi

(redirecionamento interno da playlist de vídeo)

O parâmetro redirecionamento interno da playlist de vídeo aceita um valor constante que indica se será ou não veiculado o VMAP inline (retornar um VAST dentro do VMAP).

Esse parâmetro pode ser usado para reduzir a latência e garantir os limites de frequência e exclusões competitivas em um stream de vídeo.

Exemplo de uso

Retornar VAST:
vpi=1

Retornar redirecionamentos:
vpi=0

vpmute

(reprodução de vídeo com som desativado)

Recomendado por MRC Diretrizes de avaliação de vídeos

O parâmetro vídeo sem som aceita um valor constante que indica se o anúncio exibe ou não o vídeo quando o player está sem som.

Exemplo de uso

Som desativado:
vpmute=1

Som ativado:
vpmute=0

Requisito

Obrigatório Obrigatório para Web e monetização programática

vpos

(posição de vídeo)

O parâmetro posição do vídeo aceita um valor constante que indica se a solicitação de anúncio é enviada pelo anúncio precedente, pelo anúncio intermediário ou pelo anúncio final.

Exemplo de uso

Anúncio precedente:
vpos=preroll

Anúncio intermediário:
vpos=midroll

Anúncio final:
vpos=postroll

Requisito

recomendado Recomendado para monetização programática

wta

(Por que esse anúncio?)

O parâmetro "Por que esse anúncio?" aceita um valor constante que indica a compatibilidade do player de vídeo com a renderização de "Por que esse anúncio?".

A funcionalidade "Por que esse anúncio?" é compatível automaticamente com o SDK do IMA. Quando o SDK do IMA não é usado, os players de vídeo precisam implementar a compatibilidade de Icon e IconClickFallbackImage do VAST, conforme documentado no padrão VAST do IAB.

As solicitações de anúncios em áudio precisarão enviar wta=1 se o ícone "Opções de anúncios", conforme indicado na resposta VAST, for renderizado em complementares ou outra forma fornecida ao usuário.

Para estarem qualificadas para a Demanda do Google e o tráfego de reservas hospedado pelo Google no EEE, as solicitações de anúncios precisam enviar wta=1 para indicar que o ícone "Opções de anúncios", conforme fornecido na resposta VAST, é renderizado no anúncio em vídeo, nos complementares ou em outra forma fornecida ao usuário para todos os criativos de anúncios.

Exemplo de uso

Compatível:
wta=1

Não compatível:
wta=0

Requisito

Obrigatório Obrigatório para o Ad Exchange

Obrigatório Obrigatório para o tráfego da Web e de apps no EEE

recomendado Recomendado para monetização programática

Isso foi útil?

Como podemos melhorá-lo?
Pesquisa
Limpar pesquisa
Fechar pesquisa
Menu principal
9105281387353106607
true
Pesquisar na Central de Ajuda
true
true
true
true
true
148
false
false