Conversions API untuk Berkirim Pesan Bisnis

Conversions API memungkinkan pengiklan mengirim peristiwa web, aplikasi, toko fisik, dan berkirim pesan bisnis ke Meta melalui satu endpoint, dan bukan melalui berbagai sumber. Konsolidasi ini dapat menyederhanakan stack teknologi pengiklan dan menciptakan tampilan yang lebih komprehensif dalam Pengelola Peristiwa Meta dengan menggunakan set data.

Dokumentasi ini menyediakan panduan untuk mengintegrasikan peristiwa berkirim pesan bisnis ke Conversions API. Manfaat menggunakan Conversions API untuk berkirim pesan bisnis mencakup (tetapi tidak terbatas pada):

Melihat hasil secara langsung di pelaporan Pengelola Iklan: Pengiklan dapat dengan mudah memahami hasil kampanye "klik untuk mengirim pesan", berdasarkan hasil penting yang langsung dilihat di permukaan Meta, misalnya jumlah pembelian dan biaya per pembelian, bukan jumlah percakapan yang dimulai.
Menyederhanakan integrasi data: Satu API untuk menyerap dan berbagi data di beberapa platform berkirim pesan (Messenger, WhatsApp) dan saluran (situs web, aplikasi, toko, berkirim pesan).
Meningkatkan pengukuran mitra: Aktifkan atribusi kampanye "klik untuk mengirim pesan" secara langsung di dasbor mitra melalui Ads Insight API.

Prasyarat

Set data

Peristiwa berkirim pesan bisnis yang dikirim melalui Conversions API harus dikaitkan dengan set data.

Set data memungkinkan pengiklan menghubungkan dan mengelola data peristiwa dari sumber peristiwa web, aplikasi, toko, dan berkirim pesan bisnis ke Conversions API. Set data dapat menampilkan data peristiwa dari salah satu integrasi yang akan Anda siapkan ini:

Meta Pixel (peristiwa situs web)
App Events API (peristiwa aplikasi, termasuk Facebook SDK untuk iOS atau Android, mitra pengukuran seluler (MMP))
Offline Conversions API (API lama Meta untuk peristiwa offline)

Set data memungkinkan Anda melihat semua aktivitas pelanggan dari satu antarmuka. Set data juga memungkinkan Anda mengurangi upaya membuat dan memelihara banyak integrasi API.

Di Pengelola Peristiwa, pengiklan memiliki berbagai opsi untuk membuat set data, bergantung pada titik awal mereka. Atau Anda dapat membuat set data baru di Pengelola Peristiwa dengan menautkannya saat pembuatan set peristiwa offline, atau melalui aplikasi seluler yang ada, atau saat informasi pembuatan set peristiwa berkirim pesan. Perhatikan bahwa menautkan set data ke aplikasi perlu dilakukan sebelum mengirimkan peristiwa aplikasi seluler ke Conversions API dan hanya satu aplikasi yang dapat ditautkan ke set data. Lihat selengkapnya detail dan petunjuk di sini.

Izin

Untuk menerapkan integrasi langsung sebagai pengiklan, silakan ikuti petunjuknya di sini terkait prasyarat dan izin.
Untuk menerapkan integrasi platform mitra, Anda perlu memiliki:
- Akses lanjutan ke izin ads_read, ads_management, pages_messaging, whatsapp_business_messaging, pages_show_list, dan instagram_manage_messages.
- Fitur Akses Standar Pengelolaan Iklan.
- Bergantung pada jenis peristiwa, Anda perlu memiliki akses lanjutan ke izin page_events untuk peristiwa Messenger atau WhatsApp atau instagram_manage_events untuk Instagram Direct.

Onboarding Mitra

Jika Anda menerapkan integrasi mitra sebagai platform, Anda dapat menggunakan metode onboarding Facebook Login for Business (disarankan) atau Meta Business Extension.

Lihat Buku Panduan Conversions API untuk Berkirim Pesan Bisnis, yang berisi panduan integrasi dengan petunjuk langkah demi langkah.

Dataset API untuk Berkirim Pesan dan WhatsApp

Dataset API digunakan untuk mengambil dataset_id yang terlampir di halaman tersebut. dataset_id ini digunakan nanti di Conversions API. Agar dapat menggunakan Dataset API, Anda memerlukan izin page_events untuk peristiwa Messenger atau WhatsApp yang diberikan kepada aplikasi Anda oleh klien melalui Facebook Login for Business atau Meta Business Extension.

Untuk mengambil dataset_id, Anda perlu membuat panggilan GET ke Dataset API dengan page_id dan access_token. Lihat contoh panggilan di bawah ini:

https://graph.facebook.com/v16.0/{PAGE_ID}/dataset?access_token={TOKEN}

Tanggapannya akan berupa ID, yang mewakili dataset_id. Dengan menggunakan ini dan token akses yang diterima sebelumnya, Anda kini dapat memanggil Conversions API untuk mengirim peristiwa berkirim pesan ke Meta.

Dataset API untuk Instagram

Dataset API digunakan untuk mengambil dataset_id yang terlampir di halaman tersebut. dataset_id ini digunakan nanti di Conversions API. Agar dapat menggunakan Dataset API, Anda memerlukan izin instagram_manage_events yang diberikan kepada aplikasi Anda oleh klien Anda melalui Facebook Login for Business atau Meta Business Extension.

Untuk mengambil dataset_id, Anda perlu membuat panggilan GET ke Dataset API dengan ig_user_id dan access_token. Berikut adalah contoh panggilan:

https://graph.facebook.com/v16.0/{IG_USER_ID}/dataset?access_token={TOKEN}

Tanggapannya akan berupa ID, yang mewakili dataset_id. Dengan menggunakan ini dan token akses yang diterima sebelumnya, Anda kini dapat memanggil Conversions API untuk mengirim peristiwa berkirim pesan ke Meta.

Konfigurasi

Menyiapkan Parameter Peristiwa Berkirim Pesan Bisnis

Anda dapat melihat set parameter saat ini di sini yang dapat dikirim melalui Conversions API. Untuk mengirim peristiwa berkirim pesan bisnis, kolom berikut ini dapat dibagikan di payload Data Pengguna untuk berbagai platform berkirim pesan:

Platform	Parameter	Deskripsi
Messenger	`page_id`	Wajib untuk Messenger ID Halaman Facebook yang terkait dengan bisnis itu.
Messenger	`page_scoped_user_id`	Wajib untuk Messenger Pengguna yang berinteraksi dengan Halaman diidentifikasi oleh ID Pengguna Lingkup Halaman (PSID). PSID bisa didapatkan dari webhook ini.
WhatsApp	`page_id`	Wajib untuk WhatsApp ID Halaman Facebook yang terkait dengan WhatsApp Business.
WhatsApp	`ctwa_clid`	Wajib untuk WhatsApp `ctwa_clid` hanya tersedia dari objek rujukan di bawah webhook pesan di Business API versi 2.45.1 dan yang lebih baru (di Tempat) atau Cloud API.
Instagram	`ig_account_id`	Wajib untuk Instagram ID Akun Instagram yang terkait dengan bisnis.
Instagram	`ig_sid`	Wajib untuk Instagram Pengguna yang berinteraksi dengan Instagram diidentifikasi oleh ID Pengguna Lingkup Instagram (IGSID). IGSID dapat diperoleh dari webhook ini.

Mengirim Peristiwa

Untuk mengirim peristiwa baru, buat permintaan POST ke Conversions API dari jalur ini:

https://graph.facebook.com/{API_VERSION}/{DATASET_ID}/events?access_token={TOKEN}

Saat Anda memposting ke edge ini, Meta membuat peristiwa berkirim pesan bisnis baru. Untuk lebih jelasnya, silakan buka dokumen developer berikut ini.

Berikut ini adalah ringkasan tentang kesesuaian parameter dalam keseluruhan skema di payload.

