App Events API

Kami tidak lagi merekomendasikan App Events API untuk integrasi baru. Conversions API sekarang mendukung web, aplikasi, dan peristiwa offline, jadi kami merekomendasikan agar para pengiklan menggunakan Conversions API dan bukan App Events API. Pengguna App Events API yang ada dapat terus menggunakannya, tetapi kami akan menghentikan pengembangan API ini. Inovasi ke depannya akan dikembangkan pada Conversions API. Pelajari selengkapnya tentang Conversions API untuk Peristiwa Aplikasi.


Peristiwa Aplikasi memungkinkan Anda melacak tindakan yang terjadi di aplikasi seluler atau halaman web Anda seperti penginstalan aplikasi dan peristiwa pembelian. Dengan melacak peristiwa-peristiwa ini, Anda dapat mengukur kinerja iklan dan membangun pemirsa untuk penargetan iklan.

Untuk informasi tentang melacak Peristiwa Aplikasi untuk Berkirim Pesan Bisnis, lihat App Events API untuk Berkirim Pesan Bisnis di Dokumentasi Platform Messenger.

Cara Kerjanya

Ada tiga jenis Peristiwa Aplikasi:

  • Peristiwa yang Dicatat Otomatis - Facebook SDK secara otomatis mencatat penginstalan aplikasi, sesi aplikasi, dan pembelian dalam-aplikasi.
  • Peristiwa Standar - Peristiwa populer yang dibuat Facebook untuk Anda.
  • Peristiwa Khusus - Peristiwa yang Anda buat spesifik untuk aplikasi Anda.

Peristiwa aplikasi memiliki 3 bagian:

  1. name - String wajib yang menggambarkan peristiwa. Nama muncul di catatan Peristiwa saat peristiwa aplikasi itu dikirimkan ke Analytics.
  2. valueToSum - Nilai opsional yang ditambahkan oleh Analytics ke nilai Value To Sum lainnya dari peristiwa aplikasi dengan nama yang sama.
  3. parameters - Nilai opsional yang disertakan dengan peristiwa aplikasi.

Jumlah maksimal nama peristiwa yang berbeda adalah 1.000. Catatan: Jenis peristiwa baru tidak akan dicatat setelah batas ini tercapai dan jika Anda melampaui batas ini, Anda akan melihat pesan kesalahan 100 Invalid parameter saat mencatat. Namun, Anda dapat menonaktifkan peristiwa yang sudah tidak digunakan. Baca selengkapnya tentang batas peristiwa di Pertanyaan Umum.

Sebelum Memulai

Anda memerlukan:

  • ID pengiklan Anda, ID periklanan dari perangkat Android, atau Pengidentifikasi Periklanan (IDFA) dari perangkat Apple
  • Token akses aplikasi untuk diautentikasi Facebook. Jangan menyimpan token akses aplikasi Anda di klien.

Penginstalan Aplikasi

Kirim permintaan POST dari server Anda ke endpoint /{app-id}/activities dengan parameter application_tracking_enabled dan advertiser_tracking_enabled:

Diformat agar mudah dibaca.
curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=MOBILE_APP_INSTALL
   &application_tracking_enabled=0      
   &advertiser_tracking_enabled=0       
   &advertiser_id={advertiser-tracking-id}
   &{app-access-token}"

Setelah berhasil, aplikasi Anda menerima tanggapan berikut:

{
  "success": true
}

Peringatan

  • Anda harus melaporkan hanya satu penginstalan per pengguna. Hapus duplikat ID pada ID dan level pengguna jika memungkinkan.

Kunjungi Panduan Referensi Aktivitas Aplikasi untuk daftar parameter yang tersedia.

Mengaktifkan Pelacakan Iklan

Kolom advertiser_tracking_enabled menentukan apakah seseorang telah mengaktifkan pelacakan iklan di perangkatnya. Atur ke 0 untuk menonaktifkan atau 1 untuk mengaktifkan. Anda harus mengambil data ini dan mengembalikannya ke Facebook untuk menentukan apakah pelacakan iklan dapat digunakan untuk pengoptimalan atau konversi. Meta akan menggunakan data peristiwa (dari mitra tentang aktivitas pengguna di luar Meta) sesuai dengan Kebijakan Datanya, termasuk untuk pelaporan iklan, deteksi penipuan, dan untuk membangun dan meningkatkan produk kami (termasuk produk penayangan iklan kami), tetapi akan membatasi penggunaan data tentang individu tersebut untuk mempersonalisasi iklan pengguna tersebut. Untuk perangkat yang menjalankan versi sebelum iOS 6, default parameter ini harus ke 1.

