Formulir Prospek untuk Iklan

Dokumen ini menjelaskan cara menggunakan Marketing API untuk membuat iklan untuk penciptaan prospek menggunakan Graph API.

Untuk membuat dan menerbitkan iklan prospek, ikuti langkah-langkah ini:

  1. Membuat kampanye iklan
  2. Membuat set iklan yang menautkan iklan Anda ke kampanye iklan Anda
  3. Membuat formulir prospek
  4. Membuat materi iklan dengan formulir prospek
  5. Mengaitkan kampanye dan materi iklan Anda untuk membuat iklan
  6. Menerbitkan iklan Anda

Sebelum Memulai

Panduan ini berasumsi bahwa Anda telah membaca Ringkasan Platform Messenger dan menerapkan komponen yang dibutuhkan untuk mengirim dan menerima pesan serta notifikasi.

Anda akan membutuhkan hal-hal berikut:

Langkah 1. Buat kampanye

Untuk membuat kampanye iklan untuk iklan penciptaan prospek, kirim permintaan POST ke endpoint /act_AD_ACCOUNT_ID/campaigns dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • buying_type diatur ke AUCTION
  • name diatur ke nama kampanye Anda
  • objective diatur ke OUTCOME_LEADS
  • special_ad_categories diatur ke NONE atau kategori iklan khusus
  • status diatur ke PAUSED

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai yang dicetak tebal, dicetak miring, seperti AD_ACCOUNT_ID, dengan nilai Anda.
curl -X POST "https://graph.facebook.com/v21.0/act_AD_ACCOUNT_ID/campaigns" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"YOUR_PAGE_ACCESS_TOKEN",
           "buying_type":"AUCTION",
           "name":"YOUR_LEADADS_CAMPAIGN_NAME",
           "objective":"OUTCOME_LEADS",
           "special_ad_categories":["NONE"],
           "status":"PAUSED"
         }'

Setelah berhasil, aplikasi Anda akan menerima objek JSON dengan ID kampanye Anda. ID ini akan digunakan saat membuat set iklan di langkah berikutnya.

{
  "id": "YOUR_CAMPAIGN_ID"
}

Kunjungi Referensi Kampanye Iklan untuk mempelajari selengkapnya.

Langkah 2. Buat set iklan

Untuk membuat set iklan, kirim permintaan POST ke endpoint act_ad_account_id/adsets dengan ad_account_id adalah ID akun iklan Meta Anda. Permintaan Anda harus menyertakan:

  • access_token yang diatur ke token akses Halaman
  • bid_amount diatur ke maksimal yang ingin Anda bayar
  • billing_event diatur ke IMPRESSIONS
  • campaign_id diatur ke ID kampanye iklan Anda dari Langkah 1
  • daily_budget diatur ke jumlah yang ingin Anda keluarkan per hari
  • name diatur ke nama set iklan Anda
  • optimization_goal yang diatur ke LEAD_GENERATION, atau QUALITY_LEAD
  • destination_type yang diatur ke ON_AD
  • promoted_object – yang diatur ke ID untuk Halaman Facebook bisnis Anda
  • status yang diatur ke PAUSED

Catatan: Jika Anda telah menyiapkan sumber data CRM dan memilih QUALITY_LEAD sebagai tujuan pengoptimalan, Anda dapat menambahkan pixel_id ke promoted_object untuk pengoptimalan lebih lanjut tentang kualitas. Perhatikan bahwa Anda tidak perlu menyediakan pixel_rule bersama dengan pixel_id.

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai yang dicetak tebal, dicetak miring, seperti AD_ACCOUNT_ID, dengan nilai Anda.
curl -X POST "https://graph.facebook.com/v21.0/act_AD_ACCOUNT_ID/adsets"
     -H "Content-Type: application/json" 
     -d '{
           "access_token":"YOUR_PAGE_ACCESS_TOKEN",
           "bid_amount":"YOUR_BID_AMOUNT",
           "billing_event":"IMPRESSIONS",
           "campaign_id":"YOUR_CAMPAIGN_ID",
           "daily_budget":"YOUR_DAILY_BUDGET",
           "name:"YOUR_LEADADS_ADSET_NAME",
           "optimization_goal":"LEAD_GENERATION",
           "destination_type":"ON_AD",
           "promoted_object":"YOUR_PAGE_ID",
           "status":"PAUSED"
         }'

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berikut dengan ID set iklan.

