API de plataforma digital: servicio de perfiles de anuncios

Una red puede querer crear "perfiles de aprobación de anuncios" para definir qué tipos de marcas y creatividades pueden y no pueden publicarse en las páginas de sus editores. El servicio de perfiles de anuncios le permite crear perfiles de aprobación de anuncios en el nivel de miembro o en el nivel de editor. Para crearlos a nivel de editor, incluya un identificador de editor. Si no se incluye ningún Id. de editor, será un perfil de nivel de red disponible para su uso con todos los editores.

Los perfiles de anuncios constan de varios elementos: miembros, marcas, recursos creativos, idioma, atributos técnicos, categorías y servidores de anuncios. Al crear un perfil publicitario, puedes aprobar o prohibir cada creatividad del sistema individualmente, pero es posible que prefieras ahorrar tiempo aprobando o prohibiendo marcas o miembros enteros.

• Se debe confiar en un miembro: Si crees que sus anuncios siempre serán aceptables. Por ejemplo, puede "confiar" en Network A para publicar anuncios de calidad, de modo que pueda mitigar la necesidad de auditar cada uno de sus recursos creativos.
• Se debe confiar en una marca: Si cree que los anuncios de esta marca casi siempre serán aceptables. Sin embargo, siempre tendrá la capacidad de prohibir una creatividad específica, incluso si es parte de una marca "confiable". Si la creatividad específica no está vetada, se publicará de manera predeterminada.
• Una marca debe ser prohibida: Si crees que los anuncios de esta marca nunca serán aceptables. Seguirás teniendo la posibilidad de aprobar una creatividad específica a la que se le asigne una marca "vetada", a menos que el miembro esté vetado.
• El perfil predeterminado (en blanco o ID establecido en 0) prohibirá los anuncios no auditados de otros miembros (es decir, cuando la member_id creatividad sea diferente a la member_id del TinyTag).

API de REST

Campos JSON

Servidores de anuncios

Licitadores

Marcas

Categories

Recursos creativos

Límites de frecuencia

Idiomas

Members

Asientos

Atributos técnicos

Ejemplos

Crear un nuevo perfil de anuncios

Este es un perfil bastante complejo. A continuación, hemos utilizado el comando para generar un ejemplo de cat archivo JSON de perfil de anuncio.

$ cat ad_profile
{
    "ad-profile": {
        "description": "Network Level ad profile",
        "member_id": 326,
        "brands": [
            {
                "id": "168",
                "status": "banned"
            },
            {
                "id": "255",
                "status": "banned"
            },
            {
                "id": "1072",
                "status": "trusted"
            },
            {
                "id": "1090",
                "status": "trusted"
            }
        ],
        "creatives": [
            {
                "id": "5",
                "approved": true
            }
        ],
        
        "bidders": [
            {
                "id": 2,
                "status": "trusted",
                "require_audit_type": "platform",
                "require_seller_audit_status": "always"
            },
            {
                "id": 5,
                "status": "banned"
            },
            {
                "id": 10,
                "status": "case-by-case",
                "require_audit_type": "platform_or_self",
                "require_seller_audit_status": "never"
            }
        ],
        "seats": [
          {
                "bidder_id": 2,
                "seat_code": "ABC123",
                "status": "trusted",
                "require_audit_type": "platform",
                "require_seller_audit_status": "always"
          },
          {
                "bidder_id": 5,
                "seat_code": "XYZ789",
                "status": "banned"
          }
        ],

        "notes": "This is a great ad profile",
        "default_language_status": "banned",
        "default_ad_server_status": "trusted",
        "default_category_status": "trusted",
        "default_technical_attribute_status": "trusted",
        "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
        "languages": [
            {
                "id": 1,
                "status": "trusted"
            }
        ],
        "ad_servers": null,
        "categories": [
            {
                "id": 41,
                "status": "banned"
            },
            {
                "id": 43,
                "status": "trusted"
            }
        ]
    }
}

Actualizar un perfil de anuncios existente

Dado el JSON del perfil de anuncio en el primer ejemplo, supongamos que quieres actualizar la categories matriz para incluir otro elemento. En un caso de uso del mundo real, puede haber 47 categorías en la matriz. La semántica de PUT significa que para agregar otra categoría a la matriz, deberá pasar las 47 categorías existentes más la nueva.

Puede evitar este trabajo adicional si agrega los parámetros append=true de cadena de consulta a la solicitud, como se muestra en el ejemplo siguiente. Por motivos de compatibilidad con versiones anteriores, los parámetros append_only=true también funcionarán.

