Method: userActivity.search

Trả về dữ liệu Hoạt động của người dùng.

Yêu cầu HTTP

POST https://analyticsreporting.googleapis.com/v4/userActivity:search

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
Trường
dateRange

object(DateRange)

Phạm vi ngày truy xuất hoạt động của người dùng. Nếu phạm vi ngày không được cung cấp, phạm vi ngày mặc định sẽ là (startDate: hiện tại ngày - 7 ngày, endDate: ngày hiện tại - 1 ngày).

viewId

string

Bắt buộc. Mã chế độ xem Analytics để truy xuất dữ liệu. Mọi SearchUserActivityRequest đều phải chứa viewId.

user

object(User)

Bắt buộc. Mã nhận dạng người dùng duy nhất cần truy vấn. Mọi SearchUserActivityRequest phải chứa trường này.

activityTypes[]

enum(ActivityType)

Tập hợp tất cả các loại hoạt động đang được yêu cầu. Chỉ những khoảng trống khớp với những loại này mới được trả về trong phản hồi. Nếu trống, tất cả hoạt động sẽ được trả về.

pageSize

number

Kích thước trang là để phân trang và chỉ định số lượng tối đa các hàng được trả về. Kích thước trang phải lớn hơn 0. Nếu giá trị là 0 hoặc nếu trường không được chỉ định, yêu cầu sẽ trả về giá trị mặc định là 1.000 hàng mỗi trang.

pageToken

string

Mã thông báo tiếp tục để xem trang tiếp theo của kết quả. Việc thêm mã này vào yêu cầu sẽ trả về các hàng sau pageToken. pageToken phải là giá trị được trả về trong tham số nextPageToken trong phản hồi cho yêu cầu SearchUserActivityRequest.

Nội dung phản hồi

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Phản hồi từ cuộc gọi userActivity:get.

Biểu diễn dưới dạng JSON 
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Trường
sessions[]

object(UserActivitySession)

Mỗi bản ghi đại diện cho một phiên (thông tin thiết bị, thời lượng, v.v.).

totalRows

number

Tổng số hàng mà truy vấn này trả về (trên các trang khác nhau).

nextPageToken

string

Mã thông báo này sẽ được chuyển đến SearchUserActivityRequest để truy xuất trang tiếp theo.

sampleRate

number

Trường này thể hiện tốc độ lấy mẫu cho một yêu cầu đã cho và là một số từ 0,0 đến 1,0. Xem hướng dẫn cho nhà phát triển để biết thông tin chi tiết.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau đây:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

Người dùng

Chứa thông tin để nhận dạng riêng một người dùng cụ thể.

Biểu diễn dưới dạng JSON 
{
  "type": enum(UserIdType),
  "userId": string
}
Trường
type

enum(UserIdType)

Loại người dùng trong yêu cầu. Trường userId được liên kết với loại này.

userId

string

Mã nhận dạng duy nhất của người dùng đang được yêu cầu dữ liệu.

UserIdType

Đại diện cho các loại thông tin nhận dạng người dùng hiện có.

Enum
USER_ID_TYPE_UNSPECIFIED Khi Loại Id người dùng không được chỉ định, loại mặc định được sử dụng sẽ là CLIENT_ID.
USER_ID Một người dùng, như tài khoản người dùng đã đăng nhập, có thể tương tác với nội dung trên một hoặc nhiều thiết bị và / hoặc bản sao trình duyệt.
CLIENT_ID Mã ứng dụng khách đã chỉ định cho Analytics.

ActivityType

Enum
ACTIVITY_TYPE_UNSPECIFIED ActivityType sẽ không bao giờ có giá trị này trong phản hồi. Việc sử dụng loại này trong yêu cầu sẽ dẫn đến lỗi.
PAGEVIEW Được sử dụng khi hoạt động dẫn đến việc khách truy cập xem trang.
SCREENVIEW Được sử dụng khi hoạt động là do khách truy cập sử dụng một ứng dụng trên thiết bị di động.
GOAL Được dùng để biểu thị một hoạt động loại mục tiêu.
ECOMMERCE Khách truy cập đã thực hiện giao dịch thương mại điện tử trên trang.
EVENT Được dùng khi hoạt động là một sự kiện.

