Guides

API Control Plane du gateway API Conversions pour plusieurs comptes : référence

Gestion des pixels

Créer une connexion de pixel

Intègre un nouveau pixel Meta au gateway API Conversions.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation AddNewPixelModalMutation(
    $tenantId: ID!
    $input: PixelConnectionCreationInput!
) {
    tenantMutations(tenantId: $tenantId) {
          signalMutations {
              setupPixelSignalConfig(input: $input) {
              id
              domains
              connectionId
              connectionStatus {
                  id
                  accessTokenAvailable
                  active
                  connected
                  accessKey
                  eventBridgeActive
                  publishingEnabled
                  apiErrorCode
                  pixelID
                  pixelName
                  lastPublished
                  totalEventsPublished
                  lastReceived
                  totalEventsReceived
                  }
              }
          }
     }
}
_________________________________________________________________________________________________________    
tenantId: ID!
_________________________________________________________________________________________________________
input PixelConnectionCreationInput {
  businessId: String!
  pixelId: String!
  accessToken: String!
  apiVersion: String
  externalId: String!
  name: String
}

Champs

ChampDescription

tenantId
ID

Obligatoire

Identifiant unique du compte

PixelConnectionCreationInput

ChampDescription

businessId
Chaîne

Obligatoire

ID d’entreprise du compte

pixelId
Chaîne

Obligatoire

ID de pixel à intégrer

accessToken
Chaîne

Obligatoire

Token d'accès issu de la configuration MBE ou généré manuellement depuis le Gestionnaire d'évènements

apiVersion
Chaîne

Facultatif

Dernière version de l’API Graph

externalId
Chaîne

Obligatoire

Doit être identique au external_business_id de l’objet de configuration

name
Chaîne

Facultatif

Nom du pixel


Retours

ChampDescription

signalConfig
SignalConfig

Configurations de pixel


Codes d’erreur

CodeDescription

400

Saisie non valide

401

L'utilisateur·ice n'est pas autorisé·e à configurer le pixel

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation AddNewPixelModalMutation(
   $tenantId: ID!
   $input: PixelConnectionCreationInput!
) {
   tenantMutations(tenantId: $tenantId) {
          signalMutations {
              setupPixelSignalConfig(input: $input) {
              id
              domains
              connectionId
              connectionStatus {
                  id
                  accessTokenAvailable
                  active
                  eventBridgeActive
                  publishingEnabled
                  apiErrorCode
                  pixelID
                  pixelName
                  lastPublished
                  totalEventsPublished
                  lastReceived
                  totalEventsReceived
                  }
              }
          }
   }
}

Variables

{
   "tenantId": "IaoreXfj",
   "input": {
       "pixelId": "18904456377094531",
       "businessId": "2840127409433732",
       "accessToken": "<accessToken>",
       "apiVersion": "v14.0",
       "externalId": "633612748410ba6e902"
   }
}

Exemple de réponse

{
   "data": {
       "tenantMutations": {
           "signalMutations": {
               "setupPixelSignalConfig": {
                   "id": "SignalConfig:18904456377094531",
                   "domains": [],
                   "connectionId": "18904456377094531",
                   "connectionStatus": {
                       "id": "ConnectionStatus:18904456377094531",
                       "accessTokenAvailable": true,
                       "active": true,
                       "eventBridgeActive": true,
                       "publishingEnabled": true,
                       "apiErrorCode": null,
                       "pixelID": "18904456377094531",
                       "pixelName": null,
                       "lastPublished": 0.0,
                       "totalEventsPublished": 0.0,
                       "lastReceived": 0.0,
                       "totalEventsReceived": 0.0
                   }
               }
           }
       }
   }
}

Supprimer la connexion du pixel

Supprime un pixel existant du gateway.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation DeleteDataSourceModalMutation(
  $id: ID!
  $tenantId: ID!
) {
  tenantMutations(tenantId: $tenantId) {
    signalMutations {
      deleteDataSource(id: $id)
    }
  }
}
_________________________________________________________________________________________________________    
id: ID!
_____________________________________________________________________________________________________________
      
tenantId: ID!

Champs

ChampDescription

id
ID

Obligatoire

ID de pixel

tenantId
ID

Obligatoire
Identifiant unique du compte


Retours

ChampDescription

Booléen

Indique si le pixel a été supprimé avec succès


Codes d’erreur

CodeDescription

401

L'utilisateur·ice n'est pas autorisé·e à supprimer la configuration du pixel.

404

Pixel introuvable.

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation DeleteDataSourceModalMutation(
 $id: ID!
 $tenantId: ID!
) {
 tenantMutations(tenantId: $tenantId) {
   signalMutations {
     deleteDataSource(id: $id)
   }
 }
}

Variables

{
   "id":"18904456377094531",
   "tenantId":"IaoreXfj"
}

Exemple de réponse

