Manual da API de Rich Media

Anexar valores ou parâmetros a um URL de saída

Objetivo

Acrescentar valores a um URL com base na resposta dos usuários ou em valores dinâmicos dos criativos.

Essa solução adiciona parâmetros para os URLs de saída definidos no Studio ou no Campaign Manager 360. Se você quiser usar URLs de saída dinâmica extraídos de uma fonte de dados externa, como um feed XML ou uma planilha do Google, consulte Usar URLs de saída dinâmica.

Solução

Use uma string de consulta de saída adicionando o método Enabler.exitQueryString(). Consulte a referência SDK HTML5 do Studio para ver mais detalhes.

Uma string de consulta de saída é útil quando você quer enviar dados para uma página de destino. Por exemplo, se você tiver um campo de texto solicitando que o usuário envie seu CEP em um criativo, use uma string de consulta de saída para passar o CEP para uma página de destino usando o URL de destino.

O Studio somente adiciona a string de consulta a um URL de saída, não tendo controle sobre como esses dados são utilizados na página de destino. Para que os dados da string de consulta funcionem no site, este deve estar ciente dos parâmetros de consulta que estão sendo passados.

Exemplos

Este artigo aborda duas formas de usar uma string de consulta de saída:

Para acrescentar valores ao URL de destino de uma saída na forma padrão de uma string de consulta, use Enabler.exitQueryString(id, opt_queryString) em vez de Enabler.exit(). Digite o URL base na IU do Studio da mesma forma que faria com um evento de saída padrão. O parâmetro queryString é acrescentado ao fim do URL.

Com esse método, o Studio detecta automaticamente se o URL que você inseriu já possui uma string de consulta e escolhe um "?" ou um "&" como separador. Dessa forma, não é preciso adicionar manualmente um separador no valor de consulta da string no criativo.

Saiba mais sobre como o Studio escolhe um "?" ou um "&" em uma string de consulta de saída

Esse é um exemplo básico da chamada que você faria para preencher seu URL com o valor de uma variável theaterVar, bem como o URL completo resultante, incluindo o caractere de pontuação adicionado pelo Studio.

Enabler.exitQueryString("Buy Tickets","venue="+theaterVar);
Se o URL para "Buy Tickets" for https://www.yoursite.com/purchasetickets.html, a saída será: https://www.yoursite.com/purchasetickets.html?venue=thecoliseum

Como o URL que você inseriu no Studio ainda não tem uma string de consulta, o Studio escolhe acrescentar o valor com um "?". No entanto, se o URL para "Buy Tickets" for https://www.yoursite.com/purchasetickets.html?showid=1234, a saída será:

https://www.yoursite.com/purchasetickets.html?showid=1234&venue=thecoliseum

Como o URL que você inseriu no Studio já inclui uma string de consulta, o Studio opta por acrescentar o valor com um "&".

Acrescentar as respostas dos usuários a um URL de saída

Para acrescentar as informações do CEP de um usuário a partir de um campo de inserção de texto no criativo para uma página de destino, siga este exemplo:

var zipCode = document.getElementById("zipcode").value;

function zipExitHandler() {

  // Por exemplo, se "10023" estiver em um campo de texto com código "zipcode".
  Enabler.exitQueryString("my zip exit", "zip="+ zipCode);
}

exitBtn.addEventListener('click', zipExitHandler, false);

No Studio, se você digitar o URL http://www.purchasetickets.com para my zip exit, o resultado será:

http://www.purchasetickets.com?zip=10023
Acrescentar pares de valor-chave a um URL de saída

Para acrescentar os valores loc e name, configurados por um coordenador de publicidade ou um site a uma página de destino, siga este exemplo:

Os valores loc e name precisarão ser acessados usando o método Enabler.getParameter() do Studio. Para saber mais sobre ele, consulte a documentação do SDK HTML5 do Studio.

var locVar = Enabler.getParameter("loc");
var nameVar = Enabler.getParameter("name");

function onKeyValueExitHandler() {
  Enabler.exitQueryString(
      "my key value exit",
      "loc="+locVar+"&name="+nameVar);
}

exitBtn.addEventListener('click', onKeyValueExitHandler, false);

No Studio, se você digitar o URL http://www.purchasetickets.com para my key value exit, e o valor-chave estiver configurado como "madison" para loc e "mraz" para name, o resultado será:

http://www.purchasetickets.com?loc=madison&name=mraz

Isso foi útil?

Como podemos melhorá-lo?

Precisa de mais ajuda?

Siga as próximas etapas:

Pesquisa
Limpar pesquisa
Fechar pesquisa
Menu principal
11379023172837286409
true
Pesquisar na Central de Ajuda
true
true
true
true
true
74220
false
false