Spesifikasi Evaluasi

Tujuan utama evaluation_spec sebuah aturan adalah untuk menentukan objek yang akan menjadi sasaran eksekusi aturan. evaluation_type menentukan jenis metode evaluasi dan memiliki opsi berikut:

Jenis Evaluasi	Deskripsi
`SCHEDULE`	Untuk Aturan Berbasis Jadwal
`TRIGGER`	Untuk Aturan Berbasis Pemicu

evaluation_spec berisi array filters, yang memungkinkan Anda lebih mempersempit daftar objek yang cocok. Misalnya, Anda dapat membuat filter pada metrik Insight dan metadata iklan, set iklan, serta kampanye iklan. Semua filter dievaluasi bersama-sama dengan menggunakan operator AND.

Array filters berisi daftar objek filter. Objek ini adalah kamus dengan kunci field, value, dan operator:

Kunci Objek Filter Deskripsi

Kunci Objek Filter	Deskripsi
`field`	Wajib. Kolom filter, seperti data Insight atau metadata
`value`	Wajib. Nilai filter statis untuk kolom
`operator`	Wajib. Operator logika untuk kolom

field

Wajib.

Kolom filter, seperti data Insight atau metadata

value

Wajib.

Nilai filter statis untuk kolom

operator

Wajib.

Operator logika untuk kolom

Setiap filter memiliki daftar operator logika yang didukung. Berikut operator logika yang didukung dalam aturan SCHEDULE dan TRIGGER:

Operator Logika	Nilai (Contoh)
`GREATER_THAN`	numerik (100)
`LESS_THAN`	numerik (100)
`EQUAL`	numerik (100)
`NOT_EQUAL`	numerik (100)
`IN_RANGE`	tupel ([100, 200])
`NOT_IN_RANGE`	tupel ([100, 200])
`IN`	daftar (["1", "2", "3"])
`NOT_IN`	daftar (["1", "2", "3"])
`CONTAIN`	string ("ABC")
`NOT_CONTAIN`	string ("ABC")
`ANY`	daftar ([1, 2, 3])
`ALL`	daftar ([1, 2, 3])
`NONE`	daftar ([1, 2, 3])

evaluation_spec memerlukan trigger untuk jenis evaluasi TRIGGER. Pemicu berisi jenis dan spesifikasi filter yang mendasari. Spesifikasi filter dapat berupa field, value, dan operator.

Pemicu secara dinamis menentukan apakah kita harus mengevaluasi aturan atau tidak, dan hanya boleh ada satu. Lihat Aturan Berbasis Pemicu untuk informasi selengkapnya.

Di bawah ini kami mendefinisikan beberapa filter khusus dan grup filter umum yang dapat Anda gunakan.

Filter Khusus

`time_preset`

Filter time_preset menentukan periode waktu saat kita mengumpulkan metrik Insight. Saat ini, kami hanya mengizinkan satu time_preset. Ini berlaku untuk semua filter statistik dalam aturan, termasuk yang digunakan untuk pemicunya, jika ada.

Satu-satunya operator yang didukung untuk time_preset adalah EQUAL, dan ini diperlukan selama filter atau pemicu Insight ada. Aturan Berbasis Pemicu hanya mendukung preset waktu yang menyertakan TODAY karena melakukan evaluasi real-time.

Preset waktu untuk aturan dapat berperilaku berbeda dari antarmuka lain. Beberapa preset waktu di sini termasuk data hari ini. Ini karena data saat ini sangat penting untuk aturan yang frekuensinya lebih kerap dari harian. Untuk antarmuka lainnya, nilai preset LAST_N_DAYS umumnya tidak termasuk data hari ini. Lihat deskripsi di bawah ini untuk mengetahui detailnya.

{
  "field": "time_preset",
  "value": "TODAY",
  "operator": "EQUAL"
}