{
   "data": {
       "tenantMutations": {
           "signalMutations": {
               "deleteDataSource": true
           }
       }
   }
}

Activer/désactiver le gateway pour qu’il reçoive les évènements du pixel

Modifie le statut de réception de l’évènement du pixel du gateway.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation updateSignalConfigStatusMutation(
    $id: ID!, $tenantId: ID!, $input: SignalConfigStatusInput!) {
  tenantMutations(tenantId: $tenantId) {
    signalMutations {
      updateSignalConfigEventsStatus(id: $id, input: $input) {
        success
        connectionStatus {
            id
            accessTokenAvailable
            active
            connected
            accessKey
            eventBridgeActive
            publishingEnabled
            apiErrorCode
            pixelID
            pixelName
            lastPublished
            totalEventsPublished
            lastReceived
            totalEventsReceived
        }
      }
    }
  }
}
_________________________________________________________________________________________________________    
id: ID!
_____________________________________________________________________________________________________________
      
tenantId: ID!
________________________________________________________________________________________________________
input SignalConfigStatusInput {
  status: Int!
}

Champs

ChampDescription

id
ID

Obligatoire

ID de pixel à configurer

tenantId
ID

Obligatoire
Identifiant unique du compte


SignalConfigStatusInput

ChampDescription

status
Entier

Obligatoire


ValeurDescription

0

Désactiver

1

Activer


Retours

UpdateSignalConfigStatusPayload

ChampDescription

success
Booléen

Indique si l'opération sur le pixel a réussi

connectionStatus
ConnectionStatus

Configuration de la connexion du pixel


Codes d’erreur

CodeDescription

401

Non autorisé·e à effectuer une action sur le pixel

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation updateSignalConfigStatusMutation(
   $id: ID!, $tenantId: ID!, $input: SignalConfigStatusInput!) {
 tenantMutations(tenantId: $tenantId) {
   signalMutations {
     updateSignalConfigEventsStatus(id: $id, input: $input) {
       success
       connectionStatus {
         id
         connected
         active
         eventBridgeActive
         publishingEnabled
       }
     }
   }
 }
}

Variables

{
   "id": "18904456377094531",
   "tenantId": "IaoreXfj",
   "input": {
       "status": 1
       }
}

Exemple de réponse

{
   "data": {
       "tenantMutations": {
           "signalMutations": {
               "updateSignalConfigEventsStatus": {
                   "success": true,
                   "connectionStatus": {
                       "id": "ConnectionStatus:18904456377094531",
                       "connected": true,
                       "active": true,
                       "eventBridgeActive": true,
                       "publishingEnabled": true
                   }
               }
           }
       }
   }
}

Activer/désactiver le statut de publication de l'évènement du pixel

Modifie le statut de publication de l’évènement du pixel. En cas de désactivation, le gateway abandonnera les évènements reçus et ne les publiera pas sur Meta.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation updateSignalConfigCapiPublishMutation(
$id: ID!, $tenantId: ID!, $input: SignalConfigStatusInput!) {
 tenantMutations(tenantId: $tenantId) {
   signalMutations {
     updateSignalConfigCapiPublish(id: $id, input: $input) {
       success
       connectionStatus {
           id
           accessTokenAvailable
           active
           connected
           accessKey
           eventBridgeActive
           publishingEnabled
           apiErrorCode
           pixelID
           pixelName
           lastPublished
           totalEventsPublished
           lastReceived
           totalEventsReceived
       }
     }
   }
 }
}
_________________________________________________________________________________________________________    
id: ID!
_____________________________________________________________________________________________________________
      
tenantId: ID!
________________________________________________________________________________________________________
input SignalConfigStatusInput {
  status: Int!
}

Champs

ChampDescription

id
ID

Obligatoire

ID de pixel à configurer

tenantId
ID

Obligatoire
Identifiant unique du compte


SignalConfigStatusInput

ChampDescription

status
Entier

Obligatoire


ValeurDescription

0

Désactiver

1

Activer


Retours

UpdateSignalConfigStatusPayload

ChampDescription

success
Booléen

Indique si l'opération sur le pixel a réussi

connectionStatus
ConnectionStatus

Configuration de la connexion du pixel


Codes d’erreur

CodeDescription

401

Non autorisé·e à effectuer une action sur le pixel

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation updateSignalConfigCapiPublishMutation(
$id: ID!, $tenantId: ID!, $input: SignalConfigStatusInput!) {
 tenantMutations(tenantId: $tenantId) {
   signalMutations {
     updateSignalConfigCapiPublish(id: $id, input: $input) {
       success
       connectionStatus {
         id
         active
         eventBridgeActive
         publishingEnabled
       }
     }
   }
 }
}

Variables

{
   "id": "18904456377094531",
   "tenantId": "IaoreXfj",
   "input": {
       "status": 0
       }
}

Exemple de réponse