$ cat ad-profile-update.json
{
  "ad-profiles":
  [
    {
      "id": 984276,
      "categories" : [
        {
          "id" : 42,
          "status" : "banned"
        }
      ]
    }
  ]
}
$ curl -b cookies -X PUT -d '@/tmp/ad-profile-update.json' \
'https://api.appnexus.com/ad-profile?id=984276&member_id=1282&append=true'
{
   "response" : {
      "id" : 984276,
      "ad-profile" : {
         "id" : 984276,
         "description" : "Rich's Crazy Reseller - Network Ad Profile",
         "categories" : [
            {
               "id" : 41,
               "status" : "banned"
            },
            {
               "id" : 42,
               "status" : "banned"
            },
            {
               "id" : 43,
               "status" : "trusted"
            }
         ],
         // many other fields...
         "default_category_status" : "trusted"
      },
      "status" : "OK",
      "count" : 1,
      "start_element" : 0,
      "num_elements" : 100,
   }
}

Agregar un perfil de anuncio a un miembro

$ curl -b cookies -c cookies -X POST -d @ad_profile  "https://api.appnexus.com/ad-profile"
{
    "response": {
        "status": "OK",
        "id": "1317"
    }
}

Ver un perfil de anuncios

$ curl -b cookies -c cookies "https://api.appnexus.com/ad-profile?id=1317"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 1317,
      "state": "active",
      "description": "Network Level ad profile",
      "member_id": 326,
      "default_brand_status": "trusted",
      "members": null,
      "brands": [
        {
          "id": "168",
          "status": "banned"
        },
        {
          "id": "255",
          "status": "banned"
        },
        {
          "id": "1072",
          "status": "trusted"
        },
        {
          "id": "1090",
          "status": "trusted"
        }
      ],
      "creatives": [
        {
          "id": "5",
          "approved": true
        }
      ],
        
    "bidders": [
        {
          "id": 2,
          "status": "trusted",
          "block_unaudited_creatives": false,
          "allow_pending_creatives": false,
          "require_audit_type": "platform",
          "require_seller_audit_status": "always"
        },
        {
          "id": 5,
          "status": "banned",
          "block_unaudited_creatives": null,
          "allow_pending_creatives": null,
          "require_audit_type": null,
          "require_seller_audit_status": null
        }
      ],
      "seats": [
        {
          "seat_code": "ABC123",
          "bidder_id": 2,
          "status": "trusted",
          "block_unaudited_creatives": false,
          "allow_pending_creatives": false,
          "require_audit_type": "platform",
          "require_seller_audit_status": "always"
        },
        {
          "seat_code": "XYZ789",
          "bidder_id": 5,
          "status": "banned",
          "block_unaudited_creatives": null,
          "allow_pending_creatives": null,
          "require_audit_type": null,
          "require_seller_audit_status": null
        }
      ]

      "total_creative_count": 8369,
      "approved_creative_count": 1,
      "banned_creative_count": 8368,
      "creatives_approved_percent": 0.011948858883977,
      "creatives_unreviewed": 8367,
      "brands_unreviewed": null,
      "exclude_unaudited": true,
      "exclude_unaudited_direct": false,
      "notes": "This is a great ad profile.",
      "publisher_id": null,
      "last_modified": "2010-07-23 16:15:49",
      "default_language_status": "banned",
      "default_ad_server_status": "trusted",
      "default_category_status": "trusted",
      "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
      "default_technical_attribute_status": "trusted",
      "languages": [
        {
          "id": 1,
          "status": "trusted"
        }
      ],
      "ad_servers": null,
      "categories": [
        {
          "id": 41,
          "status": "banned"
        },
        {
          "id": 43,
          "status": "trusted"
        }
      ],
      "technical_attributes": null
    }
  }
}

Ejemplos creativos de limitación de frecuencia de atributos

Agregar una regla de límite de frecuencia a un perfil de anuncio

El {{"frequency_caps"}} campo estará {{null}} al principio:

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": null
    }
}

Agregar una regla de límite de frecuencia

$ cat add_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "technical_attributes": [ {"id":4},{"id":6} ],
          "categories": [ {"id":59},{"id":37} ]
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @add_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}

El perfil de anuncios ahora tendrá la regla del límite de frecuencia

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            },
            {
              "id": 6,
              "name": "Expandable"
            }
          ],
          "categories": [
            {
              "id": 37,
              "name": "Politics"
            },
            {
              "id": 59,
              "name": "Get Rich Quick"
            }
          ]
        }
      ]
      ...

Modificar una regla de límite de frecuencia

Use el {{PUT}} comando en el {{ad-profile}} servicio. El identificador del límite de frecuencia debe especificarse en el JSON de actualización. Si no se especifica el id. del límite de frecuencia, se eliminará la regla existente y se creará una nueva.

{code}
$ cat update_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "id": 64,
          "technical_attributes": [ {"id":4} ],
          "categories": [ ],
          "max_day_imps": 20
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @update_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}
{code}

Compruebe el perfil de anuncios para ver la regla actualizada

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 20,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            }
          ],
          "categories": null
        }
      ]
      ...