Marketing API

Iklan yang Klik ke WhatsApp

Panduan ini menjelaskan cara membuat dan menerbitkan iklan yang Mengeklik ke WhatsApp menggunakan Marketing API.

Iklan yang klik ke WhatsApp mengarahkan orang yang mengeklik iklan Anda langsung ke percakapan dengan bisnis Anda di WhatsApp. Gunakan iklan ini untuk menjangkau orang dalam skala besar dan memberikan layanan individual yang menonjol.

Iklan yang mengeklik ke WhatsApp mendukung iklan dengan gambar, video, carousel, atau tayangan slide. Anda juga dapat menyertakan perintah panggilan di iklan Anda.

Jika Anda tertarik untuk membuat iklan yang mengarahkan orang ke obrolan Messenger atau Instagram, lihat Iklan yang Mengeklik ke Messenger atau Iklan yang Mengeklik ke Instagram untuk panduannya. Anda juga dapat membuat iklan yang memilih destinasi yang paling mungkin akan ditanggapi oleh pengguna, lihat Iklan yang Mengeklik ke Multidestinasi untuk informasi selengkapnya.

Ringkasan Pembuatan Iklan

Dokumen ini menjelaskan langkah-langkah yang perlu diikuti untuk menyiapkan integrasi Anda untuk iklan klik ke WhatsApp.

Anda akan perlu:

  1. Membuat kampanye iklan
  2. Membuat set iklan yang menautkan iklan Anda ke kampanye iklan Anda
  3. Membuat materi iklan untuk jenis iklan WhatsApp yang ingin Anda sajikan
  4. Membuat iklan dengan menautkan materi iklan ke set iklan Anda
  5. Menerbitkan iklan Anda ke Facebook, Instagram, dan Messenger

Sebelum Memulai

Panduan ini berasumsi Anda memiliki:

Untuk membuat panggilan yang berhasil ke semua endpoint dalam panduan ini, Anda akan membutuhkan:

  • Token akses Halaman yang diminta oleh orang yang dapat melakukan tugas ADVERTISE di Halaman
  • Izin berikut harus diberikan kepada orang yang menggunakan aplikasi Anda:
    • ads_management
    • pages_manage_ads
    • pages_read_engagement
    • pages_show_list

Langkah 1: Buat kampanye iklan

Mulailah dengan membuat kampanye iklan Anda. Untuk melakukan ini, buat permintaan POST ke endpoint /act_<AD_ACCOUNT_ID>/campaigns dengan <AD_ACCOUNT_ID> adalah ID akun iklan Meta Anda. Permintaan Anda harus menyertakan:

Parameter

NamaDeskripsi

name

string

Wajib.
Nama kampanye klik ke WhatsApp.

objective

enum

Wajib.
Tujuan kampanye.
Tujuan yang didukung adalah OUTCOME_ENGAGEMENT, OUTCOME_SALES, dan OUTCOME_TRAFFIC.
Catatan: Untuk kampanye dengan permintaan panggilan, objective harus merupakan OUTCOME_ENGAGEMENT.

special_ad_categories

list<Object>

Wajib.
Kategori iklan khusus yang terkait dengan kampanye klik ke WhatsApp. Lihat referensi Kampanye Iklan untuk detail selengkapnya.

status

enum

Opsional.
Opsi yang valid adalah PAUSED dan ACTIVE.
Jika status ini PAUSED, semua set iklan dan iklan yang aktif akan dijeda dan memiliki status efektif CAMPAIGN_PAUSED.

Permintaan Standar

curl -X POST \
  -F 'name=Click to WhatsApp Campaign' \
  -F 'objective=OUTCOME_ENGAGEMENT' \
  -F 'status=ACTIVE' \
  -F 'special_ad_categories=[]' \
  -F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/campaigns

Permintaan Kampanye Panggilan

curl -X POST \
  -F 'name=Click to WhatsApp Calling Campaign' \
  -F 'objective=OUTCOME_ENGAGEMENT' \
  -F 'status=PAUSED' \
  -F 'special_ad_categories=[]' \
  -F 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/campaigns

Tanggapan

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON dengan ID kampanye yang baru Anda buat.

{
  "id": "<AD_CAMPAIGN_ID>"
}

Memperbarui

Anda dapat memperbarui kampanye dengan membuat permintaan POST ke /<AD_CAMPAIGN_ID>.