Untuk peristiwa Messenger:

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "messenger",
      "user_data": {
        "page_id": <PAGE_ID>,
        "page_scoped_user_id": <PSID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

Untuk peristiwa WhatsApp:

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "whatsapp",
      "user_data": {
        "page_id": <PAGE_ID>,
        "ctwa_clid": "ARAkLkA8rmlFeiCktEJQ-QTwRiyYHAFDLMNDBH0CD3qpjd0HR4irJ6LEkR7JwFF4XvnO2E4Nx0-eM-GABDLOPaOdRMv-_zfUQ2a", // <CLICK_TO_WHATSAPP_CLICK_ID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

Untuk peristiwa Instagram:

Contoh Permintaan CAPI CTD

POST /{dataset_id}/events

{
  "data": [
    {
      "event_name": "Purchase",
      "event_time": 1675999999,
      "action_source": "business_messaging",
      "messaging_channel": "instagram",
      "user_data": {
        "ig_account_id": <IG_ACCOUNT_ID>,
        "ig_sid": <IGSID>
      },
      "custom_data": {
        "currency": "USD",
        "value": 123
      }
    }
  ],
  "partner_agent": "<PARTNER_NAME>"
}

Pemecahan Masalah

Gunakan fitur Peristiwa Pengujian di Pengelola Peristiwa untuk pengujian:

Buka Pengelola Peristiwa, pilih set data yang tertaut dengan halaman
Klik tab Peristiwa Pengujian
Pilih saluran marketing dan saluran berkirim pesan
Klik tombol Graph API Explorer
Graph API Explorer akan diisi dengan payload yang sudah diisi sebelumnya
Klik tombol Kirim

Panduan Video

Lihat video ini untuk penjelasan langkah demi langkah tentang cara menerapkan terintegrasi.

Ada Masalah

Kami mengalami masalah saat memutar video ini.

Selengkapnya

Pertanyaan Umum

Jenis peristiwa berkirim pesan apa yang didukung Conversions API untuk Berkirim Pesan Bisnis?

J: Conversions API untuk Berkirim Pesan Bisnis saat ini hanya mendukung prospek yang dikirim dan peristiwa pembelian untuk pengiriman pesan bisnis. Perhatikan bahwa peristiwa berkirim pesan hanya mewakili interaksi pelanggan yang terjadi di utas berkirim pesan, bukan konversi yang terjadi di saluran lain seperti situs web. Anda dapat dengan mudah membedakan peristiwa dengan memilih sumber tindakan yang terkait selama proses integrasi Anda.

Apakah Meta memberikan panduan tentang mana yang sebaiknya digunakan, aplikasi yang sama atau berbeda, untuk berbagai integrasi Conversions API?

J: Praktik terbaiknya adalah bahwa mitra sebaiknya menggunakan satu aplikasi, agar Meta dapat mengidentifikasi semua peristiwa yang dikirim dari mitra itu. Jika Anda adalah mitra yang sudah memiliki banyak aplikasi, pastikan partner_agent diatur ke nama agen mitra yang ditetapkan untuk Anda. Hubungi perwakilan Meta jika Anda tidak yakin.

Jika terjadi konversi di luar utas pesan (misalnya di situs web atau aplikasi), bagaimana cara meneruskan peristiwa tersebut ke Meta?

J: Jika konversi terjadi di luar utas berkirim pesan, Anda tetap harus mengirim peristiwa tersebut kembali ke Meta menggunakan produk Conversions API yang relevan. Misalnya, jika terjadi konversi di situs web Anda, gunakan Conversions API untuk web. Jika konversi terjadi di aplikasi Anda, gunakan Conversions API untuk peristiwa aplikasi. Peristiwa ini tetap akan diatribusikan ke ID klik untuk Conversions API untuk web. Daftar lengkap parameter dapat ditemukan di sini.

Apakah Conversions API mengaktifkan pengoptimalan untuk iklan yang "klik untuk mengirim pesan"?

J: Conversions API mengaktifkan akses ke pengoptimalan pembelian hanya untuk iklan yang klik ke Messenger, tetapi saat ini tidak tersedia untuk pengoptimalan iklan WhatsApp. Untuk iklan yang klik ke WhatsApp, Anda dapat mengoptimalkan kampanye iklan untuk mendorong lebih banyak percakapan.

Dapatkah saya menggunakan kembali set data yang ada untuk Conversions API untuk berkirim pesan bisnis?

J: Ya, kami mendukung penautan dengan set data yang ada. Anda dapat melihat opsi yang tersedia untuk memutuskan opsi yang tepat untuk bisnis Anda.

Jika saya menggunakan Conversions API untuk Situs Web hari ini, apakah menambahkan pengiriman pesan bisnis ke integrasi yang sama akan mengganggu integrasi yang ada?

J: Tidak ada risiko jika Anda menambahkan pengiriman pesan bisnis ke integrasi CAPI Anda yang sudah ada. Atribusi didasarkan pada ID halaman/set data dan tidak terkait dengan ID aplikasi.

Berapa banyak set data yang dapat ditautkan ke suatu halaman?

J: Anda hanya dapat menautkan satu set data ke suatu halaman.

Apakah saya perlu mendeduplikasi peristiwa sebelum mengirimkannya melalui Conversions API untuk Berkirim Pesan Bisnis?

J: Meta tidak membantu deduplikasi peristiwa untuk Conversions API untuk Berkirim Pesan Bisnis, jadi kami sangat menganjurkan pengiklan untuk melakukan deduplikasi sebelum mengirimkannya melalui Conversions API untuk Berkirim Pesan Bisnis.

Lihat Juga

Gambaran Umum Conversions API
Menggunakan Conversions API
Parameter Conversions API
Praktik Terbaik
Platform WhatsApp Business (di Tempat atau Cloud API) dengan Business API versi 2.45.1 dan yang lebih baru
Instagram Messaging API