Comprendre les fonctions de scripts intelligents

Du moment que la configuration s'effectue conformément aux exigences du marketeur, le script intelligent proposera une attribution web-to-app précise. Le script reste toutefois personnalisable si le développeur a besoin d'y apporter des modifications. La section vous présente les différentes propriétés et fonctions du script, en s'appuyant sur des exemples.

Fonctions des scripts intelligents

Définir le niveau de journalisation

Utilisez la fonction setLogLevel pour définir le niveau de journalisation dans la console de votre navigateur, si nécessaire. Appelez cette fonction avant d'appeler la fonction createLink. Les arguments sont debug, warn, error ou none. La valeur par défaut du niveau de journalisation est debug.

AdjustSmartScript.setLogLevel('warn')

Créer un lien

Utilisez la fonction createLink pour créer un lien Adjust avec les propriétés d'objet de mappage spécifiées.

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

Obtenir la version du script

Utilisez la fonction getVersion pour vérifier la version des scripts intelligents.

AdjustSmartScript.getVersion()

Propriétés de l'objet de mappage

Vous devez passer l'objet mapping à la méthode createLink. Vous DEVEZ définir les propriétés suivantes dans l'objet mapping.

defaultLinkToken (string): Token de lien à utiliser lorsqu'aucun token de lien n'est applicable ou qu'aucune configuration réseau n'a été indiquée.

campaign (object): Un objet contenant les informations de campagne.
adgroup (object): Un objet contenant les informations d'adgroup.
creative (object): Un objet contenant les informations de créatif.

Les objets campaign, adgroup et creative DOIVENT contenir la propriété suivante :

in (string | string[]): Une chaîne ou un tableau de chaînes qui sont des clés de paramètres URL (chaînes de requête) à utiliser comme nom de la campagne, de l'adgroup ou du créatif.; Si un tableau est passé, le script trouve les noms parmi les paramètres GET et les passe à la fonction transform, si elle présente. Sinon, le script écrit la première valeur non vide comme nom de campagne, d'adgroup ou de créatif.

Vous POUVEZ également indiquer les propriétés suivantes :

transform (function): Une fonction appelée avec la valeur in. Elle renvoie une valeur de chaîne qui est le nom final de la campagne, de l'adgroup ou du créatif. Si transform ne renvoie pas une chaîne ou donne une erreur, le script écrit la première valeur non vide comme nom de campagne, d'adgroup ou de créatif.
defaultValue (string): Utilisé lorsque la valeur in n'est pas trouvée par la fonction transform.

Si vous avez mis en place le deep linking, vous DEVEZ définir les paramètres suivants dans l'objet mapping.

domain (string) : Le domaine personnalisé. : Vous pouvez choisir de définir le domaine personnalisé si vous n'avez pas mis en place le deep linking. Si aucun domaine n'est spécifié, un lien app.adjust.com est créé.

iosAppSchema (string) : Le schéma d'application iOS.

androidAppSchema (string) : Le schéma d'application Android.

Si vous avez mis en place le deep linking, vous POUVEZ définir les paramètres suivants.

iosDeeplinkPath (string) : Le chemin de deep link iOS.

androidDeeplinkPath (string) : Le chemin de deep link Android.

Vous POUVEZ définir les paramètres suivants dans l'objet mapping.

inputUrl (string) : L'URL de la landing page du site web mobile. Si vous n'indiquez aucune valeur, le script utilise la valeur window.location.href comme URL de page actuelle.

label (object`) Ce paramètre vous permet d'envoyer des données personnalisées. Consultez la documentation du Centre d'aide pour plus de détails.

networks (object): Un objet clé-valeur contenant les informations réseau.

L'objet networks DOIT contenir au moins une clé représentant un nom réseau. Les clés suivantes sont prises en charge :

Meta
google_ads

La valeur DOIT être un objet contenant la propriété suivante :

linkToken (string): Le token de lien du réseau défini dans la clé.

customParameters (object): Un objet contenant les informations du paramètre personnalisé.

Les objets customParameters DOIVENT contenir la propriété suivante :

in (string | string[]): Une chaîne ou un tableau de chaînes qui sont des clés de paramètres URL (chaînes de requête) à utiliser comme nom personnalisé.; Si un tableau est passé, le script trouve les noms parmi les paramètres GET et les passe à la fonction transform, si elle présente. Sinon, le script écrit la première valeur non vide comme nom personnalisé.
out (string): Une chaîne qui spécifie le nom du paramètre personnalisé à écrire dans le lien Adjust.

Vous POUVEZ également indiquer les propriétés suivantes :

transform (function): Une fonction appelée avec la valeur in. Elle renvoie une valeur de chaîne qui est le nom personnalisé final. Si transform ne renvoie pas une chaîne ou donne une erreur, la première valeur non vide est écrite comme nom personnalisé.
defaultValue (string): Utilisé lorsque la valeur in n'est pas trouvée par la fonction transform.

Exemples

Utiliser les paramètres de token de lien et de campagne

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)
// résultat attendu : https://app.adjust.com/abcd123?campaign=Summer2024&adgroup=SomeGroup

Configurer les tokens de lien pour différents partenaires avec la propriété du réseau

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)
// résultat attendu : 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)
// résultat attendu : https://app.adjust.com/efgh5678?fbclid=FB_CLICK_ID&campaign=Winter2025&adgroup=AnotherGroup&creative=image

Utiliser et transformer les propriétés defaultValue pour réécrire les valeurs dans le lien 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)
// résultat attendu : https://branded.go.link?adj_token=example123&adj_campaign=new_campaign&adj_adgroup=some-source%3A%20social&adj_creative=ad_logo_image

Écrire les paramètres personnalisés vers le lien 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)
// résultat attendu : https://example.go.link?adj_token=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image&ref_code=id%2Bmy_product

Créer des deeplinks

Deplink 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)
// résultat attendu : https://example.go.link/path/to/screen?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Deeplink 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)
// résultat attendu : https://example.go.link/some/path?adjust_t=abcd1234&adj_campaign=new_campaign&adj_adgroup=some_adset&adj_creative=logo_image

Deeplink iOS et 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)
// résultat attendu : 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

Tester les scripts intelligents

Les scripts intelligents génèrent leurs journaux dans la console du navigateur. Nous vous conseillons de tester la façon dont le script fonctionne avec le mappage spécifié et veiller à ce que les liens corrects soient générés.

Dans votre navigateur, accédez à la console des outils de développement.
Accédez à la page web où vous avez mis en place les scripts intelligents.
S'il n'y a pas de journaux avec le préfixe [adjust-smart-script], actualisez la page. Si vous ne voyez toujours pas de journaux, vérifiez que :
- Votre code ne supprime pas la journalisation en appelant AdjustSmartScript.setLogLevel('error') ou AdjustSmartScript.setLogLevel('none').
- Votre appelle la fonction AdjustSmartScript.createLink(params).

Avec différentes valeurs de la propriété inputUrl, vous pouvez tester différents cas d'utilisation. Par exemple, si vous exécutez une campagne Meta et que vous attendez également que les utilisateurs organiques visitent votre landing page, vous pouvez avoir une URL avec les paramètres de campagne et Meta et une autre URL sans paramètre additionnel.

Exemple de journaux :

[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