Reporting API Versi 2

Panduan ini menunjukkan cara menerapkan Audience Network Reporting API versi 2 (v2) untuk mendapatkan data kinerja bagi bisnis Anda.

Prasyarat

Rekomendasi

  • Karena banyaknya data yang ditampilkan di setiap kueri, penggunaan paginasi berbasis kursor direkomendasikan. Hasil paginasi diberikan segera untuk permintaan penyinkronan dan merupakan metode yang disukai untuk mengambil perincian.

Batasan

  • Semua data ditampilkan dalam zona waktu GMT
  • Metrik pendapatan ditampilkan berdasarkan jumlah impresi
    • Jika data tidak tersedia, kami merekomendasikan kueri total impresi dan pendapatan
  • Token akses pengguna yang dibuat di Pengelola Monetisasi atau Pengelola Bisnis tidak dapat digunakan

Pembaruan untuk Agregasi

Impresi dan Pendapatan Harian

Kueri impresi dan pendapatan untuk penempatan tanggal 1-4 Mei 2022 dengan perincian harian.

Yang mungkin berubah: Anda mungkin melihat bahwa beberapa data tidak tersedia setelah perubahan.

Poin pendapatan dan data CPM yang tidak tersedia karena jumlah impresi tidak mencukupi tidak akan disertakan dalam kolom results di tanggapan API. Sebagai gantinya, entri yang sesuai akan ditambahkan ke kolom omitted_results. Entri akan menyertakan kolom waktu, metrik, dan perincian, tetapi tidak akan menyertakan nilainya - silakan baca contoh tanggapan di bagian bawah halaman ini.

Sintaksis Permintaan

Gunakan endpoint GET ID > adnetworkanalytics untuk mendapatkan insight Audience Network bagi bisnis, properti, atau aplikasi.

GET /<ID>/adnetworkanalytics

Contoh Permintaan GET

Untuk mendapatkan insight, kirim permintaan GET ke endpoint /<ID>/adnetworkanalytics dengan daftar metrik yang dipisahkan koma dan daftar perincian opsional yang dipisahkan koma dengan <ID> adalah ID bisnis Meta Anda, ID properti, atau ID aplikasi Anda. Contoh berikut mendapatkan metrik selama periode 24 jam tunggal dan membatasi hasilnya menjadi 2 tanggapan per metrik.

Diformat agar mudah dibaca. Pastikan untuk mengganti nilai placeholder cetak tebal dan cetak miring dengan nilai Anda.
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

Contoh Tanggapan

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

Referensi

Parameter Kueri

ParameterDeskripsi

aggregation_period

aggregation_period=hour|day|total


Agregasi hasil berdasarkan day (default), hour, atau total. Batasan: Untuk mengumpulkan hasil per jam Anda harus meminta setidaknya 2 hari hasil menggunakan since dan until.

breakdowns

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


Permintaan sinkronisasi tidak memiliki batasan jumlah perincian yang dapat disertakan.

Jenis perincianDeskripsi

ad_space

Perincian berdasarkan ruang iklan

country

Perincian berdasarkan negara

delivery_method

Diperinci berdasarkan standard atau bidding saat metrik berasal dari iklan yang disajikan melalui tawaran Audience Network. Hanya tersedia untuk penerbit menggunakan Pengelola Monetisasi

fail_reason

Hanya tersedia untuk metrik fb_ad_network_no_fill dan fb_ad_network_no_bid.

placement

Perincian berdasarkan ID penempatan. Tidak dapat digunakan dengan placement_name.

placement_name

Perincian berdasarkan ID dan nama penempatan. Tidak dapat digunakan dengan placement.

platform

Perincian berdasarkan platform. ios, android, mobile_web, atau instant_games. Hanya tersedia untuk penerbit menggunakan Pengelola Monetisasi.

property

Perincian berdasarkan ID Properti

filters

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


Filter tanggapan lebih lanjut untuk mendapatkan hasil yang lebih spesifik. Pasangan kode:nilai field, operator, dan values diperlukan. values adalah daftar nilai yang dipisahkan koma. Saat ini hanya operator in yang didukung.

fieldvalues

country

Daftar yang dipisahkan koma dari dua huruf singkatan negara

placement

ID Penempatan. Batasan:REDACTED jika jumlah impresi tidak mencukupi.

delivery_method

standard atau bidding

platform

Dapat berupa ios (aplikasi seluler), android (aplikasi seluler), mobile_web, atau instant_games.

limit

limit=500


Jumlah baris yang akan ditampilkan. Batas: Permintaan sinkronisasi memiliki batas maksimum 2.000.

