- HTTP 请求
- 请求正文
- 响应正文
- 授权作用域
- 用户
- UserIdType
- ActivityType
- UserActivitySession
- activity
- CustomDimension
- PageviewData
- ScreenviewData
- EcommerceData
- ECommerceAction
- TransactionData
- ProductData
- EcommerceType
- GoalSetData
- GoalData
- EventData
- 试试看!
返回用户活动数据。
HTTP 请求
POST https://analyticsreporting.googleapis.com/v4/userActivity:search
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 | |
---|---|
{ "dateRange": { object( |
字段 | |
---|---|
dateRange |
用于检索用户活动的日期范围。如果未提供日期范围,则默认日期范围为 (startDate: 当前日期 - 7 天, endDate: 当前日期 - 1 天)。 |
viewId |
必需。从中提取数据的 Google Analytics(分析)数据视图 ID。每个 SearchUserActivityRequest 都必须包含 |
user |
必需。要查询的唯一身份用户 ID。每个 SearchUserActivityRequest 都必须包含此字段。 |
activityTypes[] |
所请求的所有活动类型的集合。响应中只会返回与这些类型匹配的活动。如果为空,则返回所有 activity。 |
pageSize |
页面大小用于分页,并指定返回行的最大数目。页面大小应 > 0。如果值为 0 或未指定此字段,则请求默认每页返回 1000 行。 |
pageToken |
获得下一页结果的延续令牌。将此令牌添至请求将返回 pageToken 后的行。在对 SearchUserActivityRequest 请求的响应中,pageToken 应为 nextPageToken 参数中返回的值。 |
响应正文
如果成功,响应正文将包含结构如下的数据:
userActivity:get
调用的响应。
JSON 表示法 | |
---|---|
{
"sessions": [
{
object( |
字段 | |
---|---|
sessions[] |
每条记录代表一个会话(设备详细信息、时长等)。 |
totalRows |
此查询返回的总行数(跨不同页面)。 |
nextPageToken |
应将此令牌传递给 SearchUserActivityRequest 以检索下一页。 |
sampleRate |
|
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
用户
包含用于唯一地标识特定用户的信息。
JSON 表示法 | |
---|---|
{
"type": enum( |
字段 | |
---|---|
type |
请求中的用户类型。字段 |
userId |
要为其请求数据的用户的唯一 ID。 |
UserIdType
表示各种可用的用户标识类型。
枚举 | |
---|---|
USER_ID_TYPE_UNSPECIFIED |
如果未指定 User Id 类型,则默认使用 CLIENT_ID 类型。 |
USER_ID |
一个用户(例如一个已登录用户账号),该用户可能在一个或多个设备和/或浏览器实例中与内容互动。 |
CLIENT_ID |
Google Analytics(分析)分配的 clientId。 |
ActivityType
枚举 | |
---|---|
ACTIVITY_TYPE_UNSPECIFIED |
ActivityType 在响应中绝不会有此值。在请求中使用该类型将导致错误。 |
PAGEVIEW |
因访问者浏览网页而产生活动时使用。 |
SCREENVIEW |
当访问者在移动设备上使用应用时产生了活动,使用此属性。 |
GOAL |
用于表示目标类型是活动。 |
ECOMMERCE |
访问者在网页上进行了一次电子商务交易。 |
EVENT |
在活动为事件时使用。 |
UserActivitySession
这表示在一段时间内的特定时间内在特定设备上执行的用户会话。
JSON 表示法 | |
---|---|
{
"sessionId": string,
"deviceCategory": string,
"platform": string,
"dataSource": string,
"activities": [
{
object( |
字段 | |
---|---|
sessionId |
会话的唯一 ID。 |
deviceCategory |
使用的设备类型:“移动设备”“平板电脑”等。 |
platform |
发生活动的平台:“android”、“ios”等。 |
dataSource |
某一次命中的数据源。默认情况下,从 analytics.js 发送的命中报告为“网站”,从移动 SDK 发送的命中报告为“应用”。这些值可在 Measurement Protocol 中被替换。 |
activities[] |
表示此会话中每项活动的详细视图。 |
sessionDate |
此会话的日期,采用 ISO-8601 格式。 |
Activity
Activity 表示用户 Activity 的数据。请注意,活动与命中不同。一次命中可能会导致多个 Activity。例如,如果命中包含一笔交易和一次目标达成,该命中将有两个 Activity proto,一个针对电子商务,另一个针对 GOAL。相反,多次命中也可以构建一个 Activity。在传统电子商务中,一笔交易的数据可能会通过多次命中进行发送。这些命中将合并到一个电子商务活动中。
JSON 表示法 | |
---|---|
{ "activityTime": string, "source": string, "medium": string, "channelGrouping": string, "campaign": string, "keyword": string, "hostname": string, "landingPagePath": string, "activityType": enum( |
字段 | ||
---|---|---|
activityTime |
活动的时间戳。 时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒。示例: |
|
source |
引荐来源。对于人工广告系列跟踪,此值为 utm_source 广告系列跟踪参数的值。对于 AdWords 自动标记,它是 google。如果两者都使用,则使用引荐用户的来源域名(例如 document.referrer)。它还可能包含端口地址。如果用户未通过引荐来源网址进行访问,则其值为 (direct)。 |
|
medium |
引荐类型。对于人工广告系列跟踪,此值为 utm_medium 广告系列跟踪参数的值。对于 AdWords 自动标记,此值为 cpc。如果用户来自被 Google Analytics(分析)检测到的搜索引擎,则属于自然搜索。如果引荐来源网址不是搜索引擎,则它是引荐来源。如果用户直接访问媒体资源,而 document.referrer 为空,则其值为 (none)。 |
|
channelGrouping |
与此数据视图的最终用户会话相关联的渠道组(由该数据视图的渠道分组定义)。 |
|
campaign |
对于人工广告系列跟踪,此值为 utm_campaign 广告系列跟踪参数的值。对于 AdWords 自动标记,此值是指您为媒体资源使用的在线广告系列的名称。如果两者都使用,则其值为“(not set)”。 |
|
keyword |
对于人工广告系列跟踪,此值为 utm_term 广告系列跟踪参数的值。对于 AdWords 流量,其中包含最匹配的定位条件。对于展示广告网络(有多个定位条件可能导致广告展示),则会返回 Google Ads 选择最匹配的定位条件。值可以是 display_keyword、site placement、boomuserlist、user_interest、age 或 gender。否则,其值为 (not set)。 |
|
hostname |
发出跟踪请求的主机名。 |
|
landingPagePath |
用户会话中的第一个网页或着陆页。 |
|
activityType |
此活动的类型。 |
|
customDimension[] |
与此活动相关联的所有自定义维度的列表。 |
|
联合字段 activity_details 。根据 activity_type ,将仅设置以下字段中的一个。activity_details 只能是下列其中一项: |
||
pageview |
如果 |
|
appview |
如果 |
|
ecommerce |
如果 |
|
goals |
此字段包含当 |
|
event |
此字段包含与事件相关的所有详细信息,如果 |
CustomDimension
自定义维度。
JSON 表示法 | |
---|---|
{ "index": number, "value": string } |
字段 | |
---|---|
index |
自定义维度的槽数。 |
value |
自定义维度的值。默认值(即空字符串)表示清除会话/访问者范围自定义维度值。 |
PageviewData
表示访问者浏览网页时收集的详细信息。
JSON 表示法 | |
---|---|
{ "pagePath": string, "pageTitle": string } |
字段 | |
---|---|
pagePath |
访问者浏览过的网页的网址。 |
pageTitle |
访问者浏览的网页的标题。 |
ScreenviewData
JSON 表示法 | |
---|---|
{ "screenName": string, "mobileDeviceBranding": string, "mobileDeviceModel": string, "appName": string } |
字段 | |
---|---|
screenName |
屏幕的名称。 |
mobileDeviceBranding |
移动设备制造商或品牌名称。例如:“Google”“Apple”等。 |
mobileDeviceModel |
移动设备型号。例如:“Pixel”“iPhone”等。 |
appName |
应用名称。 |
EcommerceData
与用户活动相关联的电子商务详细信息。
JSON 表示法 | |
---|---|
{ "actionType": enum( |
字段 | |
---|---|
actionType |
与此电子商务操作相关联的操作。 |
transaction |
此电子商务操作的交易详情。 |
products[] |
此交易中产品的详细信息。 |
ecommerceType |
此电子商务活动的类型。 |
ECommerceAction
与电子商务操作相关联的所有操作的集合。
枚举 | |
---|---|
UNKNOWN |
操作类型未知。 |
CLICK |
点击浏览商品列表。 |
DETAILS_VIEW |
产品详情浏览。 |
ADD_TO_CART |
将商品添加到购物车。 |
REMOVE_FROM_CART |
从购物车中移除产品。 |
CHECKOUT |
结账。 |
PAYMENT |
完成购买。 |
REFUND |
购买交易退款。 |
CHECKOUT_OPTION |
结账选项。 |
TransactionData
表示访问者在网页上进行交易时收集的详细信息。
JSON 表示法 | |
---|---|
{ "transactionId": string, "transactionRevenue": number, "transactionTax": number, "transactionShipping": number } |
字段 | |
---|---|
transactionId |
电子商务跟踪方法为购物车中的购买提供的交易 ID。 |
transactionRevenue |
这笔交易的总销售收入(不含运费和税费)。 |
transactionTax |
交易的总税费。 |
transactionShipping |
运费总额。 |
ProductData
电子商务交易中产品的详细信息。
JSON 表示法 | |
---|---|
{ "productSku": string, "productName": string, "itemRevenue": number, "productQuantity": string } |
字段 | |
---|---|
productSku |
代表商品的唯一代码。 |
productName |
电子商务跟踪应用为已购商品提供的商品名称。 |
itemRevenue |
已购买产品项的总收入。 |
productQuantity |
交易中此产品的总数。 |
EcommerceType
这表示要返回的电子商务数据的类型。
枚举 | |
---|---|
ECOMMERCE_TYPE_UNSPECIFIED |
未指定电子商务活动类型时使用。 |
CLASSIC |
当活动包含传统(非增强型)电子商务信息时使用。 |
ENHANCED |
当活动包含增强型电子商务信息时使用。 |
GoalSetData
表示在活动中达成的一组目标。
JSON 表示法 | |
---|---|
{
"goals": [
{
object( |
字段 | |
---|---|
goals[] |
当前活动中已达成的所有目标。 |
GoalData
表示与目标相关的所有详情。
JSON 表示法 | |
---|---|
{ "goalIndex": number, "goalCompletions": string, "goalValue": number, "goalCompletionLocation": string, "goalPreviousStep1": string, "goalPreviousStep2": string, "goalPreviousStep3": string, "goalName": string } |
字段 | |
---|---|
goalIndex |
用于标识为配置文件配置的目标。 |
goalCompletions |
此活动中的目标达成总次数。 |
goalValue |
此目标中的价值。 |
goalCompletionLocation |
完成此目标的网页的网址。 |
goalPreviousStep1 |
目标达成前一步的网页的网址。 |
goalPreviousStep2 |
目标达成前两个步骤对应的网页的网址。 |
goalPreviousStep3 |
目标达成前的三个步骤所对应的网页的网址。 |
goalName |
目标的名称。 |
EventData
表示与事件相关的所有详情。
JSON 表示法 | |
---|---|
{ "eventCategory": string, "eventAction": string, "eventLabel": string, "eventValue": string, "eventCount": string } |
字段 | |
---|---|
eventCategory |
用户与之互动过的页面上的对象。例如:“Video”。 |
eventAction |
与对象的互动类型。例如:“播放”。 |
eventLabel |
随事件附加的标签。 |
eventValue |
与事件相关的数值。 |
eventCount |
此 activity 中此类事件的数量。 |