API de plataforma digital: servicio De comprobación de macro creativa

Artículo
05/17/2024

Si ejecuta creatividades de terceros, puede usar este servicio para permitir que Xandr compruebe etiquetas de terceros y anexe parámetros en la cadena de consulta, reemplace el dominio o inserte macros de seguimiento de clics Xandr en el lugar adecuado para usted. Actualmente se admiten los siguientes servidores de anuncios: MediaMind, Atlas, Fetchback y DoubleClick.

Si podemos insertar las macros Xandr, se devolverá la nueva etiqueta o dirección URL en la respuesta. Si no podemos garantizar que se insertó la macro correcta (el valor de los existing_other_macros campos o unmatched no es 0 dentro de la respuesta), el valor dentro del new_content campo o new_media_url no se mostrará en la interfaz de usuario.

API de REST

Http (método)	Endpoint	Description
`PUT`	https://api.appnexus.com/creative-macro-check (replace_pattern_in_content_url JSON)	Reemplace el contenido dentro de una dirección URL en función de patrones predefinidos.
`PUT`	https://api.appnexus.com/creative-macro-check?include_tests=1 (replace_pattern_in_content_url JSON)	Reemplace el contenido dentro de una dirección URL en función de patrones predefinidos y patrones de prueba.

Campos JSON

Campo	Tipo	Descripción
`content`	string	El campo se usa al modificar el contenido. Contenido que se va a modificar para incluir macros Xandr. Obligatorio en:`PUT`, al transformar contenido.
`new_content`	string	El campo se rellena al modificar el contenido. Contenido actualizado donde se han evaluado todas las macros no seguras. Este campo contendrá el mismo valor `content` que a menos que todas las macros Xandr se inserten correctamente.
`new_content_secure`	string	El campo se rellena al modificar el contenido. Contenido actualizado en el que se han evaluado todas las macros, tanto seguras como no seguras. Este campo contendrá el mismo valor `content` que a menos que todas las macros Xandr se inserten correctamente.
`media_url`	string	El campo se usa al modificar una dirección URL multimedia. Dirección URL multimedia que se está modificando para incluir macros Xandr. Obligatorio en:`PUT` al transformar una dirección URL de medios.
`new_media_url`	string	El campo se rellena al modificar una dirección URL multimedia. Dirección URL multimedia actualizada donde se han evaluado todas las macros no seguras. Este campo contendrá el mismo valor `media_url` que a menos que todas las macros Xandr se inserten correctamente.
`new_media_url_secure`	string	El campo se rellena al modificar una dirección URL multimedia. Dirección URL multimedia actualizada donde se han evaluado todas las macros, seguras y no seguras. Este campo contendrá el mismo valor `media_url` que a menos que todas las macros Xandr se inserten correctamente.
`recognized_servers`	matriz de cadenas	Los nombres de los adservers que contienen un patrón de dirección URL que coincide con el valor dentro del `content` campo o `media_url` . Para obtener más información, vea Reemplazos de macros a continuación.
`found_urls`	Entero	Número de direcciones URL 'src=' o 'href=' que se encuentran en el contenido creativo.
`matched_urls`	Entero	El número de que proceden de `found_urls` un servidor de anuncios reconocido.
`macro_replacements`	matriz	Matriz con información sobre los reemplazos que se realizaron, que se enumeran por tipo de macro (por ejemplo, cachebuster). Para obtener más información, vea Reemplazos de macros a continuación.
`warning`	string	Este campo muestra un mensaje de advertencia si el valor dentro de `new_content_secure` o `new_media_url_secure` no es seguro.

Reemplazos de macros

Campo	Tipo	Descripción
`type`	string	Especifica si el objeto tiene información sobre cachebuster o .`click_url`
`replaced`	Entero	Número de direcciones URL que tenían una macro para que `type` se insertó correctamente.
`existing_other_macro`	Entero	Número de direcciones URL en las que pudimos determinar dónde insertar la macro, pero ya había algo allí, por lo que la dejamos sola. Si este valor no es 0, el valor dentro del `new_content` campo o `new_media_url` no se mostrará en la interfaz de usuario.
`existing_appnexus_macro`	Entero	Número de direcciones URL en las que hemos podido determinar dónde insertar las macros.
`unmatched`	Entero	Número de direcciones URL para las que no se pudo determinar cómo insertar las macros. Si este valor no es 0, el valor dentro del `new_content` campo o `new_media_url` no se mostrará en la interfaz de usuario.

Servidores reconocidos

Campo	Tipo	Descripción
`adserver_name`	string	Nombre del adserver.

Ejemplos

Reemplazar macros dentro de una etiqueta de terceros (contenido)

El campo de contenido puede incluir varias direcciones URL, pero en este ejemplo el campo de contenido solo contiene una dirección 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}

Reemplazar macros dentro de una dirección URL de terceros (dirección URL multimedia)

{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}

Compartir a través de