Blueprint

Document a Data Layer

A data layer in Blueprint is the documented list of keys your site exposes to tags, such as dataLayer[N].event or digitalData.page.pageName. Build it key by key, seed it with standard objects, or import it from a JSON sample.

What a data layer is

A data layer documents the structure your site publishes for tags to read. Each entry is an object: a path such as dataLayer[N].ecommerce.value, its data type, an optional static value or example, and whether it is required. Requirements reference these objects, so a change here affects every requirement that uses them.

A property can hold several data layers, for example one per site section or one per vendor format.

Create a data layer

  1. In Blueprint, click Data Layers in the sidebar.
  2. Click Add Data Layer.
  3. Enter a Title and a Description.
  4. Pick the Primary Type: the format the site uses. See the table below.
  5. Click Submit. The new data layer appears in the list.

The Primary Type can only be set when the data layer is created.

Primary TypePaths start with
Google Tag ManagerdataLayer[N].
Tealiumutag_data.
W3C CEDDLdigitalData.
Adobe Data LayeradobeDataLayer.
HTML Data Attributedata- (an attribute on a page element)
Ensighten, Qubit, Other, Other Static Array, Other Object Array, URL Query ParameterNo fixed prefix

Add an object

  1. Click the data layer's title in the list to open it.
  2. Click Add Object.
  3. Pick the Type. For Google Tag Manager, Tealium, W3C CEDDL and Adobe Data Layer, the Path field shows the prefix and you type the rest, for example ecommerce.value. For HTML Data Attribute, enter a CSS Selector and the attribute Name instead.
  4. Pick the Data Type. Choosing Function replaces the Value field with a Javascript editor.
  5. Fill in the optional fields (see below) and click Save.
FieldWhat it does
ValueAn exact static value the key must hold. Tick Case-sensitive if the match should respect case
DescriptionWhat the key means
Example ValueA sample value shown to testers
RequiredMarks the key as required
Global (ALL Requirements)Applies the object to every requirement on the property

Array positions are stored as [N], so items[0].price and items[3].price are the same object. Adding a path that already exists is rejected with "An object already exist at the specified path."

Edit, clone or delete an object

Each row on the Keys tab has three icons: edit, clone, and delete. Clone opens the form pre-filled so you can change only the path. Delete asks for confirmation, because every requirement that uses the object is affected.

Generate standard objects

Open a data layer, click the arrow next to Add Object, and choose Generate Objects. Blueprint adds the standard keys for the property's analytics platform. On a GA4 property this includes event, page, user and form fields. Keys that already exist are skipped, so you can run it more than once.

See the whole structure

The JSON tab assembles every object path into one read-only JSON outline. Use it to check the shape before you hand it to developers.

Download or delete a data layer

The icons on each row of the data layer list:

IconAction
UploadOpens Import a Data Layer
DownloadDownloads a CSV with Title, Description, Data Type, Type, Value, Example, Required and Enabled for every object
EditChanges the title and description
DeleteRemoves the data layer after you confirm

Troubleshooting

ProblemCause and fix
"An object already exist at the specified path."The path is already in this data layer, possibly written with a different array index. Edit the existing object instead
A digitalData. path switched typeAny path that starts with digitalData. is saved as W3C CEDDL with the prefix removed
Generate Objects added nothingEvery standard key for the platform already exists in this data layer