Danh sách chiến dịch

• Lấy danh sách chiến dịch gửi tin Facebook Marketing Message

Request

curl --location 'https://vpage.open.nhanh.vn/v3.0/marketing/fmmcampaignlist?appId={{appId}}&businessId={{businessId}}' \
--header 'Authorization: {{accessToken}}' \
--data '{
    "filters": { },
    "paginator": {
        "size": 50
    }
}'

Tham số bộ lọc (filters)

Tất cả các trường dưới đây được truyền bên trong object "filters": { ... } của body request:

Tên trường lọc	Kiểu dữ liệu	Mặc định	Mô tả chi tiết chức năng lọc
id	String	null	Lọc theo ID chiến dịch Vpage
adCampaignId	String	null	Lọc theo ID chiến dịch Facebook (Meta Campaign ID)
adAccountId	String	null	Lọc theo tài khoản quảng cáo Facebook
pageIds	Array	null	Lọc theo danh sách Fanpage
name	String	null	Lọc tìm kiếm theo tên chiến dịch
status	Integer	null	Lọc theo trạng thái chiến dịch
syncFb	Boolean	false	Cờ đồng bộ dữ liệu trực tiếp từ Facebook: • false (mặc định): Đọc từ cache hệ thống (tốc độ cao < 200ms). • true: Gọi trực tiếp Meta Insights API để lấy số liệu mới nhất thời gian thực. Thời gian phản hồi có thể mất từ 3 - 5 giây
fromAt	Integer	null	Thời gian bắt đầu lấy số liệu thống kê • Unix timestamp (ví dụ 1761411600)
toAt	Integer	null	Thời gian kết thúc lấy số liệu thống kê • Unix timestamp (ví dụ 1761929999)

Lưu ý về cơ chế Cache & Độ trễ khi dùng syncFb

• Mặc định syncFb: false:

  • Dữ liệu thống kê (delivered, clicks, reads, spend, costPerDelivered,...) được đọc trực tiếp từ dữ liệu đã đồng bộ định kỳ trước đó.

  • Tốc độ phản hồi: nhanh

  • Đặc điểm: Số liệu có thể có độ trễ nhất định so với bảng điều khiển Meta Ads Manager (dữ liệu cache).

• Khi bật syncFb: true:

  • Hệ thống sẽ gửi request trực tiếp sang Facebook Insights để lấy dữ liệu realtime mới nhất. Thời gian phản hồi có thể mất từ 3 - 5 giây.

  • Cho phép kết hợp thêm fromAt và toAt để lọc số liệu theo thời gian cụ thể.

  • Tự động lưu vào Vpage: Toàn bộ số liệu Insight mới nhất kéo từ Meta (delivered, reads, clicks, spend, lastSyncAt) sẽ được tự động cập nhật vào chiến dịch. Nhờ đó các lần gọi sau (kể cả khi tắt syncFb - đọc từ cache) đều có ngay dữ liệu mới nhất này.

Response

• Xem cấu trúc chung tại đây.

Failed response

• Xem các mã lỗi chung tại đây.

Successful response

{
  "code": 1,
  "paginator": {
    "next": [
      1742545330
    ]
  },
  "data": [
    {
      "id": "ngVCD5oBMexIgwsbAZBW",
      "segmentIds": [
        "p7kJ_JkBLGB-hS0t3fuy",
        "120234366614800373"
      ],
      "name": "fmm message",
      "adAccountId": "act_962587495564547",
      "adCampaignId": "120232711406030373",
      "pageId": "167890463074771",
      "pageName": "Nhanh.vn Fanpage",
      "status": 1,
      "budgetType": "daily",
      "budget": 60000,
      "adStartAt": 1761411600,
      "adEndAt": 1761929999,
      "createdAt": 1761192575,
      "sentSuccess": 450,
      "delivered": 437,
      "clicks": 15,
      "reads": 120,
      "spend": 129599,
      "costPerDelivered": 297,
      "costPerRead": 1080,
      "costPerClick": 8640
    },
    {
      "id": "ngVCD5oBMexIgwsbAZBW",
      "segmentIds": [
        "120234366614800371"
      ],
      "name": "fmm notifications",
      "adAccountId": "act_962587495564547",
      "adCampaignId": "120232711406030373",
      "pageId": "167890463074771",
      "pageName": "Nhanh.vn Fanpage",
      "status": 1,
      "budgetType": "life_time",
      "budget": 100000,
      "adStartAt": 1761411600,
      "adEndAt": 1761929999,
      "createdAt": 1761192575,
      "sentSuccess": 200,
      "delivered": 195,
      "clicks": 8,
      "reads": 55,
      "spend": 50000,
      "costPerDelivered": 256,
      "costPerRead": 909,
      "costPerClick": 6250
    }
  ]
}

Chi tiết các trường dữ liệu trả về (data)

Trường	Kiểu dữ liệu	Mô tả
id	String	ID chiến dịch lưu trên Vpage
segmentIds	Array	Danh sách ID tệp đối tượng gửi tin
name	String	Tên chiến dịch
pageId	String	ID Fanpage gửi tin
pageName	String	Tên Fanpage gửi tin
adAccountId	String	ID tài khoản quảng cáo Facebook
adCampaignId	String	ID chiến dịch trên Facebook
status	Integer	Trạng thái chiến dịch (xem bảng Status bên dưới)
budgetType	String	Loại ngân sách: daily (mỗi ngày) hoặc life_time (toàn chiến dịch)
budget	Float	Ngân sách chiến dịch
adStartAt	Integer	Unix timestamp thời gian bắt đầu chạy chiến dịch
adEndAt	Integer	Unix timestamp thời gian kết thúc chiến dịch
createdAt	Integer	Unix timestamp thời gian tạo chiến dịch
sentSuccess	Integer	Số tin Vpage gửi thành công lên Meta
delivered	Integer	Số tin Meta đã gửi thành công đến khách hàng
clicks	Integer	Số lượt bấm link/nút trong tin nhắn
reads	Integer	Số lượt khách hàng đã đọc tin nhắn
spend	Float	Tổng số tiền đã chi tiêu theo báo cáo Meta
costPerDelivered	Integer	Giá 1 tin nhắn gửi thành công (spend / delivered)
costPerRead	Integer	Giá 1 lượt xem (đọc) tin nhắn (spend / reads)
costPerClick	Integer	Giá 1 lượt click link/nút trong tin nhắn (spend / clicks)

status

Value	Description
1	Đã gửi
2	Đang gửi
3	Mới
4	Thất bại
5	Chờ gửi
6	Không hoạt động
7	Nháp