Fix sendGAEvent function params and type clearly

[hjick]

The parameters of the sendGAEvent function type is too ambiguous, the function is working even if entered incorrectly.

I modified the parameters more clearly by referring to the document.

And I add example docs.

Why?

This is GA initialize code.

window['${dataLayerName}'] = window['${dataLayerName}'] || [];
function gtag(){window['${dataLayerName}'].push(arguments);}
gtag('js', new Date());

gtag('config', '${gaId}');`

arguments is array-like object.

gtag('js', new Date()) is gonna be window['${dataLayerName}'].push({ 0: 'js', 1: newDate() })

So, the sendGAEvent function is weird.

Example sendGAEvent in docs now

<button
        onClick={() => sendGAEvent({ event: 'buttonClicked', value: 'xyz' })}
      >
        Send Event
</button>

sendGAEvent({ event: 'buttonClicked', value: 'xyz' })} is gonna be window['${dataLayerName}'].push({ 0: { event: "buttonClicked", value: "xyz" })

But according to GA docs, it has to be window['${dataLayerName}'].push({ 0: 'event', 1: '<event-name>', 2: { <event_parameters> } })
like GA4 event docs example

gtag('event', '<event_name>', {
  <event_parameters>
});

GA4 event docs:
https://developers.google.com/analytics/devguides/collection/ga4/events

issue reference:
#62065 (comment)

[jamesmillerburgess]

I think this type is too restrictive.

Some gtag events take an items parameter, which is an array of Item objects.

https://developers.google.com/tag-platform/gtagjs/reference/events

[hjick]

Thank you for your review!

The url you attached return 500 status. Is that url about gtag ```event``` command?

I can't find that items parameters in recent docs about gtag.
https://developers.google.com/tag-platform/gtagjs/reference#event

If the items parameter you're talking about is a gtag command, how about creating a function for each command separately?

[hjick]

I added type GA events include items parameters you referenced.
If the event name entered by the user is the same as the event name in the link you referenced, it also provides autocomplete event parameters.

Can you check this changes?

[jamesmillerburgess]

I think your types won't allow custom events. Maybe there is an existing official set of types from Google that we could use?

[hjick]

The type allow custom events. And I also added types from Google docs.

And if user input types from Google official types, user can get autocomplete Google official params.

Also user can input custom types.
I pushed new commit. Please check that.

[hjick]

Thank you for your maintaining. I know you're busy, but could you please check one more time, this commit would be very helpful.

[leerob]

Related: #65678

[samcx]

@hjick A similar has been → #66339. Let me know if that :pr: is adequate, or if we should build upon it with this :pr: (not too familiar with the type!)

Also, for whatever reason, I have never been able to access the link. →

[hjick]

@hjick A similar has been → #66339. Let me know if that :pr: is adequate, or if we should build upon it with this :pr: (not too familiar with the type!)

Also, for whatever reason, I have never been able to access the link. →

Sorry, I'm late. I checked that #66339. I think that PR is for type of GTM. I added types for GA. I added all google recommended events (reserved event params).

Right now we can register any value, but I think merging these PRs will help people who aren't familiar with Google's suggested Params by autocomplete them.

Can you enter this link one more?
https://developers.google.com/tag-platform/gtagjs/reference/events?hl=en

[samcx]

@hjick Thank you! If you can also look into the merge conflict, that will be great .