Method: userActivity.search

Menampilkan data Aktivitas Pengguna.

Permintaan HTTP

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

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dateRange": {
    object(DateRange)
  },
  "viewId": string,
  "user": {
    object(User)
  },
  "activityTypes": [
    enum(ActivityType)
  ],
  "pageSize": number,
  "pageToken": string
}
Kolom
dateRange

object(DateRange)

Rentang tanggal untuk mengambil aktivitas pengguna. Jika rentang tanggal tidak diberikan, rentang tanggal default adalah (startDate: saat ini - 7 hari, endDate: tanggal saat ini - 1 hari).

viewId

string

Wajib. ID tampilan Analytics tempat mengambil data. Setiap SearchUserActivityRequest harus berisi viewId.

user

object(User)

Wajib. ID pengguna unik untuk kueri. Setiap SearchUserActivityRequest harus berisi kolom ini.

activityTypes[]

enum(ActivityType)

Kumpulan semua jenis aktivitas yang diminta. Hanya aktivitas yang cocok dengan jenis ini yang akan ditampilkan dalam respons. Jika kosong, semua aktivitas akan ditampilkan.

pageSize

number

Ukuran halaman adalah untuk paging dan menentukan jumlah maksimum baris yang ditampilkan. Ukuran halaman harus > 0. Jika nilainya 0 atau jika kolom tidak ditentukan, permintaan akan menampilkan default 1.000 baris per halaman.

pageToken

string

Token kelanjutan untuk mendapatkan halaman hasil berikutnya. Menambahkan ini ke permintaan akan menampilkan baris setelah pageToken. PageToken harus berupa nilai yang ditampilkan di parameter nextPageToken sebagai respons terhadap permintaan SearchUserActivityRequest.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Respons dari panggilan userActivity:get.

Representasi JSON 
{
  "sessions": [
    {
      object(UserActivitySession)
    }
  ],
  "totalRows": number,
  "nextPageToken": string,
  "sampleRate": number
}
Kolom
sessions[]

object(UserActivitySession)

Setiap kumpulan data mewakili sesi (detail perangkat, durasi, dll.).

totalRows

number

Total baris yang ditampilkan oleh kueri ini (di berbagai halaman).

nextPageToken

string

Token ini harus diteruskan ke SearchUserActivityRequest untuk mengambil halaman berikutnya.

sampleRate

number

Kolom ini mewakili frekuensi sampling untuk permintaan tertentu dan merupakan angka antara 0,0 sampai 1,0. Lihat panduan developer untuk mengetahui detailnya.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Pengguna

Berisi informasi untuk mengidentifikasi pengguna tertentu secara unik.

Representasi JSON 
{
  "type": enum(UserIdType),
  "userId": string
}
Kolom
type

enum(UserIdType)

Jenis pengguna dalam permintaan. Kolom userId dikaitkan dengan jenis ini.

userId

string

ID unik pengguna yang datanya diminta.

UserIdType

Mewakili berbagai jenis identifikasi pengguna yang tersedia.

Enum
USER_ID_TYPE_UNSPECIFIED Ketika Jenis ID Pengguna tidak ditentukan, jenis {i>default<i} yang digunakan adalah CLIENT_ID.
USER_ID Pengguna tunggal, seperti akun pengguna yang login, yang mungkin berinteraksi dengan konten di 1 atau beberapa perangkat dan/atau instance browser.
CLIENT_ID ClientId yang ditetapkan Analytics.

ActivityType

Enum
ACTIVITY_TYPE_UNSPECIFIED ActivityType tidak akan pernah memiliki nilai ini dalam respons. Menggunakan jenis ini dalam permintaan akan menghasilkan error.
PAGEVIEW Digunakan saat aktivitas berasal dari pengunjung yang melihat halaman.
SCREENVIEW Digunakan saat aktivitas berasal dari pengunjung yang menggunakan aplikasi di perangkat seluler.
GOAL Digunakan untuk menunjukkan bahwa aktivitas jenis sasaran.
ECOMMERCE Transaksi e-commerce dilakukan oleh pengunjung di halaman tersebut.
EVENT Digunakan saat aktivitas adalah sebuah peristiwa.

