meridian.data.input_data.InputData

Ein Datencontainer für Werbedaten in einem von Meridian unterstützten Format.

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 Ein DataArray mit Dimensionen (n_geos, n_times), das die nicht negative abhängige Variable enthält. In der Regel ist das die Anzahl der verkauften Einheiten, es kann aber auch ein beliebiger Messwert sein, z. B. Umsatz oder Conversions.
kpi_type Ein String, der angibt, ob der KPI vom Typ 'revenue' oder 'non-revenue' ist. Wenn kpi_type gleich 'non-revenue' ist und revenue_per_kpi vorhanden ist, wird die ROI-Abstimmung verwendet und die Analyse anhand des Umsatzes ausgeführt. Ist revenue_per_kpi für denselben kpi_type nicht vorhanden, wird die benutzerdefinierte ROI-Abstimmung verwendet und die Analyse wird anhand des KPI ausgeführt.
controls Ein DataArray mit Dimensionen (n_geos, n_times, n_controls), das Werte für Kontrollvariablen enthält.
population Ein DataArray mit Dimensionen (n_geos,), das die Grundgesamtheit der einzelnen Gruppen enthält. Mit dieser Variablen werden KPI und Media für die Modellierung skaliert.
revenue_per_kpi Ein optionales DataArray mit Dimensionen (n_geos, n_times), das den durchschnittlichen Umsatz pro KPI-Einheit enthält. Die Modellierung erfolgt zwar anhand von kpi, die Modellanalyse und ‑optimierung jedoch anhand von KPI * revenue_per_kpi (Umsatz), sofern dieser Wert verfügbar ist. Wenn kpi dem Umsatz entspricht, wird automatisch ein Array mit Einsen übergeben.
media Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_media_channels), das nicht negative Werte für die Media-Ausführung enthält. In der Regel sind das Impressionen, es kann aber auch ein beliebiger anderer Messwert sein, z. B. Kosten oder Klicks. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Aufgrund von verzögerten Auswirkungen sollten bei der Analyse des Zeitfensters für Media bis zu max_lag zusätzliche Zeiträume vor dem Fenster berücksichtigt werden. Bei n_media_times < n_times + max_lag imputiert das Modell fehlende Werte für den Media-Verlauf als Null (keine Media-Ausführung). Bei n_media_times > n_times + max_lag werden nur die letzten n_times + max_lag Zeiträume zum Anpassen des Modells verwendet. media und media_spend müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, ist das andere nicht optional.
media_spend Ein optionales DataArray mit den Kosten der einzelnen Media-Channels. Dieser Wert wird als Nenner für ROI-Berechnungen verwendet. Die DataArray-Form kann (n_geos, n_times, n_media_channels) oder (n_media_channels,) sein, wenn die Daten über geo- und time-Dimensionen aggregiert werden. Die Gesamtausgaben sollten mit dem Zeitfenster der kpi- und controls-Daten übereinstimmen. Das ist das Zeitfenster, über das das inkrementelle Ergebnis des ROI-Zählers berechnet wird. Das zusätzliche Ergebnis wird jedoch durch die Media-Ausführung vor diesem Zeitraum beeinflusst. Das liegt an verzögerten Auswirkungen. Verzögerte Auswirkungen, die über den Zeitraum der Media-Ausführung hinausgehen, werden nicht berücksichtigt. media und media_spend müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, ist das andere nicht optional.
reach Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_rf_channels), das nicht negative reach-Werte enthält. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Das Zeitfenster muss das Zeitfenster der kpi- und controls-Daten umfassen. Es ist jedoch optional, Zeiträume mit verzögerten Auswirkungen einzubeziehen, die vor dem Zeitfenster der kpi- und controls-Daten liegen. Wenn die verzögerte Reichweite nicht berücksichtigt wird oder weniger als max_lag Zeiträume umfasst, wird der Adstock-Effekt im Modell unter der Annahme berechnet, dass die Reichweite vor dem ersten beobachteten Zeitraum null war. Wir empfehlen, die Zeiträume n_times + max_lag einzubeziehen, es sei denn, der Wert von max_lag ist zu groß. Wenn nur media-Daten verwendet werden, wird der Wert von reach auf None gesetzt. reach, frequency und rf_spend müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, sind die anderen nicht optional.
frequency Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_rf_channels), das nicht negative frequency-Werte enthält. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Das Zeitfenster muss das Zeitfenster der kpi- und controls-Daten umfassen. Es ist jedoch optional, Zeiträume mit verzögerten Auswirkungen einzubeziehen, die vor dem Zeitfenster der kpi- und controls-Daten liegen. Wenn die verzögerte Häufigkeit nicht berücksichtigt wird oder weniger als max_lag Zeiträume umfasst, wird der Adstock-Effekt im Modell unter der Annahme berechnet, dass die Häufigkeit vor dem ersten beobachteten Zeitraum null war. Wir empfehlen, die Zeiträume n_times + max_lag einzubeziehen, es sei denn, der Wert von max_lag ist zu groß. Wenn nur media-Daten verwendet werden, wird der Wert von frequency auf None gesetzt. reach, frequency und rf_spend müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, sind die anderen nicht optional.
rf_spend Ein optionales DataArray mit den Kosten der einzelnen Channels für Reichweite und Häufigkeit. Dieser Wert wird als Nenner für ROI-Berechnungen verwendet. Die DataArray-Form kann (n_rf_channels,), (n_geos, n_times, n_rf_channels) oder (n_geos, n_rf_channels) sein. Die Ausgaben sollten über geografische und/oder zeitbezogene Dimensionen aggregiert werden, die nicht dargestellt werden. Die Gesamtausgaben sollten mit dem Zeitfenster der kpi- und controls-Daten übereinstimmen. Das ist das Zeitfenster, für das das inkrementelle Ergebnis des ROI-Zählers berechnet wird. Es muss dabei beachtet werden, dass sich die Media-Ausführung vor diesem Zeitfenster aufgrund von verzögerten Effekten auf das inkrementelle Ergebnis auswirkt. Zudem werden Effekte der Media-Ausführung im Zeitfenster, die aufgrund von Verzögerungen erst nach dem Zeitfenster auftreten, nicht berücksichtigt. Wenn nur media-Daten verwendet werden, wird der Wert von rf_spend auf None gesetzt. reach, frequency und rf_spend müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, sind die anderen nicht optional.
organic_media Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_organic_media_channels), das nicht negative Werte für organische Medien enthält. Variablen für organische Medien sind Media-Aktivitäten ohne direkte Kosten. Dazu gehören unter anderem Impressionen aus Newslettern, Blogbeiträgen, Aktivitäten in sozialen Medien oder E-Mail-Kampagnen. Es können aber auch beliebige andere Messwerte wie etwa Klicks sein. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Aufgrund von verzögerten Auswirkungen sollten bei der Analyse des Zeitfensters für organische Media bis zu max_lag zusätzliche Zeiträume vor dem Fenster berücksichtigt werden. Bei n_organic_media_times < n_times + max_lag imputiert das Modell fehlende Werte für den Verlauf organischer Medien. Bei n_organic_media_times > n_times + max_lag werden nur die letzten n_times + max_lag Zeiträume zum Anpassen des Modells verwendet.
organic_reach Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_organic_rf_channels), das nicht negative Werte für die organische Reichweite enthält. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Das Zeitfenster muss das Zeitfenster der kpi- und controls-Daten umfassen. Es ist jedoch möglich, Zeiträume mit verzögerten Auswirkungen einzubeziehen, die vor dem Zeitfenster der kpi- und controls-Daten liegen. Wenn die verzögerte Reichweite nicht berücksichtigt wird oder weniger als max_lag Zeiträume umfasst, wird der Adstock-Effekt im Modell unter der Annahme berechnet, dass die Reichweite vor dem ersten beobachteten Zeitraum null war. Wir empfehlen, die Zeiträume n_times + max_lag einzubeziehen, es sei denn, der Wert von max_lag ist zu groß. Wenn keine Daten zur organischen Reichweite und Häufigkeit verwendet werden, wird für organic_reach und organic_frequency None verwendet. organic_reach und organic_frequency müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, ist das andere nicht optional.
organic_frequency Ein optionales DataArray mit Dimensionen (n_geos, n_media_times, n_organic_rf_channels), das nicht negative Werte für die organische Häufigkeit enthält. n_media_times ≥ n_times ist erforderlich und die letzten n_times Zeiträume müssen mit dem Zeitfenster von kpi und controls übereinstimmen. Das Zeitfenster muss das Zeitfenster der kpi- und controls-Daten umfassen. Es ist jedoch möglich, Zeiträume mit verzögerten Auswirkungen einzubeziehen, die vor dem Zeitfenster der kpi- und controls-Daten liegen. Wenn die verzögerte Häufigkeit nicht berücksichtigt wird oder weniger als max_lag Zeiträume umfasst, wird der Adstock-Effekt im Modell unter der Annahme berechnet, dass die Häufigkeit vor dem ersten beobachteten Zeitraum null war. Wir empfehlen, die Zeiträume n_times + max_lag einzubeziehen, es sei denn, der Wert von max_lag ist zu groß. Wenn keine Daten zur organischen Reichweite und Häufigkeit verwendet werden, ist organic_frequency None. organic_reach und organic_frequency müssen dieselbe Anzahl von Media-Channels in derselben Reihenfolge enthalten. Wenn eines dieser Argumente übergeben wird, ist das andere nicht optional.
non_media_treatments Ein optionales DataArray mit Dimensionen (n_geos, n_times, n_non_media_channels), das Werte für nicht medienbezogene Testvariablen enthält. Diese Variablen enthalten Marketingaktivitäten des Werbetreibenden, die nicht direkt mit Media in Verbindung stehen. Sie sind mit keinen direkten Marketingkosten verbunden, aber im Gegensatz zu Variablen für organische Media gibt es keine Adstock- und Hill-Auswirkungen. Sie unterscheiden sich von Kontrollvariablen, weil sie als beeinflussbar gelten und daher im kausalen Modell Testvariablen sind. Beispiele hierfür sind Werbeaktionen, der Preis eines Produkts und Änderungen an der Verpackung und/oder dem Design eines Produkts.
control_variable Gibt die Dimension der Kontrollvariablen zurück.
geo Gibt die geografische Dimension zurück.
media_channel Gibt die Dimension für den Media-Channel zurück.
media_spend_has_geo_dimension Prüft, ob das media_spend-Array eine geografische Dimension enthält.
media_spend_has_time_dimension Prüft, ob das media_spend-Array eine Zeitdimension enthält.
media_time Gibt die Koordinaten der Zeitdimension für Media zurück.
media_time_coordinates Gibt die Zeitdimension für Media in einem TimeCoordinates-Wrapper zurück.
non_media_channel Gibt die Dimension für nicht mediabezogene Testgruppen-Channels zurück.
organic_media_channel Gibt die Dimension für organische Media-Channels zurück.
organic_rf_channel Gibt die Dimension für Channels für organische Reichweite und Häufigkeit zurück.
rf_channel Gibt die Dimension für Channels für Reichweite und Häufigkeit zurück.
rf_spend_has_geo_dimension Prüft, ob das rf_spend-Array eine geografische Dimension enthält.
rf_spend_has_time_dimension Prüft, ob das rf_spend-Array eine Zeitdimension enthält.
time Gibt die Koordinaten der Zeitdimension zurück.
time_coordinates Gibt die Zeitdimension (KPI) in einem TimeCoordinates-Wrapper zurück.

