Conversions API

Mengirim Peristiwa Offline Menggunakan Conversions API

Conversions API adalah metode integrasi yang disarankan Meta untuk mengirim peristiwa offline dan toko fisik ke Meta untuk digunakan dalam pengukuran, atribusi, dan penargetan iklan. Halaman ini memerinci cara mengirim peristiwa offline melalui Conversions API langsung atau integrasi mitra.

Prasyarat

Set data

Peristiwa offline yang dikirim melalui Conversions API harus dikaitkan dengan set data.

Datasets allow advertisers to connect and manage event data from web, app, store and business messaging event sources to the Conversions API. Datasets may show event data from any of these integrations that you choose to set up:

  • Meta Pixel (website events)
  • App Events API (app events, including Facebook SDK for iOS or Android, mobile measurement partners (MMPs))
  • Offline Conversions API (Meta’s legacy API for offline events)
  • Messaging Events API (messaging events)

Datasets enable you to view all customer activities from a single interface. They also allow you to reduce the effort to build and maintain multiple API integrations.

In Events Manager, advertisers have different options to create a dataset depending on their starting point. Or you can create a brand new dataset in Events Manager by linking during offline event set creation or through an existing mobile app or during messaging event set creation information. Note that linking a dataset to an application is required before sending mobile app events to the Conversions API and only one application can be linked to a dataset. See more details and instructions here.

Anda dapat melakukan panggilan GET ke https://graph.facebook.com/v16.0/{ads-pixel-id}/?fields=is_consolidated_container untuk mendeteksi apakah set data pengiklan telah terkonsolidasi sehingga memenuhi syarat untuk meneruskan peristiwa offline menggunakan Conversions API.

Izin

  • Untuk menerapkan integrasi langsung sebagai pengiklan, silakan ikuti petunjuknya di sini untuk prasyarat dan izin.

  • Untuk menerapkan integrasi platform mitra, silakan ikuti petunjuknya di sini untuk prasyarat dan izin.

Konfigurasi

1. Menyiapkan Parameter Peristiwa Offline

Pengiklan dapat menggunakan pengaturan yang disebutkan di sini dan melihat set parameter saat ini yang dapat dikirimkan melalui Conversions API. Untuk mengirim peristiwa offline dan toko, kolom berikut dapat dibagikan di payload:

  • Pengiklan perlu mengirim action_source sebagai physical_store untuk semua peristiwa offline dan toko. Perhatikan bahwa parameter ini diwajibkan untuk semua jenis peristiwa server. Dengan menggunakan Conversions API, Anda setuju bahwa parameter action_source akurat sejauh pengetahuan Anda.
  • Semua kolom peristiwa server yang wajib untuk Conversions API harus dipatuhi.
  • Parameter informasi pelanggan (lihat di bawah ini untuk daftar parameter yang benar untuk peristiwa offline dan toko).
  • Parameter data khusus (lihat di bawah ini untuk daftar parameter yang benar untuk peristiwa offline dan toko).
  • Parameter opsional: parameter upload_tag masih didukung untuk pengunggahan peristiwa offline untuk pengiklan yang menggunakan API lama untuk peristiwa offline.

Parameter Informasi Pelanggan

Daftar berikut berisi parameter informasi pelanggan yang biasanya digunakan untuk peristiwa offline dan toko:

Nama parameter Parameter Wajib hashing

Alamat Email

email

YA

Nomor Telepon

phone

YA

Jenis kelamin

gen

YA

Tanggal Lahir

db

YA

Nama Belakang

ln

YA

Nama Depan

fn

YA

Kota

ct

YA

Negara Bagian AS

st

YA

Kode pos

zip

YA

Negara

country

YA

Pengidentifikasi Periklanan Apple

madid

YA

ID Periklanan Android

madid

YA

ID pengguna pihak ketiga

external_id

Sangat direkomendasikan

ID prospek dari Iklan Prospek

lead_id

JANGAN hash

Parameter Data Khusus

Bagian berikut berisi parameter khusus yang umum digunakan oleh peristiwa offline dan toko. Untuk kolom data khusus lainnya, lihat daftar lengkap yang kami terima untuk Conversions API di tautan berikut.

ParameterDeskripsi

event_time

jenis: bilangan bulat

Wajib

Cap waktu UNIX untuk peristiwa konversi.

Contoh:
'1456870055'


event_name
jenis: string

Wajib

Jenis peristiwa.

Contoh:
ViewContent, Search, AddToCart, AddToWishlist, InitiateCheckout, AddPaymentInfo, Purchase, Lead, Other


store_data
jenis: kamus JSON

Opsional

Simpan data lokasi tentang peristiwa konversi.

Contoh:

"store_data":
    {
        "store_page_id": 8576093908, // FBID
        "brand_page_id": 10236898932// FBID
    }

currency
jenis: string

Wajib

Kode mata uang ISO tiga huruf untuk peristiwa konversi ini. Wajib untuk peristiwa Purchase.

Contoh:
USD


value
jenis: double

Wajib

