API Báo cáo phiên bản 2

Tài liệu này hướng dẫn bạn cách triển khai API Báo cáo phiên bản 2 (v2) của Audience Network để lấy dữ liệu hiệu quả cho doanh nghiệp của mình.

Điều kiện tiên quyết

Đề xuất

  • Do lượng dữ liệu lớn được trả về trong mỗi truy vấn, bạn nên sử dụng phương thức phân trang dựa vào con trỏ . Hệ thống sẽ lập tức trả về kết quả được phân trang cho các yêu cầu đồng bộ. Đây cũng là phương thức ưu tiên để truy xuất số liệu chia nhỏ.

Giới hạn

  • Tất cả dữ liệu đều được trả về theo múi giờ GMT
  • Hệ thống trả về số liệu doanh thu dựa trên số lượt hiển thị
    • Nếu dữ liệu không có sẵn, bạn nên truy vấn tổng số lượt hiển thị và doanh thu
  • Bạn không thể sử dụng mã truy cập dành cho người dùng được tạo trong Trình quản lý kiếm tiền hoặc Trình quản lý kinh doanh

Thông tin mới cho phần tổng hợp

Lượt hiển thị và doanh thu hàng ngày

Truy vấn lượt hiển thị và doanh thu cho vị trí quảng cáo trong khoảng thời gian từ 01 - 04/05/2022 với số liệu chia nhỏ hàng ngày.

Điều gì có thể thay đổi: Bạn có thể thấy rằng một số dữ liệu không được cung cấp sau khi thay đổi.

Doanh thu và điểm dữ liệu CPM không có sẵn do số lượt hiển thị không đủ sẽ không được đưa vào trường results trong phản hồi API. Thay vào đó, các mục nhập tương ứng sẽ được thêm vào trường omitted_results. Các mục nhập này bao gồm trường thời gian, số liệu và số liệu chia nhỏ, nhưng sẽ không bao gồm giá trị. Vui lòng tham khảo phản hồi mẫu ở cuối trang này.

Cú pháp yêu cầu

Sử dụng điểm cuối GET ID > adnetworkanalytics để lấy thông tin chi tiết về Audience Network cho doanh nghiệp, tài sản hoặc ứng dụng.

GET /<ID>/adnetworkanalytics

Ví dụ về yêu cầu GET

Để lấy thông tin chi tiết, hãy gửi yêu cầu GET đến điểm cuối /<ID>/adnetworkanalytics kèm theo danh sách số liệu được phân tách bằng dấu phẩy và danh sách số liệu chia nhỏ được phân tách bằng dấu phẩy (không bắt buộc), trong đó <ID> là ID doanh nghiệp của bạn trên Meta, ID tài sản hoặc ID ứng dụng. Ví dụ sau lấy số liệu trong một khoảng thời gian 24 giờ và giới hạn kết quả ở 2 phản hồi cho mỗi số liệu.

Được định dạng để dễ đọc. Hãy nhớ thay thế các giá trị phần giữ chỗ in đậm hoặc in nghiêng bằng giá trị của bạn.
curl -X GET https://graph.facebook.com/v19.0/BUSINESS_ID/adnetworkanalytics
  ?metrics=["fb_ad_network_request","fb_ad_network_imp","fb_ad_network_click","fb_ad_network_revenue"]
  &breakdowns=["placement","country"]
  &since=2021-08-06
  &until=2021-08-06
  &limit=2

Phản hồi mẫu

{
  "data": [
    {
      "query_id": "531234567890123456789012345683d6",
      "results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1200"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_imp",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ],
          "value": "35"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "21.212345"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AD"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_request",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "12"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AE"
            }
          ],
          "value": "1"
        },
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_click",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "CA"
            }
          ],
          "value": "2"
        }
      ],
      "omitted_results": [
        {
          "time": "2021-08-06T07:00:00+0000",
          "metric": "fb_ad_network_revenue",
          "breakdowns": [
            {
              "key": "placement",
              "value": "123456789012345"
            },
            {
              "key": "country",
              "value": "AU"
            }
          ]
        }
      ]
    }
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MQZDZD"
    },
    "next": "https://graph.facebook.com/v10.0/142440604406900/adnetworkanalytics?access_token=<ACCESS_TOKEN>&since=2021-08-06&until=2021-08-06&breakdowns=%5B%22placement%22%2C%22country%22%5D&limit=2&metrics=%5B%22fb_ad_network_request%22%2C%22fb_ad_network_imp%22%2C%22fb_ad_network_click%22%2C%22fb_ad_network_revenue%22%5D&after=MQZDZD"
  }
}

