meridian.data.input_data.InputData

kontener danych reklamowych w formacie obsługiwanym przez 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 Tablica danych o wymiarach (n_geos, n_times) zawierających nieujemną zmienną zależną. Zwykle jest to liczba sprzedanych produktów, ale może to być dowolny rodzaj danych, np. przychody lub konwersje.
kpi_type Ciąg znaków określający, czy wskaźnik KPI jest typu 'revenue' czy 'non-revenue'. Gdy kpi_type to 'non-revenue' i istnieje revenue_per_kpi, używana jest kalibracja zwrotu z inwestycji, a analiza jest przeprowadzana na podstawie przychodów. Jeśli w przypadku tego samego kpi_type nie ma wartości kpi_type, używana jest niestandardowa kalibracja zwrotu z inwestycji, a analiza jest przeprowadzana na podstawie KPI.revenue_per_kpi
controls tablica DataArray o wymiarach (n_geos, n_times, n_controls) zawierających wartości zmiennych sterujących.
population Tablica DataArray o wymiarach (n_geos,) zawierających populację poszczególnych grup. Ta zmienna służy do skalowania wskaźnika KPI i multimediów na potrzeby modelowania.
revenue_per_kpi Opcjonalny tablicowy obiekt danych o wymiarach (n_geos, n_times)z wartością średnich przychodów na jednostkę KPI. Chociaż modelowanie jest wykonywane na podstawie wartości kpi, analiza i optymalizacja modelu są przeprowadzane na podstawie wartości KPI * revenue_per_kpi (przychody), jeśli jest ona dostępna. Jeśli kpi odpowiada przychodom, automatycznie przekazywana jest tablica 1.
media Opcjonalny tablica danych wymiarów (n_geos, n_media_times, n_media_channels) zawierająca nieujemne wartości wykonania reklamy. Zwykle są to wyświetlenia, ale mogą to być dowolne dane, np. koszt lub kliknięcia. Wymagane jest n_media_times ≥ n_times, a końcowe przedziały czasu n_times muszą być zgodne z oknem czasowym kpi i controls. Ze względu na opóźnienia w działaniu zalecamy, aby okno czasowe dla multimediów obejmowało do max_lag dodatkowych okresów przed tym oknem. Jeśli n_media_times < n_times + max_lag, model przypisuje historii mediów wartość zero (brak wykonania mediów). Jeśli n_media_times > n_times + max_lag, do dopasowania modelu używane są tylko ostatnie n_times + max_lag okresy. Parametry media i media_spend muszą zawierać tę samą liczbę kanałów medialnych w tej samej kolejności. Jeśli podany zostanie jeden z tych argumentów, drugi nie jest opcjonalny.
media_spend Opcjonalny element DataArray zawierający koszt każdego kanału mediów. Jest ona używana jako mianownik w obliczeniach zwrotu z inwestycji. Kształt tablicy danych może być (n_geos, n_times, n_media_channels) lub (n_media_channels,), jeśli dane są agregowane według wymiarów geo i time. Dopasuj łączny koszt do przedziału czasowego danych kpi i controls, czyli do przedziału czasowego, w którym obliczany jest przyrost przychodów w liczniku ROI. Na wynik przyrostowy wpływają działania w mediach przed tym oknem czasowym, które mają opóźnione działanie. Parametry media i media_spend muszą zawierać taką samą liczbę kanałów mediów w tej samej kolejności. Jeśli przekazany zostanie jeden z tych argumentów, drugi nie jest opcjonalny.
reach Opcjonalny zbiór DataArray wymiarów (n_geos, n_media_times, n_rf_channels) zawierający nieujemne wartości reach. Wymagane jest, aby n_media_times ≥ n_times, a końcowe okresy n_times muszą być zgodne z oknem czasowym kpi i controls. Okres czasu musi obejmować okres czasu danych kpi i controls, ale uwzględnienie okresów czasu opóźnionych przed okresem czasu danych kpi i controls jest opcjonalne. Jeśli nie uwzględnisz danych o opóźnionym zasięgu lub jeśli dane te obejmują mniej niż max_lag okresów, model oblicza AdStock, zakładając, że przed pierwszym obserwowanym okresem czasowym zasięg jest równy 0. Zalecamy uwzględnienie okresów czasu n_times + max_lag, chyba że wartość max_lag jest zbyt duża. Jeśli używane są tylko dane media, pole reach będzie zawierać wartość None. reach, frequency i rf_spend muszą zawierać taką samą liczbę kanałów komunikacji w tej samej kolejności. Jeśli podasz jeden z tych argumentów, pozostałe nie będą opcjonalne.
frequency Opcjonalny zbiór DataArray wymiarów (n_geos, n_media_times, n_rf_channels) zawierający nieujemne wartości frequency. Wymagane jest, aby n_media_times ≥ n_times, a końcowe przedziały czasowe n_times muszą być zgodne z oknem czasowym kpi i controls. Okres czasu musi obejmować okres czasu danych kpi i controls, ale uwzględnienie okresów czasu opóźnionych przed okresem czasu danych kpi i controls jest opcjonalne. Jeśli częstotliwość z opóźnieniem nie jest uwzględniona lub jeśli częstotliwość z opóźnieniem obejmuje mniej niż max_lag okresów, model oblicza AdStock, zakładając, że częstotliwość wykonania jest równa 0 przed pierwszym obserwowanym okresem. Zalecamy uwzględnienie okresów czasu n_times + max_lag, chyba że wartość max_lag jest zbyt duża. Jeśli używane są tylko dane media, wartość frequency będzie wynosić None. reach, frequency i rf_spend muszą zawierać taką samą liczbę kanałów multimedialnych w tej samej kolejności. Jeśli podasz któryś z tych argumentów, pozostałe nie będą opcjonalne.
rf_spend Opcjonalny element DataArray zawierający koszt każdego kanału zasięgu i częstotliwości. Jest ona używana jako mianownik w obliczeniach zwrotu z inwestycji. Kształt tablicy danych może być (n_rf_channels,), (n_geos, n_times, n_rf_channels) lub (n_geos, n_rf_channels). Wydatki powinny być zsumowane w przypadku wymiarów geograficznych lub czasowych, które nie są reprezentowane. Zalecamy, aby łączna kwota wydatków była zgodna z oknem czasowym danych kpi i controls, czyli okresem, w którym oblicza się przyrostowy wynik licznika ROI. Pamiętaj jednak, że na wynik przyrostowy wpływa wcześniejsze wyświetlanie multimediów przed tym okresem, co powoduje opóźnione efekty, oraz wyklucza opóźnione efekty poza okresem wyświetlania multimediów w danym okresie. Jeśli używane są tylko dane media, rf_spend będzie równe None. Wartości reach, frequency i rf_spend muszą zawierać taką samą liczbę kanałów komunikacji w tej samej kolejności. Jeśli podasz dowolny z tych argumentów, pozostałe nie będą opcjonalne.
organic_media Opcjonalny zbiór wymiarów DataArray zawierający nieujemne wartości mediów organicznych.(n_geos, n_media_times, n_organic_media_channels) Zmienne mediów bezpłatnych to działania w mediach, które nie mają bezpośredniego kosztu. Mogą to być wyświetlenia z newsletterów, postów na blogu, aktywności w mediach społecznościowych lub kampanii e-mailowych, ale mogą to być też dowolne dane, np. kliknięcia. Wymagane jest n_media_times ≥ n_times, a końcowe przedziały czasu n_times muszą być zgodne z oknem czasowym kpi i controls. Ze względu na opóźnione efekty zalecamy, aby okno czasowe dla mediów bezpłatnych obejmowało do max_lag dodatkowych okresów przed tym oknem. Jeśli n_organic_media_times < n_times + max_lag, model skutecznie przekształca historię bezpłatnych wyszukiwań. Jeśli n_organic_media_times > n_times + max_lag, do dopasowania modelu używane są tylko ostatnie n_times + max_lag okresy.
organic_reach Opcjonalny DataArray wymiarów (n_geos, n_media_times, n_organic_rf_channels) zawierający wartości dotarcia z bezpłatnych wyników wyszukiwania o dodatnich wartościach. Wymagane jest, aby n_media_times ≥ n_times, a ostateczne przedziały czasu n_times muszą być zgodne z oknem czasowym kpi i controls. Okres czasu musi obejmować okres czasu danych kpi i controls, ale nie jest konieczne uwzględnianie okresów czasu przed okresem czasu danych kpi i controls. Jeśli zasięg opóźniony nie jest uwzględniony lub obejmuje mniej niż max_lag okresów, model oblicza AdStock, zakładając, że zasięg przed pierwszym obserwowanym okresem jest równy 0. Zalecamy uwzględnienie okresów czasu n_times + max_lag, chyba że wartość max_lag jest zbyt duża. Jeśli nie są używane dane o zasięgu i częstotliwości bezpłatnego dotarcia do odbiorców, wartości organic_reach i organic_frequency będą wynosić None. organic_reach i organic_frequency muszą zawierać taką samą liczbę kanałów w tej samej kolejności. Jeśli przekazany zostanie jeden z tych argumentów, drugi nie jest opcjonalny.
organic_frequency Opcjonalny zbiór DataArray wymiarów (n_geos, n_media_times, n_organic_rf_channels) zawierający wartości dodatnie częstotliwości bezpłatnych wyszukiwań. Wymagane jest, aby n_media_times ≥ n_times, a ostateczne przedziały czasu n_times muszą być zgodne z oknem czasowym kpi i controls. Okres czasu musi obejmować okres czasu danych kpi i controls, ale nie jest konieczne uwzględnianie okresów czasu przed okresem czasu danych kpi i controls. Jeśli opóźniona częstotliwość nie jest uwzględniona lub jeśli opóźniona częstotliwość obejmuje mniej niż max_lag przedziałów czasu, model oblicza Adstock, zakładając, że częstotliwość wykonania jest równa 0 przed pierwszym obserwowanym przedziałem czasu. Zalecamy uwzględnienie okresów n_times + max_lag, chyba że wartość max_lag jest zbyt duża. Jeśli nie są używane żadne dane o zasięgu i częstotliwości bezpłatnych wyników wyszukiwania, wartość organic_frequency będzie wynosić None. Parametry organic_reach i organic_frequency muszą zawierać taką samą liczbę kanałów w tym samym porządku. Jeśli przekazany zostanie jeden z tych argumentów, drugi nie jest opcjonalny.
non_media_treatments Opcjonalna tablica danych o wymiarach (n_geos, n_times, n_non_media_channels) zawierająca wartości zmiennych niemedialnych. Zmiennymi eksperymentalnymi innych niż media są działania marketingowe podejmowane przez reklamodawcę, które nie są bezpośrednio związane z mediami. Nie są z nimi związane żadne bezpośrednie koszty marketingowe, ale w odróżnieniu od przypadku bezpłatnych zmiennych dotyczących mediów nie występują efekty Adstocka i Hilla. Różnią się one od zmiennych kontrolnych, ponieważ można je modyfikować, a więc w ramach modelu przyczynowego są zmiennymi eksperymentalnymi. Przykłady takich zmian to prowadzenie promocji, zmiana ceny produktu lub zmiana jego opakowania lub projektu.
control_variable Zwraca wymiar zmiennej sterującej.
geo Zwraca wymiar geograficzny.
media_channel Zwraca wymiar kanał medialny.
media_spend_has_geo_dimension Sprawdza, czy tablica media_spend zawiera wymiar geograficzny.
media_spend_has_time_dimension Sprawdza, czy tablica media_spend ma wymiar czasu.
media_time Zwraca współrzędne wymiaru czasu multimediów.
media_time_coordinates Zwraca wymiar Czas trwania w multimediach w opakowaniu TimeCoordinates.
non_media_channel Zwraca wymiar kanału, który nie jest związany z reklamami multimedialnymi.
organic_media_channel Zwraca wymiar kanału bezpłatnych wyników wyszukiwania.
organic_rf_channel Zwraca wymiar bezpłatnego kanału RF.
rf_channel Zwraca wymiar kanału RF.
rf_spend_has_geo_dimension Sprawdza, czy tablica rf_spend zawiera wymiar geograficzny.
rf_spend_has_time_dimension Sprawdza, czy tablica rf_spend ma wymiar czasu.
time Zwraca współrzędne wymiaru czasu.
time_coordinates Zwraca wymiar czasu (KPI) w opakowaniu TimeCoordinates.