UserActivitySession

Chỉ số này thể hiện một phiên người dùng được thực hiện trên một thiết bị cụ thể tại một thời điểm nhất định trong một khoảng thời gian.

Biểu diễn dưới dạng JSON 
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
Trường
sessionId

string

Mã nhận dạng duy nhất của phiên.

deviceCategory

string

Loại thiết bị được sử dụng: "điện thoại di động", "máy tính bảng", v.v.

platform

string

Nền tảng nơi hoạt động xảy ra: "android", "ios", v.v.

dataSource

string

Nguồn dữ liệu của một lần truy cập. Theo mặc định, các lần truy cập được gửi từ analytics.js được báo cáo là "web" còn các lần truy cập được gửi từ SDK di động được báo cáo là "ứng dụng". Bạn có thể ghi đè các giá trị này trong Measurement Protocol.

activities[]

object(Activity)

Biểu thị một khung hiển thị chi tiết trong mỗi hoạt động trong phiên này.

sessionDate

string

Ngày diễn ra phiên này ở định dạng ISO-8601.

Hoạt động

Hoạt động biểu thị dữ liệu về một hoạt động của người dùng. Lưu ý rằng Hoạt động khác với lần truy cập. Lần truy cập có thể dẫn đến nhiều Hoạt động. Ví dụ: nếu lượt truy cập bao gồm một giao dịch và một mục tiêu hoàn thành, thì sẽ có hai protos Hoạt động cho lượt truy cập này, một cho ECOMMERCE và một cho GOAL. Ngược lại, nhiều lượt truy cập cũng có thể tạo một Hoạt động. Trong thương mại điện tử cổ điển, dữ liệu cho một giao dịch có thể được gửi qua nhiều lượt truy cập. Các lượt truy cập này sẽ được hợp nhất thành một Hoạt động ECOMMERCE.

Biểu diễn dưới dạng JSON 
{
  "activityTime": string,
  "source": string,
  "medium": string,
  "channelGrouping": string,
  "campaign": string,
  "keyword": string,
  "hostname": string,
  "landingPagePath": string,
  "activityType": enum(ActivityType),
  "customDimension": [
    {
      object(CustomDimension)
    }
  ],

  // Union field activity_details can be only one of the following:
  "pageview": {
    object(PageviewData)
  },
  "appview": {
    object(ScreenviewData)
  },
  "ecommerce": {
    object(EcommerceData)
  },
  "goals": {
    object(GoalSetData)
  },
  "event": {
    object(EventData)
  }
  // End of list of possible types for union field activity_details.
}
Trường
activityTime

string (Timestamp format)

Dấu thời gian của hoạt động.

Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, chính xác đến nano giây. Ví dụ: "2014-10-02T15:01:23.045123456Z"
source

string

Các nguồn giới thiệu. Đối với theo dõi chiến dịch thủ công, đó là giá trị của thông số theo dõi chiến dịch utm_source. Đối với tính năng tự động gắn thẻ của AdWords, thuật toán là google. Nếu bạn không sử dụng cả hai, thì đó là miền của nguồn (ví dụ: document.referrer) giới thiệu người dùng. Tệp này cũng có thể chứa địa chỉ cổng. Nếu người dùng truy cập mà không có đường liên kết giới thiệu, thì giá trị của đường liên kết này là (trực tiếp).

medium

string

Loại lượt giới thiệu. Đối với theo dõi chiến dịch thủ công, đó là giá trị của thông số theo dõi chiến dịch utm_medium. Đối với tính năng tự động gắn thẻ của AdWords, giá trị này là cpc. Nếu người dùng đến từ một công cụ tìm kiếm do Google Analytics phát hiện, thì đó là kết quả không phải trả tiền. Nếu đường liên kết giới thiệu không phải là một công cụ tìm kiếm, thì đó là đường liên kết giới thiệu. Nếu người dùng đã trực tiếp truy cập vào tài sản và document.referrer là trống, thì giá trị của trường này là (không có).

channelGrouping

string

Nhóm kênh được liên kết với phiên của người dùng cuối cho Chế độ xem này (do Nhóm kênh của Chế độ xem xác định).

campaign

string

