meridian.data.input_data.InputData

Un contenitore di dati per i dati pubblicitari in un formato supportato da 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 Un array di dati di dimensioni (n_geos, n_times) contenente la variabile dipendente non negativa. In genere si tratta del numero di unità vendute, ma può essere qualsiasi metrica, ad esempio entrate o conversioni.
kpi_type Una stringa che indica se il KPI è di tipo 'revenue' o 'non-revenue'. Quando kpi_type è 'non-revenue' e esiste revenue_per_kpi, viene utilizzata la calibrazione del ROI e l'analisi viene eseguita sulle entrate. Quando revenue_per_kpi non esiste per lo stesso kpi_type, viene utilizzata la calibrazione del ROI personalizzata e l'analisi viene eseguita sul KPI.
controls Un array di dati di dimensioni (n_geos, n_times, n_controls) contenente i valori delle variabili di controllo.
population Un array di dati di dimensioni (n_geos,) contenente la popolazione di ciascun gruppo. Questa variabile viene utilizzata per scalare il KPI e i dati medi per la modellazione.
revenue_per_kpi Un array di dati facoltativo di dimensioni (n_geos, n_times) contenente l'importo medio delle entrate per unità di KPI. Sebbene la definizione del modello venga eseguita su kpi, l'analisi e l'ottimizzazione del modello vengono eseguite su KPI * revenue_per_kpi (entrate), se questo valore è disponibile. Se kpi corrisponde alle entrate, viene passato automaticamente un array di 1.
media Un array di dati facoltativo di dimensioni (n_geos, n_media_times, n_media_channels) contenente valori di esecuzione dei media non negativi. In genere si tratta di impressioni, ma può essere qualsiasi metrica, ad esempio il costo o i clic. n_media_times ≥ n_times è obbligatorio e gli intervalli di tempo n_times finali devono essere in linea con l'intervallo di tempo di kpi e controls. A causa degli effetti ritardati, consigliamo di includere fino a max_lag periodi aggiuntivi precedenti a questa finestra temporale. Se n_media_times < n_times + max_lag, il modello assegna effettivamente alla cronologia dei media il valore zero (nessuna esecuzione di media). Se n_media_times > n_times + max_lag, vengono utilizzati solo gli ultimi n_times + max_lag periodi per adattare il modello. media e media_spend devono contenere lo stesso numero di canali media nello stesso ordine. Se viene passato uno di questi argomenti, l'altro non è facoltativo.
media_spend Un DataArray facoltativo contenente il costo di ciascun canale media. Viene utilizzato come denominatore per i calcoli del ROI. La forma DataArray può essere (n_geos, n_times, n_media_channels) o (n_media_channels,) se i dati sono aggregati per le dimensioni geo e time. Allinea il costo totale alla finestra temporale dei dati kpi e controls, ovvero la finestra temporale in cui vengono calcolate le entrate incrementali del numeratore del ROI. Il risultato incrementale è influenzato dall'esecuzione dei media prima di questo intervallo di tempo, tramite effetti ritardati. media e media_spend devono contenere lo stesso numero di canali media nello stesso ordine. Se viene passato uno di questi argomenti, l'altro non è facoltativo.
reach Un DataArray facoltativo di dimensioni (n_geos, n_media_times, n_rf_channels) contenenti valori reach non negativi. È obbligatorio che n_media_times ≥ n_times e che i periodi di tempo n_times finali devano essere in linea con la finestra temporale di kpi e controls. L'intervallo di tempo deve includere l'intervallo di tempo dei dati kpi e controls, ma è facoltativo includere periodi di tempo in ritardo precedenti all'intervallo di tempo dei dati kpi e controls. Se la copertura con ritardo non è inclusa o se la copertura con ritardo include meno di max_lag periodi di tempo, il modello calcola l'inventario pubblicitario inutilizzato assumendo che l'esecuzione della copertura sia pari a zero prima del primo periodo di tempo osservato. Ti consigliamo di includere periodi di tempo di n_times + max_lag, a meno che il valore di max_lag non sia eccessivamente elevato. Se vengono utilizzati solo i dati media, reach sarà None. reach, frequency e rf_spend devono contenere lo stesso numero di canali media nello stesso ordine. Se viene passato uno di questi argomenti, gli altri non sono facoltativi.
frequency Un DataArray facoltativo di dimensioni (n_geos, n_media_times, n_rf_channels) contenenti valori frequency non negativi. È obbligatorio che n_media_times ≥ n_times e che i periodi di tempo n_times finali devano essere in linea con la finestra temporale di kpi e controls. L'intervallo di tempo deve includere l'intervallo di tempo dei dati kpi e controls, ma è facoltativo includere periodi di tempo in ritardo precedenti all'intervallo di tempo dei dati kpi e controls. Se la frequenza con ritardo non è inclusa o se include meno di max_lag periodi di tempo, il modello calcola l'inventario pubblicitario assumendo che l'esecuzione della frequenza sia pari a zero prima del primo periodo di tempo osservato. Ti consigliamo di includere periodi di tempo n_times + max_lag, a meno che il valore di max_lag non sia proibitivo. Se vengono utilizzati solo i dati media, frequency sarà None. reach, frequency e rf_spend devono contenere lo stesso numero di canali media nello stesso ordine. Se viene passato uno di questi argomenti, gli altri non sono facoltativi.
rf_spend Un DataArray facoltativo contenente il costo di ogni canale di copertura e frequenza. Viene utilizzato come denominatore per i calcoli del ROI. La forma dell'array di dati può essere (n_rf_channels,), (n_geos, n_times, n_rf_channels) o (n_geos, n_rf_channels). La spesa deve essere aggregata in base a dimensioni geografiche e/o temporali non rappresentate. Ti consigliamo di allineare il totale della spesa alla finestra temporale dei dati kpi e controls, ovvero la finestra temporale in cui viene calcolato il risultato incrementale del numeratore del ROI. Tuttavia, tieni presente che il risultato incrementale è influenzato dall'esecuzione dei contenuti multimediali precedenti a questa finestra temporale, tramite effetti ritardati, ed esclude gli effetti ritardati oltre la finestra temporale dei contenuti multimediali eseguiti durante la finestra temporale. Se vengono utilizzati solo i dati media, rf_spend sarà None. reach, frequency e rf_spend devono contenere lo stesso numero di canali media nello stesso ordine. Se viene passato uno di questi argomenti, gli altri non sono facoltativi.
organic_media Un DataArray facoltativo di dimensioni (n_geos, n_media_times, n_organic_media_channels) contenenti valori medi organici non negativi. Le variabili dei media organici sono attività mediatiche che non hanno un costo diretto. Potrebbero essere incluse le impressioni generate da newsletter, post del blog, attività sui social media o campagne email, ma può essere utilizzata qualsiasi metrica, ad esempio i clic. n_media_times ≥ n_times è obbligatorio e gli intervalli di tempo n_times finali devono essere in linea con l'intervallo di tempo di kpi e controls. A causa degli effetti ritardati, consigliamo che la finestra temporale per i contenuti organici includa fino a max_lag periodi aggiuntivi precedenti a questa finestra. Se n_organic_media_times < n_times + max_lag, il modello attribuisce efficacemente la cronologia dei contenuti organici. Se n_organic_media_times > n_times + max_lag, vengono utilizzati solo gli ultimi n_times + max_lag periodi per adattare il modello.
organic_reach Un DataArray facoltativo di dimensioni (n_geos, n_media_times, n_organic_rf_channels) contenenti valori di copertura organica non negativi. È necessario che n_media_times ≥ n_times e che i periodi di tempo n_times finali siano in linea con la finestra temporale di kpi e controls. L'intervallo di tempo deve includere l'intervallo di tempo dei dati kpi e controls, ma è facoltativo includere periodi di tempo in ritardo precedenti all'intervallo di tempo dei dati kpi e controls. Se la copertura con ritardo non è inclusa o se include meno di max_lag periodi di tempo, il modello calcola l'inventario pubblicitario inutilizzato assumendo che l'esecuzione della copertura sia pari a zero prima del primo periodo di tempo osservato. Ti consigliamo di includere periodi di tempo di n_times + max_lag, a meno che il valore di max_lag non sia eccessivamente elevato. Se non vengono utilizzati dati sulla copertura e sulla frequenza organica, organic_reach e organic_frequency saranno None. organic_reach e organic_frequency devono contenere lo stesso numero di canali nello stesso ordine. Se viene passato uno di questi argomenti, l'altro non è facoltativo.
organic_frequency Un DataArray facoltativo di dimensioni (n_geos, n_media_times, n_organic_rf_channels) contenenti valori di frequenza organica non negativi. È necessario che n_media_times ≥ n_times e che i periodi di tempo n_times finali siano in linea con la finestra temporale di kpi e controls. L'intervallo di tempo deve includere l'intervallo di tempo dei dati kpi e controls, ma è facoltativo includere periodi di tempo in ritardo precedenti all'intervallo di tempo dei dati kpi e controls. Se la frequenza con ritardo non è inclusa o se include meno di max_lag periodi di tempo, il modello calcola l'inventario pubblicitario scaduto assumendo che l'esecuzione della frequenza sia pari a zero prima del primo periodo di tempo osservato. Ti consigliamo di includere periodi di tempo n_times + max_lag, a meno che il valore di max_lag non sia eccessivamente elevato. Se non vengono utilizzati dati sulla copertura e sulla frequenza organica, organic_frequency sarà None. organic_reach e organic_frequency devono contenere lo stesso numero di canali nello stesso ordine. Se viene passato uno di questi argomenti, l'altro non è facoltativo.
non_media_treatments Un array di dati facoltativo di dimensioni (n_geos, n_times, n_non_media_channels) contenente i valori delle variabili di trattamento non mediali. Le variabili di trattamento non media sono le attività di marketing intraprese dall'inserzionista non direttamente correlate ai media. Non hanno costi di marketing diretto associati, ma a differenza delle variabili dei media organici non sono presenti effetti Adstock e Hill. Sono diverse dalle variabili di controllo in quanto considerate suscettibili di intervento e, di conseguenza, sono variabili di trattamento nel modello causale. Alcuni esempi includono l'organizzazione di una promozione, il prezzo di un prodotto e la modifica del packaging e/o del design di un prodotto.
control_variable Restituisce la dimensione della variabile di controllo.
geo Restituisce la dimensione geografica.
media_channel Restituisce la dimensione del canale multimediale.
media_spend_has_geo_dimension Controlla se l'array media_spend contiene una dimensione geografica.
media_spend_has_time_dimension Controlla se l'array media_spend ha una dimensione temporale.
media_time Restituisce le coordinate della dimensione temporale dei contenuti multimediali.
media_time_coordinates Restituisce la dimensione Tempo media in un wrapper TimeCoordinates.
non_media_channel Restituisce la dimensione del canale per i trattamenti non multimediali.
organic_media_channel Restituisce la dimensione del canale multimediale organico.
organic_rf_channel Restituisce la dimensione del canale RF organico.
rf_channel Restituisce la dimensione del canale RF.
rf_spend_has_geo_dimension Controlla se l'array rf_spend contiene una dimensione geografica.
rf_spend_has_time_dimension Controlla se l'array rf_spend ha una dimensione temporale.
time Restituisce le coordinate della dimensione temporale.
time_coordinates Restituisce la dimensione temporale (KPI) in un wrapper TimeCoordinates.