Tài liệu tham khảo

Thông số truy vấn

Thông sốMô tả

aggregation_period

aggregation_period=hour|day|total


Tổng hợp kết quả theo day (mặc định), hour hoặc total. Giới hạn: Để tổng hợp kết quả theo giờ, bạn phải truy vấn kết quả trong tối thiểu 2 ngày bằng thông số sinceuntil.

breakdowns

breakdowns=['breakdown_1', 'breakdown_2',...]


Yêu cầu đồng bộ không giới hạn lượng số liệu chia nhỏ có thể thêm.

Loại số liệu chia nhỏMô tả

ad_space

Số liệu chia nhỏ theo không gian quảng cáo

country

Số liệu chia nhỏ theo quốc gia

delivery_method

Số liệu chia nhỏ theo standard hoặc bidding khi số liệu có nguồn gốc từ quảng cáo được phân phối qua phương thức đặt giá thầu trên Audience Network. Chỉ có sẵn cho nhà phát hành sử dụng Trình quản lý kiếm tiền.

fail_reason

Chỉ có sẵn cho số liệu fb_ad_network_no_fillfb_ad_network_no_bid.

placement

Số liệu chia nhỏ theo ID vị trí quảng cáo. Không thể sử dụng với placement_name.

placement_name

Số liệu chia nhỏ theo ID và tên vị trí quảng cáo. Không thể sử dụng với placement.

platform

Số liệu chia nhỏ theo nền tảng. ios, android, mobile_web hoặc instant_games. Chỉ có sẵn cho nhà phát hành sử dụng Trình quản lý kiếm tiền.

property

Số liệu chia nhỏ theo ID tài sản

filters

filters=[{'field':'country', 'operator':'in', 'values':['US', 'JP']}]


Lọc thêm phản hồi để có kết quả cụ thể hơn nữa. Bắt buộc phải có các cặp khóa:giá trị field, operatorvalues. values là danh sách giá trị được phân tách bằng dấu phẩy. Hiện chỉ hỗ trợ toán tử in.

fieldvalues

country

Danh sách chữ viết tắt tên quốc gia gồm hai chữ cái được phân tách bằng dấu phẩy

placement

ID vị trí quảng cáo. Giới hạn:REDACTED nếu không có đủ số lượt hiển thị.

delivery_method

standard hoặc bidding

platform

Có thể là ios (ứng dụng di động), android (ứng dụng di động), mobile_web hoặc instant_games.

limit

limit=500


Số hàng sẽ trả về. Giới hạn: Các yêu cầu đồng bộ có giới hạn tối đa là 2.000 hàng.

metrics

Bắt buộc.


metrics=['metric_1', 'metric_2',...]


Bắt buộc phải có ít nhất một số liệu. Tuy nhiên, không giới hạn số lượng số liệu trong một yêu cầu.

ordering_column

ordering_column=time|value


Sắp xếp kết quả theo thời gian hoặc giá trị. Mặc định là time nếu không được thêm.

ordering_type

ordering_column=ascending|descending


Mặc định là descending nếu không được thêm.

since

since=YYYY-MM-DD hoặc since=1548880485


Giới hạn bắt đầu của truy vấn. Mặc định là 7 ngày qua nếu không được thêm.

Giới hạn:

  • Để sử dụng nhãn thời gian Unix, bạn phải truy vấn ít nhất 1 giờ.
  • Bạn chỉ được yêu cầu tối đa 8 ngày trong yêu cầu đồng bộ.
  • Hệ thống chỉ lưu giữ dữ liệu trong 540 ngày. Yêu cầu dữ liệu vượt quá $currentDate - 539 days sẽ không trả về dữ liệu bổ sung.

until

until=YYYY-MM-DD hoặc until=1548880485+86400


Giới hạn kết thúc của truy vấn

Số liệu có sẵn

Số liệuMô tả

fb_ad_network_bidding_bid_rate

Tỷ lệ phản hồi về giá thầu

fb_ad_network_bidding_request

Số lượng yêu cầu giá thầu

fb_ad_network_bidding_response

Số lượng phản hồi về giá thầu

fb_ad_network_bidding_win_rate

