Partager via

Science des données Toolkit - Service de modèle d’élément de ligne

Le service Modèle d’élément de ligne est utilisé pour associer des modèles personnalisés au tableau de modèles personnalisés. Par rapport au service d’élément de ligne standard, le service Modèle d’élément de ligne permet de faire la distinction entre les modèles chargés par le client et les modèles générés par Xandr. La distinction entre les modèles client et Xandr est importante pour les éléments suivants :

  • Création de rapports avec le flux de données de niveau journal du modèle personnalisé.
  • Association de modèles de cadence et d’autres types de modèles que Xandr génère également pour les éléments de ligne.
    • Les modèles générés par Xandr sont automatiquement ajoutés aux éléments de ligne dans le cadre du système d’optimisation V8. Le soumissionnaire doit s’en remettre aux modèles chargés par le client lors de l’évaluation des modèles personnalisés associés aux éléments de ligne.
    • Les processus automatisés Xandr ne doivent pas remplacer les modèles chargés par le client.

Utilisation

Points de terminaison

Authentification

/line-item-model prend en charge les méthodes d’authentification standard de l’API Xandr.

Méthodes et champs pris en charge

Méthode Point de terminaison Objectif
SUPPRIMER /line-item-model?id={line_item_id} Supprimer une seule association de modèle personnalisé sur un élément de ligne, en fonction d’un objet JSON « line-item-model »
GET /line-item-model?id={line_item_id} Obtenir la liste des modèles personnalisés associés à un élément de ligne
POST Méthode non prise en charge.
PUT /line-item-model?id={line_item_id} Ajoutez ou mettez à jour des modèles personnalisés existants associés à un élément de ligne, en fonction d’un objet JSON « line-item-model ».

Paramètres

Nom Type de données Description Exemple
line-item-id int ID de l’objet Line Item sur lequel nous aimerions interroger
Obligatoire sur : GET, PUT, DELETE		 /line-item-model?id=123

Champs

Nom Type de données Description Retourné le Exemple
custom_model_id int ID du modèle personnalisé associé à l’élément de ligne GET, PUT "custom_model_id": 211973
line-item-models chaîne et tableau de modèles personnalisés ID de l’élément de ligne que nous avons interrogé, ainsi que le tableau de modèles personnalisés associés à cet élément de ligne GET, PUT "line_item_models": { "4125657": [ { "custom_model_id": 139527, "type": "cadence" }, { "custom_model_id": 130004, "type": "expected_value" } ] }
type string Type de cette association de modèle. Vous trouverez la liste complète des types de modèles de composants conditionnels dans la page Évaluation de l’offre avec des modèles personnalisés . GET, PUT "type": "ev_click"

Exemples d’utilisation

Exemple GET

Modèles personnalisés 'GET' associés à un élément de ligne

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

Réponse :

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

Exemple PUT

'PUT' : Create et Mettre à jour des modèles personnalisés associés à un élément de ligne

Remarque

Informations d’utilisation importantes

PUT n’ajoute que de nouveaux modèles à un élément de ligne ou met à jour les modèles existants. Si un modèle n’est pas référencé dans votre line_item_model tableau, il n’est pas affecté par votre demande, sauf si l’un des modèles répertoriés dans votre tableau est identique type à un modèle déjà associé à l’élément de ligne.

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"
    }
  ]
}

Réponse :

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

Exemple DELETE

'DELETE' un modèle personnalisé associé à un élément de ligne

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

Réponse:

{
  "response": {
    "dbg_info": {...},
    "num_elements": null,
    "start_element": null,
    "count": 1,
    "status": "OK"
  }
}
  • Last updated on