- Referensi: 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. ID. 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. Laporan ini biasanya menyertakan informasi berikut: nama referensi laporan, status laporan, stempel waktu pembuatan laporan, dll. |
ReportDefinition
Definisi cara menjalankan laporan.
Representasi JSON |
---|
{ "dimensions": [ { object ( |
Kolom | |
---|---|
dimensions[] |
Opsional. Dimensi yang diminta dan ditampilkan. |
metrics[] |
Opsional. Metrik yang diminta dan ditampilkan. |
dateRanges[] |
Opsional. Rentang tanggal data untuk 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 hanya meminta 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 SQL. Dimensi tidak dapat digunakan dalam filter ini. |
offset |
Opsional. Jumlah baris baris awal dari Penyimpanan Google Analytics. Baris pertama dihitung sebagai baris 0. Saat membuat tugas laporan, parameter |
limit |
Opsional. Jumlah baris yang akan ditampilkan dalam Laporan. Jika tidak ditentukan, total 10.000 baris akan ditampilkan. API ini menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. API juga dapat menampilkan lebih sedikit baris daripada |
metricAggregations[] |
Opsional. Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris tempat dimensionValues ditetapkan ke "RESERVED_(MetricAggregation)". |
orderBys[] |
Opsional. Menentukan cara baris diurutkan dalam respons. |
currencyCode |
Opsional. Kode mata uang dalam format ISO4217, seperti "AED", "USD", "JPY". Jika kolom kosong, laporan akan menggunakan mata uang default properti. |
cohortSpec |
Opsional. Grup kelompok yang terkait dengan permintaan ini. Jika ada grup kelompok dalam permintaan, kolom 'kohor' dimensi kustom harus ada. |
keepEmptyRows |
Opsional. Jika salah atau tidak ditentukan, tiap baris dengan semua metrik yang sama dengan 0 tidak akan ditampilkan. Jika true (benar), baris ini 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, kota dimensi menunjukkan kota tempat peristiwa berasal. Nilai dimensi dalam respons laporan adalah string; misalnya, kota bisa 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 dirujuk oleh |
dimensionExpression |
Satu dimensi dapat menjadi hasil dari ekspresi beberapa dimensi. Misalnya, dimensi "country, city": concatenate(country, ", ", city). |
DimensionExpression
Digunakan untuk menyatakan dimensi yang merupakan hasil rumus beberapa dimensi. Contoh penggunaan: 1) lowerCase(dimensi) 2) concatenate(dimension1, simbol, dimension2).
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 ke huruf kecil. |
upperCase |
Digunakan untuk mengonversi nilai dimensi ke huruf besar. |
concatenate |
Digunakan untuk menggabungkan nilai dimensi ke 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 ke 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 yang ditempatkan di antara nama dimensi. Pemisah sering kali berupa karakter tunggal seperti "|" atau "," tapi bisa juga berupa string yang lebih panjang. Jika nilai dimensi berisi pembatas, keduanya akan ada sebagai 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 matematika 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 dalam |
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 menyatakan filter dimensi atau metrik. Kolom dalam FilterExpression yang sama harus berupa semua dimensi atau semua 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 |
Ekspresi Filter di andGroup memiliki hubungan AND. |
orGroup |
Ekspresi Filter di orGroup memiliki hubungan OR. |
notExpression |
FilterExpression BUKAN dari notExpression. |
filter |
Filter primitif. Dalam FilterExpression yang sama, semua nama kolom filter harus berupa semua dimensi atau semua 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 |
Dimulai dengan nilai string. |
ENDS_WITH |
Diakhiri dengan nilai string. |
CONTAINS |
Berisi nilai string. |
FULL_REGEXP |
Pencocokan penuh untuk ekspresi reguler dengan nilai string. |
PARTIAL_REGEXP |
Pencocokan sebagian untuk ekspresi reguler dengan nilai string. |
InListFilter
Hasilnya harus berupa 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 berikut ini: |
|
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 |
{i>SUM<i}. |
MINIMUM |
Operator minimum. |
MAXIMUM |
Operator maksimum. |
COUNT |
Operator jumlah. |
OrderBy
Urutkan menurut menentukan cara baris diurutkan dalam respons. Misalnya, mengurutkan baris berdasarkan jumlah peristiwa menurun adalah satu pengurutan, dan mengurutkan baris berdasarkan string nama peristiwa adalah pengurutan yang berbeda.
Representasi JSON |
---|
{ "desc": boolean, // Union field |
Kolom | |
---|---|
desc |
Jika true (benar), mengurutkan dengan urutan menurun. |
Kolom union one_order_by . Tentukan satu jenis pesanan paling lambat untuk 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 menurut nilai metrik.
Representasi JSON |
---|
{ "metricName": string } |
Kolom | |
---|---|
metricName |
Nama metrik dalam permintaan untuk mengurutkan. |
DimensionOrderBy
Mengurutkan menurut nilai dimensi.
Representasi JSON |
---|
{
"dimensionName": string,
"orderType": enum ( |
Kolom | |
---|---|
dimensionName |
Nama dimensi dalam permintaan 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 poin kode Unicode huruf kecil. Misalnya, "2" < "A" < "b" < X < "z". |
NUMERIC |
Nilai dimensi dikonversi menjadi angka sebelum mengurutkan. Misalnya dalam NUMERIC mengurutkan, "25" < "100", dan dalam ALPHANUMERIC urutkan, "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. Misalnya, Anda dapat memilih kelompok pengguna yang diperoleh 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
. Setelah kelompok tersebut selama enam minggu ke depan, ditentukan dalam objek cohortsRange
.
Misalnya, lihat Contoh Laporan Kelompok.
Respons laporan dapat menunjukkan deret waktu mingguan, di mana aplikasi Anda telah 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 menjadi 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 termasuk 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 kontak pertamanya berada antara tanggal mulai dan tanggal akhir yang ditentukan dalam 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 diisi. Perincian yang digunakan untuk menafsirkan |
startOffset |
Jika Jika Jika |
endOffset |
Wajib diisi. Jika Jika Jika |
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. Umumnya digunakan jika dateRange kelompok adalah satu hari dan permintaan berisi cohortNthDay . |
WEEKLY |
Perincian mingguan. Umumnya digunakan jika dateRange kelompok berdurasi seminggu (dimulai pada hari Minggu dan berakhir pada hari Sabtu) dan permintaan berisi cohortNthWeek . |
MONTHLY |
Perincian bulanan. Umumnya 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), akumulasi hasil dari hari kontak pertama hingga hari akhir. Tidak didukung dalam bahasa |
ReportMetadata
Metadata laporan untuk tugas laporan tertentu.
Representasi JSON |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Kolom | |
---|---|
creationQuotaTokensCharged |
Hanya output. Total token kuota yang ditagih 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 RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: |
taskRowCount |
Hanya output. Jumlah total baris dalam hasil laporan. Kolom ini akan diisi saat status aktif. Anda dapat memanfaatkan |
errorMessage |
Hanya output. Pesan error akan terisi jika tugas laporan gagal selama pembuatan. |
totalRowCount |
Hanya output. Total jumlah baris di penyimpanan Google Analytics. Jika Anda ingin mengkueri baris data tambahan di luar laporan saat ini, baris 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 akan terjadi segera setelah panggilan CreateReport. |
ACTIVE |
Laporan telah dibuat sepenuhnya dan siap untuk pembuatan 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. |