Tỷ lệ thắng thầu theo người đấu giá

fb_ad_network_click

Số lượt click

fb_ad_network_cpm

CPM hiệu quả (eCPM)

fb_ad_network_ctr

Tỷ lệ click ước tính

fb_ad_network_fill_rate

Tỷ lệ yêu cầu quảng cáo được thực hiện

fb_ad_network_filled_request

Số yêu cầu quảng cáo được thực hiện

fb_ad_network_imp

Số lượt hiển thị

fb_ad_network_no_bid

Số lượng lý do phổ biến cho việc không đặt giá thầu


Chỉ áp dụng khi được sử dụng như số liệu chia nhỏ riêng fail_reason cho số liệu

fb_ad_network_no_fill

Số lượng lý do phổ biến cho việc không điền


Chỉ áp dụng khi được sử dụng như số liệu chia nhỏ riêng fail_reason cho số liệu

fb_ad_network_request

Yêu cầu quảng cáo

fb_ad_network_revenue

Doanh thu ước tính

fb_ad_network_show_rate

Số lượt hiển thị chia cho tỷ lệ thực hiện

Khắc phục sự cố

Trình gỡ lỗi mã truy cập

Sử dụng Trình gỡ lỗi mã truy cập để lấy thông tin chi tiết về mã truy cập, bao gồm các quyền, tính hiệu lực, quyền truy cập vào tài sản và ID ứng dụng được liên kết với mã đó.

Thông báo lỗi

Thông báo lỗi/Sự cốGiải pháp

Mã hết hạn

Để có trải nghiệm người dùng tốt nhất, hãy sử dụng Mã truy cập dài hạn

"Facebook đã phát hiện [ứng dụng của bạn] không dùng kết nối bảo mật để chuyển lỗi thông tin khi sử dụng phạm vi read_audience_network_insights."

Đảm bảo Doanh nghiệp bạn đã được tích hợp vào Trình quản lý kiếm tiền và bạn đã tạo ít nhất một tài sản.

"Đang đọc thông tin chi tiết về Trang, doanh nghiệp, ứng dụng, miền hoặc nhóm nguồn sự kiện không thuộc sở hữu của người dùng hoặc ứng dụng thực hiện truy vấn."

Xem lại Cài đặt cho doanh nghiệp để đảm bảo rằng bạn đang yêu cầu dữ liệu thuộc sở hữu của Doanh nghiệp mà bạn đang truy vấn.

"Yêu cầu GET không được hỗ trợ. Đối tượng có ID X không tồn tại, không tải được do thiếu quyền hoặc không hỗ trợ thao tác này. Hãy đọc Tài liệu về API Đồ thị."

Xem lại tài sản để đảm bảo rằng bạn đang yêu cầu dữ liệu cho tài sản mà bạn sở hữu.

"Cách truy cập API báo cáo v2.0 đã thay đổi. Giờ đây, bạn cần triển khai phương thức Đăng nhập bằng Facebook cho ứng dụng của mình thì mới truy cập được API này. Hãy xem hướng dẫn tại đây: https://developers.facebook.com/docs/facebook-login/"

Bạn đã cố truy vấn API Báo cáo v2 bằng mã Người dùng hệ thống. Hãy sử dụng phương thức Đăng nhập bằng Facebook để truy vấn hoặc chuyển về v1 (nhưng trong tương lai, bạn vẫn cần triển khai phương thức Đăng nhập bằng Facebook).

"Sai đối số: Tất cả ứng dụng đều phải có tài sản"

Đảm bảo Doanh nghiệp bạn đã được tích hợp vào Trình quản lý kiếm tiền và bạn đã tạo ít nhất một tài sản.

"Vui lòng giảm lượng dữ liệu bạn đang yêu cầu, sau đó thử yêu cầu lại."

  • Nếu bạn chọn khoảng thời gian tổng hợpday hoặc hour, hãy đặt giá trị thấp hơn cho thông số giới hạn.
  • Nếu bạn sử dụng khoảng thời gian tổng hợp là total, hãy giảm khoảng ngày đã chỉ định bằng thông số từ/đến.

"Bạn có thể thực hiện tối đa 250 truy vấn mỗi phút"

API Báo cáo v2 cho phép yêu cầu có nhiều thông số và sử dụng tính năng phân trang. Hãy tìm hiểu cách hạn chế sử dụng yêu cầu API khi có thể.