Leitfäden

Conversions API Gateway for Multiple Accounts Control Plane API: Hinweise

Kontoverwaltung

Konto erstellen

Erstellt ein Gateway für mehrere Konten, die von einem Partner oder Werbetreibenden je nach Input verwaltet werden können.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
mutation CreateTenantMutation(
        $input: CreateTenantInput!
      ) {
        tenantMutations {
          createTenant(input: $input) {
            tenant {
              id
              name
              status
              canPartnerManage
              users {
                id
                email
                roles {
                    name
                    displayName
                }
                tenants {
                    id
                    name
                    status
                    canPartnerManage
                    availableRoles {
                        name
                        displayName
                    }
                }
                isSelf
                canBeDeleted
                defaultTenantId
              }
              availableRoles {
                name
                displayName
              }
              tenantUsage {
                  totalActivePixels
                  totalInactivePixels
                  totalPixels
                  tenantUsageByTraffic {
                    totalEventsReceived
                    totalPixelsWithTraffic
                    publishError
                    durationInHours,
                    lastUpdatedAt
                 }
              }
              canEditTenantSettingsInUI
              canViewTenantInUI
              canEditTenantSettingsInUI
            }
          }
        }
      }
 _________________________________________________________________________________________________________    
input CreateTenantInput {
    name: String!
    canPartnerManage: Boolean!
    adminEmail: String
    eventEnrichment: Boolean!
}

Felder

CreateTenantInput

FeldBeschreibung

name
String

Erforderlich

Name des Kontos

canPartnerManage
Boolescher Wert

Erforderlich
Boolescher Wert, der angibt, ob ein Partner dieses Konto verwalten kann

adminEmail
String

Optional
E-Mail-Adresse des*der Administrator*in (dies ist erforderlich, wenn canPartnerManage „false“ ist)

eventEnrichment
Boolescher Wert

Erforderlich
Events mit erweiterten Abgleichsdaten verbessern


Rückgabe

CreateTenantResult

FeldBeschreibung

tenant
Mandant

Neu erstellter Mandant


Fehlercodes

CodeBeschreibung

400

Ungültiger Input bereitgestellt

401

Nicht zur Kontoerstellung autorisiert

500

Interner Serverfehler


Beispielanfrage

Mutation

 mutation CreateTenantMutation(
        $input: CreateTenantInput!
      ) {
        tenantMutations {
          createTenant(input: $input) {
            tenant {
              id
              name
              status
              canPartnerManage
            }
          }
        }
      }

Variablen

{
   "input": {
       "name": "TestAdvertiserViaAPI",
       "canPartnerManage": true,
       "eventEnrichment": true
       }
}

Beispielantwort

{
   "data": {
       "tenantMutations": {
           "createTenant": {
               "tenant": {
                   "id": "hU2koC34",
                   "name": "TestAdvertiserViaAPI",
                   "status": 0,
                   "canPartnerManage": true
               }
           }
       }
   }
}

Konto löschen

Löscht das Konto eines Werbetreibenden.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
    mutation DeleteTenant($tenantId: String!) {
      tenantMutations {
        deleteTenant(tenantId: $tenantId)
      }
    }

 _________________________________________________________________________________________________________    
tenantId: String!

Felder

FeldBeschreibung

tenantId
String

Erforderlich

Eindeutige ID des zu löschenden Kontos.


Rückgabe

Boolescher Wert

Gibt an, ob Mandant erfolgreich gelöscht wurde.


Fehlercodes

CodeBeschreibung

400

Ungültiger Input bereitgestellt

401

Nicht zur Kontolöschung autorisiert

500

Interner Serverfehler


Beispielanfrage

Mutation

 mutation DeleteTenant($tenantId: String!) {
   tenantMutations {
   deleteTenant(tenantId: $tenantId)
   }
}

Variablen

{
   "tenantId": "Tse53QtW"
}

Beispielantwort

{
   "data": {
       "tenantMutations": {
           "deleteTenant": true
       }
   }
}

Konto aktualisieren

Aktualisiert das Konto mit einem neuen Namen, Status und Berechtigung für den Partner, um das Konto zu verwalten.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
 mutation TenantEditNameModalMutation(
  $input: UpdateTenantInput!
) {
  tenantMutations {
    updateTenant(input: $input) {
        tenant {
            id
            name
            status
            canPartnerManage
            users {
                id
                email
                roles {
                    name
                    displayName
                }
                tenants {
                    id
                    name
                    status
                    canPartnerManage
                    availableRoles {
                        name
                        displayName
                    }
                }
                isSelf
                canBeDeleted
                defaultTenantId
            }
            availableRoles {
                name
                displayName
            }
            tenantUsage {
                totalActivePixels
                totalInactivePixels
                totalPixels
                tenantUsageByTraffic {
                   totalEventsReceived
                   totalPixelsWithTraffic
                   publishError
                   durationInHours,
                   lastUpdatedAt
               }
            }
            canEditTenantSettingsInUI
            canViewTenantInUI
            canEditTenantSettingsInUI
        }
    }
  }
}
      
_________________________________________________________________________________________________________    
input UpdateTenantInput {
    tenantId: String!
    name: String
    status: Int
    canPartnerManage: Boolean
}

