Leitfäden

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

Objekte

Mandant

FeldBeschreibung

id
String

Eindeutige ID des Kontos.

name
String

Name des Kontos.

status
Int

Der Kontostatus kann drei Werte annehmen, die seinen Zustand angeben:


WertBeschreibung

0

Aktiv

1

Konfiguration steht aus

2

Deaktiviert

canPartnerManage
Boolescher Wert

Diese Kennzeichnung gibt an, ob ein Partner dieses Konto verwalten kann.

users
Nutzer*innen

List der Nutzer*innen im Konto.

availableRoles
Rolle

Verfügbare Rollen für das Konto.

canEditTenantSettingsInUI
Boolescher Wert

Diese Kennzeichnung gibt an, ob ein*e Nutzer*in Kontoeinstellungen wie Pixel, Domains usw. ändern kann.

canViewTenantInUI
Boolescher Wert

Diese Kennzeichnung gibt an, ob der*die Nutzer*in das Kontodetail in der UI tatsächlich anzeigen kann.

canEditTenantUsersInUI
Boolescher Wert

Diese Kennzeichnung gibt an, ob ein*e Nutzer*in Nutzer*innen in der Liste der Kontonutzer*innen hinzufügen/entfernen oder deren Berechtigungen ändern kann.

tenantUsage
TenantUsage

Info zur Mandantennutzung.

Nutzer*in

FeldBeschreibung

id
String

Eindeutige ID des Kontos.

domain
String

E-Mail-Adresse des*der Nutzer*in

status
Int

Der Nutzungsstatus kann drei Werte annehmen, die seinen Zustand angeben:


WertBeschreibung

0

Deaktiviert

1

Aktiviert

2

Ausstehend

roles
Rolle

Liste der Rollen des*der Nutzer*in.

tenants
Mandant

Konten, denen der*die Nutzer*in angehört.

isSelf
Boolescher Wert

Zeigt an, ob es sich bei dem*der angemeldeten Nutzer*in um den*die gleiche*n Nutzer*in handelt (bei api wäre dies immer „false“).

canBeDeleted
Boolescher Wert

Zeigt an, dass der*die Nutzer*in der*die einzige Administrator*in eines oder mehrerer Konten ist, sodass er*sie nicht gelöscht werden kann.

userExpiry
String

Ablaufdatum für den*die vorübergehende Nutzer*in im Format des Datumstrings „jjjj-mm-tt“.


Rolle

FeldBeschreibung

name
String

Vollständiger Rollenname.


Rollen können für Agency-Nutzer*innen (Partnernutzer*innen) oder Werbetreibenden-Nutzer*innen (Kontonutzer*innen) sein.


Der Rollenname folgt dem folgenden Format:

Für Partner: agency-[ROLE-ACTION]


Für Werbetreibende: advertiser-[ROLE-ACTION]-[tenantId]


[ROLE-ACTION]: Hiermit wird die Aufgabe der Rolle beschrieben. Sie kann einen von drei Werten annehmen:

  1. admin
  2. user
  3. view

[tenantId]: die ID des Kontos, dessen Rollen Nutzer*innen zugewiesen werden.

displayName
String

Dies ist die [ROLE-ACTION] der Rolle.

tenantName
String

Name des Mandanten/Kontos.

UserType

WertBeschreibung

AGENCY

Dies ist für den Partner/Host.

ADVERTISER

Dies ist für den Mandanten/das Konto.

SignalConfig

FeldBeschreibung

id
ID

Eindeutige ID im Format SignalConfig:<pixel id>.

connectionId
String

Die Pixel-ID.

connectionStatus
ConnectionStatus

Verbindungsstatus des Pixels.

domain
String

Liste der Domains.

dataSetType
String

Typ-String des Datensatzes:

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

ConnectionStatus

FeldBeschreibung

id
ID

Eindeutige ID der Pixel-Verbindung ConnectionStatus:<pixel id>.

connected
Boolescher Wert

Gibt an, ob Pixel-ID und Zugriffstoken vorhanden sind.

active
Boolescher Wert

Gibt an, ob Pixel aktiv ist.

eventBridgeActive
Boolescher Wert

Gibt an, ob Event Bridge für Pixel aktiv ist.