UserActivitySession

Ini mewakili sesi pengguna yang dilakukan pada perangkat tertentu pada waktu tertentu selama jangka waktu tertentu.

Representasi JSON 
{
  "sessionId": string,
  "deviceCategory": string,
  "platform": string,
  "dataSource": string,
  "activities": [
    {
      object(Activity)
    }
  ],
  "sessionDate": string
}
Kolom
sessionId

string

ID unik sesi.

deviceCategory

string

Jenis perangkat yang digunakan: "seluler", "tablet", dll.

platform

string

Platform tempat aktivitas terjadi: "android", "ios", dll.

dataSource

string

Sumber data sebuah klik. Secara default, klik yang dikirim dari analytics.js dilaporkan sebagai "web" dan klik yang dikirim dari SDK seluler dilaporkan sebagai "app". Nilai ini dapat diganti di Measurement Protocol.

activities[]

object(Activity)

Menampilkan tampilan mendetail ke setiap aktivitas dalam sesi ini.

sessionDate

string

Tanggal sesi ini dalam format ISO-8601.

Aktivitas

Aktivitas mewakili data untuk aktivitas pengguna. Perhatikan bahwa Aktivitas berbeda dari hit. Hit dapat mengakibatkan beberapa Aktivitas. Misalnya, jika hit menyertakan transaksi dan sasaran tercapai, akan ada dua proto Aktivitas untuk hit ini, satu untuk ECOMMERCE dan satu untuk GOAL. Sebaliknya, beberapa hit juga dapat membuat satu Aktivitas. Pada e-commerce klasik, data untuk satu transaksi mungkin dikirim melalui beberapa hit. Hit ini akan digabungkan menjadi satu Aktivitas ECOMMERCE.

Representasi 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.
}
Kolom
activityTime

string (Timestamp format)

Stempel waktu aktivitas.

Stempel waktu dalam format RFC3339 UTC "Zulu", akurat hingga nanodetik. Contoh: "2014-10-02T15:01:23.045123456Z".
source

string

Sumber rujukan. Untuk pelacakan kampanye manual, parameter ini adalah nilai parameter pelacakan kampanye utm_source. Untuk pemberian tag otomatis AdWords, itu adalah google. Jika Anda tidak menggunakan keduanya, domain sumber adalah (mis., document.referrer) yang merujuk pengguna. File ini juga dapat berisi alamat port. Jika pengguna datang tanpa perujuk, nilainya adalah (langsung).

medium

string

Jenis rujukan. Untuk pelacakan kampanye manual, parameter ini adalah nilai parameter pelacakan kampanye utm_medium. Untuk pemberian tag otomatis AdWords, metodenya adalah cpc. Jika pengguna berasal dari mesin telusur yang terdeteksi oleh Google Analytics, berarti data tersebut organik. Jika perujuk bukan mesin telusur, perujuk itu adalah rujukan. Jika pengguna langsung membuka properti dan document.referrer kosong, nilainya adalah (none).

channelGrouping

string

Grup Saluran yang dikaitkan dengan sesi pengguna akhir untuk Tampilan ini (didefinisikan oleh Pengelompokan Saluran Tampilan).

campaign

string

Untuk pelacakan kampanye manual, parameter ini adalah nilai parameter pelacakan kampanye utm_campaign. Untuk pemberian tag otomatis AdWords, ini adalah nama kampanye iklan online yang Anda gunakan untuk properti. Jika Anda tidak menggunakan keduanya, nilainya adalah (not set).

keyword

string

