Guides

API Plan de contrôle du gateway API Conversions pour plusieurs comptes : référence

Objets

Locataire

ChampDescription

id
Chaîne

Identifiant unique du compte

name
Chaîne

Nom du compte

status
Entier

Trois valeurs peuvent être associées au compte en fonction de son statut :


ValeurDescription

0

Activé

1

Configuration en attente

2

Désactivé

canPartnerManage
Booléen

Cet indicateur précise si un partenaire peut gérer le compte.

users
Utilisateur

Liste des utilisateur·ices du compte

availableRoles
Rôle

Rôles disponibles pour le compte

canEditTenantSettingsInUI
Booléen

Cet indicateur précise si l’utilisateur·ice peut modifier les paramètres du compte comme les pixels, les domaines, etc.

canViewTenantInUI
Booléen

Cet indicateur précise si l’utilisateur·ice peut réellement voir les détails du compte dans l’UI.

canEditTenantUsersInUI
Booléen

Cet indicateur précise si un·e utilisateur·ice peut ajouter/supprimer des utilisateur·ices de compte dans la liste ou en modifier les autorisations.

tenantUsage
TenantUsage

Informations sur l’utilisation par le ou la locataire.

Utilisateur·ice

ChampDescription

id
Chaîne

Identifiant unique de l’utilisateur·ice

email
Chaîne

Adresse e-mail de l’utilisateur·ice

status
Entier

Trois valeurs peuvent être associées à l’utilisateur·ice en fonction de son statut :


ValeurDescription

0

Désactivé

1

Activé

2

En attente

roles
Rôle

Liste des rôles de l’utilisateur·ice

tenants
Locataire

Comptes auxquels l’utilisateur·ice appartient

isSelf
Booléen

Cet indicateur précise si l’utilisateur·ice connecté·e est identique (toujours False avec l’API).

canBeDeleted
Booléen

Cet indicateur précise que l’utilisateur·ice est l’unique admin d’un ou de plusieurs comptes et ne peut donc pas être supprimé·e.

userExpiry
Chaîne

Date d’expiration pour l’utilisateur·ice temporaire, au format de la chaîne de date « aaaa-mm-jj ».


Rôle

ChampDescription

name
Chaîne

Nom complet du rôle.


Les rôles peuvent correspondre à des utilisateur·ices de type agence (partenaire) ou annonceur (compte).


Le nom du rôle suit le format ci-après :

Pour les partenaires : agency-[ROLE-ACTION]


Pour les annonceurs : advertiser-[ROLE-ACTION]-[tenantId]


[ROLE-ACTION] : décrit la responsabilité du rôle. Trois valeurs sont possibles :

  1. admin
  2. user
  3. view

[tenantId] : ID du compte dont les rôles sont assignés aux utilisateur·ices

displayName
Chaîne

Il s’agit du [ROLE-ACTION] du rôle.

tenantName
Chaîne

Nom du ou de la locataire/du compte

UserType

ValeurDescription

AGENCY

Pour les partenaires/l’hôte

ADVERTISER

Pour le locataire/le compte

SignalConfig

ChampDescription

id
ID

Identifiant unique au format SignalConfig:<pixel id>

connectionId
Chaîne

ID de pixel

connectionStatus
ConnectionStatus

Statut de connexion du pixel

domains
Chaîne

Liste de domaines

dataSetType
Chaîne

Saisir la chaîne de l’ensemble de données :

  • PIXEL
  • PRIVATE_COMPUTE
  • INDEPENDENT_PIXEL
  • ADVERTISER_HOSTED_SDK
  • EMPTY
  • UNKNOWN

ConnectionStatus

ChampDescription

id
ID

Identifiant unique de la connexion du pixel : ConnectionStatus:<pixel id>

connected
Booléen

Indique si l’ID de pixel et le token d’accès sont présents.

active
Booléen

Indique si le pixel est actif ou non.

eventBridgeActive
Booléen

Indique si Event Bridge est actif pour le pixel.

publishingEnabled
Booléen