{
  "id": "YOUR_ADSET_ID"
}

Kunjungi Referensi Set Iklan untuk mempelajari selengkapnya.

Langkah 3. Buat Formulir Prospek

Untuk membuat formulir, kirim permintaan POST ke endpoint /PAGE_ID/leadgen_forms dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • name diatur ke nama formulir Anda
  • questions diatur ke array objek yang mendefinisikan jenis pertanyaan dan urutan kemunculan di formulir menggunakan parameter key
    • pertanyaan khusus menggunakan parameter label
    • pertanyaan khusus menggunakan parameter options dengan menu pilihan jawaban

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X POST "https://graph.facebook.com/v21.0/PAGE_ID/leadgen_forms" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token": "YOUR_PAGE_ACCESS_TOKEN",
           "name": "YOUR_LEADADS_FORM_NAME",
           "questions": "[
               {"type":"FULL_NAME", "key": "question1"},
               {"type":"EMAIL", "key": "question2"},
               {"type":"PHONE", "key": "question3"},
               {"type":"CUSTOM", "key": "question4" "label": "Do you like rainbows?"}
               {"type":"CUSTOM", "key": "question5" "label": "What is your favorite color?", 
                   "options": [
                       {value: "Red", key: "key1"},
                       {value: "Green", key: "key2"},
                       {value: "Blue", key: "key2"},
                   ]}
           ]"
         }'

Formulir untuk Percakapan Messenger

Formulir yang ingin Anda gunakan dalam iklan dalam percakapan Messenger harus berisi hal berikut:

  • Parameter questions.type hanya dapat diatur ke salah satu dari nilai berikut:
    • CUSTOM
    • EMAIL
    • FIRST_NAME
    • FULL_NAME
    • LAST_NAME
    • PHONE

    Jika formulir memiliki questions.type yang diatur ke nilai lain selain yang tercantum dalam daftar, formulir tidak akan memenuhi syarat.

  • Parameter block_display_for_non_targeted_viewer harus diatur ke false. Ini menandai formulir sebagai Dibagikan secara Terbuka.

Permintaan Contoh Formulir Prospek Messenger yang Memenuhi Syarat

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X POST "https://graph.facebook.com/v21.0/PAGE_ID/leadgen_forms" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token": "YOUR_PAGE_ACCESS_TOKEN"
           "block_display_for_non_targeted_viewer": "false"
           "name": "LeadAds Form for Messenger Conversation Name"
           "questions": "[
               {"type":"FULL_NAME", "key": "question1"},
               {"type":"EMAIL", "key": "question2"},
               {"type":"PHONE", "key": "question3"},
               {"type":"CUSTOM", "key": "question4" "label": "Do you like rainbows?"}
               {"type":"CUSTOM", "key": "question5" "label": "What is your favorite color?", 
                   "options": [
                       {value: "Red", key: "key1"},
                       {value: "Green", key: "key2"},
                       {value: "Blue", key: "key2"},
                   ]}
           ]"
         }'

Jenis Pertanyaan Tambahan

