gtag.js API 参考

gtag.js 语法

gtag.js API 由单个函数 (gtag()) 构成,其语法如下:

gtag(<command>, <command parameters>)
  • <command> 是三个 gtag 命令之一:configsetevent
  • <command parameters> 是要传递给 gtag() 的参数。 命令参数因命令而异;请参阅下文中的命令参考。

只要您的 gtag 命令显示在全局代码段之后,您就可以在网页上的任何位置调用该命令。要了解如何向网页添加全局代码段,请参阅开发者指南

config

用于向目标添加额外的配置信息,通常是针对具体产品的配置信息(例如 Google Analytics(分析)跟踪信息)。

gtag('config', '<target_ID>', {<additional_config_info>})

其中 <target_ID> 是唯一标识匹配目标(如 Google Analytics(分析)媒体资源或 AdWords 帐号)的标识符。例如,Google Analytics(分析)的 <target_ID> 通常类似于“UA-12345-6”。

<additional_config_info> 是一个或多个参数-值对,例如:

'send_page_view' : false

多个参数-值对之间必须以英文逗号分隔。

示例:

gtag('config', 'AW-123456789');

配置为 AdWords 帐号接收 gtag() 数据。

gtag('config', 'UA-12345-6');

配置为 Google Analytics(分析)帐号接收 gtag() 数据,并向该 Google Analytics(分析)帐号发送网页浏览匹配数据。

gtag('config', 'UA-12345-6', {'send_page_view': false});

配置为 Google Analytics(分析)帐号接收 gtag() 数据,并使 gtag() 停止向 Google Analytics(分析)发送网页浏览匹配数据

set

用于设置始终存在于网页上的所有后续 gtag() 调用中的值。

gtag('set', {<parameter-value-pair>, <parameter-value-pair>})

<parameter-value-pair> 是一个键名,还是一个会始终存在于所有 gtag() 调用中的值,例如:

gtag('set', {
  'country': 'US',
  'currency': 'USD'
});

针对网页上所有后续事件,将 country 的值设为“US”,将 currency 的值设为“USD”。

使用 set 命令不同于直接将值传递给 event 命令。如果您直接将值传递给 event 命令,这些值仅会应用到正在被触发的事件。但是如果您使用 set,这些值会始终存在于当前网页上,且会随所有后续事件传递。为进一步说明这一点,我们来比较以下两个示例:

gtag('event', 'login', {'method': 'Google'});
gtag('event', 'share');

gtag('set', {'method': 'Google'});
gtag('event', 'login');
gtag('event', 'share');

在第一个示例中,login 事件会在 method 值为“Google”时传递,而 share 事件无需任何参数即可传递。在第二个示例中,loginshare 均会在 method 值为“Google”时传递。

event

使用 event 命令可发送事件数据。全局代码段必须显示在同一网页上的 event 命令之前,否则系统不会发送数据。

gtag('event', '<eventName>', {<optionalEventParams>})

<eventName> 是以下任何一种事件:

<optionalEventParams> 是一个或多个参数-值对,每个参数-值对均以英文逗号分隔。

示例

下面的 event 命令会触发带有两个参数(app_namescreen_name)的推荐事件 screen_view

gtag('event', 'screen_view', {
  'app_name': 'myAppName',
  'screen_name': 'Home'
});