Nilai peristiwa konversi. Wajib untuk peristiwa Purchase.

Contoh:
16.00


content_type jenis: string

Opsional

content_type iklan katalog Advantage+ yang valid.

Contoh:
product


contents

jenis: array JSON

Opsional. Wajib jika Anda mengintegrasikan iklan dengan katalog.

Wajib: id, quantity


Direkomendasikan: price, brand, category

Wajib: [ {id: "A", quantity: 1}, {id: "B", quantity: 2}, {id: "C", quantity: 1}]


Direkomendasikan: [ {id: "A", quantity: 1, brand: "Brand_A", category: "", price: 10.0}]


custom_data

jenis: kamus JSON

Opsional.

Informasi tentang peristiwa konversi ini.

Contoh: {category: 'ICECREAM'}


order_id

jenis: string

Opsional.

Pengidentifikasi unik untuk tiap transaksi atau pesanan dalam set peristiwa offline. Contoh: untuk retail ini bisa berupa ID tanda terima.

Contoh: ATN10001, 123456


item_number

jenis: string

Opsional.

Pengidentifikasi unik untuk membedakan peristiwa dalam pesanan atau transaksi yang sama.

Contoh: 1, a



2. 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 offline dan toko baru. Untuk detail selengkapnya, lihat dokumen developer berikut ini.

Berikut ini ringkasan tentang kesesuaian parameter dalam keseluruhan skema di payload:

curl -X POST \
  -F 'data=[
       {
  "event_name": "Purchase",
  "event_time": 1674000041,
  "user_data": {
    "em": [
      "309a0a5c3e211326ae75ca18196d301a9bdbd1a882a4d2569511033da23f0abd"
    ],
    "ph": [
      "254aa248acb47dd654ca3ea53f48c2c26d641d23d7e2e93a1ec56258df7674c4",
      "6f4fcb9deaeadc8f9746ae76d97ce1239e98b404efe5da3ee0b7149740f89ad6"
    ]
  },
  "custom_data": {
    "currency": "usd",
    "value": 123.45,
    "contents": [{
      "id": "product123",
      "quantity": 1
    }]
  },
  "action_source": "physical_store"
}
]' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v15.0/<DATASET_ID>/events

Kami sarankan agar Anda mengunggah secara real time atau setiap hari untuk mendapat hasil pengoptimalan yang optimal, agar data offline dapat dicocokkan secara efektif dengan kinerja iklan yang ditayangkan.

event_time bisa sampai 7 hari sebelum Anda mengirim peristiwa ke Meta. Jika event_time di data lebih dari 7 hari pada masa lalu, kami akan menampilkan kesalahan untuk seluruh permintaan dan tidak memproses peristiwa. Untuk peristiwa toko offline dan fisik dengan physical_store sebagai action_source, Anda harus mengunggah transaksi dalam 62 hari sejak konversi.

Data yang diunggah diproses secara real time, jadi Anda dapat melihat hasilnya begitu Anda menambahkannya. Anda dapat melihat dokumen Pusat Bantuan tentang Praktik Terbaik untuk Data peristiwa offline.

3. Menyiapkan Deduplikasi

Tidak seperti deduplikasi yang diatur di seluruh peristiwa Conversions API dan Meta Pixel, peristiwa offline hanya dapat dideduplikasi terhadap peristiwa offline lain. Kami mendukung dua metode deduplikasi: berdasarkan order_id atau berdasarkan pengguna. Deduplikasi menggunakan kombinasi kolom: dataset_id, event_time, event_name, item_number, dan kolom kode berdasarkan metode di payload peristiwa tersebut.

Deduplikasi default menggunakan order_id dengan kombinasi kolom di atas. Jika tidak ada order_id di payload, logika deduplikasi berdasarkan pengguna akan digunakan.

Misalnya, jika ada dua order dengan event_time yang sama, event_name yang memiliki order_id yang sama, atau set Parameter Informasi Pelanggan tanpa order_id, kami akan menganggapnya sebagai peristiwa duplikat dan mengambil peristiwa pertama. Metode deduplikasi berdasarkan pengguna hanya dapat digunakan dengan kolom Parameter Informasi Pelanggan yang sama di kedua payload.

Jendela deduplikasi maksimumnya adalah 7 hari.

4. Memecahkan Masalah Peristiwa

Anda dapat menggunakan fitur Bantuan Payload untuk membuat data payload:

  • Pilih sumber tindakan physical_store jika berlaku. Dengan menggunakan Conversions API, Anda setuju bahwa parameter action_source akurat sejauh pengetahuan Anda.
  • Isi info untuk peristiwa yang akan dikirimkan ke Meta
  • Ini akan menghasilkan payload peristiwa, yang dapat digunakan sebagai template untuk integrasi Conversions API Anda

Gunakan fitur Peristiwa Pengujian di Pengelola Peristiwa untuk pengujian. Perhatikan bahwa fitur Peristiwa Pengujian hanya mendukung peristiwa web dan aplikasi.

Lihat Juga

Artikel Pusat Bantuan Bisnis