Membaca

Untuk memastikan bahwa Anda telah berhasil membuat kampanye klik ke WhatsApp, Anda dapat membuat permintaan GET ke /<AD_CAMPAIGN_ID>. Lihat referensi Kampanye Iklan untuk daftar lengkap parameter yang tersedia.

Permintaan

curl -X GET -G \
  -d 'fields=name,status,objective' \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_CAMPAIGN_ID>

Tanggapan

{
  "name": "Click to WhatsApp Campaign",
  "status": "PAUSED",
  "objective": "OUTCOME_ENGAGEMENT",
  "id": "<AD_CAMPAIGN_ID>"
}

Langkah 2: Buat set iklan

Setelah Anda memiliki kampanye iklan, buat set iklan. Untuk membuat set iklan, buat permintaan POST ke endpoint /act_<AD_ACCOUNT_ID>/adsets dengan <AD_ACCOUNT_ID> adalah ID akun iklan Meta Anda. Permintaan Anda harus menyertakan:

Parameter

NamaDeskripsi

bid_amount

int32 yang tidak bertanda tangan

Wajib jika bid_strategy diatur ke LOWEST_COST_WITH_BID_CAP atau COST_CAP.
Jumlah maksimum yang Anda mau bayar untuk hasil berdasarkan pada optimization_goal Anda.

bid_strategy

enum

Opsional.
Pilih strategi tawaran kampanye ini yang sesuai dengan tujuan bisnis spesifik Anda. Lihat referensi Kampanye Iklan untuk detail selengkapnya.
Nilai:LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP

billing_event

enum

Wajib.
Harus diatur ke IMPRESSIONS untuk iklan yang mengeklik ke WhatsApp. Meta menagih Anda saat iklan Anda ditampilkan kepada orang-orang.

campaign_id

string numerik atau integer

Wajib.
Kampanye klik ke WhatsApp yang valid sebagai tujuan penambahan set iklan ini.

daily_budget

int64

Wajib jika lifetime_budget belum diatur.
Anggaran harian ditentukan dalam mata uang akun Anda. Hanya diizinkan untuk set iklan dengan durasi (perbedaan antara end_time dan start_time) lebih dari 24 jam.
daily_budget atau lifetime_budget harus lebih besar dari 0.

destination_type

string

Wajib.
Atur ke WHATSAPP untuk iklan klik ke WhatsApp berdestinasi tunggal.

end_time

datetime

Wajib saat lifetime_budget ditentukan.
Ketika membuat set iklan dengan daily_budget, tentukan end_time=0 atau kosongkan kolom ini untuk mengatur set iklan sebagai "ongoing" (sedang berlangsung) tanpa tanggal akhir.
Contoh:2015-03-12 23:59:59-07:00 atau 2015-03-12 23:59:59 PDT. Cap waktu UNIX UTC.

lifetime_budget

int64

Wajib jika daily_budget tidak diatur.
Anggaran sepanjang masa dari set iklan ditentukan dalam mata uang akun Anda. Jika ditentukan, Anda juga harus menentukan end_time.
daily_budget atau lifetime_budget harus lebih besar dari 0.

name

string

Wajib.
Nama set iklan klik ke WhatsApp.

optimization_goal

enum

Wajib.
Untuk apa/siapa set iklan dioptimalkan. Tergantung pada tujuan kampanye, set iklan mungkin memenuhi syarat untuk tujuan pengoptimalan yang berbeda.


OUTCOME_ENGAGEMENT: Tujuan interaksi dapat dioptimalkan untuk CONVERSATIONS, dan LINK_CLICKS.
OUTCOME_SALES: Tujuan penjualan dapat dioptimalkan untuk CONVERSATIONS, OFFSITE_CONVERSIONS, LINK_CLICKS, IMPRESSIONS, dan REACH.
OUTCOME_TRAFFIC: Tujuan traffic dapat dioptimalkan untuk CONVERSATIONS, LANDING_PAGE_VIEWS, LINK_CLICKS, IMPRESSIONS, REACH, dan POST_ENGAGEMENT.

promoted_object

Wajib.
Objek yang dipromosikan set iklan ini di semua iklannya. Untuk iklan yang mengeklik ke WhatsApp, promoted_object memiliki ketentuan sebagai berikut:

Wajib:

  • page_id: Wajib. ID Halaman Facebook.