Indique si des évènements peuvent être publiés.

accessKey
Chaîne

Clé d’accès d’Event Bridge

apiErrorCode
Chaîne

Dernier code d’erreur de la publication vers l’API Conversions de Meta. La valeur a le format <error code>.<error subcode>. (Référence)

pixelID
Chaîne

Identifiant unique du pixel

pixelName
Chaîne

Nom du pixel

accessTokenAvailable
Booléen

Présence ou pas du token d’accès de publication vers l’API Conversions

totalEventsPublished
Nombre à virgule flottante

Nombre total d’évènements publiés

lastPublished
Nombre à virgule flottante

Horodatage du dernier évènement publié

totalEventsReceived
Nombre à virgule flottante

Nombre total d’évènements reçus

lastReceived
Nombre à virgule flottante

Horodatage du dernier évènement reçu

IngressDomain

ChampDescription

id
ID

Identifiant unique de l’entrée

tenantName
Chaîne

Nom du compte

ingress
Chaîne

Domaine de l’annonceur·se

cnameResolveSuccess
Booléen

Le CNAME du domaine de l’annonceur·se est vérifié.

EventFilter

ChampDescription

eventName
Chaîne

Nom de l’évènement

pixelId
Chaîne

Pixel auquel le filtre s’applique. Nul si le filtre est appliqué à tous les pixels.

filterState
EventFilterState

État du filtre d’évènement

EventFilterState

Valeur

PUBLISH

DROP

MIXED

DomainFilter

ChampDescription

eventName
Chaîne

Nom du domaine

pixelId
Chaîne

Pixel auquel le filtre s’applique. Nul si le filtre est appliqué à tous les pixels.

filterState
DomainFilterState

État du filtre d’évènement

DomainFilterState

Valeur

PUBLISH

DROP

MIXED

EventTrafficSummary

ChampDescription

id
ID

Identifiant d’EventTrafficSummary : toujours EventTrafficSummary:incoming

eventNamesCount
Entier

Nombre de noms d’évènement reçus

eventsCount
Entier

Nombre total d’évènements reçus

ConversionsApiPublishSummary

ChampDescription

id
ID

Identifiant de ConversionsApiPublishSummary : toujours ConversionsApiPublishSummary:global

eventNamesCount
Entier

Nombre de noms d’évènement envoyés

eventsCount
Entier

Nombre total d’évènements envoyés

publishSuccessRate
Nombre à virgule flottante

Taux de réussite de la publication d’évènements

EventActivity

ChampDescription

id
ID

Identifiant d’EventActivity au format EventActivity:<event name>

name
Chaîne

Nom de l’évènement

receivedCount
Entier

Nombre total d’évènements reçus

publishedCount
Entier

Nombre total d’évènements publiés

lastUpdated
Chaîne

Date de la dernière mise à jour

DomainActivity

ChampDescription

id
ID

Identifiant unique de DomainActivity au format DomainActivity:<domain name>

domainName
Chaîne

Nom de domaine

receivedCount
Entier

Nombre total d’évènements reçus

publishedCount
Entier

Nombre total d’évènements publiés

TenantUsage

ChampDescription

totalPixels
Entier

Nombre total de pixels dans le compte

totalActivePixels
Entier

Nombre total de pixels actifs dans le compte

totalInactivePixels
Entier

Nombre total de pixels inactifs dans le compte

tenantUsageByTraffic
TenantUsageByTraffic

Utilisation par le ou la locataire en fonction du trafic

pixelIds
Chaîne

Liste des ID de pixel associés

TenantUsageByTraffic

ChampDescription

totalEventsReceived
Long

Nombre total d’évènements reçus pour un·e locataire sur une durée donnée

totalPixelsWithTraffic
Entier

Nombre total de pixels avec du trafic sur une durée donnée

publishError
Booléen

Erreur de publication vers CAPI sur une durée donnée

durationInHours
Entier

Durée

lastUpdatedAt
Chaîne

Date de la dernière mise à jour

Voir aussi