Nilai Preset Waktu	Deskripsi
`LIFETIME`	Masa aktif objek
`TODAY`	Hari ini mulai dari tengah malam dalam zona waktu akun iklan
`LAST_2_DAYS`	`YESTERDAY` dan `TODAY`
`LAST_3_DAYS`	2 hari penuh terakhir dan `TODAY`
`LAST_7_DAYS`	6 hari penuh terakhir dan `TODAY`
`LAST_14_DAYS`	13 hari penuh terakhir dan `TODAY`
`LAST_28_DAYS`	27 hari penuh terakhir dan `TODAY`
`LAST_30_DAYS`	29 hari penuh terakhir dan `TODAY`
`THIS_MONTH`	Bulan ini, termasuk `TODAY`
`THIS_WEEK_MON_TODAY`	Minggu ini dengan hari Senin sebagai hari pertama dalam seminggu, termasuk `TODAY`
`THIS_WEEK_SUN_TODAY`	Minggu ini dengan hari Minggu sebagai hari pertama dalam seminggu, termasuk `TODAY`
`YESTERDAY`	Satu hari penuh sebelumnya, tidak termasuk `TODAY`
`LAST_2D`	2 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_3D`	3 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_7D`	7 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_14D`	14 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_28D`	28 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_30D`	30 hari penuh terakhir, tidak termasuk `TODAY`
`LAST_ND_14_8`	14 hari terakhir hingga 7 hari terakhir, untuk ROAS
`LAST_ND_30_8`	30 hari terakhir hingga 7 hari terakhir, untuk ROAS
`LAST_ND_60_8`	60 hari terakhir hingga 7 hari terakhir, untuk ROAS
`LAST_ND_120_8`	120 hari terakhir hingga 7 hari terakhir, untuk ROAS
`LAST_ND_180_8`	180 hari terakhir hingga 7 hari terakhir, untuk ROAS
`LAST_ND_LIFETIME_8`	Masa aktif hingga 7 hari terakhir, untuk ROAS
`LAST_ND_60_29`	60 hari terakhir hingga 28 hari terakhir, untuk ROAS
`LAST_ND_120_29`	120 hari terakhir hingga 28 hari terakhir, untuk ROAS
`LAST_ND_180_29`	180 hari terakhir hingga 28 hari terakhir, untuk ROAS
`LAST_ND_LIFETIME_29`	Masa aktif hingga 28 hari terakhir, untuk ROAS

`attribution_window`

Filter attribution_window menentukan periode kilas balik saat metrik Insight dikumpulkan. Untuk informasi selengkapnya, lihat Dokumentasi Insights di Jendela Atribusi.

Saat ini, kami hanya mengizinkan satu attribution_window, dan Ini berlaku untuk semua filter statistik dalam aturan. Satu-satunya operator yang didukung untuk attribution_window adalah EQUAL, dan ini hanya didukung oleh Aturan Berbasis Jadwal.

Mau ditentukan atau tidak, satu-satunya value yang diizinkan untuk attribution_window adalah ACCOUNT_DEFAULT.

{
  "field": "attribution_window",
  "value": "ACCOUNT_DEFAULT",
  "operator": "EQUAL"
}

Nilai Jendela Atribusi	Deskripsi
`ACCOUNT_DEFAULT`	Menggunakan pengaturan jendela atribusi level akun

Filter Metadata

Dengan filter metadata, Anda dapat memfilter objek berdasarkan status kolom metadatanya saat ini. Ini juga mendukung pemfilteran multi-level, yang berarti Anda dapat menggunakan awalan untuk menerapkan filter metadata pada induk atau kakek-nenek objek. Hal ini tidak memengaruhi filter lainnya. Filter Insight masih berlaku untuk objek normal.

Semua filter metadata didukung untuk Aturan Terjadwal, tetapi hanya subset yang didukung untuk Aturan Pemicu.

Misalnya, jika Anda menginginkan aturan yang berlaku untuk set iklan dalam kampanye iklan yang tujuannya adalah WEBSITE_CLICKS, Anda dapat menyertakan dua filter:

 "filters" : [
  {
    "field": "entity_type",
    "value": "ADSET",
    "operator": "EQUAL",
  },
  {
    "field": "campaign.objective",
    "value": "WEBSITE_CLICKS",
    "operator": "EQUAL"
  }
]

Filter Metadata yang didukung oleh aturan Berbasis Jadwal dan Pemicu

Kolom Metadata	Deskripsi
`id`*	Objek statis tertentu yang aturannya diterapkan. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`int`, `array(int)` Operator yang Didukung:`EQUAL`, `IN`, `NOT_IN`
`entity_type`*	Level objek yang aturannya diterapkan. Awalan yang Didukung: tidak ada Nilai yang Didukung:`AD`, `ADSET`, `CAMPAIGN` Operator yang Didukung:`EQUAL`
`name`	Nama objek, berdasarkan kecocokan sebagian atau sepenuhnya. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`string` Operator yang Didukung:`EQUAL`, `CONTAIN`, `NOT_CONTAIN`
`adlabel_ids`	ID label iklan objek. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`array(int)` Operator yang Didukung:`ANY`, `ALL`, `NONE`
`objective`	Tujuan kampanye iklan objek. Awalan yang Didukung: kampanye iklan Nilai yang Didukung:`array(APP_INSTALLS, BRAND_AWARENESS, CONVERSIONS, EVENT_RESPONSES, LINK_CLICKS, ...)` Operator yang Didukung:`IN`, `NOT_IN`
`start_time`	Waktu-epoch objek dimulai. Awalan yang Didukung: set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`stop_time`	Waktu-epoch objek berhenti. Awalan yang Didukung: set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`
`buying_type`	Jenis pembelian kampanye iklan objek. Awalan yang Didukung: kampanye iklan Nilai yang Didukung:`array(AUCTION, FIXED_CPM, RESERVED)` Operator yang Didukung:`IN`, `NOT_IN`
`billing_event`	Peristiwa penagihan set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`array(APP_INSTALLS, LINK_CLICKS, IMPRESSIONS, ...)` Operator yang Didukung:`IN`, `NOT_IN`
`optimization_goal`	Sasaran pengoptimalan set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`array(APP_INSTALLS, LINK_CLICKS, IMPRESSIONS, ...)` Operator yang Didukung:`IN`, `NOT_IN`
`is_autobid`	Status penawaran otomatis set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`array(bool)` Operator yang Didukung:`IN`, `NOT_IN`
`daily_budget`	Anggaran harian set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`lifetime_budget`	Anggaran sepanjang masa promosi set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`spend_cap`	Batas pengeluaran kampanye iklan objek. Awalan yang Didukung: kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`bid_amount`	Jumlah tawaran objek. Awalan yang Didukung: iklan, set iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`created_time`	Waktu-epoch objek dibuat. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`updated_time`	Waktu-epoch objek diperbarui. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`

Filter Metadata hanya didukung oleh aturan Berbasis Jadwal

Kolom Metadata	Deskripsi
`effective_status`**	Status efektif objek. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`array(ACTIVE, PAUSED, ADSET_PAUSED, CAMPAIGN_PAUSED, PENDING_REVIEW, ARCHIVED, DELETED, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO)` Operator yang Didukung:`IN`, `NOT_IN`
`placement.page_types`	Jenis halaman untuk penempatan set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`array(DESKTOPFEED, HOME, INSTAGRAMSTREAM, INSTAGRAMSTORY, ...)` Operator yang Didukung:`ANY`, `ALL`, `NONE`
`budget_reset_period`	Periode reset anggaran set iklan objek. Awalan yang Didukung: set iklan Nilai yang Didukung:`array(DAY, LIFETIME)` Operator yang Didukung:`IN`, `NOT_IN`
`hours_since_creation`	Jam setelah `created_time` objek. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`estimated_budget_spending_percentage`	Estimasi persentase anggaran set iklan Anda yang akan dibelanjakan pada akhir jadwalnya. Estimasi ini menggunakan mekanisme yang sama seperti fitur Penyesuaian Saldo Anggaran Set Iklan kami, sehingga bisa digunakan untuk semua jenis anggaran tetapi mengharuskan 10 jam penayangan per hari. Awalan yang Didukung: set iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`audience_reached_percentage`	Estimasi persentase jangkauan set iklan Anda terhadap ukuran pemirsanya. Awalan yang Didukung: set iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`active_time`	Detik sejak objek memiliki status efektif `ACTIVE`. Jika objek saat ini tidak `ACTIVE`, akan mengembalikan nilai `0`. Awalan yang Didukung: iklan, set iklan, kampanye iklan Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`
`current_time`	Waktu-epoch saat ini. Awalan yang Didukung: tidak ada Nilai yang Didukung:`int` Operator yang Didukung:`GREATER_THAN`, `LESS_THAN`, `IN_RANGE`, `NOT_IN_RANGE`