Untuk pelacakan kampanye manual, parameter ini adalah nilai parameter pelacakan kampanye utm_term. Untuk traffic AdWords, kolom ini berisi kriteria penargetan yang paling cocok. Untuk Jaringan Display, jika beberapa kriteria penargetan dapat menyebabkan iklan muncul, jaringan tersebut menampilkan kriteria penargetan yang paling cocok seperti yang dipilih oleh Google Ads. Hal ini dapat berupa display_keyword, penempatan situs, boomuserlist, user_interest, usia, atau gender. Jika tidak, nilainya adalah (not set).

hostname

string

Nama host yang digunakan untuk membuat permintaan pelacakan.

landingPagePath

string

Halaman pertama di sesi pengguna, atau halaman landing.

activityType

enum(ActivityType)

Jenis aktivitas ini.

customDimension[]

object(CustomDimension)

Daftar semua dimensi kustom yang dikaitkan dengan aktivitas ini.

Kolom union activity_details. Bergantung pada activity_type, tepat satu kolom berikut akan disetel. activity_details hanya dapat berupa salah satu dari yang berikut:
pageview

object(PageviewData)

Nilai ini akan ditetapkan jika activityType sama dengan PAGEVIEW. Kolom ini berisi semua detail tentang pengunjung dan halaman yang dikunjungi.

appview

object(ScreenviewData)

Nilai ini akan ditetapkan jika activityType sama dengan SCREEN_VIEW.

ecommerce

object(EcommerceData)

Nilai ini akan ditetapkan jika activityType sama dengan ECOMMERCE.

goals

object(GoalSetData)

Kolom ini berisi daftar semua sasaran yang dicapai dalam aktivitas ini jika activityType sama dengan GOAL.

event

object(EventData)

Kolom ini berisi semua detail yang berkaitan dengan acara dan akan ditetapkan jika activityType sama dengan EVENT.

CustomDimension

Dimensi kustom.

Representasi JSON 
{
  "index": number,
  "value": string
}
Kolom
index

number

Jumlah slot dimensi kustom.

value

string

Nilai dimensi kustom. Nilai default (yaitu string kosong) menunjukkan nilai dimensi kustom cakupan sesi/pengunjung.

PageviewData

Menampilkan detail yang dikumpulkan saat pengunjung melihat halaman.

Representasi JSON 
{
  "pagePath": string,
  "pageTitle": string
}
Kolom
pagePath

string

URL halaman yang dilihat pengunjung.

pageTitle

string

Judul halaman yang dilihat pengunjung.

ScreenviewData

Representasi JSON 
{
  "screenName": string,
  "mobileDeviceBranding": string,
  "mobileDeviceModel": string,
  "appName": string
}
Kolom
screenName

string

Nama layar.

mobileDeviceBranding

string

Produsen atau nama bermerek seluler. Misalnya: "Google", "Apel", dll.

mobileDeviceModel

string

Model perangkat seluler. Misalnya: "Pixel", "iPhone" dll.

appName

string

Nama aplikasi.

EcommerceData

Detail e-commerce yang terkait dengan aktivitas pengguna.

Representasi JSON 
{
  "actionType": enum(ECommerceAction),
  "transaction": {
    object(TransactionData)
  },
  "products": [
    {
      object(ProductData)
    }
  ],
  "ecommerceType": enum(EcommerceType)
}
Kolom
actionType

enum(ECommerceAction)

Tindakan yang terkait dengan tindakan e-commerce ini.

transaction

object(TransactionData)

Detail transaksi dari tindakan e-commerce ini.

products[]

object(ProductData)

Detail produk dalam transaksi ini.

ecommerceType

enum(EcommerceType)

Jenis aktivitas e-commerce ini.

ECommerceAction

Kumpulan semua tindakan yang terkait dengan tindakan e-commerce.