Felder

UpdateTenantInput

FeldBeschreibung

tenantId
String

Erforderlich

Eindeutige ID des Kontos

name
String

Optional

Name des Kontos

status
Int

Optional

Kontostatus (auf Mandantenobjekt verweisen)

canPartnerManage
Boolescher Wert

Optional

Gibt an, ob der Partner dieses Konto verwaltet


Rückgabe

TenantMutationResponse

FeldBeschreibung

tenant
Mandant

Aktualisierter Mandant


Fehlercodes

CodeBeschreibung

400

Ungültiger Input bereitgestellt

401

Nicht zur Aktualisierung des Mandanten autorisiert

500

Interner Serverfehler


Beispielanfrage

Mutation

mutation TenantEditNameModalMutation(
 $input: UpdateTenantInput!
) {
 tenantMutations {
   updateTenant(input: $input) {
     tenant {
       id
       name
       status
       canPartnerManage
     }
   }
 }
}

Variablen

{
   "input":{
       "tenantId":"IaoreXfj",
       "name":"Test Account Name Update",
       "status":0,
       "canPartnerManage":true
   }
}

Beispielantwort

{
   "data": {
       "tenantMutations": {
           "updateTenant": {
               "tenant": {
                   "id": "IaoreXfj",
                   "name": "Test Account Name Update",
                   "status": 0,
                   "canPartnerManage": true
               }
           }
       }
   }
}

Konto abrufen

Ruft das Werbekonto ab, das einer eingegebenen eindeutigen ID entspricht.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
query TenantAccountUsersViewQuery(
  $tenantId: String!
) {
  tenant(tenantId: $tenantId)  {
        id
        name
        status
        canPartnerManage
        users {
            id
            email
            roles {
                name
                displayName
            }
            tenants {
                id
                name
                status
                canPartnerManage
                availableRoles {
                    name
                    displayName
                }
            }
            isSelf
            canBeDeleted
            defaultTenantId
        }
        availableRoles {
            name
            displayName
        }
        tenantUsage {
            totalActivePixels
            totalInactivePixels
            totalPixels
            tenantUsageByTraffic {
               totalEventsReceived
               totalPixelsWithTraffic
               publishError
               durationInHours,
               lastUpdatedAt
            }
        }
        canEditTenantSettingsInUI
        canViewTenantInUI
        canEditTenantSettingsInUI
    }
}
_________________________________________________________________________________________________________    
tenantId: String!

Felder

FeldBeschreibung

tenantId
String

Erforderlich

Eindeutige ID des Kontos, das abgerufen werden soll


Rückgabe

FeldBeschreibung

tenant
Mandant

Kontodetails werden abgerufen


Fehlercodes

CodeBeschreibung

401

Nicht zur Anzeige des Kontos autorisiert

500

Interner Serverfehler


Beispielanfrage

Abfrage

query TenantAccountUsersViewQuery(
 $tenantId: String!
) {
 tenant(tenantId: $tenantId) {
   id
   name
   users {
     id
     email
     roles {
         name
         displayName
     }
   }
 }
}

Variablen

{
   "tenantId":"wW58k7FQ"
}

Beispielantwort

{
   "data": {
       "tenant": {
           "id": "wW58k7FQ",
           "name": "Test Account",
           "users": [
               {
                   "id": "992bc489-a799-4374-8933-0109eed60e3d",
                   "email": "tempuser@test.com",
                   "roles": [
                       {
                           "name": "advertiser-manage-wW58k7FQ",
                           "displayName": "manage"
                       }
                   ]
               }
           ]
       }
   }
}

Kontoverwendung

Ruf die Kontoverwendung in Bezug auf aktive und inaktive Pixel ab, die einer eindeutigen ID für das Konto entsprechen. Außerdem werden Traffic-Nutzungsstatistiken für eine Dauer zurückgegeben.

Schema

POST https://{capig_domain}/hub/graphql/ 
_________________________________________________________________________________________________________________
      
query TenantUsageQuery(
  $tenantId: String!
) {
    tenantUsage(tenantId: $tenantId) {
        totalActivePixels
        totalInactivePixels
        totalPixels
        tenantUsageByTraffic {
           totalEventsReceived
           totalPixelsWithTraffic
           publishError
           durationInHours,
           lastUpdatedAt
       }
    }
}

_________________________________________________________________________________________________________    
tenantId: String!

Felder

FeldBeschreibung

tenantId
String

Erforderlich

Eindeutige ID des Kontos


Rückgabe

FeldBeschreibung

TenantUsage
TenantUsage

TenantUsage


Fehlercodes

CodeBeschreibung

401

Nicht zur Anzeige der Kontonutzung autorisiert

500

Interner Serverfehler


Beispielanfrage

Abfrage

query {
   tenantUsage(tenantId: "IaoreXfj"){
       totalActivePixels
       totalInactivePixels
       totalPixels
   }
}

Beispielantwort

{
   "data": {
       "tenantUsage": {
           "totalActivePixels": 3,
           "totalInactivePixels": 1,
           "totalPixels": 4
       }
   }
}

Siehe auch