`entity_type` dan `id`

Untuk setiap aturan jenis evaluasi SCHEDULE atau TRIGGER, Anda harus menentukan filter entity_type atau id.

Saat Anda menetapkan filter entity_type, Anda menentukan level objek dinamis untuk menerapkan aturan. Misalnya, jika entity_type berupa AD, aturan itu mengevaluasi secara otomatis setiap iklan baru yang ditambahkan ke akun iklan. Ini terjadi tanpa memandang kapan Anda membuat aturan itu. Dengan menentukan filter id, aturan hanya berlaku untuk daftar objek statis.

Saat Anda menentukan filter id tanpa awalan, kami secara otomatis menghitung level objek untuk menerapkan aturan. Misalnya, jika ingin menerapkan aturan ke iklan [123, 456], Anda hanya perlu satu kolom filter id, nilai [123, 456], dan operator IN. Dalam hal ini, entity_type tidak diperlukan, karena Anda memberikan daftar objek statis awal, dan kami dapat menghitung level objek tersebut.

Anda dapat menggunakan entity_type dan id bersama dengan pemfilteran multi-level. Misalnya, jika Anda menginginkan aturan yang berlaku untuk semua iklan di bawah set iklan tertentu, Anda dapat memiliki filter entity_type untuk AD dan filter adset.id dengan set iklan yang ditentukan.