Methoden

as_dataset

Quelle ansehen

as_dataset() -> xr.Dataset

Gibt Daten als einzelnes xarray.Dataset-Objekt zurück.

get_all_channels

Quelle ansehen

get_all_channels() -> np.ndarray

Gibt alle Channeldimensionen zurück.

Diese Methode gibt die Namen der folgenden Channels zurück: Media, Reichweite und Häufigkeit, organische Media, organische Reichweite und Häufigkeit und nicht mediabezogene Channels,. Sie werden in genau dieser Reihenfolge in einem einzigen Array zusammengeführt.

get_all_media_and_rf

Quelle ansehen

get_all_media_and_rf() -> np.ndarray

Gibt alle Werte für die Media-Ausführung zurück, einschließlich für Media sowie Reichweite und Häufigkeit.

Wenn für die Modellierung Media, Reichweite und Häufigkeit verwendet wurden, wird „Reichweite × Häufigkeit“ an das Ende von „Media“ angehängt.

Ausgabe
np.ndarray mit Dimensionen (n_geos, n_media_times, n_channels), die für jeden media_channel oder rf_channel „Media“ oder „Reichweite × Häufigkeit“ enthalten.

get_all_paid_channels

Quelle ansehen

get_all_paid_channels() -> np.ndarray

Gibt alle Dimensionen für kostenpflichtige Channels zurück, einschließlich Media sowie Reichweite und Häufigkeit.

Wenn sowohl Channels für Media- als auch für Reichweite und Häufigkeit vorhanden sind, werden die Channels für Reichweite und Häufigkeit an das Ende der Media-Channels angefügt.

get_n_top_largest_geos

Quelle ansehen

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

Ermittelt die angegebene Anzahl der größten geografischen Einheiten nach Bevölkerungszahl.

Argumente
num_geos Die Anzahl der größten geografischen Einheiten nach Bevölkerungszahl, die zurückgegeben werden sollen.

Ausgabe
Eine Liste der angegebenen Anzahl der größten geografischen Einheiten.

get_total_spend

Quelle ansehen

get_total_spend() -> np.ndarray

Gibt die Gesamtausgaben zurück, einschließlich media_spend und rf_spend.

__eq__

__eq__(
    other
)

Gibt zurück, ob „self==value“.

frequency None
media None
media_spend None
non_media_treatments None
organic_frequency None
organic_media None
organic_reach None
reach None
revenue_per_kpi None
rf_spend None