Metodi

as_dataset

Visualizza codice sorgente

as_dataset() -> xr.Dataset

Restituisce i dati come un singolo oggetto xarray.Dataset.

get_all_channels

Visualizza codice sorgente

get_all_channels() -> np.ndarray

Restituisce tutte le dimensioni del canale.

Questo metodo restituisce i nomi dei canali media, RF, media organici, RF organici e non media, concatenati in un unico array in questo ordine.

get_all_media_and_rf

Visualizza codice sorgente

get_all_media_and_rf() -> np.ndarray

Restituisce tutti i valori di esecuzione dei media, inclusi i media e l'RF.

Se per la definizione del modello sono stati utilizzati media, copertura e frequenza, la copertura * frequenza viene concatenata alla fine dei media.

Resi
np.ndarray con dimensioni (n_geos, n_media_times, n_channels) contenente media o copertura * frequenza per ogni media_channel o rf_channel.

get_all_paid_channels

Visualizza codice sorgente

get_all_paid_channels() -> np.ndarray

Restituisce tutte le dimensioni dei canali a pagamento, inclusi i media e la RF.

Se sono presenti sia canali media che RF, i canali RF vengono concatenati alla fine dei canali media.

get_n_top_largest_geos

Visualizza codice sorgente

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

Trova il numero specificato di aree geografiche più grandi per popolazione.

Args
num_geos Il numero di aree geografiche più grandi da restituire in base alla popolazione.

Resi
Un elenco del numero specificato di aree geografiche principali più grandi.

get_total_spend

Visualizza codice sorgente

get_total_spend() -> np.ndarray

Restituisce la spesa totale, inclusi media_spend e rf_spend.

__eq__

__eq__(
    other
)

Restituisce self==value.

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