Selain jenis pertanyaan biasanya yang ditampilkan di [bagian Membuat Formulir Prospek]{#create-a-lead-form}, Anda dapat menambahkan jenis pertanyaan khusus lainnya untuk kasus penggunaan berikut:

  • Penjadwalan Janji Temu—Pertanyaan penjadwalan janji temu me-render pemilihan tanggal dan waktu dengan pilihan jam terbatas dan pesan konfirmasi di bawah pertanyaan.
  • Tanda Pengenal Nasional atau Pemerintah—Pertanyaan Tanda Pengenal nasional me-render pertanyaan berdasarkan negara seseorang dan validasi format ID yang dimasukkan.
  • Pencari Lokasi Toko— Pertanyaan pencari lokasi toko me-render fitur pemilih lokasi toko berdasarkan input kode pos pengguna.

Penjadwalan Janji Temu

Pertanyaan penjadwalan janji temu me-render pemilihan tanggal dan waktu dengan pilihan jam terbatas dan pesan konfirmasi di bawah pertanyaan.

Untuk menambahkan pertanyaan penjadwalan janji temu, tambahkan objek pertanyaan dengan parameter type yang diatur ke DATE_TIME. Secara opsional, Anda juga dapat menambahkan pesan konfirmasi di parameter inline_context yang akan di-render langsung di bawah kolom pertanyaan untuk konteks lebih lanjut, jika perlu.

...
           "questions": "[
               ...
               {"type": "DATE_TIME", 
                "label": "Appointment time", 
                "inline_context": "We will verify and call you to confirm your appointment."
               },
...

Tanda Pengenal Nasional

Pertanyaan Tanda Pengenal nasional me-render pertanyaan berdasarkan negara seseorang dan validasi format ID yang dimasukkan. Pertanyaan ini dapat diajukan untuk negara-negara berikut:

  • Argentina – {"type": "ID_AR_DNI"}
  • Brasil – ID_CPF
  • Cile – ID_CL_RUT
  • Kolombia – ID_CO_CC
  • Ekuador – ID_EC_CI
  • Peru – ID_PE_DNI

Untuk menambahkan pertanyaan Tanda Pengenal nasional, tambahkan objek pertanyaan dengan parameter type yang diatur ke jenis negara orang tersebut.

Batasan

  • Anda hanya dapat meminta satu Tanda Pengenal Nasional dalam bentuk apa pun dan hanya dapat menargetkan orang-orang di negara yang sesuai. Contoh: jika Anda meminta DNI dari Peru, target pemirsa kita harus dibatasi Peru. Hanya iklan yang sesuai dengan kriteria ini yang disetujui.
  • Pemeriksaan validasi untuk format yang valid; itu tidak memverifikasi bahwa Tanda Pengenal tersebut benar-benar milik orang sungguhan.
...
           "questions": "[
               ...
               {"type": "ID_AR_DNI"
               },
...

Pencari Lokasi Toko

Pertanyaan pencari lokasi toko me-render fitur pemilih lokasi toko berdasarkan input kode pos pengguna.

Anda harus mengatur Struktur Halaman Toko untuk menggunakan pertanyaan ini. Pelajari caranya di Menyiapkan Struktur Halaman Toko di Facebook – Pusat Bantuan Bisnis Meta

Untuk menambahkan pertanyaan pencari lokasi toko, tambahkan objek pertanyaan dengan parameter type diatur ke STORE_LOOKUP dan parameter context_provider_type diatur ke LOCATION_MANAGER.

...
           "questions": "[
               ...
               {"type": "STORE_LOOKUP", 
                "label": "Which store do you want to visit?", 
                "context_provider_type": "LOCATION_MANAGER"
               },
...

Pengaturan Formulir Lanjutan

Dapatkan prospek yang berkualitas lebih tinggi dengan menambahkan satu atau beberapa dari pengaturan formulir berikut:

Menambahkan Pelacakan Kinerja

Untuk membantu Anda melacak sumber prospek Anda, tambahkan kolom tracking_parameters, atur ke daftar parameter pasangan kode-nilai yang ingin dilacak, ke formulir Anda. Parameter ini tidak muncul di iklan Anda, tetapi memungkinkan Meta memberi Anda metadata tentang prospek yang dihasilkan dari formulir.

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "tracking_parameters": {"your_tracking_parameter_name":"your_tracking_parameter_value"},
           "questions": "[
...

Menambahkan Pengaturan Niat yang Lebih Tinggi

Secara default, iklan prospek dioptimalkan untuk volume prospek, namun Anda dapat membuat formulir yang menghasilkan prospek dengan niat yang lebih tinggi. Jenis prospek ini bisa untuk orang-orang yang mungkin tertarik pada produk atau layanan tertentu, seperti memesan test drive di dealer. Pengaturan formulir ini menambahkan langkah ke aliran pengajuan formulir di mana seseorang meninjau dan mengonfirmasikan jawaban mereka sebelum orang tersebut mengirimkan formulir.

Untuk menambahkan alur konfirmasi ini ke formulir Anda, tambahkan parameter is_optimized_for_quality yang diatur ke true saat membuat formulir.

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "is_optimized_for_quality": "true",
           "questions": "[
...

Memfilter Prospek Organik

Untuk memfilter prospek organik, tambahkan parameter block_display_for_non_targeted_viewer ke true saat Anda membuat formulir.

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
...
           "name": "YOUR_LEADADS_FORM_NAME",
           "block_display_for_non_targeted_viewer": "true",
           "questions": "[
...

Contoh Tanggapan

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berisi ID untuk formulir yang akan digunakan saat membuat iklan Anda.

{
  "id": "leadgen_form_id",
}

Langkah 4. Buat Materi Iklan

Untuk membuat materi iklan dengan gambar dan formulir Anda, kirim permintaan POST ke endpoint /act_AD_ACCOUNT_ID/adcreatives dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • object_story_spec yang menyertakan objek link_data dengan parameter berikut:
    • call_to_action diatur ke objek yang berisi type dan value diatur ke ID formulir prospek Anda
    • description diatur ke deskripsi materi iklan Anda
    • image_hash diatur ke hash untuk gambar materi iklan Anda
    • message diatur ke teks materi iklan Anda
  • page_id diatur ke ID Halaman Facebook Anda

Catatan: Saat membuat link_data, nilai terkait kolom link hanya dapat berupa https//fb.me/.

Parameter link_data.call_to_action harus diatur ke salah satu dari nilai berikut:

  • APPLY_NOW
  • DOWNLOAD
  • GET_QUOTE
  • LEARN_MORE
  • SIGN_UP
  • SUBSCRIBE

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai yang dicetak tebal, dicetak miring, seperti AD_ACCOUNT_ID, dengan nilai Anda.
curl -X POST "https://graph.facebook.com/LATEST-API-VERSION/act_AD_ACCOUNT_ID/adcreatives" \
     -H "Content-Type: application/json" \
     -d '{
           "access_token":"YOUR_PAGE_ACCESS_TOKEN",
           "object_story_spec":{ 
             "link_data": { 
               "call_to_action": {
                 "type":"SIGN_UP",
                 "value":{
                   "lead_gen_form_id":"YOUR_FORM_ID"
                 }
               }, 
               "description": "YOUR_AD_CREATIVE_DESCRIPTION", 
               "image_hash": "YOUR_IMAGE_HASH", 
               "link": "http:\/\/fb.me\/", 
               "message": "YOUR_AD_CREATIVE_MESSAGE" 
             }, 
           "page_id": "YOUR_PAGE_ID" 
         }'
  

Anda dapat membuat iklan prospek carousel menggunakan object_story_spec yang sama, namun dengan kolom lead_gen_form_id tambahan yang ditentukan dalam parameter child_attachments.

Anda hanya dapat menentukan <FORM_ID> yang sama untuk semua lampiran turunan.

curl \
  -F 'object_story_spec={ 
    "page_id": "<PAGE_ID>", 
    "link_data": { 
      "message": "My description", 
      "link": "http:\/\/www.google.com", 
      "caption": "WWW.EXAMPLE.COM", 
      "child_attachments": [ 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        }, 
        { 
          "link": "http:\/\/www.google.com", 
          "image_hash": "<IMAGE_HASH>", 
          "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
        } 
      ], 
      "multi_share_optimized": true, 
      "call_to_action": {"type":"SIGN_UP","value":{"lead_gen_form_id":"<FORM_ID>"}} 
    } 
  }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/LATEST-API-VERSION/act_<AD_ACCOUNT_ID>/adcreatives

