Conversions API

Pustaka Builder Parameter

Meta telah menyediakan daftar SDK pustaka di sisi klien (JavaScript) dan sisi server (PHP, Java, Python, NodeJS, Ruby). Pustaka SDK ini ditujukan untuk membantu developer meningkatkan kualitas parameter peristiwa Conversions API (misalnya, fbc dan fbp), dan memungkinkan pengiklan mematuhi praktik terbaik Meta dalam membuat parameter ini.

Dokumen ini menyertakan ringkasan kedua pustaka, panduan tentang pustaka mana yang digunakan, dan contoh kasus penggunaan.

Ringkasan Pustaka

Sisi klien: Pustaka dan peristiwa siaran langsung berada di front-end pada sisi browser. Pustaka diimplementasikan dalam JavaScript. Developer dapat mengintegrasikannya langsung ke halaman web mereka.

Sisi server: Pustaka dan peristiwa siaran langsung berada di back-end pada sisi server. Bergantung pada bahasa yang digunakan back-end, Meta menyediakan pustaka dalam berbagai bahasa (PHP, Java, Python, NodeJS, dan Ruby).

Memilih Pustaka

Semua pustaka dapat bekerja secara independen. Untuk memaksimalkan potensi Anda atau pelanggan Anda, tinjau rekomendasi di sini.

Diuraikan menurut fungsionalitasnya, ada dua jenis pustaka yang didukung Meta:

  • Pustaka dasar parambuilder
  • Pustaka ekstensi paramshelper

Pustaka dasar: parambuilder

Parambuilder mematuhi praktik terbaik yang dirujuk dalam dokumentasi developer Meta. Hal ini diimplementasikan pada sisi klien (JavaScript) dan sisi server (PHP, Java, Python, NodeJS, Ruby).

Pustaka ekstensi: paramshelper

Paramshelper, juga dikenal sebagai clientParamsHelper, hanya berfungsi pada sisi klien front-end. Ini adalah pustaka JavaScript untuk mengambil clickID cadangan dari browser dalam aplikasi. Hal ini dapat membantu meningkatkan lebih lanjut pengambilan fbc dan kualitasnya, yaitu jumlah peristiwa yang mengandung fbc sebagai persentase dari jumlah total peristiwa.

Paramshelper dapat bekerja secara independen, tetapi kami merekomendasikan untuk melengkapinya dengan SDK builder parameter sisi server untuk memaksimalkan potensinya.

Contoh Kasus Penggunaan untuk Referensi

Kasus penggunaan berikut mungkin patut dipertimbangkan saat Anda membuat solusinya.

Direkomendasikan: Builder parameter sisi server + paramshelper sisi klien

Memasangkan builder parameter sisi server dan paramshelper sisi klien dapat membantu memaksimalkan potensi Anda untuk mencapai cakupan fbc yang tinggi.

Untuk melakukannya, Anda perlu mengintegrasikan dua pustaka bersama-sama: ParamBuilder sisi server dan ClientHelper.




Contoh alur kerja:

  1. ClientParamsHelper memanggil await decorateUrl(existing_url) di sisi klien saat memuat halaman.
  2. Di sisi klien, API pengambilan (atau komunikasi front-back end lainnya) memanggil dengan URL lengkap (contoh: example.com?fbclid=xxxxx) ke server back-end.
  3. Di sisi server, integrasikan pustaka server berdasarkan pilihan bahasa Anda di endpoint penerima (contoh, ExampleController) 
 // Example Controller which processes all requests to example.com
// Start process
ParamBuilder paramBuilder = new ParamBuilder(Arrays.asList('example.com', 'yourDomain.com'));
// Input the request's full URL, such as: example.com?fbclid=xxxxx
// Process and get recommended updated cookie
List<CookieSetting> updatedCookieList =
        paramBuilder.processRequest(
            request.getHeader("host"),  // example.com
            request.getParameterMap(), // {'fbclid':['xxxxx']}
            cookieMap, 
            request.getHeader("referer")); // optional: referer full url