Opsional:

  • whatsapp_phone_number: Nomor telepon WhatsApp yang terkait dengan set iklan klik ke WhatsApp.

Lihat Set Iklan, Objek Dipromosikan untuk detail selengkapnya.

start_time

datetime

Opsional.
Waktu mulai set iklan. Default kolom ini adalah waktu saat ini jika tidak ada nilai yang disediakan.
Contoh:2015-03-12 23:59:59-07:00 atau 2015-03-12 23:59:59 PDT. Cap waktu UNIX UTC.

status

enum

Opsional.
Status set iklan. Status ini bisa berbeda dari status efektif karena kampanye induknya. Kolom ini akan diatur default ke ACTIVE jika tidak ada nilai yang disediakan.
Nilai:ACTIVE, PAUSED, DELETED, ARCHIVED

targeting

Objek penargetan

Wajib.
Struktur penargetan iklan yang mengeklik ke WhatsApp. Lihat Penargetan untuk detail selengkapnya.

time_start

datetime

Opsional.
Dapat ditukarkan dengan start_time.

time_stop

datetime

Wajib jika lifetime_budget ditentukan.
Dapat bertukar dengan end_time.

Kunjungi referensi Set Iklan Akun Iklan kami untuk daftar lengkap parameter yang tersedia.

Permintaan

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
    "access_token":"<ACCESS_TOKEN>",
    "bid_amount":"<BID_AMOUNT>",
    "billing_event":"IMPRESSIONS",
    "campaign_id":"<CAMPAIGN_ID>",
    "daily_budget":"<DAILY_BUDGET>",
    "destination_type":"WHATSAPP",
    "name": "<AD_SET_NAME>",
    "optimization_goal": "IMPRESSIONS",
    "promoted_object": {
      "page_id": "<PAGE_ID>"
    },
    "status": "PAUSED",
    "start_time": "<START_TIME>",
    "targeting": { 
      "geo_locations": { "countries":["US","CA"] },
      "device_platforms": ["mobile", "desktop"]
    } 
  }' \
"https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adsets"

Tanggapan

{
  "id": "<AD_SET_ID>"
}

Memperbarui

Anda dapat memperbarui set iklan dengan membuat permintaan POST ke /<AD_SET_ID>.

Membaca

Untuk memastikan bahwa Anda telah berhasil membuat set iklan klik ke WhatsApp, Anda dapat membuat permintaan GET ke /<AD_SET_ID>. Lihat referensi Set Iklan untuk daftar lengkap parameter yang tersedia.

Permintaan

curl -X GET -G \
  -d 'fields=name,destination_type,optimization_goal,bid_strategy,status' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/<AD_SET_ID>

Tanggapan

{
  "name": "Click to WhatsApp Campaign",
  "status": "PAUSED",
  "objective": "OUTCOME_ENGAGEMENT",
  "id": "<AD_SET_ID>"
}

Langkah 3: Buat materi iklan

Dengan materi iklan, Anda dapat menambahkan aset ke iklan Anda. Untuk membuat materi iklan, buat permintaan POST ke endpoint /act_<AD_ACCOUNT_ID>/adcreatives dengan <AD_ACCOUNT_ID> adalah ID akun iklan Meta Anda. Permintaan Anda harus menyertakan:

Parameter

NamaDeskripsi

name

string

Wajib.
Nama untuk materi iklan Anda.

object_story_spec

Wajib.
Objek yang berisi informasi tentang pesan. Lihat Spesifikasi Cerita Objek Materi Iklan untuk detail selengkapnya.


Wajib:

  • page_id: ID Halaman Facebook

Opsional:

  • link_data: Spesifikasi untuk postingan halaman tautan atau iklan carousel
  • photo_data: Spesifikasi untuk postingan halaman foto
  • text_data: Spesifikasi untuk postingan halaman teks
  • video_data: Spesifikasi untuk postingan halaman video

degrees_of_freedom_spec

Opsional.
Lihat Penyempurnaan Standar untuk Materi Iklan Advantage+ untuk detail selengkapnya.

Kunjungi referensi Materi Iklan untuk daftar lengkap parameter yang tersedia.

Mengisi pesan selamat datang di Halaman

