Add/ga4 schemas #1387

adatzer · 2024-02-13T08:30:47Z

This PR cherry-picks #1245 and splits adding the schemas into commits.
The events are documented here: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag

istreeter

The schemas look good. My only comment is about monetary values.

A field with "type": "number" will get loaded into the warehouse as a double. If you add "multipleOf": 0.01 then it gets loaded as a decimal, which might be more convenient for the end user working with the data. (Although I am not an expert in how analysts work with this data).

See for example the following schemas which specify a multipleOf for monetary values:

schemas/com.google.analytics.ecommerce/item/jsonschema/1-0-0
schemas/com.google.analytics.ecommerce/transaction/jsonschema/1-0-0
schemas/com.google.analytics.enhanced-ecommerce/actionFieldObject/jsonschema/1-0-0
schemas/com.google.analytics.enhanced-ecommerce/impressionFieldObject/jsonschema/1-0-0
schemas/com.google.analytics.enhanced-ecommerce/productFieldObject/jsonschema/1-0-0
schemas/com.google.analytics.measurement-protocol/item/jsonschema/1-0-0
schemas/com.google.analytics.measurement-protocol/product/jsonschema/1-0-0
schemas/com.google.analytics.measurement-protocol/product_impression/jsonschema/1-0-0
schemas/com.google.analytics.measurement-protocol/transaction/jsonschema/1-0-0
schemas/com.snowplowanalytics.snowplow.ecommerce/cart/jsonschema/1-0-0
schemas/com.snowplowanalytics.snowplow.ecommerce/product/jsonschema/1-0-0
schemas/com.snowplowanalytics.snowplow.ecommerce/refund/jsonschema/1-0-0
schemas/com.snowplowanalytics.snowplow.ecommerce/transaction/jsonschema/1-0-0

greg-el

These look good to me, can't find any discrepancies with the GA4 events.

miike · 2025-05-22T00:01:49Z

If you add "multipleOf": 0.01 then it gets loaded as a decimal, which might be more convenient for the end user working with the data. (Although I am not an expert in how analysts work with this data).

@istreeter this makes sense, the other schemas are a little bit incorrect here (we need multipleOf 0.001) for consistency with three decimal place currencies. This will still create a decimal with the correct scale right?

If so I'm happy to update.

istreeter · 2025-05-22T07:47:50Z

I confirm multipleOf 0.001 will still create a decimal field. So that sounds like a good solution.

miike · 2025-05-23T04:33:19Z

Thanks for confirming @istreeter.

I've added multipleOf for fields where it feels required, primarily for ecommerce. I left virtual currencies as is because for invented currencies (or things like crypto) we don't know what scale is necessarily being used.

@greg-el Do you mind giving this another once over and then we can hopefully get it merged? Thanks.

greg-el

The multipleOf changes look good. LGTM assuming the changes are split out into the relevant commits.

