- Resource: ReportTask
- ReportDefinition
- Dimensi
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Metrik
- DateRange
- FilterExpression
- FilterExpressionList
- Filter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Operasi
- NumericValue
- BetweenFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Kelompok
- CohortsRange
- Perincian
- CohortReportSettings
- ReportMetadata
- Status
- Metode
Resource: ReportTask
Konfigurasi tugas laporan tertentu.
Representasi JSON |
---|
{ "name": string, "reportDefinition": { object ( |
Kolom | |
---|---|
name |
Hanya output. Pengenal. Nama resource tugas laporan yang ditetapkan selama pembuatan. Format: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
Opsional. Definisi laporan untuk mengambil data laporan, yang menjelaskan struktur laporan. Laporan ini biasanya mencakup kolom yang akan disertakan dalam laporan dan kriteria yang akan digunakan untuk memfilter data. |
reportMetadata |
Hanya output. Metadata laporan untuk tugas laporan tertentu, yang memberikan informasi tentang laporan. Biasanya mencakup informasi berikut: nama resource laporan, status laporan, stempel waktu laporan dibuat, dll, |
ReportDefinition
Definisi tentang bagaimana laporan harus dijalankan.
Representasi JSON |
---|
{ "dimensions": [ { object ( |
Kolom | |
---|---|
dimensions[] |
Opsional. Dimensi yang diminta dan ditampilkan. |
metrics[] |
Opsional. Metrik yang diminta dan ditampilkan. |
dateRanges[] |
Opsional. Rentang tanggal data yang akan dibaca. Jika beberapa rentang tanggal diminta, setiap baris respons akan berisi indeks rentang tanggal berbasis nol. Jika dua rentang tanggal tumpang-tindih, data peristiwa untuk hari yang tumpang-tindih akan disertakan dalam baris respons untuk kedua rentang tanggal tersebut. Dalam permintaan kelompok, |
dimensionFilter |
Opsional. Filter dimensi memungkinkan Anda meminta hanya nilai dimensi tertentu dalam laporan. Untuk mempelajari lebih lanjut, lihat Dasar-Dasar Filter Dimensi untuk mengetahui contohnya. Metrik tidak dapat digunakan dalam filter ini. |
metricFilter |
Opsional. Klausa filter metrik. Diterapkan setelah menggabungkan baris laporan, mirip dengan klausa penggunaan SQL. Dimensi tidak dapat digunakan dalam filter ini. |
offset |
Opsional. Jumlah baris untuk baris awal dari Google Analytics Storage. Baris pertama dihitung sebagai baris 0. Saat membuat tugas laporan, parameter |
limit |
Opsional. Jumlah baris yang akan ditampilkan dalam Laporan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. API juga dapat menampilkan baris lebih sedikit daripada |
metricAggregations[] |
Opsional. Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris tempat dimensionValues ditetapkan ke "RESERVED_(MetricAggregation)". |
orderBys[] |
Opsional. Menentukan bagaimana baris diurutkan dalam respons. |
currencyCode |
Opsional. Kode mata uang dalam format ISO4217, seperti "AED", "USD", "JPY". Jika kolomnya kosong, laporan akan menggunakan mata uang default properti. |
cohortSpec |
Opsional. Grup kelompok yang dikaitkan dengan permintaan ini. Jika ada grup kelompok dalam permintaan, dimensi 'kohor' harus ada. |
keepEmptyRows |
Opsional. Jika salah (false) atau tidak ditentukan, setiap baris dengan semua metrik yang sama dengan 0 tidak akan ditampilkan. Jika true (benar), baris tersebut akan ditampilkan jika tidak dihapus secara terpisah oleh filter. Terlepas dari setelan Misalnya, jika properti tidak pernah mencatat peristiwa |
Dimensi
Dimensi merupakan atribut data Anda. Misalnya, dimensi kota menunjukkan kota tempat peristiwa berasal. Nilai dimensi dalam respons laporan adalah string; misalnya, kota dapat berupa "Paris" atau "New York".
Representasi JSON |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Kolom | |
---|---|
name |
Nama dimensi. Lihat Dimensi API untuk mengetahui daftar nama dimensi yang didukung oleh metode pelaporan inti seperti Jika Dimensi direferensikan oleh |
dimensionExpression |
Satu dimensi dapat merupakan hasil dari ekspresi beberapa dimensi. Misalnya, dimensi "country, city": concatenate(country, ", ", city). |
DimensionExpression
Digunakan untuk menyatakan dimensi yang merupakan hasil dari formula beberapa dimensi. Contoh penggunaan: 1) {i>lowerCase<i} (dimensi) 2) {i>concatenate<i} (dimensi1, simbol, dimensi2).
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union one_expression . Tentukan satu jenis ekspresi dimensi untuk DimensionExpression . one_expression hanya dapat berupa salah satu dari yang berikut: |
|
lowerCase |
Digunakan untuk mengonversi nilai dimensi menjadi huruf kecil. |
upperCase |
Digunakan untuk mengonversi nilai dimensi menjadi huruf besar. |
concatenate |
Digunakan untuk menggabungkan nilai dimensi menjadi satu dimensi. Misalnya, dimensi "country, city": concatenate(country, ", ", city). |
CaseExpression
Digunakan untuk mengonversi nilai dimensi menjadi satu kasus.
Representasi JSON |
---|
{ "dimensionName": string } |
Kolom | |
---|---|
dimensionName |
Nama dimensi. Nama tersebut harus merujuk kembali ke nama di kolom dimensi permintaan. |
ConcatenateExpression
Digunakan untuk menggabungkan nilai dimensi menjadi satu dimensi.
Representasi JSON |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Kolom | |
---|---|
dimensionNames[] |
Nama dimensi. Nama tersebut harus merujuk kembali ke nama di kolom dimensi permintaan. |
delimiter |
Pemisah ditempatkan di antara nama dimensi. Pembatas sering kali berupa karakter tunggal seperti "|" atau "," tetapi bisa berupa string yang lebih panjang. Jika nilai dimensi berisi pemisah, keduanya akan ditampilkan dalam respons tanpa perbedaan. Misalnya, jika nilai dimensi 1 = "US,FR", nilai dimensi 2 = "JP", dan pembatas = ",", responsnya akan berisi "US,FR,JP". |
Metrik
Pengukuran kuantitatif laporan. Misalnya, metrik eventCount
adalah jumlah total peristiwa. Permintaan diizinkan hingga 10 metrik.
Representasi JSON |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Kolom | |
---|---|
name |
Nama metrik. Lihat Metrik API untuk mengetahui daftar nama metrik yang didukung oleh metode pelaporan inti seperti Jika Metrik direferensikan oleh |
expression |
Ekspresi matematis untuk metrik turunan. Misalnya, jumlah Peristiwa metrik per pengguna adalah |
invisible |
Menunjukkan apakah metrik tidak terlihat dalam respons laporan. Jika metrik tidak terlihat, metrik tidak akan menghasilkan kolom dalam respons, tetapi dapat digunakan di |
DateRange
Kumpulan hari yang berdekatan: startDate
, startDate + 1
, ..., endDate
. Permintaan diizinkan hingga 4 rentang tanggal.
Representasi JSON |
---|
{ "startDate": string, "endDate": string, "name": string } |
Kolom | |
---|---|
startDate |
Tanggal mulai inklusif untuk kueri dalam format |
endDate |
Tanggal akhir inklusif untuk kueri dalam format |
name |
Menetapkan nama untuk rentang tanggal ini. Dimensi |
FilterExpression
Untuk menampilkan filter dimensi atau metrik. Kolom di FilterExpression yang sama harus berupa semua dimensi atau metrik.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union expr . Tentukan satu jenis ekspresi filter untuk FilterExpression . expr hanya dapat berupa salah satu dari yang berikut: |
|
andGroup |
FilterEkspresi di andGroup memiliki hubungan AND. |
orGroup |
FilterEkspresi di orGroup memiliki hubungan ATAU. |
notExpression |
FilterExpression BUKAN dari notExpression. |
filter |
Filter primitif. Dalam FilterExpression yang sama, semua nama kolom filter harus berupa semua dimensi atau metrik. |
FilterExpressionList
Daftar ekspresi filter.
Representasi JSON |
---|
{
"expressions": [
{
object ( |
Kolom | |
---|---|
expressions[] |
Daftar ekspresi filter. |
Filter
Ekspresi untuk memfilter nilai dimensi atau metrik.
Representasi JSON |
---|
{ "fieldName": string, // Union field |
Kolom | |
---|---|
fieldName |
Nama dimensi atau nama metrik. Harus berupa nama yang ditentukan dalam dimensi atau metrik. |
Kolom union one_filter . Tentukan satu jenis filter untuk Filter . one_filter hanya dapat berupa salah satu dari yang berikut: |
|
stringFilter |
Filter terkait string. |
inListFilter |
Filter untuk nilai dalam daftar. |
numericFilter |
Filter untuk nilai numerik atau tanggal. |
betweenFilter |
Filter untuk antara dua nilai. |
StringFilter
Filter untuk string
Representasi JSON |
---|
{
"matchType": enum ( |
Kolom | |
---|---|
matchType |
Jenis pencocokan untuk filter ini. |
value |
Nilai string yang digunakan untuk pencocokan. |
caseSensitive |
Jika true (benar), nilai string peka huruf besar/kecil. |
MatchType
Jenis pencocokan filter string
Enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
Tidak ditentukan |
EXACT |
Pencocokan persis dari nilai string. |
BEGINS_WITH |
Diawali dengan nilai string. |
ENDS_WITH |
Berakhir dengan nilai string. |
CONTAINS |
Berisi nilai string. |
FULL_REGEXP |
Kecocokan penuh untuk ekspresi reguler dengan nilai string. |
PARTIAL_REGEXP |
Kecocokan parsial untuk ekspresi reguler dengan nilai string. |
InListFilter
Hasilnya harus berada dalam daftar nilai string.
Representasi JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Kolom | |
---|---|
values[] |
Daftar nilai string. Tidak boleh kosong. |
caseSensitive |
Jika true (benar), nilai string peka huruf besar/kecil. |
NumericFilter
Filter untuk nilai numerik atau tanggal.
Representasi JSON |
---|
{ "operation": enum ( |
Kolom | |
---|---|
operation |
Jenis operasi untuk filter ini. |
value |
Nilai numerik atau nilai tanggal. |
Operasi
Operasi yang diterapkan pada filter numerik
Enum | |
---|---|
OPERATION_UNSPECIFIED |
Tidak ditentukan. |
EQUAL |
Sama dengan |
LESS_THAN |
Kurang dari |
LESS_THAN_OR_EQUAL |
Kurang dari atau sama dengan |
GREATER_THAN |
Lebih dari |
GREATER_THAN_OR_EQUAL |
Lebih dari atau sama dengan |
NumericValue
Untuk mewakili angka.
Representasi JSON |
---|
{ // Union field |
Kolom | |
---|---|
Kolom union one_value . Salah satu nilai numerik one_value hanya dapat berupa salah satu dari yang berikut: |
|
int64Value |
Nilai bilangan bulat |
doubleValue |
Nilai ganda |
BetweenFilter
Untuk menyatakan bahwa hasilnya harus antara dua angka (inklusif).
Representasi JSON |
---|
{ "fromValue": { object ( |
Kolom | |
---|---|
fromValue |
Diawali dengan angka ini. |
toValue |
Berakhir dengan angka ini. |
MetricAggregation
Mewakili agregasi metrik.
Enum | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Operator tidak ditentukan. |
TOTAL |
operator SUM. |
MINIMUM |
Operator minimum. |
MAXIMUM |
Operator maksimum. |
COUNT |
Operator jumlah. |
OrderBy
Urutkan menurut menentukan bagaimana baris akan diurutkan dalam respons. Misalnya, mengurutkan baris berdasarkan jumlah peristiwa menurun adalah satu pengurutan, dan mengurutkan baris berdasarkan string nama peristiwa adalah urutan yang berbeda.
Representasi JSON |
---|
{ "desc": boolean, // Union field |
Kolom | |
---|---|
desc |
Jika true (benar), mengurutkan dari bawah ke atas. |
Kolom union one_order_by . Tentukan satu jenis pesanan berdasarkan OrderBy . one_order_by hanya dapat berupa salah satu dari yang berikut: |
|
metric |
Mengurutkan hasil menurut nilai metrik. |
dimension |
Mengurutkan hasil menurut nilai dimensi. |
MetricOrderBy
Mengurutkan berdasarkan nilai metrik.
Representasi JSON |
---|
{ "metricName": string } |
Kolom | |
---|---|
metricName |
Nama metrik dalam permintaan untuk mengurutkan. |
DimensionOrderBy
Mengurutkan berdasarkan nilai dimensi.
Representasi JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Kolom | |
---|---|
dimensionName |
Nama dimensi dalam permintaan yang akan digunakan untuk mengurutkan. |
orderType |
Mengontrol aturan untuk pengurutan nilai dimensi. |
OrderType
Aturan untuk mengurutkan nilai dimensi string.
Enum | |
---|---|
ORDER_TYPE_UNSPECIFIED |
Tidak ditentukan. |
ALPHANUMERIC |
Pengurutan alfanumerik berdasarkan titik kode Unicode. Misalnya, "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Urutkan alfanumerik yang tidak peka huruf besar/kecil berdasarkan titik kode Unicode huruf kecil. Misalnya, "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Nilai dimensi dikonversi menjadi angka sebelum mengurutkan. Misalnya dalam pengurutan NUMERIK, "25" < "100", dan dalam urutan ALPHANUMERIC , "100" < "25". Semua nilai dimensi non-numerik memiliki nilai pengurutan yang sama di bawah semua nilai numerik. |
CohortSpec
Spesifikasi kelompok untuk laporan kelompok.
Laporan kelompok membuat deret waktu retensi pengguna untuk kelompok tersebut. Misalnya, Anda dapat memilih kelompok pengguna yang diakuisisi pada minggu pertama bulan September dan mengikuti kelompok tersebut selama enam minggu ke depan. Memilih pengguna yang diperoleh pada minggu pertama kelompok September ditentukan dalam objek cohort
. Mengikuti kelompok tersebut selama enam minggu ke depan ditentukan dalam objek cohortsRange
.
Misalnya, lihat Contoh Laporan Kelompok.
Respons laporan dapat menampilkan deret waktu mingguan yang mengatakan bahwa aplikasi Anda mempertahankan 60% dari kelompok ini setelah tiga minggu dan 25% dari kelompok ini setelah enam minggu. Kedua persentase ini dapat dihitung dengan metrik cohortActiveUsers/cohortTotalUsers
dan akan berupa baris terpisah dalam laporan.
Representasi JSON |
---|
{ "cohorts": [ { object ( |
Kolom | |
---|---|
cohorts[] |
Menentukan kriteria pemilihan untuk mengelompokkan pengguna ke dalam kelompok. Sebagian besar laporan kelompok hanya menentukan satu kelompok. Jika beberapa kelompok ditentukan, setiap kelompok dapat dikenali dalam laporan berdasarkan namanya. |
cohortsRange |
Laporan kelompok mengikuti kelompok selama rentang tanggal pelaporan yang diperpanjang. Rentang ini menentukan durasi offset untuk mengikuti kohor. |
cohortReportSettings |
Setelan opsional untuk laporan kelompok. |
Kelompok
Menentukan kriteria pemilihan kelompok. Kelompok adalah sekelompok pengguna yang memiliki karakteristik yang sama. Misalnya, pengguna dengan firstSessionDate
yang sama akan masuk dalam kelompok yang sama.
Representasi JSON |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Kolom | |
---|---|
name |
Menetapkan nama untuk kelompok ini. Dimensi |
dimension |
Dimensi yang digunakan oleh kelompok. Wajib dan hanya mendukung |
dateRange |
Kelompok memilih pengguna yang tanggal sentuh pertamanya berada di antara tanggal mulai dan tanggal akhir yang ditentukan di Dalam permintaan kelompok,
|
CohortsRange
Mengonfigurasi rentang tanggal pelaporan yang diperpanjang untuk laporan kelompok. Menentukan durasi offset untuk mengikuti kohor.
Representasi JSON |
---|
{
"granularity": enum ( |
Kolom | |
---|---|
granularity |
Wajib. Perincian yang digunakan untuk menafsirkan |
startOffset |
Jika Jika Jika |
endOffset |
Wajib. Jika Jika Jika |
Tingkat perincian
Perincian yang digunakan untuk menafsirkan startOffset
dan endOffset
untuk rentang tanggal pelaporan yang diperpanjang untuk laporan kelompok.
Enum | |
---|---|
GRANULARITY_UNSPECIFIED |
Tidak boleh ditentukan. |
DAILY |
Perincian harian. Biasanya digunakan jika dateRange kelompok adalah satu hari dan permintaan berisi cohortNthDay . |
WEEKLY |
Perincian mingguan. Biasa digunakan jika dateRange kelompok berdurasi seminggu (dimulai pada hari Minggu dan berakhir pada hari Sabtu) dan permintaan berisi cohortNthWeek . |
MONTHLY |
Perincian bulanan. Biasanya digunakan jika dateRange kelompok berdurasi satu bulan dan permintaan berisi cohortNthMonth . |
CohortReportSettings
Setelan opsional laporan kelompok.
Representasi JSON |
---|
{ "accumulate": boolean } |
Kolom | |
---|---|
accumulate |
Jika true (benar), hasilnya akan mengakumulasikan dari hari kontak pertama hingga hari akhir. Tidak didukung dalam |
ReportMetadata
Metadata laporan untuk tugas laporan tertentu.
Representasi JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Kolom | |
---|---|
creationQuotaTokensCharged |
Hanya output. Total token kuota yang dikenakan biaya selama pembuatan laporan. Karena jumlah token ini didasarkan pada aktivitas dari status |
state |
Hanya output. Status saat ini untuk tugas laporan ini. |
beginCreatingTime |
Hanya output. Waktu saat Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: |
taskRowCount |
Hanya output. Total jumlah baris dalam hasil laporan. Kolom ini akan diisi saat status aktif. Anda dapat menggunakan |
errorMessage |
Hanya output. Pesan error akan terisi jika tugas laporan gagal selama pembuatan. |
totalRowCount |
Hanya output. Jumlah total baris di penyimpanan Google Analytics. Jika Anda ingin membuat kueri baris data tambahan di luar laporan saat ini, baris data tambahan tersebut dapat memulai tugas laporan baru berdasarkan
Misalnya, |
Negara Bagian
Status pemrosesan.
Enum | |
---|---|
STATE_UNSPECIFIED |
Status yang tidak ditentukan tidak akan pernah digunakan. |
CREATING |
Laporan sedang dibuat dan akan tersedia di masa mendatang. Pembuatan dilakukan segera setelah panggilan CreateReport. |
ACTIVE |
Laporan sudah sepenuhnya dibuat dan siap untuk kueri. |
FAILED |
Laporan gagal dibuat. |
Metode |
|
---|---|
|
Memulai pembuatan tugas laporan. |
|
Mendapatkan metadata laporan tentang tugas laporan tertentu. |
|
Mencantumkan semua tugas laporan untuk properti. |
|
Mengambil konten tugas laporan. |