Secara default, jika Anda tidak menentukan filter effective_status, kami secara implisit menambahkan filter effective_status saat mengevaluasi aturan.

Untuk semua jenis eksekusi yang berlaku pada objek aktif, filter default ini memiliki operator IN dan nilai ['ACTIVE', 'PENDING_REVIEW']. Ini berarti aturan hanya mengevaluasi objek yang memiliki atau akan memiliki penayangan aktif. Untuk jenis eksekusi yang tidak berlaku pada objek aktif (UNPAUSE), kami menambahkan filter ini dengan operator NOT_IN dan nilai ['DELETED', 'ARCHIVED']. Filter default adalah pengoptimalan internal untuk jenis eksekusi kami.

Filter Insight

Kami mengevaluasi filter insight berdasarkan nilai saat ini yang ditampilkan Insights API untuk time_preset tertentu. Filter ini diterapkan langsung ke daftar atau level objek, dan tidak mendukung pemfilteran multi-level. Semua filter Insight mendukung operator berikut: GREATER_THAN, LESS_THAN, EQUAL, IN_RANGE, NOT_IN_RANGE.

Satuan yang ditampilkan di sini didasarkan pada basis mata uang di Marketing API. Misalnya, untuk USD, satuan dasarnya adalah sen, yang berarti bahwa nilai 1.000 untuk yang dibelanjakan setara dengan $10,00.

Untuk deskripsi setiap kolom di bawah, lihat dokumen Insights API. Semua filter ini didukung oleh Aturan Berbasis Jadwal.

Di bawah ini adalah daftar filter Insight dan apakah filter tersebut didukung oleh Aturan Berbasis Pemicu:

Kolom Insight	Diizinkan untuk Aturan Berbasis Pemicu?
`mobile_app_purchase_roas` (Contoh)	Tidak
`website_purchase_roas` (Contoh)	Tidak
`impressions`	Ya
`unique_impressions`	Ya
`clicks`	Ya
`unique_clicks`	Ya
`spent`	Ya
`results`	Ya
`cost_per`	Ya
`cpc`	Ya
`cpm`	Ya
`ctr`	Ya
`cpa`	Ya
`cpp`	Ya
`reach`	Ya
`frequency`	Ya
`leadgen`	Ya
`link_ctr`	Ya
`cost_per_unique_click`	Ya
`result_rate`	Ya
`mobile_app_install`	Ya
`cost_per_mobile_app_install`	Ya
`app_custom_event`	Ya
`app_custom_event.fb_mobile_achievement_unlocked`	Ya
`app_custom_event.fb_mobile_activate_app`	Ya
`app_custom_event.fb_mobile_add_payment_info`	Ya
`app_custom_event.fb_mobile_add_to_cart`	Ya
`app_custom_event.fb_mobile_add_to_wishlist`	Ya
`app_custom_event.fb_mobile_complete_registration`	Ya
`app_custom_event.fb_mobile_content_view`	Ya
`app_custom_event.fb_mobile_initiated_checkout`	Ya
`app_custom_event.fb_mobile_level_achieved`	Ya
`app_custom_event.fb_mobile_purchase`	Ya
`app_custom_event.fb_mobile_rate`	Ya
`app_custom_event.fb_mobile_search`	Ya
`app_custom_event.fb_mobile_spent_credits`	Ya
`app_custom_event.fb_mobile_tutorial_completion`	Ya
`app_custom_event.other`	Ya
`cost_per_mobile_achievement_unlocked`	Ya
`cost_per_mobile_activate_app`	Ya
`cost_per_mobile_add_payment_info`	Ya
`cost_per_mobile_add_to_cart`	Ya
`cost_per_mobile_add_to_wishlist`	Ya
`cost_per_mobile_complete_registration`	Ya
`cost_per_mobile_content_view`	Ya
`cost_per_mobile_initiated_checkout`	Ya
`cost_per_mobile_level_achieved`	Ya
`cost_per_mobile_purchase`	Ya
`cost_per_mobile_rate`	Ya
`cost_per_mobile_search`	Ya
`cost_per_mobile_spent_credits`	Ya
`cost_per_mobile_tutorial_completion`	Ya
`offline_conversion`	Tidak
`offline_conversion.add_payment_info`	Tidak
`offline_conversion.add_to_cart`	Tidak
`offline_conversion.add_to_wishlist`	Tidak
`offline_conversion.complete_registration`	Tidak
`offline_conversion.initiate_checkout`	Tidak
`offline_conversion.lead`	Tidak
`offline_conversion.other`	Tidak
`offline_conversion.purchase`	Tidak
`offline_conversion.search`	Tidak
`offline_conversion.view_content`	Tidak
`cost_per_offline_conversion`	Tidak
`cost_per_offline_other`	Tidak
`offsite_conversion`	Ya
`offsite_conversion.fb_pixel_add_payment_info`	Ya
`offsite_conversion.fb_pixel_add_to_cart`	Ya
`offsite_conversion.fb_pixel_add_to_wishlist`	Ya
`offsite_conversion.fb_pixel_complete_registration`	Ya
`offsite_conversion.fb_pixel_initiate_checkout`	Ya
`offsite_conversion.fb_pixel_lead`	Ya
`offsite_conversion.fb_pixel_purchase`	Ya
`offsite_conversion.fb_pixel_search`	Ya
`offsite_conversion.fb_pixel_view_content`	Ya
`offsite_conversion.fb_pixel_other`	Ya
`cost_per_add_payment_info_fb`	Ya
`cost_per_add_to_cart_fb`	Ya
`cost_per_add_to_wishlist_fb`	Ya
`cost_per_complete_registration_fb`	Ya
`cost_per_initiate_checkout_fb`	Ya
`cost_per_lead_fb`	Ya
`cost_per_purchase_fb`	Ya
`cost_per_search_fb`	Ya
`cost_per_view_content_fb`	Ya
`link_click`	Ya
`cost_per_link_click`	Ya
`like`	Ya
`offsite_engagement`	Ya
`post`	Ya
`post_comment`	Ya
`post_engagement`	Ya
`cost_per_post_engagement`	Tidak
`post_like`	Ya
`post_reaction`	Ya
`view_content`	Ya
`video_play`	Ya
`vote`	Ya
`unique_clicks`	Tidak
`reach`	Tidak
`lifetime_impressions`	Tidak
`lifetime_spent`	Tidak
`today_spent`	Tidak
`yesterday_spent`	Tidak

Filter Lanjutan

Anda dapat menyesuaikan dan menurunkan kolom lanjutan berdasarkan filter Insight dan metadata di atas. Untuk informasi selengkapnya, lihat Filter Spesifikasi Evaluasi Lanjutan.

Filter lanjutan mendukung operator berikut: GREATER_THAN, LESS_THAN, EQUAL, IN_RANGE, NOT_IN_RANGE. Filter ini hanya didukung oleh Aturan Berbasis Jadwal.

Untuk beberapa filter lanjutan yang paling umum digunakan, kami mendukung alias sebagai filter:

Alias Kolom Lanjutan	Diturunkan Dari
`daily_ratio_spent`	`today_spent / adset.daily_budget`
`lifetime_ratio_spent`	`lifetime_spent / adset.lifetime_budget`

Spesifikasi Evaluasi

Filter Khusus

time_preset

attribution_window

Filter Metadata

Filter Metadata yang didukung oleh aturan Berbasis Jadwal dan Pemicu

Filter Metadata hanya didukung oleh aturan Berbasis Jadwal

entity_type dan id

Filter Insight

Filter Lanjutan

`time_preset`

`attribution_window`

`entity_type` dan `id`