meridian.data.input_data.InputData

Penampung data untuk data iklan dalam format yang didukung oleh Meridian.

meridian.data.input_data.InputData(
    kpi: xr.DataArray,
    kpi_type: str,
    controls: xr.DataArray,
    population: xr.DataArray,
    revenue_per_kpi: (xr.DataArray | None) = None,
    media: (xr.DataArray | None) = None,
    media_spend: (xr.DataArray | None) = None,
    reach: (xr.DataArray | None) = None,
    frequency: (xr.DataArray | None) = None,
    rf_spend: (xr.DataArray | None) = None,
    organic_media: (xr.DataArray | None) = None,
    organic_reach: (xr.DataArray | None) = None,
    organic_frequency: (xr.DataArray | None) = None,
    non_media_treatments: (xr.DataArray | None) = None
)

kpi DataArray dimensi (n_geos, n_times) yang berisi variabel dependen non-negatif. Biasanya ini adalah jumlah unit yang terjual, tetapi dapat berupa metrik apa pun, seperti pendapatan atau konversi.
kpi_type String yang menunjukkan apakah KPI adalah jenis 'revenue' atau 'non-revenue'. Jika kpi_type adalah 'non-revenue' dan revenue_per_kpi ada, kalibrasi ROI akan digunakan dan analisis dijalankan berdasarkan pendapatan. Jika revenue_per_kpi tidak ada untuk kpi_type yang sama, kalibrasi ROI kustom akan digunakan dan analisis akan dijalankan pada KPI.
controls DataArray dimensi (n_geos, n_times, n_controls) yang berisi nilai variabel kontrol.
population DataArray dimensi (n_geos,) yang berisi populasi setiap grup. Variabel ini digunakan untuk menskalakan KPI dan media untuk pemodelan.
revenue_per_kpi DataArray opsional dari dimensi (n_geos, n_times) yang berisi jumlah pendapatan rata-rata per unit KPI. Meskipun pemodelan dilakukan di kpi, analisis dan pengoptimalan model dilakukan di KPI * revenue_per_kpi (pendapatan), jika nilai ini tersedia. Jika kpi sesuai dengan pendapatan, array satu akan diteruskan secara otomatis.
media DataArray opsional dari dimensi (n_geos, n_media_times, n_media_channels) yang berisi nilai eksekusi media non-negatif. Biasanya ini adalah tayangan, tetapi dapat berupa metrik apa pun, seperti biaya atau klik. n_media_times ≥ n_times diperlukan, dan jangka waktu n_times akhir harus selaras dengan jangka waktu kpi dan controls. Karena efek jeda, sebaiknya periode waktu untuk media mencakup hingga max_lag periode tambahan sebelum periode ini. Jika n_media_times < n_times + max_lag, model akan secara efektif mengimput histori media sebagai nol (tidak ada eksekusi media). Jika n_media_times > n_times + max_lag, maka hanya periode n_times + max_lag akhir yang digunakan untuk menyesuaikan model. media dan media_spend harus berisi jumlah saluran media yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak bersifat opsional.
media_spend DataArray opsional yang berisi biaya setiap saluran media. Ini digunakan sebagai denominator untuk penghitungan ROI. Bentuk DataArray dapat berupa (n_geos, n_times, n_media_channels) atau (n_media_channels,) jika data digabungkan berdasarkan dimensi geo dan time. Selaraskan total biaya dengan periode waktu data kpi dan controls, yang merupakan periode waktu untuk menghitung pendapatan tambahan dari penghitung ROI. Hasil inkremental dipengaruhi oleh eksekusi media sebelum periode waktu ini, melalui efek yang tertunda. media dan media_spend harus berisi jumlah saluran media yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak bersifat opsional.
reach DataArray opsional dari dimensi (n_geos, n_media_times, n_rf_channels) yang berisi nilai reach non-negatif. n_media_times harus ≥ n_times, dan jangka waktu n_times akhir harus selaras dengan periode waktu kpi dan controls. Interval waktu harus menyertakan interval waktu data kpi dan controls, tetapi opsional untuk menyertakan jangka waktu jeda sebelum interval waktu data kpi dan controls. Jika jangkauan jeda tidak disertakan, atau jika jangkauan jeda mencakup periode waktu kurang dari max_lag, model akan menghitung Adstock dengan asumsi bahwa eksekusi jangkauan adalah nol sebelum periode waktu pertama yang diamati. Sebaiknya sertakan jangka waktu n_times + max_lag, kecuali jika nilai max_lag terlalu besar. Jika hanya data media yang digunakan, reach akan menjadi None. reach, frequency, dan rf_spend harus berisi jumlah saluran media yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak bersifat opsional.
frequency DataArray opsional dari dimensi (n_geos, n_media_times, n_rf_channels) yang berisi nilai frequency non-negatif. n_media_times harus ≥ n_times, dan jangka waktu n_times akhir harus selaras dengan periode waktu kpi dan controls. Interval waktu harus menyertakan interval waktu data kpi dan controls, tetapi opsional untuk menyertakan jangka waktu jeda sebelum interval waktu data kpi dan controls. Jika frekuensi jeda tidak disertakan, atau jika frekuensi jeda mencakup periode waktu kurang dari max_lag, maka model akan menghitung Adstock dengan asumsi bahwa eksekusi frekuensi adalah nol sebelum periode waktu pertama yang diamati. Sebaiknya sertakan jangka waktu n_times + max_lag, kecuali jika nilai max_lag terlalu besar. Jika hanya data media yang digunakan, frequency akan menjadi None. reach, frequency, dan rf_spend harus berisi jumlah saluran media yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak bersifat opsional.
rf_spend DataArray opsional yang berisi biaya setiap saluran jangkauan dan frekuensi. Ini digunakan sebagai denominator untuk penghitungan ROI. Bentuk DataArray dapat berupa (n_rf_channels,), (n_geos, n_times, n_rf_channels), atau (n_geos, n_rf_channels). Pembelanjaan harus digabungkan berdasarkan dimensi geografis dan/atau waktu yang tidak direpresentasikan. Sebaiknya total pembelanjaan sesuai dengan periode waktu data kpi dan controls, yang merupakan periode waktu untuk menghitung hasil inkremental dari penghitung ROI). Namun, perlu diperhatikan bahwa hasil inkremental dipengaruhi oleh eksekusi media sebelum periode waktu ini, melalui efek jeda, dan mengecualikan efek jeda di luar periode waktu media yang dieksekusi selama periode waktu. Jika hanya data media yang digunakan, rf_spend akan menjadi None. reach, frequency, dan rf_spend harus berisi jumlah saluran media yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak bersifat opsional.
organic_media DataArray opsional dari dimensi (n_geos, n_media_times, n_organic_media_channels) yang berisi nilai media organik non-negatif. Variabel media organik adalah aktivitas media yang tidak memiliki biaya langsung. Hal ini dapat mencakup tayangan iklan dari newsletter, postingan blog, aktivitas media sosial, atau kampanye email, tetapi juga dapat berupa metrik apa pun, seperti klik. n_media_times ≥ n_times diperlukan, dan jangka waktu n_times akhir harus selaras dengan jangka waktu kpi dan controls. Karena efek jeda, sebaiknya periode waktu untuk media organik mencakup hingga max_lag periode tambahan sebelum periode ini. Jika n_organic_media_times < n_times + max_lag, model akan secara efektif mengatribusikan histori media organik. Jika n_organic_media_times > n_times + max_lag, hanya periode n_times + max_lag akhir yang digunakan untuk menyesuaikan model.
organic_reach DataArray opsional dari dimensi (n_geos, n_media_times, n_organic_rf_channels) yang berisi nilai jangkauan organik non-negatif. n_media_times harus ≥ n_times, dan periode waktu n_times akhir harus selaras dengan periode waktu kpi dan controls. Interval waktu harus mencakup interval waktu data kpi dan controls, tetapi menyertakan jangka waktu jeda sebelum interval waktu data kpi dan controls bersifat opsional. Jika jangkauan tertunda tidak disertakan, atau jika jangkauan tertunda mencakup periode waktu kurang dari max_lag, model akan menghitung Adstock dengan asumsi bahwa eksekusi jangkauan adalah nol sebelum periode waktu pengamatan pertama. Sebaiknya sertakan periode waktu n_times + max_lag, kecuali jika nilai max_lag terlalu besar. Jika tidak ada data jangkauan dan frekuensi organik yang digunakan, organic_reach dan organic_frequency akan menjadi None. organic_reach, dan organic_frequency harus berisi jumlah saluran yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak opsional.
organic_frequency DataArray opsional dari dimensi (n_geos, n_media_times, n_organic_rf_channels) yang berisi nilai frekuensi organik non-negatif. n_media_times harus ≥ n_times, dan periode waktu n_times akhir harus selaras dengan periode waktu kpi dan controls. Interval waktu harus mencakup interval waktu data kpi dan controls, tetapi menyertakan jangka waktu jeda sebelum interval waktu data kpi dan controls bersifat opsional. Jika frekuensi dengan jeda tidak disertakan, atau jika frekuensi dengan jeda mencakup kurang dari max_lag jangka waktu, model akan menghitung Adstock dengan asumsi bahwa eksekusi frekuensi adalah nol sebelum jangka waktu pengamatan pertama. Sebaiknya sertakan jangka waktu n_times + max_lag, kecuali jika nilai max_lag terlalu besar. Jika tidak ada data jangkauan dan frekuensi organik yang digunakan, organic_frequency akan menjadi None. organic_reach dan organic_frequency harus berisi jumlah saluran yang sama dalam urutan yang sama. Jika salah satu argumen ini diteruskan, argumen lainnya tidak opsional.
non_media_treatments DataArray opsional dari dimensi (n_geos, n_times, n_non_media_channels) yang berisi nilai variabel perlakuan non-media. Variabel perlakuan non-media adalah aktivitas pemasaran yang dilakukan oleh pengiklan yang tidak terkait langsung dengan media. Variabel ini tidak memiliki biaya pemasaran langsung yang terkait, tetapi tidak seperti variabel media organik, tidak ada efek Adstock dan Hill. Variabel ini berbeda dengan variabel kontrol karena dianggap dapat diintervensi dan karenanya merupakan variabel perlakuan dalam model kausal. Beberapa contohnya mencakup menjalankan promosi, harga produk, dan perubahan pada kemasan dan/atau desain produk.
control_variable Menampilkan dimensi variabel kontrol.
geo Menampilkan dimensi geografis.
media_channel Menampilkan dimensi saluran media.
media_spend_has_geo_dimension Memeriksa apakah array media_spend memiliki dimensi geografis.
media_spend_has_time_dimension Memeriksa apakah array media_spend memiliki dimensi waktu.
media_time Menampilkan koordinat dimensi waktu media.
media_time_coordinates Menampilkan dimensi waktu media dalam wrapper TimeCoordinates.
non_media_channel Menampilkan dimensi saluran perlakuan non-media.
organic_media_channel Menampilkan dimensi saluran media organik.
organic_rf_channel Menampilkan dimensi saluran RF organik.
rf_channel Menampilkan dimensi saluran RF.
rf_spend_has_geo_dimension Memeriksa apakah array rf_spend memiliki dimensi geografis.
rf_spend_has_time_dimension Memeriksa apakah array rf_spend memiliki dimensi waktu.
time Menampilkan koordinat dimensi waktu.
time_coordinates Menampilkan dimensi waktu (KPI) dalam wrapper TimeCoordinates.