Đối với theo dõi chiến dịch thủ công, đây là giá trị của thông số theo dõi chiến dịch utm_campaign. Đối với tính năng tự động gắn thẻ của AdWords, đó là tên của (các) chiến dịch quảng cáo trực tuyến mà bạn sử dụng cho thuộc tính. Nếu bạn không sử dụng cột nào, giá trị của tham số đó sẽ là (not set).

keyword

string

Đối với theo dõi chiến dịch thủ công, đó là giá trị của thông số theo dõi chiến dịch utm_term. Đối với lưu lượng truy cập AdWords, mục này chứa tiêu chí nhắm mục tiêu phù hợp nhất. Đối với mạng hiển thị, nơi có nhiều tiêu chí nhắm mục tiêu có thể đã khiến quảng cáo xuất hiện, mạng hiển thị sẽ trả về tiêu chí nhắm mục tiêu phù hợp nhất do Google Ads chọn. Đây có thể là display_keyword, vị trí trang web, boomuserlist, user_interest, độ tuổi hoặc giới tính. Nếu không, giá trị của lớp này là (not set).

hostname

string

Tên máy chủ dùng để thực hiện yêu cầu theo dõi.

landingPagePath

string

Trang đầu tiên trong phiên hoạt động của người dùng hoặc trang đích.

activityType

enum(ActivityType)

Loại hoạt động này.

customDimension[]

object(CustomDimension)

Danh sách tất cả các phương diện tuỳ chỉnh được liên kết với hoạt động này.

Trường hợp activity_details. Tuỳ thuộc vào activity_type, chính xác một trong các trường sau sẽ được đặt. activity_details chỉ có thể là một trong những trạng thái sau:
pageview

object(PageviewData)

Giá trị này sẽ được thiết lập nếu activityType bằng PAGEVIEW. Trường này chứa tất cả thông tin về khách truy cập và trang đã được truy cập.

appview

object(ScreenviewData)

Giá trị này sẽ được thiết lập nếu activityType bằng SCREEN_VIEW.

ecommerce

object(EcommerceData)

Giá trị này sẽ được thiết lập nếu activityType bằng ECOMMERCE.

goals

object(GoalSetData)

Trường này chứa danh sách tất cả các mục tiêu đã đạt được trong hoạt động này khi activityType bằng GOAL.

event

object(EventData)

Trường này chứa tất cả thông tin chi tiết liên quan đến một sự kiện và sẽ được thiết lập nếu activityType bằng EVENT.

CustomDimension

Phương diện tuỳ chỉnh.

Biểu diễn dưới dạng JSON 
{
  "index": number,
  "value": string
}
Trường
index

number

Số vị trí của phương diện tùy chỉnh.

value

string

Giá trị của phương diện tuỳ chỉnh. Giá trị mặc định (tức là chuỗi trống) cho biết việc xoá giá trị phương diện tuỳ chỉnh trong phạm vi vị trí/khách truy cập.

PageviewData

Biểu thị các thông tin chi tiết được thu thập khi khách truy cập xem một trang.

Biểu diễn dưới dạng JSON 
{
  "pagePath": string,
  "pageTitle": string
}
Trường
pagePath

string

URL của trang mà khách truy cập đã xem.

pageTitle

string

Tiêu đề của trang mà khách truy cập đã xem.

ScreenviewData

Biểu diễn dưới dạng JSON 
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Trường
screenName

string

Tên màn hình.

mobileDeviceBranding

string

Tên thương hiệu hoặc tên nhà sản xuất thiết bị di động. Ví dụ: "Google", "Táo", v.v.

mobileDeviceModel

string

Kiểu thiết bị di động. Ví dụ: "Pixel", "iPhone", v.v.

appName

string

Tên ứng dụng.

EcommerceData

Thông tin chi tiết về thương mại điện tử liên quan đến hoạt động của người dùng.

Biểu diễn dưới dạng JSON 
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
Trường
actionType

enum(ECommerceAction)

Hành động liên quan đến hành động thương mại điện tử này.

transaction

object(TransactionData)

Chi tiết giao dịch của hành động thương mại điện tử này.

products[]

object(ProductData)

Thông tin chi tiết về các sản phẩm trong giao dịch này.

