Leitfäden

Conversions API Gateway für mehrere Konten – Control Plane API: Referenz

Pixel-Verwaltung

Pixel-Verbindung erstellen

Schaltet ein neues Meta-Pixel für das Conversions API Gateway frei.

Schema

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
}

Felder

FeldBeschreibung

tenantId
ID

Erforderlich

Eindeutige ID des Kontos

PixelConnectionCreationInput

FeldBeschreibung

businessId
String

Erforderlich

Die Business-ID des Kontos

pixelId
String

Erforderlich

Die Pixel-ID, die integriert werden muss

accessToken
String

Erforderlich

Zugriffsschlüssel, der aus der MBE-Einrichtung stammt oder manuell mit dem Events Manager generiert wurde

apiVersion
String

Optional

Neueste API-Version für Graph API

externalId
String

Erforderlich

Sollte mit external_business_id im Setup-Objekt übereinstimmen

name
String

Optional

Name des Pixels


Rückgabe

FeldBeschreibung

signalConfig
SignalConfig

Pixel-Konfigurationen


Fehlercodes

CodeBeschreibung

400

Ungültiger Input bereitgestellt

401

Nutzer*in ist nicht zum Einrichten der Pixel-Konfiguration berechtigt.

500

Interner Serverfehler


Beispielanfrage

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
                  }
              }
          }
   }
}

Variablen

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

Beispielantwort

{
   "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
                   }
               }
           }
       }
   }
}

Pixel-Verbindung löschen

Löscht ein vorhandenes Pixel aus dem Gateway.

Schema

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

Felder

FeldBeschreibung

id
ID

Erforderlich

Die Pixel-ID

tenantId
ID

Erforderlich
Eindeutige ID des Kontos


Rückgabe

FeldBeschreibung

Boolescher Wert

Gibt an, ob das Pixel erfolgreich gelöscht wurde


Fehlercodes

CodeBeschreibung

401

Nutzer*in ist nicht zum Entfernen der Pixel-Konfiguration berechtigt.

404

Pixel nicht gefunden.

500

Interner Serverfehler


Beispielanfrage

Mutation

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

Variablen

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

Beispielantwort

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

Empfang von Pixel-Events durch Gateway aktivieren/deaktivieren

Ändert den Empfangsstatus eines Gateways für Pixel-Events.

Schema

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!
}

Felder

FeldBeschreibung

id
ID

Erforderlich

Pixel-ID, die konfiguriert werden muss

tenantId
ID

Erforderlich
Eindeutige ID des Kontos


SignalConfigStatusInput

FeldBeschreibung

status
Int

Erforderlich


WertBeschreibung

0

Deaktivieren

1

Aktivieren


Rückgabe

UpdateSignalConfigStatusPayload

FeldBeschreibung

success
Boolescher Wert

Gibt an, ob die Operation für das Pixel erfolgreich war

connectionStatus
ConnectionStatus

Pixel-Verbindungskonfiguration


Fehlercodes

CodeBeschreibung

401

Nicht zum Durchführen der Aktion für das Pixel berechtigt

500

Interner Serverfehler


Beispielanfrage

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
       }
     }
   }
 }
}

Variablen

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

Beispielantwort

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

Pixel-Event-Veröffentlichungsstatus aktivieren/deaktivieren

Ändert den Veröffentlichungsstatus eines Pixel-Events. Bei Deaktivierung verwirft das Gateway empfangene Events und veröffentlicht sie nicht in Meta.

Schema

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!
}

Felder

FeldBeschreibung

id
ID

Erforderlich

Pixel-ID, die konfiguriert werden muss

tenantId
ID

Erforderlich
Eindeutige ID des Kontos


SignalConfigStatusInput

FeldBeschreibung

status
Int

Erforderlich


WertBeschreibung

0

Deaktivieren

1

Aktivieren


Rückgabe

UpdateSignalConfigStatusPayload

FeldBeschreibung

success
Boolescher Wert

Gibt an, ob die Operation für das Pixel erfolgreich war

connectionStatus
ConnectionStatus

Pixel-Verbindungskonfiguration


Fehlercodes

CodeBeschreibung

401

Nicht zum Durchführen der Aktion für das Pixel berechtigt

500

Interner Serverfehler


Beispielanfrage

Mutation

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

Variablen

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

Beispielantwort

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

Pixel-Event-Veröffentlichungsstatus nach Event-Name aktivieren/deaktivieren

Ändert den Veröffentlichungsstatus eines Pixel-Events nach Event-Name und Pixel-ID. Bei Deaktivierung verwirft das Gateway empfangene Events und veröffentlicht sie nicht in Meta.

Schema

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!
}

Felder

FeldBeschreibung

tenantId
ID

Erforderlich
Eindeutige ID des Kontos


UpdateEventFilterInput

FeldBeschreibung

eventName
String

Erforderlich

Name des zu filternden Events

pixelIds
String

Optional

Liste der Pixel-IDs, auf die der Filter angewendet werden muss. Falls der Wert null angegeben wird, werden alle Pixel für das Konto aktualisiert.

filterState
EventFilterState

Erforderlich

Zustand des Filters


Rückgabe

UpdateEventFilterResult

FeldBeschreibung

updatedFilter
EventFilter

Aktualisierter Event-Filter


Fehlercodes

CodeBeschreibung

401

Nicht zum Aktualisieren der Event-Filter berechtigt

500

Interner Serverfehler


Beispielanfrage

Mutation

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

Variablen

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

Beispielantwort

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

Websites, von denen Events empfangen und veröffentlicht werden dürfen, blockieren/ihre Blockierung aufheben

Blockiert den Empfang von Events von bestimmten Websites.

Schema

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!
}

Felder

FeldBeschreibung

tenantId
ID

Erforderlich
Eindeutige ID des Kontos


UpdateDomainFilterInput

FeldBeschreibung

domain
String

Erforderlich

Name der zu filternden Domain


Zu verwendendes Format: example.com

pixelIds
String

Optional

Liste der Pixel-IDs, auf die der Filter angewendet werden muss

filterState
DomainFilterState

Erforderlich

Zustand des Filters


Rückgabe

UpdateDomainFilterResult

FeldBeschreibung

updatedFilter
DomainFilter

Domainfilter-Objekt


Fehlercodes

CodeBeschreibung

401

Nicht zum Aktualisieren der Domain-Filter berechtigt

500

Interner Serverfehler


Beispielanfrage

Mutation

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

Variablen

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

Beispielantwort

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

Siehe auch