Compartir a través de

Ciencia de datos Toolkit: servicio de modelo de elemento de línea

  • Artículo

El servicio Modelo de elemento de línea se usa para asociar modelos personalizados a la matriz de modelos personalizados. En comparación con el servicio de elemento de línea estándar, el servicio Modelo de elemento de línea permite distinguir entre los modelos cargados por el cliente y los modelos generados por Xandr. La distinción entre los modelos de cliente y Xandr es importante para lo siguiente:

  • Generación de informes con la fuente de distribución de datos de nivel de registro del modelo personalizado.
  • Asociar modelos de cadencia y otros tipos de modelos que Xandr también genera para elementos de línea.
    • Los modelos generados por Xandr se anexan automáticamente a elementos de línea como parte del sistema de optimización V8. El licitador debe aplazar los modelos cargados por el cliente al evaluar los modelos personalizados asociados a los elementos de línea.
    • Los procesos automatizados de Xandr no deben sobrescribir los modelos cargados por el cliente.

Uso

Puntos de conexión

Autenticación

/line-item-model admite métodos de autenticación estándar de la API Xandr.

Métodos y campos admitidos

Método Punto de conexión Objetivo
DELETE /line-item-model?id={line_item_id} Eliminar una única asociación de modelo personalizado en un elemento de línea, dado un objeto JSON "line-item-model"
GET /line-item-model?id={line_item_id} Obtener una lista de modelos personalizados asociados a un elemento de línea
POST No se admite el método .
PUT /line-item-model?id={line_item_id} Agregue o actualice modelos personalizados existentes asociados a un elemento de línea, dado un objeto JSON "line-item-model".

Parameters

Nombre Tipo de datos Description Ejemplo
line-item-id Entero Identificador del objeto Line Item del que deseamos consultar
Obligatorio en: GET, PUT, DELETE		 /line-item-model?id=123

Fields

Nombre Tipo de datos Description Devuelto activado Ejemplo
custom_model_id Entero Identificador del modelo personalizado asociado al elemento de línea GET, PUT "custom_model_id": 211973
line-item-models cadena y matriz de modelos personalizados Identificador del elemento de línea que hemos consultado, junto con la matriz de modelos personalizados asociados a ese elemento de línea GET, PUT "line_item_models": { "4125657": [ { "custom_model_id": 139527, "type": "cadence" }, { "custom_model_id": 130004, "type": "expected_value" } ] }
type string El "tipo" de esta asociación de modelo. Puede encontrar una lista completa de tipos de modelo de componentes condicionales en la página Valoración de pujas con modelos personalizados . GET, PUT "type": "ev_click"

Ejemplos de uso

Ejemplo get

Modelos personalizados "GET" asociados a un elemento de línea

curl -H 'Authorization: {api_token}' 'https://api.appnexus.com/line-item-model?id=123'

Respuesta:

{
  "response": {
    "dbg_info": {...},
    "num_elements": null,
    "start_element": null,
    "count": 2,
    "line_item_models": {
      "123": [
        {
          "custom_model_id": 139527,
          "type": "cadence"
        },
        {
          "custom_model_id": 130004,
          "type": "expected_value"
        }
      ]
    },
    "status": "OK"
  }
}

Ejemplo PUT

'PUT': Create y actualizar modelos personalizados asociados a un elemento de línea

Nota:

Información de uso importante

PUT solo agregará nuevos modelos a un elemento de línea o actualizará los modelos existentes. Si no se hace referencia a un modelo en line_item_model la matriz, no se ve afectado por la solicitud, a menos que uno de los modelos enumerados en la matriz sea el mismo type que un modelo ya asociado al elemento de línea.

curl -H 'Authorization: {api_token}' -d @update_models.json -X PUT 'https://api.appnexus.com/line-item-model?id=12345'

update_models.json

// Update / Set a single model
{
  "line_item_model": {
      "custom_model_id": 123,
      "type": "click_imp"
    }
}
 
// Set / Update multiple models
{
  "line_item_models": [
    {
      "custom_model_id": 123,
      "type": "click_imp"
    },
    {
      "custom_model_id": 456,
      "type": "ev_click"
    }
  ]
}

Respuesta:

{
  "response": {
    "dbg_info": {...},
    "num_elements": null,
    "start_element": null,
    "count": 1,
    "line_item_models": {
      "12345": [
        {
          "custom_model_id": 123,
          "type": "click_imp"
        },
                {
          "custom_model_id": 456,
          "type": "ev_click"
        }
      ]
    },
    "status": "OK"
  }
}

Ejemplo de DELETE

'DELETE' un modelo personalizado asociado a un elemento de línea

curl -H 'Authorization: {api_token}' -d @detach_model.json -X DELETE 'https://api.appnexus.com/line-item-model?id=:line_item_id'

detach_model.json

{
  "line_item_model": {
        "type": "cadence"
  }
}

Respuesta:

{
  "response": {
    "dbg_info": {...},
    "num_elements": null,
    "start_element": null,
    "count": 1,
    "status": "OK"
  }
}