Dengan Video

Anda juga dapat menggunakan video di materi iklan utama dan bukan foto. Pertama, unggah video ke galeri video iklan, lalu gunakanlah dalam parameter object_story_spec:

curl -X POST \
  -F 'object_story_spec={
       "page_id": "<PAGE_ID>",
       "video_data": {
         "link_description": "try it out",
         "image_url": "<IMAGE_URL>",
         "video_id": "<VIDEO_ID>",
         "call_to_action": {
           "type": "SIGN_UP",
           "value": {
             "link": "http://fb.me/",
             "lead_gen_form_id": "<FORM_ID>"
           }
         }
       }
     }' \
  -F 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adcreatives

Contoh Tanggapan Materi Iklan

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berikut dengan ID materi iklan.

{
  "id": "YOUR_AD_CREATIVE_ID"
}
      

Untuk membuat iklan, Anda perlu menghubungkan materi iklan dan set iklan. Untuk membuat iklan, kirim permintaan POST ke endpoint /act_AD_ACCOUNT_ID/ads. Permintaan Anda harus menyertakan:

  • access_token yang diatur ke token akses Halaman
  • adset_id (dari Langkah 2)
  • creative_id (dari Langkah 4)
  • nama
  • status

Contoh Permintaan Iklan dengan Materi Iklan

Diformat agar mudah dibaca. Ganti nilai yang dicetak tebal, dicetak miring, seperti AD_ACCOUNT_ID, dengan nilai Anda.
curl -X POST "https://graph.facebook.com/v21.0/act_AD_ACCOUNT_ID/ads"
     -H "Content-Type: application/json" 
     -d '{
           "access_token"="YOUR_PAGE_ACCESS_TOKEN",
           "name":"YOUR_LEADADS_AD_NAME",
           "adset_id"="YOUR_AD_SET_ID",
           "creative"={ "creative_id": "YOUR_AD_CREATIVE_ID" },
           "status"="PAUSED"
         }'

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berikut dengan ID iklan.

