Référence de l'API Addrevenue

Référence de l'API Addrevenue (brouillon)

Notre API REST a été développée pour répondre aux besoins des affiliés et des annonceurs. Vous générez un jeton API à vie manuellement dans notre interface utilisateur. Ce jeton porteur est ensuite envoyé comme en-tête d'autorisation à chaque requête.

URL de base de l'API

Tous les points de terminaison commencent par l'URL de base :

https://addrevenue.io/api/v2

Utilisez toujours le protocole HTTPS.

Authentification

Pour générer un jeton, connectez-vous à Addrevenue et allez dans Jetons API, puis Générer un nouveau jeton API. Cela crée un jeton API unique et à vie pour le compte connecté.

Le jeton doit ensuite être envoyé comme jeton porteur dans toutes les requêtes vers un point de terminaison de l'API.

Exemple d'en-tête :

Authorization: Bearer 1892cd44-c59c-42bf-9f1d-a5316ea695cc
Content-type: application/json

Erreurs

L'envoi d'un jeton porteur vide, mal formé ou invalide entraînera l'une de ces erreurs HTTP :

Statut Message Cause
400 Authorization header not found L'en-tête Authorization est manquant ou mal formé, par exemple sans le préfixe « Bearer ».
403 Invalid token L'en-tête est correctement formaté, mais le jeton API fourni n'existe pas.
403 Inactive account L'en-tête est correctement formaté et le jeton existe, mais il appartient à un compte qui n'est pas actif.
403 (message spécifique au point de terminaison) Le point de terminaison n'est pas disponible pour ce type de compte, par exemple « Endpoint only available to affiliates ».
404 Endpoint not found Le point de terminaison demandé n'existe pas.

Les réponses d'erreur se présentent ainsi :

{
    "error": {
        "message": "Invalid token"
    }
}

Réponses

