<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/google/meridian/blob/v2.2.0/scenarioplanner/__init__.py) |

Generates Meridian Scenario Planner Dashboards in Looker Studio.

This package provides tools to create and manage Meridian dashboards. It helps
transform data from the MMM (Marketing Mix Modeling) schema into a custom
Looker Studio dashboard, which can be shared via a URL.

The typical workflow is:

1. Analyze MMM data into the appropriate schema.
2. Generate UI-specific proto messages from this data using `mmm_ui_proto_generator`.
3. Build a Looker Studio URL that embeds this UI proto data using `linkingapi`.

Key functionalities include:

- `linkingapi`: Builds Looker Studio report URLs with embedded data sources. This allows for the creation of pre-configured reports.
- `mmm_ui_proto_generator`: Generates a `Mmm` proto message for the Meridian Scenario Planner UI. It takes structured MMM data and transforms it into the specific proto format that the dashboard frontend expects.
- `converters`: Provides utilities to convert and transform analyzed model data into a data format that Looker Studio expects.

## Modules

[`converters`](https://developers.google.com/meridian/reference/api/scenarioplanner/converters.md) module: Provides tools for converting and wrapping MMM schema data.

[`linkingapi`](https://developers.google.com/meridian/reference/api/scenarioplanner/linkingapi.md) module: Builds Looker Studio report URLs.

[`mmm_ui_proto_generator`](https://developers.google.com/meridian/reference/api/scenarioplanner/mmm_ui_proto_generator.md) module: Generates an `Mmm` (Marketing Mix Model) proto for Meridian UI.