publishingEnabled
Boolescher Wert

Gibt an, ob Events veröffentlicht werden können.

accessKey
String

Zugriffsschlüssel für Event Bridge.

apiErrorCode
String

Letzter Fehlercode von der Veröffentlichung in Meta Conversions API. Der Wert weist das Format <error code>.<error subcode> auf. (Referenz)

pixelID
String

Die eindeutige ID des Pixels.

pixelName
String

Name des Pixels.

accessTokenAvailable
Boolescher Wert

Zugriffstoken zur Veröffentlichung in der Conversions API vorhanden oder nicht.

totalEventsPublished
Gleitkommazahl

Insgesamt veröffentlichte Events.

lastPublished
Gleitkommazahl

Zeitstempel des zuletzt veröffentlichten Events.

totalEventsReceived
Gleitkommazahl

Insgesamt empfangene Events.

lastReceived
Gleitkommazahl

Zeitstempel des zuletzt empfangenen Events.

IngressDomain

FeldBeschreibung

id
ID

Eindeutige ID für den Ingress.

tenantName
String

Name des Kontos.

ingress
String

Werbetreibenden-Domain.

cnameResolveSuccess
Boolescher Wert

CName der Werbetreibenden-Domain ist verifiziert.

EventFilter

FeldBeschreibung

eventName
String

Name des Events.

pixelId
String

Das Pixel, auf das der Filter angewendet wird. Es ist null, wenn der Filter auf alle Pixel angewendet wird.

filterState
EventFilterState

Zustand des Event-Filters.

EventFilterState

Wert

PUBLISH

DROP

MIXED

DomainFilter

FeldBeschreibung

eventName
String

Name der Domain.

pixelId
String

Das Pixel, auf das der Filter angewendet wird. Es ist null, wenn der Filter auf alle Pixel angewendet wird.

filterState
DomainFilterState

Zustand des Event-Filters.

DomainFilterState

Wert

PUBLISH

DROP

MIXED

EventTrafficSummary

FeldBeschreibung

id
ID

ID für EventTrafficSummary – immer EventTrafficSummary:incoming.

eventNamesCount
Int

Anzahl der empfangenen Event-Namen.

eventsCount
Int

Insgesamt empfangene Events.

ConversionsApiPublishSummary

FeldBeschreibung

id
ID

ID für ConversionsApiPublishSummary – immer ConversionsApiPublishSummary:global.

eventNamesCount
Int

Anzahl der gesendeten Event-Namen.

eventsCount
Int

Insgesamt gesendete Events.

publishSuccessRate
Gleitkommazahl

Erfolgsrate veröffentlichter Events.

EventActivity

FeldBeschreibung

id
ID

ID für EventActivity im Format – EventActivity:<event name>.

name
String

Event-Name

receivedCount
Int

Insgesamt empfangene Events.

publishedCount
Int

Insgesamt veröffentlichte Events.

lastUpdated
String

Zeitpunkt der letzten Aktualisierung.

DomainActivity

FeldBeschreibung

id
ID

Eindeutige ID für DomainActivity im Format – DomainActivity:<domain name>.

domainName
String

Domainname.

receivedCount
Int

Insgesamt empfangene Events.

publishedCount
Int

Insgesamt veröffentlichte Events.

TenantUsage

FeldBeschreibung

totalPixels
Int

Gesamt-Pixel im Konto.

totalActivePixels
Int

Gesamtzahl der aktiven Pixel im Konto.

totalInactivePixels
Int

Gesamtzahl der inaktiven Pixel im Konto.

tenantUsageByTraffic
TenantUsageByTraffic

Mandantennutzung nach Traffic.

pixelIds
String

Liste der verknüpften Pixel-IDs

TenantUsageByTraffic

FeldBeschreibung

totalEventsReceived
Long

Gesamtzahl der für einen Mandanten empfangenen Events für eine Dauer.

totalPixelsWithTraffic
Int

Gesamtzahl der Pixel mit Traffic für eine Dauer.

publishError
Boolescher Wert

Fehler beim Veröffentlichen in CAPI für eine Dauer.

durationInHours
Int

Die Dauer.

lastUpdatedAt
String

Zuletzt aktualisiert um.

Siehe auch