API partenaire

Demande d’annonces pour des dates futures

En utilisant la propriété campaignFilterDate de CitrusAd vous pouvez rechercher les campagnes qui seront en ligne à la date demandée.

📘

Cette fonction est idéale pour les intégrations de bannières publicitaires, en particulier si vous avez l'obligation légale d'afficher des informations tarifaires dans la bannière au moment où le client choisit le créneau de diffusion.

À quoi ça sert ?

Lorsque vous spécifiez une propriété campaignFilterDate dans votre demande d'annonce à CitrusAd, nous examinerons uniquement les campagnes qui seront actives à cette date, ou les campagnes définies sur « Toujours active » dans le système CitrusAd.

Dans le système CitrusAd, les annonceurs peuvent définir une campagne comme active uniquement sur certaines plages de dates.

C'est généralement à l'annonceur de décider s'il souhaite programmer sa campagne sur une période spécifique. Il peut également sélectionner « Toujours active » pour permettre à la campagne de continuer à dépenser si un budget est disponible.

Par exemple, la campagne ci-dessus sera active entre le 07/02/2023 et le 14/03/2023. Si une demande d'annonce pertinente est reçue avec une propriété campaignFilterDate comprise entre ces deux dates, la campagne sera diffusée si elle est considérée comme la publicité la plus pertinente.

Exigences d'intégration

Aperçu

En plus d'une intégration standard avec CitrusAd, votre intégration devra être améliorée pour spécifier une propriété campaignFilterDate dans votre requête. Aucun changement n'est nécessaire pour la comptabilisation d'impressions et de clics, et vous devez vous assurer que votre comptabilisation des commandes est correcte, comme indiqué ci-dessous.

Demande d'annonce

Votre demande d'annonce devra spécifier une propriété campaignFilterDate, au format ISO-8601, comme dans l'exemple ci-dessous :

La fonctionnalité campaignFilterDate sera la date à laquelle le client recevra sa commande de votre site Web.

POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Basic <API_KEY>
{
    "customerId": "wertg5432a",
    "placement": "search",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "searchTerm": "chocolate",
    "campaignFilterDate": "2022-11-20T13:40:00+01:00",
    "options": {
                         "filterMode": "AndOr",
                             },
    "maxNumberOfAds": 3    
}

Comptabilisation des commandes

Lorsque vous comptabilisez des commandes, vous devez vous assurer que les éléments ci-dessous sont mis en œuvre :

  • la date de commande que vous spécifiez doit être l'heure à laquelle le client a effectué le paiement, et non l'heure à laquelle la commande du client sera récupérée/livrée.
    • Cela permet de s'assurer que l'algorithme d'attribution de CitrusAd peut appliquer la bonne fenêtre de retour aux interactions de vos clients pour attribuer les ventes aux campagnes qui ont été présentées au client.
  • Comme il est probable qu'un client soumette à nouveau ses commandes, vous devrez également vous assurer que vous n'envoyez pas d'ID de commande à CitrusAd. Cela permettra de s'assurer que, lorsque vous soumettez à nouveau des commandes et des mises à jour de commandes, l'algorithme de CitrusAd examine la commande et les attribue en conséquence.
    • Actuellement, l'algorithme d'attribution de CitrusAd ne traite pas à nouveau une commande lorsqu'elle est soumise avec un ID de commande qui a déjà été soumis.

Veuillez consulter les données de commande pour obtenir les informations correctes concernant la comptabilisation des commandes.

Rapports de la plateforme

Comme le système CitrusAd affiche les rapports en temps réel, les clics et les impressions, y compris ceux concernant les diffusions futures, seront comptabilisés lorsqu'il y aura consultation ou clic.

Comme les publicités sont diffusées en temps réel, les portefeuilles seront débités au fur et à mesure que les impressions et les clics seront signalés à CitrusAd.

🚧

Comptabilisation des dépenses

Comme cette fonctionnalité recherche des campagnes à venir, il se peut que vous voyiez des campagnes avec des dates actives dans le futur indiquant des données de dépenses et de comptabilisation qui s'accumulent. C'est le comportement voulu pour cette fonctionnalité car les campagnes dont l'activité est prévue sur une période future sont recherchées à l'avance.