// Save cookie from server side
for (CookieSetting updatedCookie : updatedCookieList) {
      Cookie cookie = new Cookie(updatedCookie.getName(), updatedCookie.getValue());
      cookie.setMaxAge(updatedCookie.getMaxAge());
      cookie.setDomain(updatedCookie.getDomain());
      response.addCookie(cookie);
 }

// Get fbc, fbp
String fbc = paramBuilder.getFbc();
String fbp = paramBuilder.getFbp();

// Call CAPI endpoint
.....
.setFbc(fbc)
.setFbp(fbp)
....

ParamBuilder + ParamHelper sisi klien

Jika ingin mengintegrasikan dengan pustaka sisi klien, Anda dapat menggunakan parambuilder untuk mencakup semua fitur.

Contoh: Integrasikan dengan ParamBuilder(clientParamBuilder) sisi klien saja

Saat ini kami mendukung API processAndCollectAllParams(url) saat memuat halaman. Ia akan mengadopsi kedua fitur dari clientParamBuilder dan clientParamsHelper untuk mengambil dan menyimpan cookie fbc dan fbp.

Contoh alur kerja:

  1. Pustaka clientParamBuilder akan dipanggil sebagai processAndCollectAllParams(url) saat memuat halaman.
  2. Permintaan dikirim ke sisi server. Server kemudian dapat membaca fbc, fbp dari cookie.

ParamBuilder sisi server saja

Harap tinjau Panduan Onboarding Builder Parameter Sisi Server atau file README yang ditautkan di dalamnya untuk beberapa contoh terperinci.

Contoh alur kerja:

  1. Pada endpoint server, impor pustaka ParamBuilder berdasarkan bahasa dan kerangka kerja yang relevan.
  2. Panggil paramBuilder.processRequest untuk mendapatkan daftar cookie terbaru yang direkomendasikan.
  3. Atur cookie pada tanggapan Anda.
  4. Atur fbc dan fbp ke panggilan Conversions API’ menggunakan paramBuilder.getFbc() dan paramBuilder.getFbp().

ParamBuilder sisi klien saja

Harap tinjau Panduan Onboarding Builder Parameter Sisi Klien atau file README yang ditautkan di dalamnya untuk beberapa contoh terperinci.

Contoh alur kerja:

  1. Saat memuat halaman tujuan, panggil clientParamBuilder.processAndCollectParams(url).
  2. Permintaan kemudian dikirim ke sisi server. Server kemudian dapat membaca fbc dan fbp dari cookie.
    • Catatan: Jika URL tujuan tidak berisi fbclid, fbc mungkin hilang. Perilaku ini telah diantisipasi.

Praktik Terbaik

  1. Pastikan Anda menyimpan cookie _fbp dan _fbc sedini mungkin dalam perjalanan pelanggan di halaman web Anda. Idealnya, ambil cookie _fbp dan _fbc saat memuat halaman tujuan Anda. Tidak direkomendasikan untuk mengambilnya hanya pada peristiwa down-funnel atau ketika peristiwa tertentu dipicu.
  2. Jangan menimpa atau menyesuaikan cookie _fbc atau _fbp. _fbc peka huruf besar dan kecil; jangan menormalkan atau memformat _fbc menjadi huruf kecil.
  3. Pastikan pustaka diterapkan ke semua permukaan, seperti seluler, desktop, dan browser, serta domain yang ingin Anda lacak.
  4. Pustaka sisi server diperuntukkan bagi sisi back-end dan pustaka sisi klien diperuntukkan bagi sisi browser front-end. Developer dapat mengintegrasikan pustaka sisi klien secara langsung ke halaman web mereka, sedangkan pustaka sisi server dipanggil di server, sisi back-end. Perhatikan bahwa sisi klien hanya tersedia di JS sementara Meta menyediakan pustaka dalam berbagai bahasa (PHP, Java, Python, NodeJS, dan Ruby) untuk pustaka sisi server.

Lihat Juga