{
  "id": "YOUR_AD_ID"
}

Langkah 6. Terbitkan iklan Anda

Verifikasikan bahwa iklan Anda ada di pengelola iklan. Klik tombol Tinjau dan terbitkan di pojok kanan atas. Pilih kampanye, set iklan untuk kampanye, dan iklan.

Anda dapat menerbitkan iklan Anda dari pengelola iklan atau menggunakan API. Untuk menerbitkan dengan menggunakan API, ulangi Langkah 4 dengan parameter status diatur ke ACTIVE.

Iklan Anda akan ditinjau oleh Meta dan statusnya akan PENDING_REVIEW. Setelah disetujui, statusnya akan ACTIVE dan iklan Anda akan ditayangkan.

Pengelolaan Formulir

Dapatkan daftar formulir Anda, pertanyaan formulir tertentu, dan arsipkan formulir lama.

Mendapatkan Daftar Formulir

Untuk mendapatkan daftar formulir penciptaan prospek, kirim permintaan GET ke endpoint /page_id/leadgen_forms dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • fields (opsional) diatur ke daftar kolom yang dipisahkan koma untuk mendapatkan informasi spesifik, seperti nama dan ID formulir

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X GET "https://graph.facebook.com/v21.0/PAGE_ID/leadgen_forms
    ?fields=name,id
    &access_token": "YOUR_PAGE_ACCESS_TOKEN"

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berisi daftar formulir Anda. Anda dapat menggunakan ID formulir untuk mendapatkan pertanyaan untuk formulir tersebut atau untuk mengarsipkan formulir tersebut.

Mendapatkan Daftar Formulir yang Memenuhi Syarat untuk Messenger

Hanya formulir berisipersyaratan tertentu yang memenuhi syarat untuk dikirim dalam percakapan Messenger.

Untuk mendapatkan daftar formulir prospek yang memenuhi syarat, kirim permintaan GET ke endpoint /page_id/leadgen_forms dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • fields diatur ke is_eligible_for_in_thread_forms

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X GET "https://graph.facebook.com/v21.0/PAGE_ID/leadgen_forms
    ?fields=is_eligible_for_in_thread_forms
    &access_token": "YOUR_PAGE_ACCESS_TOKEN"

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berisi daftar ID untuk formulir yang memenuhi syarat.

{
  "data": [
    {
      "id": "eligible_form_1_id"
    },
    {
      "id": "eligible_form_2_id"
    }
  ],
...
}

Mendapatkan Daftar Pertanyaan

Untuk mendapatkan daftar pertanyaan untuk formulir penciptaan prospek spesifik, kirim permintaan GET ke endpoint /page_id/leadgen_form_id dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • fields diatur ke questions

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X GET "https://graph.facebook.com/v21.0/page_id/leadgen_form_id
    ?fields=questions
    &access_token=page_access_token"

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berisi daftar pertanyaan.

Mengarsipkan Formulir

Anda hanya dapat mengarsipkan formulir prospek karena menghapus tidak didukung. Setelah formulir diarsipkan:

  • Formulir tidak akan muncul (secara default) di Galeri Formulir
  • Anda tidak dapat menggunakan formulir yang diarsipkan dalam iklan, mencoba melakukannya dapat menghasilkan kesalahan melalui API.
  • Formulir yang diarsipkan tidak akan tersedia selama pembuatan iklan untuk CF atau PE.

Untuk mengarsipkan formulir penciptaan prospek spesifik, kirim permintaan POST ke endpoint /page_id/leadgen_form_id dengan parameter berikut:

  • access_token yang diatur ke token akses Halaman
  • status diatur ke ARCHIVED

Contoh Permintaan

Diformat agar mudah dibaca. Ganti nilai tebal, miring dengan nilai Anda.
curl -X GET "https://graph.facebook.com/v21.0/page_id/leadgen_form_id
    ?status=ARCHIVED
    &access_token=page_access_token"

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON berisi objek dengan success diatur ke true.

Formulir yang diarsipkan dapat diaktifkan ulang melalui pengiriman permintaan dengan status diatur ke ACTIVE.