Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/content/docs/zaraz/advanced/context-enricher.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ sidebar:

---

import { DashButton } from "~/components";

The Zaraz Context Enricher is a tool to modify or enrich [the context](/zaraz/reference/context/) that is being used across Zaraz using a Cloudflare Worker. The Context Enricher allows you access to the client and system variables.

## Creating a Worker
Expand All @@ -14,8 +16,10 @@ To use a Context Enricher, you first need to create a new Cloudflare Worker. You

To create a new Worker in the Cloudflare dashboard:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/).
2. Go to **Workers & Pages** and select **Create application**.
1. In the Cloudflare dashboard, go to the **Workers & Pages** page.

<DashButton url="/?to=/:account/workers-and-pages" />
2. Select **Create application**.
3. Give a name to your Worker and select **Deploy**.
4. Select **Edit code**.

Expand Down Expand Up @@ -43,8 +47,9 @@ Keep reading for more complete examples of different use cases or refer to [Zara

Now that your Worker is published, you can select it in your Zaraz settings:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/).
2. Go to **Zaraz** > **Settings**.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/tag-management/settings" />
3. Select your Context Enricher Worker.
4. Save your settings.

Expand Down
14 changes: 10 additions & 4 deletions src/content/docs/zaraz/advanced/import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ sidebar:

---

import { DashButton } from "~/components";

Exporting your Zaraz configuration can be useful if you want to create a local backup or if you need to import it to another website. Zaraz provides an easy way to export and import your configuration.

## Export your Zaraz configuration

To export your Zaraz configuration:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Zaraz** > **Settings** > **Advanced**.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/tag-management/settings" />
2. Go to **Advanced**.
3. Click "Export" to download your configuration.

## Import your Zaraz configuration
Expand All @@ -28,6 +32,8 @@ Importing a Zaraz configuration replaces your existing configuration, meaning th

To import a Zaraz configuration:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Zaraz** > **Settings** > **Advanced**.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/tag-management/settings" />
2. Go to **Advanced**.
3. Click **Browse** to select your configuration file, and **Import** to import it.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar:
order: 15
---

import { DashButton } from "~/components";