Pesan default yang dilihat pelanggan adalah "Halo! Bisakah minta info lebih lanjut tentang ini?". Anda dapat membuat pengalaman pengguna yang lebih disesuaikan untuk iklan Anda yang mengeklik ke WhatsApp dengan menyesuaikan pesan salam iklan di kolom page_welcome_message di bawah object_story_spec.

Catatan: Jika Anda menggunakan pesan WhatsApp untuk memicu alur bot, pastikan untuk bekerja sama dengan BSP dan agensi Anda untuk memperbaruinya agar alur tidak terganggu.

Contoh

Menambahkan pesan isi otomatis dengan pesan salam

"page_welcome_message": {
  "type": "VISUAL_EDITOR",
  "version": 2,
  "landing_screen_type": "welcome_message",
  "media_type": "text",
  "text_format": {
    "customer_action_type": "autofill_message",
    "message": {
      "autofill_message": {
        "content": "<AUTOFILL_MESSAGE>"
      },
      "text": "<GREETING_MESSAGE>"
    }
  }
}

Menambahkan pencair suasana dengan pesan salam

"page_welcome_message": {
  "type": "VISUAL_EDITOR",
  "version": 2,
  "landing_screen_type": "welcome_message",
    "media_type": "text",
    "text_format": {
      "customer_action_type": "ice_breakers",
      "message": {
        "text": "<GREETING_MESSAGE>",
        "ice_breakers": [
          {
            "title": "<ICEBREAKER>"
          },
          {
            "title": "<ICEBREAKER>"
          },
          {
            "title": "<ICEBREAKER>"
          }
        ]
      }
    }
  }
}

Menambahkan pesan dengan permintaan panggilan

curl \
  -F 'object_story_spec={
      "page_id": "<PAGE_ID>"
      "link_data": {
     "image_hash":<IMAGE_HASH>
            "call_to_action": {
              	"type": "WHATSAPP_MESSAGE",
              	"value": {
                  	"app_destination": "WHATSAPP"
             	 }
          },
          "link": "https://api.whatsapp.com/send",
          "name": <AD_HEADLINE>",
          "page_welcome_message":
       "type": "VISUAL_EDITOR",
        "version": 2,
        "landing_screen_type": "ctwa_call_prompt",
        "media_type": "text",
        "text_format": {
          "message": {
            "text": "<MESSAGE>"", 
            "call_prompt_data": {
              "call_prompt_message": "<CALL_PROMPT_MESSAGE>"
            }
          }
        },
        "user_edit": false
      },
  https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adcreatives

Tanggapan

{
  "id": "<AD_CREATIVE_ID>"
}

Contoh membuat materi iklan

Permintaan

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Sample ad creative",
        "object_story_spec": {
          "page_id": "<PAGE_ID>",
          "link_data": {
            "name": "<AD_HEADLINE>",
            "message": "<AD_PRIMARY_TEXT>",
            "description": "<AD_DESCRIPTION>",
            "image_hash": "<IMAGE_HASH>",
            "link": "https://api.whatsapp.com/send",
            "page_welcome_message": "<PAGE_WELCOME_MESSAGE>",
            "call_to_action": {
              "type": "WHATSAPP_MESSAGE",
              "value": {
                "app_destination": "WHATSAPP"
              }
            }
          }
        },
        "degrees_of_freedom_spec": {
          "creative_features_spec": {
            "standard_enhancements": {
              "enroll_status": "OPT_IN"
            }
          }
        }
      }' \
"https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/adcreatives"

Tanggapan

Setelah berhasil, aplikasi Anda akan menerima tanggapan JSON dengan ID materi iklan yang baru Anda buat.

{
  "id": "<AD_CREATIVE_ID>"
}

Membuat materi iklan menggunakan konten Instagram

Anda juga dapat menggunakan konten Instagram yang ada untuk materi iklan Anda.

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
        "source_instagram_media_id": "<INSTAGRAM_MEDIA_ID>",
        "instagram_user_id": "<INSTAGRAM_USER_ID>",
        "object_id": "<PAGE_ID>",
        "call_to_action": {
          "type": "WHATSAPP_MESSAGE",
            "value": {
              "link": "https://api.whatsapp.com/send",
              "app_destination": "WHATSAPP"
            }
          }
        },
        "degrees_of_freedom_spec": {
          "creative_features_spec": {
            "standard_enhancements": {
              "enroll_status": "OPT_IN"
            }
          }
        }
      }' \
  https://graph.facebook.com/latest-api-version />/act_<AD_ACCOUNT_ID>/adcreatives

