Entenda as funções dos scripts inteligentes

Desde que a configuração seja feita de acordo com os requisitos do profissional de marketing, o script inteligente deve fornecer uma atribuição web para aplicativo precisa. No entanto, o script é personalizável se o desenvolvedor precisar fazer mais alterações. A seção abaixo guia você pelas diferentes propriedades e funções do script e fornece exemplos.

Funções dos scripts inteligentes

Set log level

Use a função setLogLevel para definir o nível de log no console do seu navegador, caso necessário. Chame essa função antes de chamar a createLink. Os argumentos são debug, warn, error ou none. O valor do nível de log padrão é debug.

AdjustSmartScript.setLogLevel('warn')

Criar link

Use a função createLink para criar um link da Adjust com as propriedades de mapeamento do objeto especificadas.

const mapping = { /* mapping object properties */ }
AdjustSmartScript.createLink(mapping)

Get version

Use a função getVersion para conferir a versão dos scripts inteligentes.

AdjustSmartScript.getVersion()

Mapeamento de propriedade de objeto

É obrigatório passar o objeto mapping ao método createLink. É OBRIGATÓRIO definir as seguintes propriedades no objeto mapping.

defaultLinkToken (string): token de link a ser usado quando nenhum link de rede for válido ou nenhuma configuração de rede tiver sido fornecida.

campaign (object): um objeto que contém informação da campanha.
adgroup (object): um objeto que contém informação do grupo de anúncios.
creative (object): um objeto que contém informação do criativo.

Os objetos campaign, adgroup e creative PRECISAM conter as seguintes propriedades:

in (string | string[]): uma string ou matriz de strings que são chave das strings de consulta de pesquisa de URL a serem usadas como nome da campanha, do grupo de anúncios ou do criativo.; se uma matriz é passada, o script encontra os nomes nos parâmetros GET e os passa à função transform, caso ela esteja presente. Caso não esteja, o script escreve o primeiro valor não vazio como o nome da campanha, do grupo de anúncios ou do criativo.

Você também PODE fornecer as seguintes propriedades:

transform (function): uma função chamada com o valor de in. Ela retorna um valor de string com o nome final da campanha, do grupo de anúncios ou do criativo. Se a função transform não retornar uma string ou apresentar um erro, o script escreve o primeiro valor não vazio como o nome da campanha, do grupo de anúncios ou do criativo.
defaultValue (string): usada quando o valor de in não for encontrado na função transform.

Se tiver implementado o deep linking, você PRECISA definir os seguintes parâmetros no objeto mapping:

domain (string): o domínio com marca.; é possível escolher definir o domínio com marca, caso o deep linking não tenha sido implementado. Se nenhum domínio for especificado, um link app.adjust.com será criado.

iosAppSchema (string): o esquema do aplicativo para iOS.

androidAppSchema (string): o esquema do aplicativo para Android.

Se tiver implementado o deep linking, você PODE definir os seguintes parâmetros:

iosDeeplinkPath (string): o caminho do deep link para iOS.

androidDeeplinkPath (string): o caminho do deep link para Android.

Você PODE definir os seguintes parâmetros no objeto mapping.

inputUrl (string): a URL da página de destino mobile. Se não for definido um valor, o script usará o valor window.location.href como a URL atual da página.