Zaraz supports loading custom third-party tools using [Managed Components](https://managedcomponents.dev/). These can be Managed Components that you have developed yourself or that were developed by others. Using Custom Managed Components with Zaraz is done by converting them into a Cloudflare Worker running in your account.

If you are new to Managed Components, we recommend you get started with [creating your own Managed Component](https://managedcomponents.dev/getting-started/quickstart) or check out [our demo Managed Component](https://github.com/managed-components/demo).
Expand Down Expand Up @@ -53,8 +55,10 @@ export default async function (manager) {
As with regular tools, it is recommended that you [create the triggers](/zaraz/custom-actions/create-trigger/) you need first, if the Custom Managed Component you are adding needs to start actions using firing triggers different from the default `Pageview` trigger.
:::

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
2. Select **Zaraz** > **Tools Configuration** > [**Third-party tools**](https://dash.cloudflare.com/?to=/:account/:zone/zaraz/tools-config/tools/catalog).
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Select **Tools Configuration** > [**Third-party tools**](https://dash.cloudflare.com/?to=/:account/:zone/zaraz/tools-config/tools/catalog).
3. Select **Add new tool** and choose **Custom Managed Component** from the tools library page. Select **Continue** to confirm your selection.
4. In **Select Custom MC**, choose a Custom Managed Component that you have deployed to your account, such as `custom-mc-my-new-counter-mc`. Select **Continue**.
5. In **Permissions**, select the permissions you want to grant the Custom Managed Component. If you run an untrusted Managed Component, pay close attention to what permissions you are granting. Select **Continue**.
Expand Down
8 changes: 6 additions & 2 deletions src/content/docs/zaraz/advanced/using-jsonata.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ sidebar:

---

import { DashButton } from "~/components";

For advanced use cases, it is sometimes useful to be able to retrieve a value in a particular way. For instance, you might be using `zaraz.track` to send a list of products to Zaraz, but the third-party tool you want to send this data to requires the total cost of the products. Alternatively, you may want to manipulate a value, such as converting it to lowercase.

Cloudflare Zaraz uses JSONata to enable you to perform complex operations on your data. With JSONata, you can evaluate expressions against the [Zaraz Context](/zaraz/reference/context/), allowing you to access and manipulate a wide range of values. To learn more about the values available and how to access them, consult the [full reference](/zaraz/reference/context/). You can also refer to the [complete JSONata documentation](https://docs.jsonata.org/) for more information about JSONata's capabilities.

To use JSONata inside Zaraz, follow these steps:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Zaraz** > **Tools configuration** > **Tools**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management/settings" />
2. Go to **Tools configuration** > **Tools**.
3. Select **Edit** next to a tool that you have already configured.
4. Select an action or add a new one.
5. Choose the field you want to use JSONata in, and wrap your JSONata expression with double curly brackets, like `{{ expression }}`.
Expand Down
9 changes: 6 additions & 3 deletions src/content/docs/zaraz/consent-management/custom-css.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,11 @@ sidebar:

---

import { DashButton } from "~/components";

You can add custom CSS to the Zaraz Consent Management Platform, to make the consent modal more in-line with your website's design.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Consent**.
3. Find the **Custom CSS** section, and add your custom CSS code as you would on any other HTML editor.
1. In the Cloudflare dashboard, go to the **Consent** page.

<DashButton url="/?to=/:account/tag-management/consent" />
2. Find the **Custom CSS** section, and add your custom CSS code as you would on any other HTML editor.
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,28 @@ head:

---

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Consent**.
3. Turn on **Enable Consent Management**.
4. In **Consent modal text** fill in any legal information required in your country. Use HTML code to format your information as you would in any other HTML editor.
5. Under **Purposes**, select **Add new Purpose**. Give your new purpose a name and a description. Purposes are the reasons for using third-party tools in your website.
6. In **Assign purpose to tools**, match tools to purposes by selecting one of the purposes previously created from the drop-down menu. Do this for all your tools.
7. Select **Save**.
import { DashButton } from "~/components";

1. In the Cloudflare dashboard, go to the **Consent** page.

<DashButton url="/?to=/:account/tag-management/consent" />
2. Turn on **Enable Consent Management**.
3. In **Consent modal text** fill in any legal information required in your country. Use HTML code to format your information as you would in any other HTML editor.
4. Under **Purposes**, select **Add new Purpose**. Give your new purpose a name and a description. Purposes are the reasons for using third-party tools in your website.
5. In **Assign purpose to tools**, match tools to purposes by selecting one of the purposes previously created from the drop-down menu. Do this for all your tools.
6. Select **Save**.

Your Consent Management platform is ready. Your website should now display a modal asking for consent for the tools you have configured.

## Adding different languages

In your Zaraz consent settings, you can add your consent modal text and purposes in various languages.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Consent**.
3. Select a default language of your choice. The default setting is English.
4. In **Consent modal text** and **Purposes**, you can select different languages and add translations.
1. In the Cloudflare dashboard, go to the **Consent** page.

<DashButton url="/?to=/:account/tag-management/consent" />
2. Select a default language of your choice. The default setting is English.
3. In **Consent modal text** and **Purposes**, you can select different languages and add translations.

## Overriding the consent modal language

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,18 @@ head:

---

import { DashButton } from "~/components";


The Zaraz Consent Management Platform is compliant with the IAB Transparency & Consent Framework. Enabling this feature [could be required](https://blog.google/products/adsense/new-consent-management-platform-requirements-for-serving-ads-in-the-eea-and-uk/) in order to serve Google Ads in the EEA and the UK.

The CMP ID of the approval is 433 and be can seen in the [IAB Europe](https://iabeurope.eu/cmp-list/) website.

Using the Zaraz Consent Management Platform in IAB TCF Compliance Mode is is opt-in.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Select **Zaraz** > **Consent**.
3. Check the **Use IAB TCF compliant modal** option.
4. Under the **Assign purposes to tools** section, add vendor details to every tool that was not automatically assigned.
5. Press **Save**.
1. In the Cloudflare dashboard, go to the **Consent** page.

<DashButton url="/?to=/:account/tag-management/consent" />
2. Check the **Use IAB TCF compliant modal** option.
3. Under the **Assign purposes to tools** section, add vendor details to every tool that was not automatically assigned.
4. Press **Save**.
15 changes: 11 additions & 4 deletions src/content/docs/zaraz/custom-actions/additional-fields.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,19 @@ sidebar:

---

import { DashButton } from "~/components";


Some tools supported by Zaraz let you add fields in addition to the required field. Fields can usually be added either to a specific action, or to all the action within a tool, by adding the field as a **Default Field**.

## Add an additional field to a specific action

Adding an additional field to an action will attach it to this action only, and will not affect your other actions.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Select **Zaraz** > **Tools Configuration** > **Third-party tools**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Select **Tools Configuration** > **Third-party tools**.
3. Locate the third-party tool with the action you want to add the additional field to, and select **Edit**.
4. Select the action you wish to modify.
5. Select **Add Field**.
Expand All @@ -27,8 +32,10 @@ The new field will now be used in this event.

Adding an additional field to the tool sets it as a default field for all of the tool actions. It is the same as adding it to every action in the tool.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Select **Zaraz** > **Tools**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Select **Tools Configuration** > **Third-party tools**.
3. Locate the third-party tool where you want to add the field, and select **Edit**.
4. Select **Settings** > **Add Field**.
5. Choose the desired field from the drop-down menu, and select **Add**.
Expand Down
11 changes: 8 additions & 3 deletions src/content/docs/zaraz/custom-actions/create-action.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@ sidebar:
order: 2
---

Once you have your triggers ready, you can use them to configure your actions. An action defines a specific task that your tool will perform.
import { DashButton } from "~/components";


Once you have your triggers ready, you can use them to configure your actions. An action defines a specific task that your tool will perform.

To create an action, first [add a third-party tool](/zaraz/get-started/). If you have already added a third-party tool, follow these steps to create an action.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Under **Third-party tools**, locate the tool you want to configure an action for, and select **Edit**.
4. Under Custom actions select **Create action**.
5. Give the action a descriptive name.
Expand Down
9 changes: 7 additions & 2 deletions src/content/docs/zaraz/custom-actions/create-trigger.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ sidebar:
order: 2
---

import { DashButton } from "~/components";


Triggers define the conditions under which a tool will start an action. Since a tool must have actions in order to work, and actions must have triggers, it is important to set up your website's triggers correctly. A trigger can be made out of one or more Rules. Zaraz supports [multiple types of Trigger Rules](/zaraz/reference/triggers/).

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Select the **Triggers** tab.
4. Select **Create trigger**.
5. In **Trigger Name** enter a descriptive name for your trigger.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,28 +5,38 @@ sidebar:
order: 6

---
import { DashButton } from "~/components";

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools**.

1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools**.
3. Under **Third-party tools**, locate your tool and select **Edit**.

On this page you will be able to edit settings related to the tool, add actions, and edit existing ones. To edit an existing action, select its name.

## Enable or disable a tool

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Under **Third-party tools**, locate your tool and select the **Enabled** toggle.

## Enable or disable an action

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration** > **Third-party tools**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration** > **Third-party tools**.
3. Locate the tool you wan to edit and select **Edit**.
4. Find the action you want to change state, and enable or disable it with the toggle.

## Delete a tool

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Under **Third-party tools**, locate your tool and select **Delete**.
15 changes: 11 additions & 4 deletions src/content/docs/zaraz/custom-actions/edit-triggers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,21 @@ head:

---

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
import { DashButton } from "~/components";


1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Under **Triggers**, locate your trigger and select **Edit**.

You can edit every field related to the trigger, as well as add new trigger rules.

## Delete a trigger

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag setup** page.

<DashButton url="/?to=/:account/tag-management" />
2. Go to **Tools Configuration**.
3. Under **Triggers**, locate your trigger and select **Delete**.
8 changes: 6 additions & 2 deletions src/content/docs/zaraz/embeds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ sidebar:

---

import { DashButton } from "~/components";

Embeds are tools for incorporating external content, like social media posts, directly onto webpages, enhancing user engagement without compromising site performance and security.

Cloudflare Zaraz introduces server-side rendering for embeds, avoiding third-party JavaScript to improve security, privacy, and page speed. This method processes content on the server side, removing the need for direct communication between the user's browser and third-party servers.

To add an Embed to Your Website:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login), and select your account and domain.
2. Go to **Zaraz** > **Tools Configuration**.
1. In the Cloudflare dashboard, go to the **Tag Setup** page.

<DashButton url="/?to=/:account/tag-management/zaraz" />
2. Go to **Tools Configuration**.
3. Click "add new tool" and activate the desired tools on your Cloudflare Zaraz dashboard.
4. Add a placeholder in your HTML, specifying the necessary attributes. For a generic embed, the snippet looks like this:

Expand Down
9 changes: 6 additions & 3 deletions src/content/docs/zaraz/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
order: 10
---

import { GlossaryTooltip } from "~/components";
import { DashButton, GlossaryTooltip } from "~/components";

Below you will find answers to our most commonly asked questions. If you cannot find the answer you are looking for, refer to the [community page](https://community.cloudflare.com/) or [Discord channel](https://discord.cloudflare.com) to explore additional resources.

Expand Down Expand Up @@ -72,8 +72,11 @@ To prevent Zaraz from loading on specific pages, refer to [Load Zaraz selectivel

Resetting your Zaraz configuration will erase all of your configuration settings, including any tools, triggers, and variables you've set up. This action will disable Zaraz immediately. If you want to start over with a clean slate, you can always reset your configuration.

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/), and select your account and domain.
2. Go to **Zaraz** > **Settings** > **Advanced**.
1. In the Cloudflare dashboard, go to the **Settings** page.

<DashButton url="/?to=/:account/tag-management/settings" />

2. Go to **Advanced**.
3. Click "Reset" and follow the instructions.

### Zaraz Web API
Expand Down
Loading
Loading