Metody

as_dataset

Wyświetl źródło

as_dataset() -> xr.Dataset

Zwraca dane w ramach pojedynczego obiektu xarray.Dataset.

get_all_channels

Wyświetl źródło

get_all_channels() -> np.ndarray

Zwraca wszystkie wymiary kanału.

Ta metoda zwraca nazwy kanałów z reklamą, z reklamą w mediach, z bezpłatnymi reklamami w mediach oraz bezpłatnymi reklamami w mediach, a także nazwy kanałów bez reklam, połączone w jeden tablica w tej kolejności.

get_all_media_and_rf

Wyświetl źródło

get_all_media_and_rf() -> np.ndarray

Zwraca wszystkie wartości wykonania mediów, w tym media i RF.

Jeśli do modelowania zostały użyte media, zasięg i częstotliwość, zasięg * częstotliwość jest łączony na końcu mediów.

Zwroty
np.ndarray z wymiarami (n_geos, n_media_times, n_channels) zawierającymi media lub zasięg * częstotliwość dla każdego media_channel lub rf_channel.

get_all_paid_channels

Wyświetl źródło

get_all_paid_channels() -> np.ndarray

Zwraca wszystkie wymiary płatnych kanałów, w tym media i RF.

Jeśli występują zarówno kanały medialne, jak i kanały RF, kanały RF są łączone na końcu kanałów medialnych.

get_n_top_largest_geos

Wyświetl źródło

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

Znajduje określoną liczbę największych obszarów geograficznych według liczby ludności.

Argumenty
num_geos Liczba największych obszarów geograficznych do zwrócenia na podstawie liczby ludności.

Zwroty
Lista wybranej liczby największych obszarów geograficznych.

get_total_spend

Wyświetl źródło

get_total_spend() -> np.ndarray

Zwraca łączne wydatki, w tym media_spend i rf_spend.

__eq__

__eq__(
    other
)

Zwraca wartość self==value.

częstotliwość None
media None
media_spend None
non_media_treatments None
organic_frequency None
organic_media None
organic_reach None
dotrzesz None
revenue_per_kpi None
rf_spend None