Kunjungi Apple, Referensi AdSuppport untuk mendapatkan status pelacakan dari seorang pengguna.

Snippet kode berikut mengilustrasikan cara mengambil nilai dari bendera pelacakan aktif.

Anda bisa mendapatkan pengaturan saat ini dari bendera pelacakan diaktifkan dari properti Settings.shared.isAdvertiserTrackingEnabled.

print("isAdvertiserTrackingEnabled: \(Settings.shared.isAdvertiserTrackingEnabled)")

Menonaktifkan Pelacakan Iklan

Aplikasi apa pun dapat memilih untuk menyertakan pengaturan bagi pengguna untuk menonaktifkan pelacakan iklan dalam aplikasi itu. Facebook meminta partner untuk menyertakan opsi ini di SDK mereka dan melaporkan kembali pilihan pengguna ke Facebook bersama dengan peristiwa penginstalan atau konversi. Facebook menggunakan peristiwa penginstalan atau konversi untuk pelaporan iklan, tetapi membatasinya agar tidak digunakan dalam pengoptimalan iklan. Pengaturan pengguna harus tetap ada di seluruh peluncuran aplikasi.

Peristiwa Konversi

Kirim permintaan POST ke endpoint /{app-id}/activities dengan event diatur ke CUSTOM_APP_EVENTS dan atur advertiser_tracking_enabled untuk setiap peristiwa. Parameter advertiser_id atau attribution diperlukan.

Diformat agar mudah dibaca.
curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=CUSTOM_APP_EVENTS" 
   &advertiser_id={advertiser-tracking-id}
   &advertiser_tracking_enabled=1 
   &application_tracking_enabled=1
   &custom_events=[
      {"_eventName":"fb_mobile_purchase",
       "event_id":"123456",
       "fb_content":"[
            {"id": "1234", "quantity": 2,}, 
            {"id": "5678", "quantity": 1,}
        ]",
       "fb_content_type":"product",
       "_valueToSum":21.97,
       "fb_currency":"GBP",
      }
    ]
   &{app-access-token}" 

Setelah berhasil, aplikasi Anda menerima tanggapan berikut:

{
  "success": true
}

Atribusi

Endpoint attribution mengembalikan instalasi dan konversi berdasarkan klik yang terjadi pada iklan dalam 28 hari. Pengelola Iklan menggunakan tampilan 1 hari melalui model atribusi klik-tayang 28 hari dan insight ditampilkan berdasarkan impresi atau waktu klik, bukan waktu instalasi atau konversi. Ini penting saat membandingkan pelaporan Anda dengan laporan Pengelola Iklan Facebook. Selain klaim peristiwa aplikasi klik iklan standar, Anda juga harus memperhatikan skenario berikut:

  • Klaim Atribusi Lihat-Tayang - Pengaturan consider_views=TRUE memberikan data atribusi untuk penginstalan yang terjadi dalam 1 hari sejak impresi iklan, asalkan akun Pusat Akun tersebut tidak mengeklik iklan dalam 28 hari. Tanggapan yang ditampilkan adalah is_view_through=TRUE dan view_time akan menggantikan click_time. Semua atribusi lainnya sama dengan data atribusi klik iklan.

  • Klaim Lintas Kampanye - Pengiklan dapat melacak kinerja semua iklan yang mengarah ke peristiwa aplikasi. Facebook mengirimkan klaim untuk peristiwa dari kampanye iklan selama tujuan kampanye tidak ditetapkan ke penginstalan aplikasi seluler atau interaksi aplikasi seluler. Data ini muncul hanya jika pengiklan telah menambahkan aplikasi ke bidang "Pelacakan Peristiwa Aplikasi Seluler" di iklan mereka.

  • Kasus Pengguna — Jika klien Anda ingin melacak penginstalan yang dihasilkan oleh iklan postingan Halaman atau klik iklan situs web yang mengarahkan pengguna ke situs seluler, mereka dapat melakukannya di pengelola iklan dan Facebook akan mengeklaim penginstalan aplikasi yang relevan.

  • Klaim Lintas Perangkat - Pengiklan dengan aplikasi di beberapa platform dapat melihat data untuk penginstalan aplikasi yang didorong dari iklan di berbagai platform.

  • Kasus Penggunaan — Seorang pengguna mengeklik iklan aplikasi di iPhone, lalu menginstal aplikasi yang sama di iPad. Kita dapat mengatribusikan penginstalan aplikasi di iPad ke iklan iPhone terlepas dari penargetan iklannya.

