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 ditentukan, rentang tanggal default adalah (startDate: tanggal saat ini - 7 hari, endDate: tanggal saat ini - 1 hari).

viewId

string

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

user

object(User)

Wajib diisi. 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 lanjutan 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 catatan 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 menunjukkan rasio pengambilan sampel untuk permintaan tertentu dan berupa angka antara 0,0 hingga 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.

IdPenggunaJenis

Mewakili berbagai jenis identifikasi pengguna yang tersedia.

Enumerasi
USER_ID_TYPE_UNSPECIFIED Jika Jenis ID Pengguna tidak ditentukan, jenis default 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 Analytics menetapkan clientId.

JenisAktivitas

Enumerasi
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 pada halaman.
EVENT Digunakan saat aktivitas berupa peristiwa.

SesiAktivitasPengguna

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)

Menyatakan tampilan detail tentang setiap aktivitas dalam sesi ini.

sessionDate

string

Tanggal sesi ini dalam format ISO-8601.

Aktivitas

Aktivitas merepresentasikan data untuk aktivitas pengguna. Perhatikan bahwa Aktivitas berbeda dari hit. Hit dapat mengakibatkan beberapa Aktivitas. Misalnya, jika klik mencakup transaksi dan sasaran tercapai, akan ada dua proto Aktivitas untuk klik ini, satu untuk ECOMMERCE dan satu untuk GOAL. Sebaliknya, beberapa hit juga dapat membuat satu Aktivitas. Dalam e-commerce klasik, data untuk satu transaksi mungkin dikirim melalui beberapa hit. Klik ini akan digabungkan ke 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, ini adalah nilai parameter pelacakan kampanye utm_source. Untuk pemberian tag otomatis AdWords, atribut ini adalah Google. Jika Anda tidak menggunakan keduanya, domain tersebut adalah domain sumber (misalnya, document.referrer) yang merujuk pengguna. File ini mungkin juga berisi alamat port. Jika pengguna datang tanpa perujuk, nilainya adalah (direct).

medium

string

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

channelGrouping

string

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

campaign

string

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

keyword

string

Untuk pelacakan kampanye manual, ini adalah nilai parameter pelacakan kampanye utm_term. Untuk traffic AdWords, kolom ini berisi kriteria penargetan yang paling cocok. Untuk jaringan display, tempat beberapa kriteria penargetan dapat menyebabkan iklan tampil, jaringan tersebut menampilkan kriteria penargetan yang paling cocok seperti yang dipilih oleh Iklan. Ini dapat berupa display_keyword, penempatan situs, boomuserlist, user_interest, usia, atau gender. Jika tidak, nilainya adalah (belum ditetapkan).

hostname

string

Nama host tempat permintaan pelacakan dibuat.

landingPagePath

string

Halaman pertama di pengguna' sesi, atau halaman landing.

activityType

enum(ActivityType)

Jenis aktivitas ini.

customDimension[]

object(CustomDimension)

Daftar semua dimensi kustom yang terkait dengan aktivitas ini.

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

object(PageviewData)

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

appview

object(ScreenviewData)

Ini akan ditetapkan jika activityType sama dengan SCREEN_VIEW.

ecommerce

object(EcommerceData)

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 terkait dengan suatu peristiwa dan akan ditetapkan jika activityType sama dengan EVENT.

Dimensi Kustom

Dimensi kustom.

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

number

Nomor slot dimensi kustom.

value

string

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

DataKunjungan Halaman

Mewakili detail yang dikumpulkan saat pengunjung melihat halaman.

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

string

URL halaman yang dilihat oleh pengunjung.

pageTitle

string

Judul halaman yang dilihat pengunjung.

DataTampilanLayar

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

string

Nama layar.

mobileDeviceBranding

string

Produsen seluler atau nama bermerek. Mis.: "Google", "Apple" dll.

mobileDeviceModel

string

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

appName

string

Nama aplikasi.

Data E-commerce

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.

E-commerce

Kumpulan semua tindakan yang terkait dengan tindakan e-commerce.

Enumerasi
UNKNOWN Jenis tindakan tidak diketahui.
CLICK Klik-tayang 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.

DataTransaksi

Mewakili 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) transaksi.

transactionTax

number

Total pajak untuk transaksi.

transactionShipping

number

Biaya pengiriman total.

DataProduk

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.

Jenis E-commerce

Ini menunjukkan jenis data e-commerce yang ditampilkan.

Enumerasi
ECOMMERCE_TYPE_UNSPECIFIED Digunakan saat jenis aktivitas e-commerce tidak ditentukan.
CLASSIC Digunakan saat aktivitas memiliki informasi e-commerce klasik (yang tidak disempurnakan).
ENHANCED Digunakan saat aktivitas telah meningkatkan informasi e-commerce.

SasaranSetData

Menyatakan kumpulan sasaran yang telah dicapai dalam suatu aktivitas.

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

object(GoalData)

Semua sasaran yang dicapai dalam aktivitas saat ini.

DataSasaran

Mewakili semua detail yang terkait dengan sasaran.

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

number

Atribut ini mengidentifikasi sasaran seperti yang dikonfigurasi untuk profil.

goalCompletions

string (int64 format)

Jumlah total sasaran tercapai dalam aktivitas ini.

goalValue

number

Nilai di 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.

DataPeristiwa

Mewakili semua detail yang terkait dengan peristiwa.

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

string

Objek di halaman yang berinteraksi. Contoh: 'Video'.

eventAction

string

Jenis interaksi dengan objek. Contoh: 'play'.

eventLabel

string

Label yang dilampirkan dengan peristiwa.

eventValue

string (int64 format)

Nilai numerik yang terkait dengan peristiwa.

eventCount

string (int64 format)

Jumlah peristiwa semacam ini dalam aktivitas ini.

Cobalah!