label (object`) Este parâmetro permite que você envie dados personalizados. Confira a documentação da Central de Ajuda para mais informações.

networks (object): um objeto de valor-chave que contém informação de rede.

O objeto networks PRECISA conter ao menos uma chave representando um nome de rede. As seguintes chaves são compatíveis:

Meta
google_ads

O valor PRECISA ser um objeto contendo a seguinte propriedade:

linkToken (string): o token de link da rede definido na chave.

customParameters (object): um objeto que contém informações de parâmetro personalizado.

O objeto customParameters PRECISA conter a seguinte propriedade:

in (string | string[]): uma string ou matriz de strings que são chave das strings de consulta de pesquisa de URL a serem usadas como nome personalizado.; se uma matriz é passada, o script encontra os nomes nos parâmetros GET e os passa à função transform, caso ela esteja presente. Caso não esteja, o script escreve o primeiro valor não vazio como o nome personalizado.
out (string): uma string que especifica o nome do parâmetro personalizado a ser escrito no link da Adjust.

Você também PODE fornecer as seguintes propriedades:

transform (function): uma função chamada com o valor de in. Ela retorna um valor de string com o nome personalizado final. Se a função transform não retornar uma string ou apresentar um erro, o primeiro valor não vazio será escrito como o nome personalizado.
defaultValue (string): usada quando o valor de in não for encontrado na função transform.

Exemplos

Uso de token de link e parâmetros de campanha

const mapping = {
  inputUrl: "https://www.landing.com?campaign_name=Summer2024&ad_group=SomeGroup",
  defaultLinkToken: "abcd123",
  campaign: { in: "campaign_name" },
  adgroup: { in: "ad_group" },
  creative: { in: "element" }
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://app.adjust.com/abcd123?campaign=Summer2024&adgroup=SomeGroup

Configuração de tokens de links para diferentes parceiros com a propriedade das redes

const mapping = {
  defaultLinkToken: "abcd1234",
  networks: {
    meta: { linkToken: 'efgh5678'},
    google_ads: { linkToken: 'ijkl9012' }
  },
  campaign: { in: "c" },
  adgroup: { in: "a" },
  creative: { in: "cr" }
}
const link1 = AdjustSmartScript.createLink({
  ...mapping,
  inputUrl: "https://www.landing.com?c=Summer2024&a=SomeGroup&cr=banner&gclid=CLICK_ID"
});
console.log(link1)
// expected output: https://app.adjust.com/ijkl9012?gclid=CLICK_ID&campaign=Summer2024&adgroup=SomeGroup&creative=banner
const link2 = AdjustSmartScript.createLink({
  ...mapping,
  inputUrl: "https://www.landing.com?c=Winter2025&a=AnotherGroup&cr=image&fbclid=FB_CLICK_ID"
});
console.log(link2)
// expected output: https://app.adjust.com/efgh5678?fbclid=FB_CLICK_ID&campaign=Winter2025&adgroup=AnotherGroup&creative=image

Uso das propriedades transform e defaultValue para reescrever os valores no link da Adjust

const mapping = {
  inputUrl: "https://www.landing.com?utm_content=logo_image&utm_medium=social&utm_source=some-source&utm_campaign=new_campaign",
  defaultLinkToken: "example123",
  domain: "branded.go.link",
  campaign: {
    in: "utm_campaign",
    defaultValue: "dummy-name"
  },
  adgroup: {
    in: ["utm_source", "utm_medium"],
    transform: function(values) { return (values[0] && values[1]) ? `${values[0]}: ${values[1]}` : undefined; }
  },
  creative: {
    in: "utm_content",
    transform: function(values) { return values[0] ? `ad_${values[0]}` : 'ad_default' }
  }
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://branded.go.link?adj_token=example123&adj_campaign=new_campaign&adj_adgroup=some-source%3A%20social&adj_creative=ad_logo_image

Escrita dos parâmetros personalizados no link da Adjust

const mapping = {
  inputUrl: "https://www.landing.com?user_id=id&cr=logo_image&ad=some_adset&c=new_campaign&product=my_product",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  customParameters: [{
    in: ['product', 'user_id'],
    out: 'ref_code',
    transform: function (values) {
      const product = values[0]
      const userId = values[1]
      if (product && userId) {
        return `${userId}+${product}`
      }
      return ''
    }
  }]
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link?adj_token=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image&ref_code=id%2Bmy_product

Criação de deep links

Deep link para iOS

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  iosAppSchema: "app",
  iosDeeplinkPath: "path/to/screen",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link/path/to/screen?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Deep link do Android

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  androidAppSchema: "scheme",
  androidDeeplinkPath: "some/path",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://example.go.link/some/path?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Deep link para iOS e Android

const mapping = {
  inputUrl: "https://www.landing.com?&cr=logo_image&ad=some_adset&c=new_campaign",
  domain: "example.go.link",
  defaultLinkToken: "abcd1234",
  campaign: { in: "c" },
  adgroup: { in: "ad" },
  creative: { in: "cr" },
  androidAppSchema: "scheme",
  androidDeeplinkPath: "some/path",
  iosAppSchema: "app",
  iosDeeplinkPath: "path/to/screen",
}
const link = AdjustSmartScript.createLink(mapping);
console.log(link)
// expected output: https://hello.go.link/path/to/screen?adjust_t=abcd1234&adjust_deeplink=scheme%3A%2F%2Fsome%2Fpath&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Teste dos scripts inteligentes

Os scripts inteligentes geram seus logs no console do navegador. Nós recomendamos testar como o script funciona com o mapeamento específico e garantir que os links corretos estão sendo gerados.

No seu navegador, vá para as Ferramentas do desenvolvedor.
Vá para a página web em que quer implementar os scripts inteligentes.
Se não houver logs com o prefixo [adjust-smart-script], atualize a página. Se ainda vir nenhum log, confirme se:
- Seu código não está interrompendo a criação de log chamando AdjustSmartScript.setLogLevel('error') ou AdjustSmartScript.setLogLevel('none').
- Seu código está chamando a função AdjustSmartScript.createLink(params).

Com os diferentes valores da propriedade inputUrl, você pode testar diferentes casos de uso. Por exemplo, se estiver executando uma campanha da Meta e espera que usuários orgânicos visitem sua página de destino, você pode configurar uma URL com os parâmetros da campanha e da Meta, e outra URL com quaisquer parâmetros adicionais.

Exemplos de logs:

[adjust-smart-script]: No networks configured
[adjust-smart-script]: Use defaultLinkToken to create adjust link
[adjust-smart-script]: Found value for campaign is new_campaign
[adjust-smart-script]: Found value for adgroup is some_adset
[adjust-smart-script]: Found value for creative is logo_image
[adjust-smart-script]: Transformed value for ref_code is id+my_product
[adjust-smart-script]: Misconfigured deep link: no valid androidAppSchema provided