metrics

Wajib.


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


Setidaknya perlu satu metrik tetapi tidak ada batasan jumlah metrik yang dapat disertakan dalam permintaan.

ordering_column

ordering_column=time|value


Urutan berdasarkan hasil menurut waktu atau nilai. Default-nya time jika tidak disertakan.

ordering_type

ordering_column=ascending|descending


Default ke descending jika tidak disertakan.

since

since=YYYY-MM-DD atau since=1548880485


Batas mulai kueri. Default-nya 7 hari terakhir jika tidak disertakan.

Batasan:

  • Untuk menggunakan cap waktu Unix, Anda harus meng-kueri setidaknya 1 jam.
  • Anda hanya dapat meminta hingga 8 hari dalam permintaan sinkronisasi.
  • Data hanya disimpan selama 540 hari. Permintaan data di luar $currentDate - 539 days tidak akan memberikan data tambahan.

until

until=YYYY-MM-DD atau until=1548880485+86400


Batas akhir kueri

Metrik yang Tersedia

MetrikDeskripsi

fb_ad_network_bidding_bid_rate

Tingkat tanggapan tawaran

fb_ad_network_bidding_request

Jumlah permintaan penawaran

fb_ad_network_bidding_response

Jumlah tanggapan tawaran

fb_ad_network_bidding_win_rate

Tingkat lelang yang dimenangkan oleh penawar

fb_ad_network_click

Jumlah klik

fb_ad_network_cpm

CPM efektif (eCPM)

fb_ad_network_ctr

Estimasi klik tayang

fb_ad_network_fill_rate

Tingkat permintaan iklan yang diisi

fb_ad_network_filled_request

Jumlah permintaan iklan yang terisi

fb_ad_network_imp

Jumlah impresi

fb_ad_network_no_bid

Jumlah alasan tidak menawar teratas


Hanya tersedia bila digunakan sebagai fail_reason perincian metrik tunggal

fb_ad_network_no_fill

Jumlah alasan tidak mengisi teratas


Hanya tersedia bila digunakan sebagai fail_reason perincian metrik tunggal

fb_ad_network_request

Permintaan iklan

fb_ad_network_revenue

Estimasi pendapatan

fb_ad_network_show_rate

Impresi dibagi Isian

Pemecahan Masalah

Debugger Token Akses

Gunakan Debugger Token Akses untuk mendapatkan informasi mendetail untuk token akses, termasuk izin, validitas, akses properti, dan ID Aplikasi yang terkait dengan token.

Pesan Kesalahan

Pesan Kesalahan / MasalahResolusi

Token Kedaluwarsa

Demi pengalaman pengguna yang terbaik, gunakan Token Akses Berdurasi Lama

“Facebook has detected that [your app] isn't using a secure connection to transfer information error when using read_audience_network_insights scope."

Pastikan Bisnis Anda sudah menjalani onboarding di Pengelola Monetisasi dan Anda sudah membuat minimal satu properti.

"Reading insights of a Page, business, app, domain or event source group not owned by the querying user or application."

Tinjau Pengaturan Bisnis untuk memastikan bahwa Anda meminta data milik Bisnis yang Anda kueri.

"Unsupported GET request. Object with ID X does not exist, cannot be loaded due to missing permissions, or does not support this operation. Read the Graph API documentation."

Periksa properti untuk memastikan bahwa Anda meminta data untuk properti milik Anda sendiri.

"The way to access reporting API v2.0 has changed. You now need to implement Facebook Login for your app to access this API. See instructions here: https://developers.facebook.com/docs/facebook-login/"

Anda telah mencoba melakukan kueri Reporting API v2 dengan token Pengguna Sistem. Gunakan Facebook Login untuk melakukan kueri, atau kembali ke v1 (tetapi Anda harus menerapkan Facebook Login di waktu mendatang).

"Bad arg: All applications should have a property"

Pastikan Bisnis Anda telah menggunakan Pengelola Monetisasi dan Anda telah membuat setidaknya satu properti.

"Please reduce the amount of data you're asking for, then retry your request."

  • Jika Anda menggunakan periode agregasiday atau hour, atur nilai yang lebih rendah untuk parameter limit.
  • Jika Anda menggunakan periode agregasi total, kurangi durasi rentang tanggal yang ditentukan oleh parameter sejak/sampai.

"You can have at most 250 queries per minute"

Reporting API V2 memungkinkan permintaan dengan beberapa parameter dan penggunaan paginasi. Pelajari cara menggunakan lebih sedikit permintaan API jika memungkinkan.