API مستوى التحكم في بوابة واجهة API التحويلات للحسابات المتعددة: المرجع

إدارة البيكسل

إنشاء اتصال بيكسل

تأهيل بيكسل Meta جديد في بوابة واجهة API التحويلات.

المخطط

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
}      
     

الحقول

PixelConnectionCreationInput

القيم التي يتم إرجاعها

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

حذف اتصال البيكسل

حذف بيكسل موجود من البوابة.

المخطط

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

الحقول

القيم التي يتم إرجاعها

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

تنشيط/إلغاء تنشيط البوابة من استقبال أحداث البيكسل

تغيير حالة استلام حدث بيكسل الخاص بالبوابة.

المخطط

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

الحقول

SignalConfigStatusInput

القيم التي يتم إرجاعها

UpdateSignalConfigStatusPayload

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

تنشيط/إلغاء تنشيط حالة نشر حدث البيكسل

تغيير حالة نشر حدث البيكسل. إذا تم إلغاء التنشيط، فستتجاهل البوابة الأحداث المستلمة ولن تنشرها على Meta.

المخطط

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

الحقول

SignalConfigStatusInput

القيم التي يتم إرجاعها

UpdateSignalConfigStatusPayload

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

تنشيط/إلغاء تنشيط حالة نشر حدث البيكسل حسب اسم الحدث

تغيير حالة نشر حدث البيكسل حسب اسم الحدث ومعرف البيكسل. إذا تم إلغاء التنشيط، فستتجاهل البوابة هذه الأحداث ولن تنشرها على Meta.

المخطط

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

الحقول

UpdateEventFilterInput

القيم التي يتم إرجاعها

UpdateEventFilterResult

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

حظر/إلغاء حظر مواقع الويب المسموح لها باستقبال الأحداث ونشرها

يحظر تلقي الأحداث من مواقع ويب معينة.

المخطط

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

الحقول

UpdateDomainFilterInput

القيم التي يتم إرجاعها

UpdateDomainFilterResult

رموز الأخطاء

عينة من الطلب

التغير

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

المتغيرات

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

عينة من الاستجابة

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

راجع أيضًا

• API مستوى التحكم في بوابة واجهة API التحويلات للحسابات المتعددة
• API مستوى التحكم: المرجع
• مرجع API مستوى التحكم: إدارة الحساب
• مرجع API مستوى التحكم: إدارة المستخدمين
• مرجع API مستوى التحكم: تكوين توجيه بيانات الحساب
• مرجع API مستوى التحكم: أدوات قياس أحداث الحساب
• مرجع API مستوى التحكم: الكائنات