Pencocokan Lanjut

Pencocokan lanjut memungkinkan Anda mengirim data pelanggan ke Facebook, tempat kami menggunakan data ini agar lebih akurat dalam menentukan akun Pusat Akun mana yang mengambil tindakan untuk menanggapi iklan Anda. Dengan data ini, Facebook dapat mencocokkan peristiwa konversi dengan pelanggan Anda untuk mengoptimalkan iklan Anda dan membangun pemirsa pemasaran ulang yang lebih besar.

Kirim permintaan POST ke endpoint /{app-id}/activities dengan parameter ud diatur ke parameter yang akan membantu melacak pelanggan Anda seperti email pelanggan atau nomor telepon. Semua data pelanggan harus di-hash atau Facebook akan mengabaikannya. Pastikan untuk mengatur advertiser_tracking_enabled setiap peristiwa individu.

Diformat agar mudah dibaca.
curl -i -X POST "https://graph.facebook.com/{app-id}/activities
   ?event=CUSTOM_APP_EVENTS
   &advertiser_id={advertiser-tracking-id}
   &advertiser_tracking_enabled=1 
   &application_tracking_enabled=1
   &custom_events=[
      {"_eventName":"fb_mobile_purchase",
      "event_id":"123456",
       "fb_content":"[
            {"id": "1234", "quantity": 2,}, 
            {"id": "5678", "quantity": 1,}
        ]",
       "fb_content_type":"product",
       "_valueToSum":21.97,
       "fb_currency":"GBP",
      }
    ]
   &ud[em]={sha256-hashed-email}
   &{app-access-token}"

Setelah berhasil, aplikasi Anda menerima tanggapan berikut:

{
  "success": true
}

Semua data pengguna harus di-hash SHA256 sebelum Anda mengirimkannya ke Facebook. Facebook akan mengabaikan data yang tidak di-hash.

Menghapus Duplikat

Untuk peristiwa aplikasi, kami menerapkan fungsi penghapusan duplikat yang sama dengan yang ada untuk peristiwa web. Logika memanfaatkan penghapusan duplikat berdasarkan kolom event_id dan event_name. Parameter event_id adalah pengidentifikasi yang secara unik dapat membedakan antara peristiwa serupa. ID peristiwa yang tidak akurat dapat menyebabkan konversi Anda salah dihapus duplikatnya, yang selanjutnya memengaruhi pelaporan konversi dan kinerja kampanye.

Informasi Perangkat yang Diperluas

Kirim informasi perangkat, seperti lebar dan tinggi layar, dalam panggilan peristiwa aplikasi Anda menggunakan /{app-id}/activities?extinfo. Nilai dipisahkan dengan koma dan harus dalam urutan yang diindeks di panduan referensi /application/activites. Semua nilai diperlukan saat menggunakan extinfo.

  • version haruslah a2 untuk Android
  • version haruslah i2 untuk iOS

Referensi

Mendapatkan Cookie Seluler

Kami mendorong Anda untuk mengaitkan peristiwa aplikasi dengan advertiser_id. Namun, untuk perangkat Android dan perangkat iOS sebelum iOS 6, Anda juga dapat menggunakan parameter attribution yang diatur ke cookie seluler perangkat.

Catatan: Cookie seluler tidak berasal dari atribut pengguna atau perangkat apa pun. Cookie ini tidak bersifat persisten dan dirancang untuk sering disegarkan. Jangan gunakan cookie seluler untuk menargetkan ulang iklan.

Android

Cookie adalah string alfanumerik 22 karakter acak.

Dapatkan ID atribusi Facebook menggunakan ContentProvider:

public static final Uri ATTRIBUTION_ID_CONTENT_URI = Uri.parse("content://com.facebook.katana.provider.AttributionIdProvider");

public static final String ATTRIBUTION_ID_COLUMN_NAME = "aid";

public static String getAttributionId(ContentResolver contentResolver) {
        String [] projection = {ATTRIBUTION_ID_COLUMN_NAME};
        Cursor c = contentResolver.query(ATTRIBUTION_ID_CONTENT_URI, projection, null, null, null);
        if (c == null || !c.moveToFirst()) {
            return null;
        }
        String attributionId = c.getString(c.getColumnIndex(ATTRIBUTION_ID_COLUMN_NAME));
        c.close();
        return attributionId;
    }

Anda juga harus mengambil ID periklanan aplikasi Android Anda.

iOS

Cookie seluler dibuat oleh aplikasi iOS Facebook menggunakan CFUUIDCreateString dan merupakan representasi string UUID 128-bit.

Dapatkan ID cookie dan IDFA dan kirimkan ke Facebook sebagai pengidentifikasi:

ASIdentifierManager *manager = [ASIdentifierManager sharedManager];
NSString *advertiserID = [[manager advertisingIdentifier] UUIDString];

if (advertiserID) {
  // do stuff
}

Header X-Forwarded-For HTTP

Jika permintaan POST dilakukan dari tempat sentral seperti server atau proxy, pada dasarnya, panggilan server ke server, maka header X-Forwarded-For HTTP diperlukan untuk memastikan lokasi yang akurat dan informasi perangkat. Kirim alamat IP perangkat, format IPv4 atau IPv6, melalui parameter header X-Forwarded-For HTTP di setiap permintaan peristiwa aplikasi yang Anda kirim. Dengan melakukannya, ini akan memungkinkan kami memasangkan advertiser_id ke alamat IP yang benar, yang kemudian dapat kami gunakan di platform kami.

Contoh IPv6

curl ...
  -H "X-Forwarded-For: fd45:f238:3b40:23b1:ffff:ffff:ffff:abcd" \
  https://graph.facebook.com/<APP_ID>/activities/

Contoh IPv4

curl ...
  -H "X-Forwarded-For: 192.168.0.99" \
  https://graph.facebook.com/<APP_ID>/activities

Pengujian

  1. Buka Pengelola Peristiwa.
  2. Klik ikon Sumber data di sisi kiri halaman.
  3. Pilih nama dan ID data Anda.
  4. Klik peristiwa Uji, dan pilih saluran sebagai Aplikasi.
  5. Kirim permintaan AE-API dengan fitur graph api.
  6. Interaksi Anda akan segera muncul di tab peristiwa Uji.

Ketidaksesuaian

Jika klien membandingkan laporan partner tentang pengukuran seluler dengan laporan Facebook dan melihat perbedaan, berikut beberapa item untuk diperiksa:

Jika Facebook melaporkan jumlah penginstalan lebih sedikit daripada MMP:

  • Apakah Facebook SDK terintegrasi dengan benar?
  • Apakah klien menggunakan ID aplikasi yang salah?

Jika Facebook melaporkan jumlah penginstalan lebih banyak daripada MMP:

  • Apakah jendela atribusinya sama? Facebook umumnya memiliki jendela atribusi yang lebih besar daripada kebanyakan partner pengukuran seluler.
  • Apakah SDK MMP terintegrasi dengan benar?
  • Apakah klien menggunakan ID aplikasi yang salah?
  • Apakah ketidaksesuaian hanya terjadi di iOS7? Apakah MMP menerima Pengidentifikasi Periklanan Apple (IDFA) dari perangkat dan meneruskannya dengan benar ke FB?

Referensi

Extinfo Aktivitas Aplikasi

Kunjungi panduan referensi /application/activites untuk informasi selengkapnya tentang informasi aplikasi yang diperluas.

Parameter Data Pengguna

Silakan unduh file CSV ini

untuk contoh data yang dinormalisasi dengan benar dan data dengan hash untuk parameter di bawah ini.



Unduh (Klik kanan > Simpan Tautan Sebagai)

Parameter Data Informasi Pelanggan

Data Parameter Contoh Panduan Format

Kota

ct

menlopark

Kota dengan huruf kecil tanpa spasi

