What is an event settings variable?
You can reuse event settings across several Google tags and GA4 Event tags using a Google Tag: Event Settings variable.
For example, suppose you own an online store and you are having a sale. Now, you would like to track how many people use the discount code that you provided them. Instead of adding a discount
parameter to each of your tags manually, you can reuse the parameter with a Google Tag: Event Settings variable.
How to use an event settings variable
To create a new event settings variable:
- Open Google Tag Manager
- In your workspace, open the Variables menu on the left.
- Create a New user-defined variable.
- In Variable Configuration, select the Google Tag: Event Settings variable.
- Add the parameters you want to reuse. You can find a table of pre-defined parameters below. If none of these fit your needs, you can always create a custom parameter. Just type a name of your choice in the Name field.
- Optional: Add Google Analytics User Properties to your event:
- Under Google Analytics User Properties, click Add Property.
- Set up the key-value pair to send with the event:
-
Set Property Name to the category you want to send, for example,
favorite_food
. - Set Value to the user-specific data, for example,
apple
.
-
- Name your variable and Save.
Reuse settings in a Google tag
To send event-level parameters with every event, use the event settings variable in a Google tag.
- In your workspace, open the Tags menu on the left.
- Select a Google tag you want to apply a settings variable to.
- Reuse settings:
- To reuse Configuration settings, select a Google tag: Configuration settings variable from the dropdown list.
- To reuse Shared event settings, select a Google tag: Event settings variable from the dropdown list.
- To see what parameters were inherited from the settings variable, click Show inherited settings.
- To edit an inherited parameter for the Google tag only, click on Edit .
- To revert an edited inherited parameter, click Reset .
- Save the tag and Publish the container.
Reuse settings in a GA4 Event tag
To send event-level parameters for only for select GA4 events, add the event settings variable to a GA4 Event tag.
- In your workspace, open the Tags menu on the left.
- Select a GA4 Event tag you want to apply a settings variable to.
- Reuse settings:
- To reuse Event settings, select a Google Tag: Event Settings variable from the dropdown list.
- To see what parameters were inherited from the settings variable, click Show inherited settings.
- To edit an inherited parameter for the Google tag only, click on Edit .
- To revert an edited inherited parameter, click Reset .
- Save the tag and Publish the container.
Valid parameters for event settings
The following table lists pre-defined parameters and which products you can use them with (marked by an x). These are not event names. For a list of predefined event names, see the recommended events reference.
Name | Type | Default value | Description | Ads | GA4 | Merchant Center |
---|---|---|---|---|---|---|
achievement_id | string | undefined | The id of the achievement that was unlocked. Part of the unlock_achievement event to measure game experience. | x | ||
aw_feed_country | string | undefined | The country associated with the feed where your items are uploaded. Use CLDR territory codes, for example, 'US' .Part of Conversions with Cart Data reporting. |
x | ||
aw_language | string | undefined | The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. Part of Conversions with Cart Data reporting. | x | ||
aw_merchant_id | integer | undefined | The Merchant Center ID. Provide this parameter if you keep an item in several Merchant Center accounts and you want to control from which Merchant Center the item's data, for example, its COGS, should be read. Part of Conversions with Cart Data reporting. | x | ||
content_group | string | undefined | Content groups let you categorize pages and screens into custom buckets. Learn more | x | x | |
content_id | string | undefined | An identifier for the content that was selected, for example, C_12345 . Part of the select_content event. |
x | x | |
content_type | string | undefined | The type of content, for example 'image' . Part of the share and select_content event. |
x | ||
coupon | string | undefined | The coupon name/code associated with the event. Event-level and item-level coupon parameters are independent. |
x | ||
country | string | undefined | Parameter to capture the user's country. Use ISO 3166-1 alpha-2 format. (For example, 'US' for United States) |
x | ||
currency | string | undefined | Currency of the items associated with the event, in 3-letter ISO 4217 format. * If you set value then currency is required for revenue metrics to be computed accurately. |
x | x | x |
delivery_postal_code | number | undefined | The regional prefix, or designation portion, of a postal code for an order's shipping address. The regional prefix is used to determine the merchant's on-time performance. When submitting this data, we recommend only including the first 3 digits of a zip code. Part of Ads conversion tracking to validate shipping data. |
x | x | |
discount | number | undefined | The monetary discount value associated with the item. | x | x | |
estimated_delivery_date | string | undefined | The latest (or "max") promised delivery date for an order in a customer's cart data. For orders with products that are under consideration for free and fast delivery (new or maintain status), Google uses this date to validate shipping speed. Note: This parameter uses the international date format (YYYY-MM-DD). The date you submit here should be based on the date and time zone of the location you submitted for the delivery_postal_code .Part of Ads conversion tracking to validate shipping data. |
x | ||
group_id | string | undefined | The ID of the group, for example, G_12345 . Part of the join_group event used to measure how popular certain groups or social features are. |
x | ||
items | array<Item> | undefined | Lists the items for the event. This is an ecommerce parameter that has sub-parameters. You can find the sub-parameters for: | x | x | x |
language | string | navigator.language |
Specifies the language preference of the user. | x | x | x |
method | string | undefined | The method a user chooses to do something, for example 'email' . Part of the login , share , and sign_up event. |
x | ||
payment_type | string | undefined | A customer's chosen payment method, for example, 'credit card' . |
x | ||
score | number | undefined | The user's score. Part of the post_score event to measure scores in games. |
x | ||
search_term | string | undefined | The term that was searched for. Part of the search event. |
x | ||
send_to | string | undefined | Specifies a Google tag destination ID. To be used together with the groups configuration parameter. |
x | x | x |
shipping | number | undefined | Shipping cost associated with a transaction, for example, 4.99 . |
x | x | x |
shipping_tier | string | undefined | The shipping tier (e.g. 'Ground' , 'Air' , 'Next-day' ) selected for delivery of the purchased item. |
x | x | x |
tax | number | undefined | Tax cost associated with a transaction, for example, 1.11 . |
x | x | |
transaction_id | string | undefined | The unique identifier of a transaction, for example, T_12345 .The transaction_id parameter helps you avoid getting duplicate events for a purchase. |
x | x | x |
user_data | object | undefined | Parameter to opt-out of automatic user-provided data collection. To opt out for select pages, set user_data to null . To opt-out of user-defined data collection altogether, use the Google tag setting. |
x | ||
user_properties | object | undefined | Parameter to send additional Google Analytics User Properties with an event. Learn how to set up user properties. | x | ||
value | number | undefined | The monetary value of the event, for example, 12.99 .value is required for meaningful reporting and to populate the purchasers predictive audience.* If you set value , you also need to set currency . |
x | x | x |
virtual_currency_name | string | undefined | The name of the virtual currency. Part of the earn_virtual_currency and spend_virtual_currency events. |
x |
Related resources
- Reuse configuration settings
- Measure ecommerce events
- Set up Google Ads tags
- Floodlight parameters and the Google tag
- Merchant Center: Product data attributes