{
   "data": {
       "tenantMutations": {
           "signalMutations": {
               "updateSignalConfigCapiPublish": {
                   "success": true,
                   "connectionStatus": {
                       "id": "ConnectionStatus:18904456377094531",
                       "active": false,
                       "eventBridgeActive": true,
                       "publishingEnabled": false
                   }
               }
           }
       }
   }
}

Activer/désactiver le statut de publication de l'évènement du pixel par nom d’évènement

Modifie le statut de publication de l'évènement du pixel par nom d'évènement et ID de pixel. En cas de désactivation, le gateway abandonnera ces évènements et ne les publiera pas sur Meta.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation EventFilterStatusMutation($tenantId: ID!, $input: UpdateEventFilterInput!) {
 tenantMutations(tenantId: $tenantId) {
   updateEventFilter(input: $input) {
     updatedFilter {
       id
       eventName
       pixelId
       filterState
     }
   }
 }
}
_________________________________________________________________________________________________________    
tenantId: ID!
_____________________________________________________________________________________________________________
      
input UpdateEventFilterInput {
  eventName: String!
  pixelIds: [String!]
  filterState: EventFilterState!
}

Champs

ChampDescription

tenantId
ID

Obligatoire
Identifiant unique du compte


UpdateEventFilterInput

ChampDescription

eventName
Chaîne

Obligatoire

Nom de l'évènement à filtrer

pixelIds
Chaîne

Facultatif

Liste des ID de pixel auxquels le filtre doit être appliqué. En l’absence de liste, tous les pixels du compte seront mis à jour

filterState
EventFilterState

Obligatoire

État du filtre


Retours

UpdateEventFilterResult

ChampDescription

updatedFilter
EventFilter

Filtre d'évènement mis à jour


Codes d’erreur

CodeDescription

401

Non autorisé·e à mettre à jour les filtres d'évènement

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation EventFilterStatusMutation($tenantId: ID!, $input: UpdateEventFilterInput!) {
tenantMutations(tenantId: $tenantId) {
  updateEventFilter(input: $input) {
    updatedFilter {
      eventName
      pixelId
      filterState
    }
  }
}
}

Variables

{
"tenantId": "IaoreXfj",
"input": {
  "eventName": "AddToCart",
  "pixelIds": ["18904456377094531"],
  "filterState": "PUBLISH"
}
}

Exemple de réponse

{
   "data": {
       "tenantMutations": {
           "updateEventFilter": {
               "updatedFilter": {
                   "eventName": "AddToCart",
                   "pixelId": "18904456377094531",
                   "filterState": "PUBLISH"
               }
           }
       }
   }
}

Bloquer/débloquer les sites Web autorisés à recevoir et publier des évènements

Blocs recevant les évènements de sites Web spécifiques.

Schéma

POST https://{capig_domain}/capig/graphql/ 
_________________________________________________________________________________________________________________
      
mutation useComitDomainFilterChangeMutation($tenantId: ID!, $input: UpdateDomainFilterInput!) {
  tenantMutations(tenantId: $tenantId) {
    updateDomainFilter(input: $input) {
      updatedFilter {
        id
        domain
        pixelId
        filterState
      }
    }
  }
}
_________________________________________________________________________________________________________    
tenantId: ID!
_____________________________________________________________________________________________________________
      
input UpdateDomainFilterInput {
  domain: String!
  pixelIds: [String!]
  filterState: DomainFilterState!
}

Champs

ChampDescription

tenantId
ID

Obligatoire
Identifiant unique du compte


UpdateDomainFilterInput

ChampDescription

domain
Chaîne

Obligatoire

Nom du domaine à filtrer


Le format doit être : exemple.com

pixelIds
Chaîne

Facultatif

Liste des ID de pixel auxquels le filtre doit être appliqué.

filterState
DomainFilterState

Obligatoire

État du filtre


Retours

UpdateDomainFilterResult

ChampDescription

updatedFilter
DomainFilter

Objet du filtre de domaine


Codes d’erreur

CodeDescription

401

Non autorisé·e à mettre à jour les filtres de domaine

500

Erreur interne du serveur


Exemple de requête

Mutation

mutation useComitDomainFilterChangeMutation($tenantId: ID!, $input: UpdateDomainFilterInput!) {
 tenantMutations(tenantId: $tenantId) {
   updateDomainFilter(input: $input) {
     updatedFilter {
       id
       domain
       pixelId
       filterState
     }
   }
 }
}

Variables

{
 "tenantId": "IaoreXfj",
 "input": {
   "domain": "example.com",
   "filterState": "DROP"
 }
}

Exemple de réponse

"data": {
       "tenantMutations": {
           "updateDomainFilter": {
               "updatedFilter": {
                   "id": "DomainFilter:example.com:global",
                   "domain": "example.com",
                   "pixelId": null,
                   "filterState": "DROP"
               }
           }
       }
   }

Voir aussi