Memperbarui

Anda dapat memperbarui materi iklan dengan membuat permintaan POST ke /<AD_CREATIVE_ID>.

Membaca

Untuk memastikan bahwa Anda telah berhasil membuat materi iklan klik ke WhatsApp, Anda dapat membuat permintaan GET ke /<AD_CREATIVE_ID>. Lihat Materi Iklan untuk daftar lengkap parameter yang tersedia.

Permintaan

curl -X GET -G \
  -d 'fields=name,object_story_spec{link_data{call_to_action,page_welcome_message}}' \
  -d 'access_token=<ACCESS_TOKEN>' \
  https://graph.facebook.com/v21.0/<AD_CREATIVE_ID>

Tanggapan

{
  "name": "Sample ad creative",
  "object_story_spec" {
    "page_welcome_message": {
      "type": "VISUAL_EDITOR",
      "version": 2,
      "landing_screen_type": "welcome_message",
      "media_type": "text",
      "text_format": {
        "customer_action_type": "autofill_message",
        "message": {
          "autofill_message": {
            "content": "Sample autofill message"
          },
        "text": "Sample greeting message"
        }
      }
    }
  },
  "id": "<AD_CREATIVE_ID>"
}

Langkah 4: Buat iklan

Iklan memungkinkan Anda untuk menghubungkan informasi materi iklan dengan set iklan Anda. Untuk membuat iklan, buat permintaan POST ke endpoint /act_<AD_ACCOUNT_ID>/ads dengan <AD_ACCOUNT_ID> adalah ID akun iklan Meta Anda. Permintaan Anda harus menyertakan:

Parameter

NamaDeskripsi

name

string

Wajib.
Nama untuk iklan Anda.

adset_id

string numerik atau integer

Wajib.
ID set iklan.

creative

Wajib.
Materi iklan yang akan digunakan oleh iklan ini. Anda dapat menyediakan creative_id dari materi iklan yang ada atau membuat materi iklan baru dengan menyertakan semua kolom wajib. Lihat Materi Iklan untuk detail selengkapnya.

status

enum

Wajib.
Status iklan yang terkonfigurasi.
Nilai:ACTIVE, PAUSED, DELETED, ARCHIVED

Permintaan

curl -X POST \
  -H "Content-Type: application/json" \
  -d '{
        "name": "Sample ad",
        "adset_id": "<AD_SET_ID>",
        "creative": {
          "creative_id": "<AD_CREATIVE_ID>"
        },
        "status": "PAUSED"
     }' \
  "https://graph.facebook.com/v21.0/act_<AD_ACCOUNT_ID>/ads"

Tanggapan

{
  "id": "<AD_ID>"
}

Memperbarui

Anda dapat memperbarui iklan dengan membuat permintaan POST ke /<AD_ID>.

Membaca

Untuk memastikan bahwa Anda telah berhasil membuat iklan klik ke WhatsApp, Anda dapat membuat permintaan GET ke /<AD_ID>. Lihat referensi iklan untuk daftar lengkap parameter yang tersedia.

Permintaan

curl -X GET -G \
  -d 'fields=status,adset_id,campaign_id \
  -d 'access_token=<ACCESS_TOKEN>' \
https://graph.facebook.com/v21.0/<AD_ID>

Tanggapan

{
  "status": "PAUSED",
  "adset_id": "<AD_SET_ID>",
  "campaign_id": "<AD_CAMPAIGN_ID>",
  "id": "<AD_ID>"
}

Langkah 5: Terbitkan Iklan Anda

Verifikasikan iklan Anda ada di Pengelola Iklan. Saat Anda siap untuk menerbitkan perubahan Anda, pilih kampanye Anda, set iklan untuk kampanye, dan iklan, lalu klik tombol Terbitkan.

Anda juga dapat menerbitkan iklan Anda menggunakan API. Cukup kirim permintaan POST ke /<AD_ID> dengan parameter status diatur ke ACTIVE dengan <AD_ID> adalah iklan yang ingin Anda terbitkan.

Iklan Anda akan ditinjau oleh Meta dan statusnya akan PENDING_REVIEW. Setelah disetujui, status akan secara otomatis diperbarui ke ACTIVE, dan iklan Anda akan ditayangkan.