Toutes les réponses sont au format JSON. Une réponse réussie contient un tableau results, un objet meta (nombre d'éléments et pagination), et un objet links (liens de pagination) :

{
    "results": [
        { "id": 1000, "description": "Sample campaign A" },
        { "id": 1001, "description": "Sample campaign B" }
    ],
    "meta": {
        "count": 2,
        "totalCount": 27,
        "page": 1,
        "perPage": 2,
        "totalPages": 14,
        "hasPrevPage": false,
        "hasNextPage": true
    },
    "links": {
        "self": "https://addrevenue.io/api/v2/campaigns?limit=2",
        "next": "https://addrevenue.io/api/v2/campaigns?limit=2&page=2"
    }
}

results est toujours un tableau, même pour un seul résultat. meta.totalCount correspond au nombre total d'éléments correspondants sur toutes les pages, pas seulement la page actuelle. Ci-dessous, chaque point de terminaison liste les champs que vous pouvez attendre dans chaque élément de results, ainsi que lesquels de ces champs peuvent aussi servir de filtre.

Points de terminaison de l'API

Paramètres de requête

Vous pouvez filtrer la plupart des points de terminaison en ajoutant un paramètre de chaîne de requête portant le même nom qu'un champ propre à l'élément — par exemple id, status, market, advertiserId, ou channelId. Cela ne fonctionne que pour les champs contenant une valeur statique et stockée — le tableau des champs de réponse de chaque point de terminaison ci-dessous indique quels champs sont filtrables de cette manière. Cela ne fonctionne pas pour les champs calculés ou dérivés d'autres données (par exemple advertiserName, commissionShort, ou epc), ni pour les objets et tableaux imbriqués (par exemple markets ou programs). Filtrer sur un champ non filtrable renvoie une erreur au lieu d'être simplement ignoré.

Pagination

Utilisez limit (nombre d'éléments par page) et page (numéro de page à partir de 1) pour parcourir les résultats, par exemple /products?limit=50&page=2. offset est également pris en charge comme alternative héritée à page.

Intervalles de dates

Pour les points de terminaison où cela s'applique, vous pouvez filtrer sur un intervalle de dates à l'aide de fromDate et/ou toDate — ensemble, pour définir un intervalle, ou séparément. Ce filtre porte sur la date de création de l'enregistrement (son champ date, pour stats et trackingErrors) — chaque point de terminaison ci-dessous précise si cela est pris en charge.

Lorsque cela est indiqué, vous pouvez aussi utiliser updatedFromDate/updatedToDate, qui filtrent sur la date de dernière mise à jour d'un élément plutôt que sur sa date de création.

Annonceurs

GET /advertisers

Accessible pour

Tous les types de comptes.

Les comptes affiliés voient tous les annonceurs actifs — passez channelId pour restreindre la liste aux annonceurs ayant une relation (active, en attente, ou rejetée) avec ce canal. Les comptes annonceurs ne voient que leur propre compte. Les comptes agence voient les annonceurs qu'ils gèrent.

Paramètres de requête

Paramètre Description
channelId Optionnel (affiliés uniquement). Restreint les résultats aux annonceurs ayant une relation avec ce canal, et ajoute relation/relationStatus à chaque résultat.
expand Optionnel. Définissez à 1 pour inclure aussi programs et landingPages pour chaque annonceur.
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID de l'annonceur.
name Oui Raison sociale de l'entreprise.
displayName Oui Nom d'affichage public.
address, zipcode, city, country Oui Adresse de l'entreprise.
shortDescription — Courte description marketing.
categoryId Oui Catégorie, par ex. insurance, foodDrink.
logoImageFilename — URL absolue de l'image du logo.
url — Site web de l'annonceur.
type — Toujours advertiser.
orgno, vatno Oui Numéro d'entreprise et numéro de TVA.
businessType — Type d'entité juridique.
autoApproveChannels Oui Indique si les nouvelles relations avec des canaux sont approuvées automatiquement.
policyPaidAds/restrictionPaidAds Oui Politique publicité payante (allowed/notAllowed) et toute restriction en texte libre.
policySocialMedia/restrictionSocialMedia Oui Politique réseaux sociaux et restriction.
policyEmailMarketing/restrictionEmailMarketing Oui Politique email marketing et restriction.
policyCouponRebate/restrictionCouponRebate Oui Politique coupons/remises et restriction.
policyCashbackReward/restrictionCashbackReward Oui Politique cashback/récompense et restriction.
ecommercePlatform Oui Par ex. shopify, customBuilt.
trackingMethod Oui Méthode d'intégration du suivi.
discountCodeTracking Oui Indique si le suivi des codes de réduction est activé.
approvedForPrepayouts Oui Indique si l'annonceur est approuvé pour les paiements anticipés.
customTrackingParameters Oui Paramètres de requête supplémentaires ajoutés aux liens de suivi.
markets — Objet indexé par code marché. Chaque marché a market, displayName, url, status, presentation (HTML), shortDescription, affiliatePageUrl, productFeedUrl, redirectUrl, endedDate, endedReason, activatedDate, productCount.
programs — Uniquement avec channelId ou expand. Programmes de commission — voir le point de terminaison Programmes pour le détail des champs.
landingPages — Uniquement avec expand.
relation/relationStatus — Uniquement avec channelId. La relation de votre canal avec cet annonceur, et son statut.

Bannières

GET /banners

Accessible pour

Tous les types de comptes.

Les comptes affiliés voient les groupes de bannières de tous les annonceurs actifs — passez channelId pour obtenir aussi un code de suivi pour chaque bannière. Les comptes annonceur et agence voient tous les groupes de bannières de leur(s) propre(s) annonceur(s), y compris les inactifs.

Paramètres de requête

Paramètre Description
channelId Optionnel (affiliés uniquement). Si fourni, des codes de suivi pour toutes les bannières sont inclus dans la réponse.
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID du groupe de bannières.
created Oui Date de création du groupe de bannières.
name, description Oui Nom et description du groupe de bannières.
url Oui URL de destination optionnelle qui remplace celle du groupe.
advertiserId Oui L'annonceur auquel appartient ce groupe.
advertiserName — Le nom d'affichage de l'annonceur.
banners — Objet indexé par ID de bannière. Chaque bannière a id, created, width, height, filesize, format, filename, et, uniquement avec channelId, trackingLink, imageLink, bannerHtmlCode (un extrait <a><img></a> prêt à intégrer).

GET /brokenLinks

Accessible pour

Affiliés uniquement.

Champs de réponse

Champ Filtrable Description
id — ID du lien rompu.
url — L'URL rompue.
httpCode — Le code de statut HTTP rencontré, par ex. 404.
created — Date de détection du lien rompu.

Ce point de terminaison couvre toujours une fenêtre fixe de 30 jours et renvoie l'ensemble complet des résultats — les paramètres de requête (y compris la pagination et les filtres de date) ne sont pas pris en charge ici.

Campagnes

GET /campaigns

Accessible pour

Tous les types de comptes.

Les comptes affiliés voient toutes les campagnes actives publiques de tous les annonceurs, ainsi que les campagnes exclusives à leurs propres canaux — passez channelId pour restreindre aux annonceurs ayant une relation approuvée avec ce canal, ce qui ajoute aussi un trackingLink à chaque campagne. Les comptes annonceur et agence voient toutes les campagnes de leur(s) propre(s) annonceur(s) — actives et inactives, publiques et exclusives à un canal.

Paramètres de requête

Paramètre Description
channelId Optionnel (affiliés uniquement). Restreint aux annonceurs ayant une relation approuvée avec le canal, et ajoute trackingLink à chaque campagne.
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID de la campagne.
advertiserId Oui L'annonceur qui gère la campagne.
advertiserName, advertiserUrl — Le nom d'affichage et le site web de l'annonceur.
description Oui Description de la campagne.
discountCode Oui Le code de réduction, s'il s'agit d'une campagne de coupon.
url Oui Page de destination de la campagne.
terms Oui Texte des conditions générales.
validFrom, validTo Oui Période de validité.
channelId Oui Défini uniquement pour les campagnes exclusives à un canal.
created Oui Date de création de la campagne.
bannerGroupId Oui Groupe de bannières associé, le cas échéant.
type — coupon ou offer.
status — active ou ended.
markets — Tableau des codes marché auxquels s'applique la campagne.
trackingLink — Uniquement avec channelId. Votre lien étiqueté-canal vers l'URL de la campagne.

Canaux

GET /channels

Accessible pour

Affiliés uniquement.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID du canal.
affiliateId Oui L'ID de votre compte affilié.
name, url Oui Nom du canal et URL du site web.
type Oui Par ex. website.
visitors Oui Volume de visiteurs estimé.
status Oui Statut du canal.
created Oui Date de création du canal.
markets — Tableau des codes marché, ou null.

Événements

GET /events

Accessible pour

Tous les types de comptes, restreint à votre/vos propre(s) annonceur(s)/canal(-aux) comme d'habitude — il n'y a aucune différence de comportement entre les types de comptes au-delà de cela.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création — notez que cela filtre sur created, pas sur le champ date distinct présent dans la réponse.

Champs de réponse

Champ Filtrable Description
id Oui ID de l'événement.
date, created Oui Date de l'événement et horodatage complet.
advertiserId, channelId Oui L'annonceur et le canal concernés.
type Oui Type d'événement, par ex. Click. Cela varie selon l'intégration de l'annonceur et n'est pas une liste fixe.
url Oui URL de la page où l'événement s'est produit.
value, currency Oui Valeur de la commande et devise, le cas échéant.
orderId Oui ID de commande de l'annonceur, le cas échéant.
sandbox Oui Indique s'il s'agissait d'un événement de test/sandbox.
referrer Oui Référent HTTP.
clickId Oui Le clic auquel cet événement est associé.
bannerId Oui La bannière cliquée, le cas échéant.
clickRef Oui Référence de clic interne.
market Oui Code marché.
redirectUrl Oui La page de destination de l'annonceur vers laquelle le clic a redirigé.
affiliateUrl Oui L'URL de la page affilié d'origine.
affiliateGclid, wctid Oui Identifiants de clic Google Ads / autre plateforme publicitaire, le cas échéant.
easylink Oui Indique si cet événement provient d'un Easylink.
deviceType Oui desktop, mobile, tablet, ou backend.
crossDeviceId Oui ID de suivi multi-appareils, si disponible.
subids Oui Vos propres paramètres de sous-ID, si envoyés.

Impressions

GET /impressions

Accessible pour

Tous les types de comptes, restreint à votre/vos propre(s) annonceur(s)/canal(-aux) comme d'habitude — il n'y a aucune différence de comportement entre les types de comptes au-delà de cela.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID de l'impression.
date, created Oui Date de l'impression et horodatage complet.
advertiserId, channelId Oui L'annonceur et le canal concernés.
url Oui URL de la page où l'impression s'est produite.
referrer Oui Référent HTTP.
bannerId Oui La bannière affichée.
market Oui Code marché.
deviceType Oui desktop, mobile, tablet, ou backend.

Prospects

POST /leads

Accessible pour

Affiliés uniquement. Prend actuellement en charge un ensemble limité d'annonceurs intégrés.

Corps de la requête

Champ Description
channelId Requis. Doit être l'un de vos propres canaux.
advertiserId Requis. Doit être un annonceur intégré à l'API Prospects, et avoir une relation active avec le canal donné.
(autres champs) Spécifiques à l'annonceur — transmis tels quels au système de réception de prospects de l'annonceur.

La réponse est renvoyée telle quelle depuis le système de réception de prospects de l'annonceur, plutôt que dans le format standard results/meta utilisé par les autres points de terminaison.

Paiements

GET /payouts

Accessible pour

Affiliés uniquement.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id Oui ID du paiement.
affiliateId Oui L'ID de votre compte affilié.
date, created Oui Date du paiement et date de création du paiement.
name Oui Nom du bénéficiaire.
payoutDate Oui Date à laquelle le paiement a effectivement été effectué.
address, zipcode, city, country Oui Adresse du bénéficiaire.
orgno, vatno Oui Numéro d'entreprise et numéro de TVA.
status Oui Statut du paiement.
sum, vat, total Oui Montant hors TVA, montant de la TVA, et total.
currency Oui Devise du paiement.
payoutMethod Oui Par ex. méthode de virement bancaire utilisée.
gigapayPayoutId Oui Référence au paiement Gigapay, si utilisé.
gigapayPayout — Détails étendus du paiement Gigapay, si utilisé.
currencyExchangeFee Oui Frais appliqués pour la conversion de devise, le cas échéant.
taxRate Oui Taux d'imposition appliqué.
bankCountry Oui Pays de la banque, le cas échéant.
manualAdjustment Oui Tout ajustement manuel appliqué au paiement.
noOfTransactions — Nombre de transactions incluses.
kickbackRows, noOfKickbackRows — Lignes de rétrocommission, le cas échéant.
language — Langue dans laquelle le document de paiement a été généré.
accountNumber — Numéro de compte bancaire du bénéficiaire.
periodFrom, periodTo, periodText — La période couverte par ce paiement.
vatText — Texte de mention TVA affiché sur le document de paiement.
reverseCharge — Indique si l'autoliquidation de la TVA s'applique.
rows — Lignes du document de paiement.
transactions — Objet indexé par ID de transaction — mêmes champs que le point de terminaison Transactions ci-dessous.

Flux de produits

GET /productfeeds

Accessible pour

Tous les types de comptes.

Les comptes affiliés voient les métadonnées de flux pour chaque annonceur ayant une récupération de flux terminée — passez channelId pour restreindre aux annonceurs ayant une relation active avec ce canal, ce qui étiquette aussi l'URL du flux pour le suivi de ce canal. Les comptes annonceur et agence ne voient toujours que les flux de leur(s) propre(s) annonceur(s).

Paramètres de requête

Paramètre Description
channelId Optionnel. Voir ci-dessus.
detectedCurrency Optionnel. Filtre les flux dont la devise détectée automatiquement correspond.
detectedLanguage Optionnel. Filtre les flux dont la langue détectée automatiquement correspond.

Les filtres de date (fromDate/toDate) et la pagination ne sont pas pris en charge sur ce point de terminaison — il renvoie toujours l'ensemble complet des résultats pour chaque récupération de flux terminée.

Champs de réponse

Champ Filtrable Description
advertiserId Oui L'annonceur auquel appartient ce flux.
advertiserName — Le nom d'affichage de l'annonceur.
market — Code marché couvert par le flux.
sourceProductFeedUrl — L'URL de flux d'origine de l'annonceur.
url/productFeedUrl — Uniquement avec channelId. Votre URL de flux étiquetée-canal.
started, finished Oui Début et fin de la récupération du flux. Mêmes valeurs que latestFetchDate/latestFetchFinished ci-dessous.
latestFetchDate, latestFetchFinished — Doublons, noms plus explicites de started/finished.
checksum Oui Somme de contrôle du flux récupéré, pour la détection de changement. Même valeur que latestFetchChecksum.
latestFetchChecksum — Doublon de checksum.
products — Nombre de produits dans le flux.
hasGtin — Nombre de produits du flux comportant un GTIN.
detectedCurrency, detectedLanguage Oui Devise et langue du flux détectées automatiquement.

Produits

GET /products

Accessible pour

Tous les types de comptes.

Les comptes annonceur et agence voient leur propre catalogue complet, y compris les produits masqués. Les comptes affiliés ne voient que les produits visibles des annonceurs ayant un marché actif.

Paramètres de requête

Paramètre Description
limit Optionnel. Nombre de produits par page.
page Optionnel. Numéro de page.
channelId Optionnel (affiliés). Ajoute un trackingLink à chaque produit.

Exemple : /products?limit=50&page=2

Les filtres de date (fromDate/toDate) ne sont pas pris en charge sur ce point de terminaison.

Champs de réponse

Champ Filtrable Description
id Oui ID de produit interne.
advertiserId Oui L'annonceur qui vend ce produit.
market Oui Code marché.
title Oui Titre du produit.
link Oui URL de la page produit.
product_type, google_product_category Oui Champs de catégorie, suivant la spécification du flux Google Shopping.
image_link Oui URL de l'image du produit.
condition Oui Par ex. new.
availability Oui Par ex. in_stock.
price, sale_price, currency Oui Prix normal, prix soldé, et devise.
shipping, size, color, gender, material, age_group Oui Attributs du produit, lorsqu'ils sont disponibles.
min_handling_time, max_handling_time — Délai de traitement en jours avant expédition, inclus uniquement lorsque l'annonceur a configuré une valeur de repli pour son flux.
brand Oui Nom de la marque.
sku, mpn, gtin, product_id, item_group_id Oui Identifiants du produit.
hidden Oui Indique si le produit est masqué aux comptes non-annonceurs.
checksum Oui Somme de contrôle des données du produit, pour la détection de changement.
has_image_link Oui Indique si une URL d'image est disponible.
trackingLink — Uniquement avec channelId. Votre lien étiqueté-canal vers la page produit.

Programmes

GET /programs

Accessible pour

Tous les types de comptes.

Les comptes affiliés ne voient que les programmes actifs. Les comptes annonceur et agence voient tous leurs programmes quel que soit leur statut.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création.

Champs de réponse

Champ Filtrable Description
id, name Oui ID et nom du programme.
percent, amount, currency Oui Le taux de commission — percent pour variable, amount/currency pour fixe.
status Oui Statut du programme.
commissionType Oui variable ou fixed.
conversionEventId Oui Le type d'événement sur lequel ce programme verse une commission.
commissionShort — Commission lisible, par ex. "15%" ou "30 EUR".
commissionValue, commissionUnit — La valeur numérique de la commission et son unité (% ou code devise).
commission — Forme lisible plus longue, par ex. "Fixed (30 EUR)".
tieredCommissionModel, tieredCommissionStartDate Oui Modèle de paliers et date de prise d'effet, si le programme est à paliers.
channelId — Défini uniquement pour les programmes exclusifs à un canal.
markets — Tableau des codes marché auxquels s'applique le programme.
tiers — Uniquement pour les programmes à paliers. Chaque palier a transactions, value, amount/currency, commissionShort, transactionsText.
rules — Uniquement lorsque des règles de commission conditionnelles sont configurées sur le programme.

Relations

GET /relations

Accessible pour

Tous les types de comptes, restreint à vos propres relations comme d'habitude — il n'y a aucune différence de comportement entre les types de comptes au-delà de cela.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date de création.
updatedFromDate, updatedToDate Optionnel. Filtre par date de dernière mise à jour de la relation.

Champs de réponse

Champ Filtrable Description
id Oui ID de la relation.
advertiserId Oui Le côté annonceur de la relation.
advertiserName — Le nom d'affichage de l'annonceur.
channelId Oui Le côté canal de la relation.
channelName, channelType, channelCategory — Le nom, le type et la catégorie du canal.
created, updated Oui Date de création et de dernière mise à jour de la relation.
status Oui Statut de la relation, par ex. active.
noticeDate, noticeDays Oui Délai de préavis, si la relation est en cours de résiliation.
endedDate, endedReason Oui Date et raison de la fin de la relation, le cas échéant.
activatedDate Oui Date à laquelle la relation est devenue active.
trackingLink — Le lien de suivi de votre canal pour cet annonceur.
programs — Tableau des programmes de commission disponibles sur cette relation — mêmes champs que le point de terminaison Programmes ci-dessus, plus individualCommission: true lorsque ce canal a sa propre commission personnalisée pour ce programme (auquel cas percent/amount reflètent déjà cette personnalisation).

Statistiques

GET /stats

Accessible pour

Tous les types de comptes. Les comptes annonceur et agence reçoivent en plus les champs de frais de courtage (brokerageFee, totalBrokerageFee, deniedBrokerageFee, denialRateBrokerageFee) dans la réponse ; ceux-ci ne sont pas inclus pour les comptes affiliés, car le courtage est la marge de la plateforme prélevée sur la commission de l'affilié.

Paramètres de requête

Paramètre Description
groupBy Optionnel. Agrège la réponse selon une ou plusieurs dimensions : date, advertiser, channel, et/ou program. Si omis, la réponse est un total unique agrégé. Combinez plusieurs dimensions avec une virgule, par ex. groupBy=date,channel.
currency Optionnel. Un code devise à 3 lettres vers lequel convertir les champs monétaires. Par défaut, la devise de votre compte.
advertiserId, channelId, programId, market Optionnel. Filtre l'agrégation sur un annonceur, un canal, un programme, et/ou un marché spécifique.
fromDate, toDate Optionnel. Filtre par date — ce point de terminaison agrège par date, pas par created.

Champs de réponse

Champ Description
advertiserId/advertiserName, channelId/channelName, programId/programName, affiliateId, market Inclus uniquement pour les dimensions selon lesquelles vous avez groupé.
date/week/month/quarter/year Inclus uniquement si vous avez groupé par date.
clicks, impressions Nombre de clics et d'impressions.
transactions, transactionsInclClick Nombre de transactions, avec et sans les conversions de type clic uniquement.
sales Valeur totale des ventes.
commission Commission totale.
deniedTransactions, deniedCommission Nombre de transactions refusées et leur commission.
totalTransactions Nombre total de transactions, refusées incluses.
uniqueAdvertisersWithClicks/uniqueChannelsWithClicks/uniqueMarketsWithClicks Nombres distincts sur les clics de ce groupe.
uniqueAdvertisersWithTransactions/uniqueChannelsWithTransactions/uniqueMarketsWithTransactions Nombres distincts sur les transactions de ce groupe.
uniqueMarketsWithClicksGroup Les codes marché observés, sous forme de chaîne.
epc Gains par clic.
cr Taux de conversion.
aov Panier moyen.
currency Devise des champs monétaires.

Ce point de terminaison renvoie des statistiques pré-agrégées plutôt que des enregistrements individuels, donc ses champs ne sont pas filtrables champ par champ comme pour les autres points de terminaison — utilisez plutôt les paramètres de requête ci-dessus.

Erreurs de suivi

GET /trackingErrors

Accessible pour

Tous les types de comptes, restreint à votre/vos propre(s) annonceur(s)/canal(-aux) comme d'habitude — il n'y a aucune différence de comportement entre les types de comptes au-delà de cela.

Paramètres de requête

Paramètre Description
fromDate, toDate Optionnel. Filtre par date.

Champs de réponse

Champ Filtrable Description
id Oui ID de l'erreur de suivi.
date Oui Date à laquelle l'erreur s'est produite.
channelId, advertiserId Oui Le canal et l'annonceur concernés.
redirectUrl Oui L'URL vers laquelle le clic a tenté de rediriger, le cas échéant.
clickUrl Oui L'URL de suivi qui a été appelée.
message Oui Description de ce qui s'est mal passé.
referrer Oui Référent HTTP.

Transactions

GET /transactions

Accessible pour

Tous les types de comptes. Les comptes annonceur et agence reçoivent en plus les champs de frais de courtage (brokerageMarkup, brokerageFee, deniedBrokerageFee, originalBrokerageFee) dans la réponse ; ceux-ci ne sont pas inclus pour les comptes affiliés.

Paramètres de requête

Paramètre Description
includeClicks Optionnel. Définissez à 1 pour inclure un tableau des clics ayant précédé chaque transaction.
includeProducts Optionnel. Définissez à 1 pour inclure les lignes de produits de chaque transaction.
includeTransactionListStatus Optionnel. Définissez à 1 pour inclure le statut du lot de paiement auquel appartient chaque transaction.
orderBy Optionnel. Ordre de tri des résultats, par ex. created DESC.
fromDate, toDate Optionnel. Filtre par date de création.
updatedFromDate, updatedToDate Optionnel. Filtre par date de dernière mise à jour de la transaction.

Champs de réponse

Champ Filtrable Description
id Oui ID de la transaction.
date, created, updated Oui Date de la transaction, horodatage de création, et horodatage de dernière mise à jour.
channelId, advertiserId Oui Le canal et l'annonceur concernés.
channelName, advertiserName — Leurs noms d'affichage.
programId Oui Le programme de commission appliqué.
programName Oui Le nom du programme de commission.
eventId Oui L'événement de suivi sous-jacent dont cette transaction a été créée.
commissionType Oui variable ou fixed.
commissionPercent, commissionAmount Oui Le taux appliqué, correspondant à commissionType.
eventValue, currency Oui Valeur de la commande et devise.
conversionEventId Oui Le type d'événement de conversion, par ex. Purchase.
status Oui new, approved, denied, delayed, ou paidOut.
eventOrderId Oui L'ID de commande propre à l'annonceur.
payoutId Oui Le paiement dans lequel cette transaction a été incluse, une fois payée.
transactionListId Oui Le lot de paiement auquel appartient cette transaction.
transactionListStatus — Uniquement avec includeTransactionListStatus. Statut de ce lot de paiement.
clickRef, clickId Oui Références vers le clic d'origine.
clickDate/clicks — Uniquement avec includeClicks. Le(s) clic(s) ayant précédé cette transaction.
products — Uniquement avec includeProducts. Lignes de produits — chacune avec id, product_id, title, category, brand, quantity, price, total.
denyReason, denyReasonCategory, denyDate Oui Renseignés lorsque la transaction a été refusée.
market Oui Code marché.
discountCodes Oui Code(s) de réduction utilisé(s) dans la commande, si suivi.
affiliateGclid, wctid Oui Identifiants de clic Google Ads / autre plateforme publicitaire, le cas échéant.
untrackedSale Oui Indique si cette vente a été ajoutée manuellement comme non suivie.
clickCount Oui Nombre de clics associés à cette transaction.
individualCommissionId Oui Renseigné lorsqu'une commission personnalisée par canal a été appliquée.
commissionSource Oui Origine de la commission, par ex. program, individualCommission.
delayedUntil Oui Date jusqu'à laquelle la transaction est retenue, si différée.
subids Oui Vos propres paramètres de sous-ID, si envoyés.
source Oui Origine de la transaction.
commission, commissionText — Montant de commission calculé et sa forme lisible.
originalCommission — Commission avant tout ajustement.
currencies — Objet indexé par code devise, chacun avec rate, commission, eventValue, originalCommission — une vue de la même transaction convertie dans cette devise.

Mise à jour du statut d'une transaction

PATCH /transactions/status/{id}

Accessible pour

Annonceurs uniquement.

Met à jour le statut d'une transaction. La réponse contient la transaction mise à jour, dans le même format que ci-dessus.

Corps de la requête

{ "status": "approved" }

Vous pouvez aussi rechercher une transaction par votre propre ID de commande plutôt que par son ID de transaction Addrevenue — omettez {id} du chemin et envoyez { "orderId": "your-order-id", "status": "approved" }.

Valeurs status acceptées : new, approved, denied, delayed. Une transaction ne peut plus être modifiée une fois qu'elle a été incluse dans un lot de paiement ayant quitté l'état d'attente.

Journal des modifications

2026-09-02 : Extension de la référence de l'API pour documenter tous les points de terminaison disponibles ainsi que l'ensemble de leurs paramètres de requête et de réponse.

2026-08-04 : Correction de GET /products afin que les comptes autres que l'annonceur lui-même ne voient plus les produits des annonceurs dont le marché n'est pas actif.

2026-07-28 : Ajout du paramètre de requête includeProducts sur GET /transactions.

2026-07-16 : Correction de GET /relations qui incluait parfois des programmes exclusifs à un canal ne s'appliquant pas au canal donné.

2026-06-25 : Correction de la précision de detectedCurrency/detectedLanguage sur GET /productfeeds. GET /products inclut désormais min_handling_time/max_handling_time lorsque l'annonceur a configuré une valeur de repli.

2026-06-02 : Correction du lien de pagination links.prev, qui pouvait apparaître à tort sur la première page de résultats.

2026-05-15 : Ajout des champs detectedCurrency et detectedLanguage à la réponse de GET /productfeeds.

2026-04-28 : Ajout du point de terminaison GET /brokenLinks.

2026-04-07 : Ajout du champ landingPages à la réponse de GET /advertisers (disponible avec expand=1).

2026-03-06 : Ajout du champ conversionEventId à la réponse de GET /programs.

2026-01-25 : Correction des paramètres de requête updatedFromDate/updatedToDate, qui n'étaient jusqu'ici pas appliqués en raison d'une incohérence de nommage interne.

2024-09-18 : Changement des noms des paramètres de pagination de productsPerPage et selectedPage vers limit et offset.

2022-05-12 : Ajout du nouveau point de terminaison /payouts permettant aux affiliés de récupérer tous leurs paiements.

2022-04-28 : Ajout du nouveau point de terminaison /productfeeds permettant aux affiliés de récupérer une liste de toutes les URL de flux de produits.

2022-04-27 : Ajout du nouveau point de terminaison /relations pour lister vos relations entre canaux et annonceurs.

2022-04-22 : Ajout de la possibilité de grouper /stats selon plusieurs dimensions.

2022-04-21 : Ajout de channelId comme paramètre de requête au point de terminaison /advertisers, pour limiter la réponse aux annonceurs ayant des relations avec le canal donné.

2022-04-20 : Ajout du point de terminaison /stats pour obtenir des statistiques agrégées.

2022-04-19 : Ajout de la possibilité de limiter les réponses de certains points de terminaison comme transactions et events à l'aide des paramètres de requête fromDate et/ou toDate.

2022-03-22 : Lors de l'envoi de channelId au point de terminaison /campaigns, seules les campagnes des annonceurs ayant une relation approuvée avec le canal seront désormais affichées.

2022-03-19 : Ajout du paramètre de requête includeClicks au point de terminaison /transactions, pour inclure tous les clics précédents dans un tableau.

2022-03-18 : Ajout de trackingLink dans la réponse du point de terminaison /campaigns, si le paramètre channelId est fourni.

2022-03-18 : Ajout de advertiserName dans la réponse du point de terminaison /campaigns.

2022-03-18 : Ajout de advertiserName dans la réponse du point de terminaison /banners.

×

Créer un compte

Choisissez le type de compte qui correspond le mieux à votre profil