Utiliser l'API de tarification externe

Cette page décrit comment calculer les informations de tarification en utilisant une intégration tierce.

API de tarification externe

Guaranteed Campaigns

La fonctionnalité API de tarification externe vous permet de contourner les cartes de tarifs internes de Guaranteed Campaigns et de gérer la tarification de manière externe via votre propre moteur de tarification. De cette façon, le module Guaranteed Campaigns ingère les données tarifaires de votre moteur de tarification externe, offrant ainsi flexibilité et contrôle sur la stratégie de tarification.

  • La fonctionnalité de remplacement du CPM est un prérequis pour l'API de tarification externe. Elle est activée automatiquement et ne peut pas être désactivée lorsqu'un domaine a l'API de tarification externe activée et obtient un prix d'un moteur de tarification externe.
  • L'API de tarification externe fournit une substitution de CPM à la ligne de diffusion.
  • Le remplacement du CPM reflète la tarification gérée en externe et apparaît dans le champ CPM Override sur la page Create Digital Line Item.

Note : Le CPM ne sera mis à jour que si vous modifiez un élément de la ligne de diffusion, ce qui garantit que la tarification reste stable à moins que vous n'effectuiez des modifications.

Vous pouvez définir l'URL et la clé API de votre point de terminaison d'API de tarification externe dans les paramètres du domaine. Voir Pricing API.

Note : Les paramètres deGuaranteed Campaigns sont disponibles uniquement pour les utilisateurs ayant le rôle Admin ou Direct Sales Admin. Pour plus d'informations, voir Permissions utilisateur.

Pour configurer le point de terminaison de l'API de tarification externe :

Guaranteed Campaigns

  1. Accédez à la page Settings.
  2. Dans l'onglet Guaranteed, cliquez sur General.

  3. Dans la section Pricing API, saisissez l'URL du point de terminaison de tarification externe et votre clé d'authentification API.

Pour utiliser l'API de tarification externe dans le module Guaranteed Campaigns et effectuer les calculs finaux pour différents types d'achat, suivez ces étapes :

Pour utiliser l'API de tarification externe :

Guaranteed Campaigns

  1. Créer une campagne garantie.
  2. Choisissez les écrans et configurez les paramètres tels que le type d'achat, la longueur de la publicité et la durée comme d'habitude.

    3. Le module Guaranteed Campaigns communique avec l'API de tarification externe, qui récupère et met à jour les informations de tarification dynamiquement en fonction de votre sélection d'écrans.

    Le module Guaranteed Campaigns effectue le calcul final en utilisant les informations de tarification reçues de l'API de tarification externe.

    Les valeurs calculées sont ensuite utilisées pour finaliser la configuration de la ligne de diffusion, garantissant une tarification précise et dynamique pour le type d'achat spécifié.

Vous pouvez remplacer le prix que fournit l'API de tarification externe en remplaçant la valeur dans la section Price Adjustments.

Note : Si l'API de tarification externe ne renvoie pas de valeur, le bouton Add Pricing Adjustment est activé afin que vous puissiez saisir manuellement le prix ou le CPM souhaité. Voir Étape 8 – Ajuster le prix (Facultatif).

Vous pouvez également remplacer le coût de l'élément de campagne dans l'Outil de création de campagne. Le système tiendra compte de la valeur de remplacement pour le calcul du prix final.

Ce qui suit décrit le fonctionnement de l'API de tarification externe.

Le module Guaranteed Campaigns envoie tous les détails de la sélection au moteur de tarification externe avec l'appel API suivant :

Copier 
POST https://direct.broadsign.com/api/v1/third_party/pricing

Voici un exemple de charge utile :

Copier 
{
"schedule":
{
"start_date":"2023-12-19",
"end_date":"2024-01-01",
"start_time":"00:00:00",
"end_time":"23:59:59",
"dow_mask":127,
"slot_duration":15
},
"screens":[224016,224020],
"filters":[],
"buy_mode":
{
"type":"ppl",
"values":{"bs_saturation":1,"saturation":1,"custom_cpm":0},
"active":true
}
}

Voici un exemple de réponse pour les types d'achat suivants :

  • Fréquence
  • Part de voix
  • Prise de contrôle
Copier 
{
"override_type": "price",  #override type is price for these type of buys, Direct will expect a price value
"value": 450.0             #final value of price returned
}

Voici un exemple de réponse pour les types d'achat suivants :

  • Impression
  • Budget
  • Diffusions
Copier 
{
"value": 10.0,            #final value of CPM returned
"override_type": "cpm"    #override type is CPM for these type of buys, Direct will expect a CPM value
}

Vous pouvez appeler le moteur de tarification pour extraire les valeurs récentes envoyées par le moteur de tarification externe avec l'API suivante :

Copier 
GET /api/v1/third_party/pricing/logs/proposal_item/<proposal_item_id>

Voici un exemple de réponse à cet appel :

Copier 
   "id":12345,
   "override_type": "cpm",
   "value":10.0,
   "arbitrary_additional_info":
{
      "screens":[
         {
            "id":"1",
            "Cpm":15.0 // CPM for screen 1
         },
         {
            "id":"2",
            "Cpm": 2.0  // CPM for screen 2
         }
      ]

Le module Guaranteed Campaigns mettra en cache la réponse de tout appel API en amont effectué pour une durée de 20 minutes.

Vous pouvez vider votre cache à tout moment en utilisant le point de terminaison suivant :

Copier 
POST api/v1/pricing/cache_clear