…-0-0 (close #1372)

…ma/1-0-0 (close #1373)

#1374)

…lose #1375)

#1376)

…lose #1377)

…0-0 (close #1378)

…lose #1379)

…0-0 (close #1380)

…ema/1-0-0 (close #1381)

close #1382)

…-0-0 (close #1383)

…1-0-0 (close #1384)

#1385)

close #1386)

AlexBenny · 2025-05-30T15:57:04Z

I've splitted out mike's changes to the relevant commits

AlexBenny

@miike @greg-el can you quickly check the comments I raised?
In a few places the field is nullable but also required.
They are technically valid but ambiguous. I'd like to check with you if this is by design or a mistake.

AlexBenny · 2025-05-30T16:13:27Z

schemas/com.google.tag-manager.server-side/post_score/jsonschema/1-0-0

+        "properties": {
+                "score": {
+                        "description": "The score to post.",
+                        "type": ["number", "null"]


Are we okay to keep it nullable even if it's a required field?
(for ref: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events#post_score)

Yeah, null is fine here.

AlexBenny · 2025-05-30T16:16:54Z

schemas/com.google.tag-manager.server-side/spend_virtual_currency/jsonschema/1-0-0

+                        "maxLength": 500
+                }
+        },
+        "required": ["virtual_currency_name", "value"],


Same here. Is it ok to keep them nullable even if required?
Ref: https://developers.google.com/analytics/devguides/collection/protocol/ga4/reference/events#spend_virtual_currency

Yeah no issue, this just means you can send null in here if you want to.

AlexBenny · 2025-05-30T16:18:04Z

schemas/com.google.tag-manager.server-side/unlock_achievement/jsonschema/1-0-0

+                        "maxLength": 500
+                }
+        },
+        "required": ["achievement_id"],


Required but nullable. Is it ok?

AlexBenny

LGTM

adatzer mentioned this pull request Feb 13, 2024

Add additional GA4 schemas #1245

Closed

jethron changed the base branch from master to release/r167 April 30, 2025 23:30

jethron requested a review from miike April 30, 2025 23:31

jbeemster assigned istreeter May 2, 2025

jbeemster requested a review from istreeter May 2, 2025 07:06

istreeter reviewed May 2, 2025

View reviewed changes

AlexBenny requested a review from greg-el May 12, 2025 15:46

greg-el approved these changes May 21, 2025

View reviewed changes

miike requested review from greg-el and istreeter May 23, 2025 04:33

greg-el approved these changes May 28, 2025

View reviewed changes

greg-el added the new-schema label May 28, 2025

adatzer added 15 commits May 30, 2025 17:39

Add com.google.tag-manager.server-side/add_shipping_info/jsonschema/1…

09f198b

…-0-0 (close #1372)

Add com.google.tag-manager.server-side/earn_virtual_currency/jsonsche…

96f44bf

…ma/1-0-0 (close #1373)

Add com.google.tag-manager.server-side/level_end/jsonschema/1-0-0 (close

724a01a

#1374)

Add com.google.tag-manager.server-side/level_start/jsonschema/1-0-0 (c…

87bae11

…lose #1375)

Add com.google.tag-manager.server-side/level_up/jsonschema/1-0-0 (close

4c09ed7

#1376)

Add com.google.tag-manager.server-side/post_score/jsonschema/1-0-0 (c…

20e3bd1

…lose #1377)

Add com.google.tag-manager.server-side/remove_from_cart/jsonschema/1-…

b867d61

…0-0 (close #1378)

Add com.google.tag-manager.server-side/select_item/jsonschema/1-0-0 (c…

4147773

…lose #1379)

Add com.google.tag-manager.server-side/select_promotion/jsonschema/1-…

6b9b490

…0-0 (close #1380)

Add com.google.tag-manager.server-side/spend_virtual_currency/jsonsch…

1b38f7b

…ema/1-0-0 (close #1381)

Add com.google.tag-manager.server-side/tutorial_begin/jsonschema/1-0-0 (

bf90027

close #1382)

Add com.google.tag-manager.server-side/tutorial_complete/jsonschema/1…

673c034

…-0-0 (close #1383)

Add com.google.tag-manager.server-side/unlock_achievement/jsonschema/…

20dd65d

…1-0-0 (close #1384)

Add com.google.tag-manager.server-side/view_cart/jsonschema/1-0-0 (close

15de435

#1385)

Add com.google.tag-manager.server-side/view_promotion/jsonschema/1-0-0 (

ddf153f

close #1386)

AlexBenny force-pushed the add/ga4_schemas branch from 52bca49 to ddf153f Compare May 30, 2025 15:55

AlexBenny reviewed Jun 4, 2025

View reviewed changes

AlexBenny approved these changes Jun 12, 2025

View reviewed changes

istreeter approved these changes Jun 12, 2025

View reviewed changes

Prepare for R167 release

c6a4821

istreeter merged commit d05d5fe into release/r167 Jun 12, 2025
1 of 2 checks passed

istreeter deleted the add/ga4_schemas branch June 12, 2025 08:27

Add/ga4 schemas #1387

Add/ga4 schemas #1387

Uh oh!

Conversation

adatzer commented Feb 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

istreeter left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greg-el left a comment

Choose a reason for hiding this comment

Uh oh!

miike commented May 22, 2025

Uh oh!

istreeter commented May 22, 2025

Uh oh!

miike commented May 23, 2025

Uh oh!

greg-el left a comment

Choose a reason for hiding this comment

Uh oh!

AlexBenny commented May 30, 2025

Uh oh!

AlexBenny left a comment

Choose a reason for hiding this comment

Uh oh!

AlexBenny May 30, 2025

Choose a reason for hiding this comment

Uh oh!

miike Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

AlexBenny May 30, 2025

Choose a reason for hiding this comment

Uh oh!

miike Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

AlexBenny May 30, 2025

Choose a reason for hiding this comment

Uh oh!

miike Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

AlexBenny left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

adatzer commented Feb 13, 2024 •

edited

Loading

istreeter left a comment •

edited

Loading