ecommerceType

enum(EcommerceType)

Loại hoạt động thương mại điện tử.

ECommerceAction

Tập hợp tất cả các hành động được liên kết với một hành động thương mại điện tử.

Enum
UNKNOWN Loại hành động không xác định.
CLICK Số lượt nhấp vào các danh sách sản phẩm.
DETAILS_VIEW Chế độ xem chi tiết sản phẩm.
ADD_TO_CART Thêm(các) sản phẩm vào giỏ hàng.
REMOVE_FROM_CART Xoá(các) sản phẩm khỏi giỏ hàng.
CHECKOUT Thanh toán.
PAYMENT Giao dịch mua đã hoàn tất.
REFUND Hoàn tiền cho giao dịch mua.
CHECKOUT_OPTION Tuỳ chọn thanh toán.

TransactionData

Biểu thị các chi tiết được thu thập khi khách truy cập thực hiện giao dịch trên trang.

Biểu diễn dưới dạng JSON 
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
Trường
transactionId

string

Mã giao dịch, được cung cấp bởi phương pháp theo dõi thương mại điện tử, cho giao dịch mua hàng trong giỏ hàng.

transactionRevenue

number

Tổng doanh thu bán hàng (không bao gồm phí vận chuyển và thuế) của giao dịch.

transactionTax

number

Tổng thuế cho giao dịch.

transactionShipping

number

Tổng chi phí vận chuyển.

ProductData

Thông tin chi tiết về sản phẩm trong một giao dịch thương mại điện tử.

Biểu diễn dưới dạng JSON 
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
Trường
productSku

string

Mã duy nhất đại diện cho sản phẩm.

productName

string

Tên sản phẩm, do ứng dụng theo dõi thương mại điện tử cung cấp, cho các mặt hàng đã mua.

itemRevenue

number

Tổng doanh thu từ các mặt hàng sản phẩm đã mua.

productQuantity

string (int64 format)

Tổng số đơn vị sản phẩm này trong giao dịch.

EcommerceType

Mã này thể hiện loại dữ liệu thương mại điện tử được trả về.

Enum
ECOMMERCE_TYPE_UNSPECIFIED Được dùng khi loại hoạt động thương mại điện tử chưa được chỉ định.
CLASSIC Được dùng khi hoạt động có thông tin thương mại điện tử phiên bản cũ (không nâng cao).
ENHANCED Được dùng khi hoạt động có thông tin thương mại điện tử nâng cao.

GoalSetData

Đại diện cho một tập hợp các mục tiêu đã đạt được trong một hoạt động.

Biểu diễn dưới dạng JSON 
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
Trường
goals[]

object(GoalData)

Tất cả các mục tiêu đã đạt được trong hoạt động hiện tại.

GoalData

Đại diện cho tất cả các chi tiết liên quan đến một mục tiêu.

Biểu diễn dưới dạng JSON 
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
Trường
goalIndex

number

Mã này sẽ xác định mục tiêu như được định cấu hình cho cấu hình.

goalCompletions

string (int64 format)

Tổng số lần hoàn thành mục tiêu trong hoạt động này.

goalValue

number

Giá trị trong mục tiêu này.

goalCompletionLocation

string

URL của trang nơi mục tiêu này được hoàn tất.

goalPreviousStep1

string

URL của trang một bước trước khi mục tiêu hoàn thành.

goalPreviousStep2

string

URL của trang hai bước trước khi mục tiêu hoàn thành.

goalPreviousStep3

string

URL của trang 3 bước trước khi hoàn thành mục tiêu.

goalName

string

Tên mục tiêu.

EventData

Đại diện cho tất cả các chi tiết liên quan đến một sự kiện.

Biểu diễn dưới dạng JSON 
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
Trường
eventCategory

string

Đối tượng trên trang đã được tương tác. Ví dụ: "Video".

eventAction

string

Kiểu tương tác với đối tượng. Ví dụ: "phát".

eventLabel

string

Đã đính kèm nhãn với sự kiện.

eventValue

string (int64 format)

Giá trị số được liên kết với sự kiện.

eventCount

string (int64 format)

Số lượng sự kiện như vậy trong hoạt động này.

Hãy dùng thử!