API de plateforme numérique - Service Creative Macro Check

Si vous exécutez des créations tierces, vous pouvez utiliser ce service pour autoriser Xandr à case activée balises tierces et à ajouter des paramètres dans la chaîne de requête, à remplacer le domaine ou à insérer des macros de suivi des clics Xandr à l’emplacement approprié. Nous prenons actuellement en charge les serveurs publicitaires suivants : MediaMind, Atlas, Fetchback et DoubleClick.

Si nous sommes en mesure d’insérer les macros Xandr, la nouvelle balise ou URL est retournée dans la réponse. Si nous ne parvenons pas à nous assurer que la macro appropriée a été insérée (la valeur dans les existing_other_macros champs ou n’est unmatched pas 0 dans la réponse), la valeur dans le new_content champ ou new_media_url n’est pas affichée dans l’interface utilisateur.

API REST

HTTP, méthode	Endpoint	Description
`PUT`	https://api.appnexus.com/creative-macro-check (replace_pattern_in_content_url JSON)	Remplacez le contenu d’une URL en fonction de modèles prédéfinis.
`PUT`	https://api.appnexus.com/creative-macro-check?include_tests=1 (replace_pattern_in_content_url JSON)	Remplacez le contenu d’une URL en fonction de modèles prédéfinis et de modèles de test.

Champs JSON

Champ	Type	Description
`content`	string	Le champ est utilisé lors de la modification du contenu. Contenu en cours de modification pour inclure des macros Xandr. Obligatoire Sur :`PUT`, lors de la transformation du contenu.
`new_content`	string	Le champ est rempli lors de la modification du contenu. Contenu mis à jour dans lequel toutes les macros non sécurisées ont été évaluées. Ce champ contient la même valeur que `content` sauf si toutes les macros Xandr sont correctement insérées.
`new_content_secure`	string	Le champ est rempli lors de la modification du contenu. Contenu mis à jour dans lequel toutes les macros, sécurisées et non sécurisées, ont été évaluées. Ce champ contient la même valeur que `content` sauf si toutes les macros Xandr sont correctement insérées.
`media_url`	string	Le champ est utilisé lors de la modification d’une URL de média. URL du média en cours de modification pour inclure des macros Xandr. Obligatoire Sur :`PUT`, lors de la transformation d’une URL de média.
`new_media_url`	string	Le champ est rempli lors de la modification d’une URL de média. URL du média mise à jour où toutes les macros non sécurisées ont été évaluées. Ce champ contient la même valeur que `media_url` sauf si toutes les macros Xandr sont correctement insérées.
`new_media_url_secure`	chaîne	Le champ est rempli lors de la modification d’une URL de média. URL du média mise à jour où toutes les macros, sécurisées et non sécurisées, ont été évaluées. Ce champ contient la même valeur que `media_url` sauf si toutes les macros Xandr sont correctement insérées.
`recognized_servers`	tableau de chaînes	Noms des serveurs adserver qui contiennent un modèle d’URL correspondant à la valeur dans le `content` champ ou `media_url` . Pour plus d’informations, consultez Remplacements de macros ci-dessous.
`found_urls`	int	Nombre d’URL « src= » ou « href= » trouvées dans le contenu créatif.
`matched_urls`	int	Nombre de `found_urls` qui proviennent d’un serveur publicitaire reconnu.
`macro_replacements`	tableau	Tableau contenant des informations sur les remplacements effectués, répertoriés par type de macro (par exemple, cachebuster). Pour plus d’informations, consultez Remplacements de macros ci-dessous.
`warning`	string	Ce champ affiche un message d’avertissement si la valeur dans ou n’est `new_content_securenew_media_url_secure` pas sécurisée.

Remplacements de macros

Champ	Type	Description
`type`	string	Spécifie si l’objet contient des informations sur le cachebuster ou le `click_url`.
`replaced`	int	Nombre d’URL qui avaient une macro pour laquelle l’insertion `type` a réussi.
`existing_other_macro`	int	Nombre d’URL dans lesquelles nous avons pu déterminer où insérer la macro, mais il y avait déjà quelque chose, donc nous l’avons laissée seule. Si cette valeur n’est pas 0, la valeur dans le `new_content` champ ou `new_media_url` n’est pas affichée dans l’interface utilisateur.
`existing_appnexus_macro`	int	Nombre d’URL dans lesquelles nous avons pu déterminer où insérer les macros.
`unmatched`	int	Nombre d’URL pour lesquelles nous n’avons pas pu déterminer comment insérer les macros. Si cette valeur n’est pas 0, la valeur dans le `new_content` champ ou `new_media_url` n’est pas affichée dans l’interface utilisateur.

Serveurs reconnus

Champ	Type	Description
`adserver_name`	string	Nom du serveur adserver.

Exemples

Remplacer des macros dans une balise tierce (contenu)

Le champ de contenu peut inclure plusieurs URL, mais dans cet exemple, le champ de contenu ne contient qu’une seule URL.

{code}
$ cat /tmp/replace-macros-in-tag.json

{
    "creative-macro-check": {
        "content": "<a href=\"https://clk.atdmt.com/CCC/go/329458985/direct/01">test</a>"
    }
}

$ curl -b cookies -X PUT -d '@/tmp/replace-macros-in-tag.json' "https://api.appnexus.com/creative-macro-check"

{
  "response": {
    "status": "OK",
    "creative-macro-check": {
      "new_content": "<a href=\"${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
      "new_content_secure": "<a href=\"${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
      "content": "<a href=\"https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01\">test<\/a>",
      "media_url": null,
      "new_media_url": null,
      "new_media_url_secure": null,
      "recognized_servers": [
        "Atlas"
      ],
      "recognized_server": "Atlas",
      "found_urls": 1,
      "matched_urls": 1,
      "macro_replacements": [
        {
          "type": "click",
          "replaced": 1,
          "existing_other_macro": 0,
          "existing_appnexus_macro": 0,
          "unmatched": 0
        }
      ],
      "warning": "new_content_secure contains some non secure urls"
    },
    "count": 1,
    "start_element": null,
    "num_elements": null
  }
}
{code}

Remplacer les macros dans une URL tierce (URL de média)

{code}
$ cat /tmp/replace-macros-in-url.json

{
    "creative-macro-check": {
        "media_url": "https://clk.atdmt.com/CCC/go/329458985/direct/01"
    }
}

$ curl -b cookies -c cookies -X PUT -d '@/tmp/replace-macros-in-url.json' 'https://api.appnexus.com/creative-macro-check'

{
  "response": {
    "status": "OK",
    "creative-macro-check": {
      "content": null,
      "new_content": null,
      "new_content_secure": null,
      "media_url": "https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
      "new_media_url": "${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
      "matched_urls": 1,
      "new_media_url_secure": "${CLICK_URL}https:\/\/clk.atdmt.com\/CCC\/go\/329458985\/direct\/01",
      "recognized_servers": [
        "Atlas"
      ],
      "recognized_server": "Atlas",
      "found_urls": 1,
      "macro_replacements": [
        {
          "type": "click",
          "replaced": 1,
          "existing_other_macro": 0,
          "existing_appnexus_macro": 0,
          "unmatched": 0
        }
      ],
      "warning": "new_media_url_secure is not secure"
    },
    "count": 1,
    "start_element": null,
    "num_elements": null
  }
}
{code}

Last updated on 2025-04-01

Partager via