Enum
UNKNOWN Jenis tindakan tidak diketahui.
CLICK Klik daftar produk.
DETAILS_VIEW Tampilan detail produk.
ADD_TO_CART Tambahkan produk ke keranjang.
REMOVE_FROM_CART Hapus produk dari keranjang.
CHECKOUT Check out.
PAYMENT Pembelian selesai.
REFUND Pengembalian dana pembelian.
CHECKOUT_OPTION Opsi checkout.

TransactionData

Menampilkan detail yang dikumpulkan saat pengunjung melakukan transaksi di halaman.

Representasi JSON 
{
  "transactionId": string,
  "transactionRevenue": number,
  "transactionTax": number,
  "transactionShipping": number
}
Kolom
transactionId

string

ID transaksi, yang diberikan oleh metode pelacakan e-commerce, untuk pembelian di keranjang belanja.

transactionRevenue

number

Total pendapatan penjualan (tidak termasuk pengiriman dan pajak) dari transaksi.

transactionTax

number

Total pajak untuk transaksi.

transactionShipping

number

Total biaya pengiriman.

ProductData

Detail produk dalam transaksi e-commerce.

Representasi JSON 
{
  "productSku": string,
  "productName": string,
  "itemRevenue": number,
  "productQuantity": string
}
Kolom
productSku

string

Kode unik yang mewakili produk.

productName

string

Nama produk, yang diberikan oleh aplikasi pelacakan e-commerce, untuk item yang dibeli.

itemRevenue

number

Total pendapatan dari item produk yang dibeli.

productQuantity

string (int64 format)

Jumlah total unit produk ini dalam transaksi.

EcommerceType

Ini mewakili jenis data e-commerce yang ditampilkan.

Enum
ECOMMERCE_TYPE_UNSPECIFIED Digunakan saat jenis aktivitas e-commerce tidak ditentukan.
CLASSIC Digunakan saat aktivitas memiliki informasi e-commerce klasik (tidak ditingkatkan).
ENHANCED Digunakan saat aktivitas memiliki informasi Enhanced E-commerce.

GoalSetData

Mewakili kumpulan sasaran yang tercapai dalam suatu aktivitas.

Representasi JSON 
{
  "goals": [
    {
      object(GoalData)
    }
  ]
}
Kolom
goals[]

object(GoalData)

Semua sasaran yang dicapai dalam aktivitas saat ini.

GoalData

Mewakili semua detail yang berkaitan dengan sasaran.

Representasi JSON 
{
  "goalIndex": number,
  "goalCompletions": string,
  "goalValue": number,
  "goalCompletionLocation": string,
  "goalPreviousStep1": string,
  "goalPreviousStep2": string,
  "goalPreviousStep3": string,
  "goalName": string
}
Kolom
goalIndex

number

Hal ini mengidentifikasi tujuan yang dikonfigurasi untuk profil.

goalCompletions

string (int64 format)

Jumlah total sasaran tercapai dalam aktivitas ini.

goalValue

number

Nilai dalam sasaran ini.

goalCompletionLocation

string

URL halaman tempat sasaran ini diselesaikan.

goalPreviousStep1

string

URL halaman satu langkah sebelum sasaran tercapai.

goalPreviousStep2

string

URL halaman dua langkah sebelum sasaran tercapai.

goalPreviousStep3

string

URL halaman tiga langkah sebelum sasaran tercapai.

goalName

string

Nama sasaran.

EventData

Menampilkan semua detail yang berkaitan dengan acara.

Representasi JSON 
{
  "eventCategory": string,
  "eventAction": string,
  "eventLabel": string,
  "eventValue": string,
  "eventCount": string
}
Kolom
eventCategory

string

Objek pada halaman yang berinteraksi. Misalnya: 'Video'.

eventAction

string

Jenis interaksi dengan objek. Misalnya: 'putar'.

eventLabel

string

Label dilampirkan dengan peristiwa.

eventValue

string (int64 format)

Nilai numerik yang terkait dengan peristiwa.

eventCount

string (int64 format)

Jumlah peristiwa tersebut dalam aktivitas ini.

Cobalah!