Hướng dẫn

API Tầng điều khiển của Cổng API Chuyển đổi cho nhiều tài khoản: Tài liệu tham khảo

Quản lý Pixel

Tạo kết nối Pixel

Tích hợp Meta Pixel mới vào Cổng API Chuyển đổi.

Lược đồ

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
}

Trường

TrườngMô tả

tenantId
ID

Bắt buộc

Thông tin nhận dạng duy nhất của tài khoản

PixelConnectionCreationInput

TrườngMô tả

businessId
String

Bắt buộc

ID doanh nghiệp của tài khoản

pixelId
String

Bắt buộc

ID Pixel cần tích hợp

accessToken
String

Bắt buộc

Mã truy cập từ quá trình thiết lập MBE hoặc được tạo thủ công trong Trình quản lý sự kiện

apiVersion
String

Không bắt buộc

Phiên bản API mới nhất của API Đồ thị

externalId
String

Bắt buộc

Trường này phải giống như external_business_id trong đối tượng thiết lập

name
String

Không bắt buộc

Tên Pixel


Giá trị trả về

TrườngMô tả

signalConfig
SignalConfig

Cấu hình Pixel


Mã lỗi

MãMô tả

400

Đầu vào được cung cấp không hợp lệ

401

Người dùng không được phép thiết lập cấu hình Pixel

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Xóa kết nối Pixel

Xóa Pixel hiện có khỏi Cổng.

Lược đồ

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

Trường

TrườngMô tả

id
ID

Bắt buộc

ID Pixel

tenantId
ID

Bắt buộc
Thông tin nhận dạng duy nhất của tài khoản


Giá trị trả về

TrườngMô tả

Boolean

Cho biết liệu đã xóa Pixel thành công hay chưa


Mã lỗi

MãMô tả

401

Người dùng không được phép gỡ cấu hình Pixel.

404

Không tìm thấy Pixel.

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Kích hoạt/vô hiệu hóa trạng thái nhận sự kiện Pixel của Cổng

Thay đổi trạng thái nhận sự kiện Pixel của Cổng.

Lược đồ

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

Trường

TrườngMô tả

id
ID

Bắt buộc

ID Pixel cần đặt cấu hình

tenantId
ID

Bắt buộc
Thông tin nhận dạng duy nhất của tài khoản


SignalConfigStatusInput

TrườngMô tả

status
Int

Bắt buộc


Giá trịMô tả

0

Vô hiệu hóa

1

Kích hoạt


Giá trị trả về

UpdateSignalConfigStatusPayload

TrườngMô tả

success
Boolean

Cho biết liệu thao tác trên Pixel có thành công hay không

connectionStatus
ConnectionStatus

Cấu hình kết nối Pixel


Mã lỗi

MãMô tả

401

Không được phép thực hiện hành động trên Pixel

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Kích hoạt/vô hiệu hóa trạng thái đăng sự kiện Pixel

Thay đổi trạng thái đăng sự kiện của Pixel. Nếu bị vô hiệu hóa, Cổng sẽ bỏ và không đăng các sự kiện đã nhận được lên Meta.

Lược đồ

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

Trường

TrườngMô tả

id
ID

Bắt buộc

ID Pixel cần đặt cấu hình

tenantId
ID

Bắt buộc
Thông tin nhận dạng duy nhất của tài khoản


SignalConfigStatusInput

TrườngMô tả

status
Int

Bắt buộc


Giá trịMô tả

0

Vô hiệu hóa

1

Kích hoạt


Giá trị trả về

UpdateSignalConfigStatusPayload

TrườngMô tả

success
Boolean

Cho biết liệu thao tác trên Pixel có thành công hay không

connectionStatus
ConnectionStatus

Cấu hình kết nối Pixel


Mã lỗi

MãMô tả

401

Không được phép thực hiện hành động trên Pixel

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Kích hoạt/vô hiệu hóa trạng thái đăng sự kiện Pixel theo tên sự kiện

Thay đổi trạng thái đăng sự kiện của Pixel theo tên sự kiện và ID Pixel. Nếu bị vô hiệu hóa, Cổng sẽ bỏ và không đăng những sự kiện này lên Meta.

Lược đồ

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

Trường

TrườngMô tả

tenantId
ID

Bắt buộc
Thông tin nhận dạng duy nhất của tài khoản


UpdateEventFilterInput

TrườngMô tả

eventName
String

Bắt buộc

Tên sự kiện cần lọc

pixelIds
String

Không bắt buộc

Danh sách các ID Pixel cần áp dụng bô lọc. Nếu bạn không cung cấp giá trị, hệ thống sẽ cập nhật tất cả Pixel của tài khoản

filterState
EventFilterState

Bắt buộc

Trạng thái của bộ lọc


Giá trị trả về

UpdateEventFilterResult

TrườngMô tả

updatedFilter
EventFilter

Bộ lọc sự kiện đã cập nhật


Mã lỗi

MãMô tả

401

Không được phép cập nhật bộ lọc sự kiện

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Chặn/bỏ chặn các trang web được phép nhận và đăng sự kiện

Chặn nhận sự kiện từ trang web cụ thể.

Lược đồ

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

Trường

TrườngMô tả

tenantId
ID

Bắt buộc
Thông tin nhận dạng duy nhất của tài khoản


UpdateDomainFilterInput

TrườngMô tả

domain
String

Bắt buộc

Tên miền cần lọc


Định dạng phải là example.com

pixelIds
String

Không bắt buộc

Danh sách các ID Pixel cần áp dụng bộ lọc

filterState
DomainFilterState

Bắt buộc

Trạng thái của bộ lọc


Giá trị trả về

UpdateDomainFilterResult

TrườngMô tả

updatedFilter
DomainFilter

Đối tượng bộ lọc miền


Mã lỗi

MãMô tả

401

Không được phép cập nhật bộ lọc miền

500

Lỗi máy chủ nội bộ


Yêu cầu mẫu

Đột biến

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

Biến

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

Phản hồi mẫu

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

Xem thêm