Negara

country

AS

Kode negara dua huruf dalam ISO 3166-1 alpha-2

Tanggal Lahir

db

19911226

Tahun, bulan, dan hari lahir, misalnya 19971226 untuk 26 Desember 1997

Email

em

jsumito@example.com

Gunakan huruf kecil untuk alamat email seseorang

Nama Depan

fn

joyo

Gunakan huruf kecil untuk nama depan

Jenis Kelamin

ge

m

Antara f atau m, jika tidak diketahui, kosongkan

Nama Belakang

ln

sumito

Gunakan huruf kecil untuk nama belakang

Telepon

ph

16505551212

Nomor telepon, hanya angka dengan kode negara, kode area, dan nomor

Provinsi (Negara Bagian)

st

ca

Kode provinsi (negara bagian) dua huruf

Kode Pos

zp

94035

Kode pos lima angka

Nama Peristiwa Standar

Event Name Event Parameters _valueToSum

AdClick

fb_ad_type

AdImpression

fb_ad_type

With App Ads, revenue of ads from a third-party platform appears on-screen within your app.

Contact

CustomizeProduct

Donate

fb_mobile_achievement_unlocked

fb_description

fb_mobile_activate_app *

fb_mobile_add_payment_info

fb_success

fb_mobile_add_to_cart

fb_content_type, fb_content_id and fb_currency

Price of item added

fb_mobile_add_to_wishlist

fb_content_type, fb_content_id and fb_currency

Price of item added

fb_mobile_complete_registration

fb_registration_method

fb_mobile_content_view

fb_content_type, fb_content_id and fb_currency

Price of item viewed (if applicable)

fb_mobile_initiated_checkout

fb_content_type, fb_content_id, fb_num_items, fb_payment_info_available and fb_currency

Total price of items in cart

fb_mobile_level_achieved

fb_level

fb_mobile_purchase

fb_num_items, fb_content_type, fb_content_id and fb_currency

Purchase price

fb_mobile_rate

fb_content_type, fb_content_id and fb_max_rating_value

Rating given

fb_mobile_search

fb_content_type, fb_search_string and fb_success

fb_mobile_spent_credits

fb_content_type and fb_content_id

Total value of credits spent

fb_mobile_tutorial_completion

fb_success and fb_content_id

FindLocation

Schedule

StartTrial

fb_order_id and fb_currency

Price of subscription

SubmitApplication

Subscribe

fb_order_id and fb_currency

Price of subscription

*Use fb_mobile_activate_app event in addition to install reporting to exclude users from seeing ads for this app. Do not use this event if you have automatic event logging enabled.

Parameter Peristiwa Standar

Nama Parameter Peristiwa Nilai Deskripsi

_logTime

int

Rekomendasikan parameter untuk menentukan waktu peristiwa, ditentukan di unixtime

_valueToSum

float

Nilai numerik peristiwa individu yang akan dijumlahkan dalam pelaporan, lihat di atas untuk peristiwa yang direkomendasikan untuk dilampirkan

fb_content_id

string

International Article Number (EAN) jika berlaku, atau pengidentifikasi produk atau konten lainnya. Untuk beberapa id produk: mis., "[\"1234\",\"5678\"]"

fb_content

string

Daftar objek JSON yang berisi International Article Number (EAN) jika berlaku, atau pengidentifikasi produk atau konten lainnya, serta jumlah dan harga produk. Diperlukan:id, quantity. mis., "[{\"id\": \"1234\", \"quantity\": 2,}, {\"id\": \"5678\", \"quantity\": 1,}]".

fb_content_type

string

product atau product_group

fb_currency

string

Kode ISO 4217, mis., "EUR", "USD", "JPY". Diperlukan saat meneruskan _valueToSum sebagai harga atau jumlah pembelian.

fb_description

string

Deskripsi string

fb_level

string

Level game

fb_max_rating_value

int

Batas atas skala peringkat, contohnya 5 dari skala 5 bintang

fb_num_items

int

Jumlah barang

fb_payment_info_available

boolean

1 untuk ya, 0 untuk tidak

fb_registration_method

string

Facebook, Email, Twitter, dsb.

fb_search_string

string

String teks yang dicari

fb_success

boolean

1 untuk ya, 0 untuk tidak