Metode

as_dataset

Lihat sumber

as_dataset() -> xr.Dataset

Menampilkan data sebagai satu objek xarray.Dataset.

get_all_channels

Lihat sumber

get_all_channels() -> np.ndarray

Menampilkan semua dimensi saluran.

Metode ini menampilkan nama saluran media, RF, media organik, RF organik, dan non-media, yang digabungkan menjadi satu array dalam urutan tersebut.

get_all_media_and_rf

Lihat sumber

get_all_media_and_rf() -> np.ndarray

Menampilkan semua nilai eksekusi media, termasuk media dan RF.

Jika media, jangkauan, dan frekuensi digunakan untuk pemodelan, jangkauan * frekuensi akan digabungkan ke akhir media.

Hasil
np.ndarray dengan dimensi (n_geos, n_media_times, n_channels) yang berisi media atau jangkauan * frekuensi untuk setiap media_channel atau rf_channel.

get_all_paid_channels

Lihat sumber

get_all_paid_channels() -> np.ndarray

Menampilkan semua dimensi saluran berbayar, termasuk media dan RF.

Jika saluran media dan RF ada, saluran RF akan digabungkan ke akhir saluran media.

get_n_top_largest_geos

Lihat sumber

get_n_top_largest_geos(
    num_geos: int
) -> list[str]

Menemukan jumlah geo terbesar yang ditentukan berdasarkan populasi.

Args
num_geos Jumlah geo terbesar teratas yang akan ditampilkan berdasarkan populasi.

Hasil
Daftar jumlah geo terbesar teratas yang ditentukan.

get_total_spend

Lihat sumber

get_total_spend() -> np.ndarray

Menampilkan total pembelanjaan, termasuk media_spend dan rf_spend.

__eq__

__eq__(
    other
)

Menampilkan self==value.

frekuensi None
media None
media_spend None
non_media_treatments None
organic_frequency None
organic_media None
organic_reach None
jangkauan None
revenue_per_kpi None
rf_spend None