Method: reports.batchGet

Menampilkan data Analytics.

Permintaan HTTP

POST https://analyticsreporting.googleapis.com/v4/reports:batchGet

URL menggunakan sintaksis gRPC Transcoding.

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON
{
  "reportRequests": [
    {
      object(ReportRequest)
    }
  ],
  "useResourceQuotas": boolean
}
Kolom
reportRequests[]

object(ReportRequest)

Permintaan, setiap permintaan akan memiliki respons yang terpisah. Maksimum ada 5 permintaan. Semua permintaan harus memiliki dateRanges, viewId, segments, samplingLevel, dan cohortGroup yang sama.

useResourceQuotas

boolean

Mengaktifkan kuota berbasis resource, (default-nya adalah False). Jika kolom ini ditetapkan ke True, kuota per tampilan (profil) diatur oleh biaya komputasi permintaan. Perhatikan bahwa penggunaan kuota berbasis biaya akan memungkinkan frekuensi pengambilan sampel yang lebih tinggi. (10 Juta untuk SMALL, 100 Juta untuk LARGE. Lihat dokumentasi batas dan kuota untuk mengetahui detailnya.

Isi respons

Jika berhasil, isi respons memuat data dengan struktur berikut:

Class respons utama yang menyimpan laporan dari panggilan batchGet Reporting API.

Representasi JSON
{
  "reports": [
    {
      object(Report)
    }
  ],
  "queryCost": number,
  "resourceQuotasRemaining": {
    object(ResourceQuotasRemaining)
  }
}
Kolom
reports[]

object(Report)

Respons yang sesuai dengan setiap permintaan.

queryCost

number

Jumlah token kuota resource yang dikurangi untuk menjalankan kueri. Mencakup semua respons.

resourceQuotasRemaining

object(ResourceQuotasRemaining)

Jumlah kuota resource yang tersisa untuk properti.

Cakupan Otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

PermintaanLaporan

Class permintaan utama yang menentukan permintaan Reporting API.

Representasi JSON
{
  "viewId": string,
  "dateRanges": [
    {
      object(DateRange)
    }
  ],
  "samplingLevel": enum(Sampling),
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "metricFilterClauses": [
    {
      object(MetricFilterClause)
    }
  ],
  "filtersExpression": string,
  "orderBys": [
    {
      object(OrderBy)
    }
  ],
  "segments": [
    {
      object(Segment)
    }
  ],
  "pivots": [
    {
      object(Pivot)
    }
  ],
  "cohortGroup": {
    object(CohortGroup)
  },
  "pageToken": string,
  "pageSize": number,
  "includeEmptyRows": boolean,
  "hideTotals": boolean,
  "hideValueRanges": boolean
}
Kolom
viewId

string

ID tampilan Analytics untuk mengambil data. Setiap ReportRequest dalam metode batchGet harus berisi viewId yang sama.

dateRanges[]

object(DateRange)

Rentang tanggal dalam permintaan. Permintaan dapat memiliki maksimal 2 rentang tanggal. Respons akan berisi kumpulan nilai metrik untuk setiap kombinasi dimensi untuk setiap rentang tanggal dalam permintaan. Jadi, jika ada dua rentang tanggal, akan ada dua kumpulan nilai metrik, satu untuk rentang tanggal asli dan satu untuk rentang tanggal kedua. Kolom reportRequest.dateRanges tidak boleh ditentukan untuk kelompok atau permintaan Nilai umur. Jika rentang tanggal tidak ditentukan, rentang tanggal default adalah (startDate: tanggal saat ini - 7 hari, endDate: tanggal saat ini - 1 hari). Setiap ReportRequest dalam metode batchGet harus berisi definisi dateRanges yang sama.

samplingLevel

enum(Sampling)

Ukuran sampel laporan yang diinginkan. Jika kolom samplingLevel tidak ditentukan, tingkat pengambilan sampel DEFAULT akan digunakan. Setiap ReportRequest dalam metode batchGet harus berisi definisi samplingLevel yang sama. Lihat panduan developer untuk mengetahui detailnya.

dimensions[]

object(Dimension)

Dimensi yang diminta. Permintaan dapat memiliki total 9 dimensi.

dimensionFilterClauses[]

object(DimensionFilterClause)

Klausa dimensi dimensi untuk memfilter Nilai Dimensi. Keduanya digabungkan secara logis dengan operator AND. Perhatikan bahwa pemfilteran terjadi sebelum dimensi digabungkan, sehingga metrik yang ditampilkan hanya mewakili total dimensi yang relevan saja.

metrics[]

object(Metric)

Metrik yang diminta. Permintaan harus menentukan setidaknya satu metrik. Permintaan dapat memiliki total 10 metrik.

metricFilterClauses[]

object(MetricFilterClause)

Klausul filter metrik. Keduanya digabungkan secara logis dengan operator AND. Filter metrik hanya melihat rentang tanggal pertama, bukan rentang tanggal yang dibandingkan. Perhatikan bahwa pemfilteran pada metrik terjadi setelah metrik digabungkan.

filtersExpression

string

Filter dimensi atau metrik yang membatasi data yang ditampilkan untuk permintaan Anda. Untuk menggunakan filtersExpression, berikan dimensi atau metrik yang akan digunakan untuk memfilter, diikuti dengan ekspresi filter. Misalnya, ekspresi berikut memilih dimensi ga:browser yang dimulai dengan Firefox; ga:browser=~^Firefox. Untuk informasi selengkapnya tentang filter dimensi dan metrik, lihat Referensi filter.

orderBys[]

object(OrderBy)

Urutkan urutan pada baris output. Untuk membandingkan dua baris, elemen berikut ini diterapkan secara berurutan hingga perbedaan ditemukan. Semua rentang tanggal di output mendapatkan urutan baris yang sama.

segments[]

object(Segment)

Menyegmentasikan data yang ditampilkan untuk permintaan. Definisi segmen membantu melihat subkumpulan permintaan segmen. Permintaan dapat berisi hingga empat segmen. Setiap ReportRequest dalam metode batchGet harus berisi definisi segments yang sama. Permintaan dengan segmen harus memiliki dimensi ga:segment.

pivots[]

object(Pivot)

Definisi pivot. Permintaan dapat memiliki maksimal 2 pivot.

cohortGroup

object(CohortGroup)

Grup kelompok yang terkait dengan permintaan ini. Jika ada grup kelompok dalam permintaan, dimensi ga:cohort harus ada. Setiap ReportRequest dalam metode batchGet harus berisi definisi cohortGroup yang sama.

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 reports.batchGet.

pageSize

number

Ukuran halaman adalah untuk paging dan menentukan jumlah maksimum baris yang ditampilkan. Ukuran halaman harus >= 0. Kueri menampilkan default 1.000 baris. Analytics Core Reporting API menampilkan maksimum 100.000 baris per permintaan, berapa pun jumlah yang Anda minta. Tindakan ini juga dapat menampilkan baris yang lebih sedikit dari yang diminta, jika segmen dimensi tidak sebanyak yang Anda harapkan. Misalnya, nilai untuk ga:country kurang dari 300, jadi jika hanya melakukan segmentasi menurut negara, Anda tidak bisa mendapatkan lebih dari 300 baris, meskipun Anda menetapkan pageSize ke nilai yang lebih tinggi.

includeEmptyRows

boolean

Jika disetel ke salah (false), respons tidak akan menyertakan baris jika semua metrik yang diambil sama dengan nol. Setelan defaultnya adalah false, yang akan mengecualikan baris ini.

hideTotals

boolean

Jika ditetapkan ke benar, menyembunyikan total semua metrik untuk semua baris yang cocok, untuk setiap rentang tanggal. Defaultnya salah dan akan menampilkan totalnya.

hideValueRanges

boolean

Jika ditetapkan ke benar, menyembunyikan nilai minimum dan maksimum di semua baris yang cocok. Defaultnya adalah "salah" dan rentang nilai ditampilkan.

Pengambilan sampel

Nilai untuk tingkat pengambilan sampel.

Enumerasi
SAMPLING_UNSPECIFIED Jika kolom samplingLevel tidak ditentukan, tingkat pengambilan sampel DEFAULT akan digunakan.
DEFAULT Menampilkan respons dengan ukuran sampel yang menyeimbangkan kecepatan dan akurasi.
SMALL Metode ini menampilkan respons cepat dengan ukuran pengambilan sampel yang lebih kecil.
LARGE Menampilkan respons yang lebih akurat menggunakan ukuran sampel yang besar. Namun, hal ini dapat menyebabkan proses yang lebih lambat.

Dimensi

Dimensi adalah atribut data Anda. Misalnya, dimensi ga:city menunjukkan kota, misalnya, "Paris" atau "New York", tempat sesi berasal.

Representasi JSON
{
  "name": string,
  "histogramBuckets": [
    string
  ]
}
Kolom
name

string

Nama dimensi yang akan diambil, misalnya ga:browser.

histogramBuckets[]

string (int64 format)

Jika tidak kosong, kita akan menempatkan nilai dimensi ke dalam bucket setelah string ke int64. Nilai dimensi yang bukan representasi string dari nilai integral akan dikonversi ke nol. Nilai bucket harus dalam urutan naik. Setiap bucket ditutup di ujung bawah, dan terbuka di ujung atas. Bucket "pertama" mencakup semua nilai yang kurang dari batas pertama, bucket "terakhir" mencakup semua nilai hingga tak terhingga. Nilai dimensi yang termasuk dalam bucket akan diubah ke nilai dimensi baru. Misalnya, jika seseorang memberikan daftar "0, 1, 3, 4, 7", maka kita mengembalikan bucket berikut:

  • bucket #1: nilai < 0, nilai dimensi "<0"
  • bucket #2: nilai dalam [0,1), nilai dimensi "0"
  • bucket #3: nilai dalam [1,3), nilai dimensi "1-2"
  • bucket #4: nilai dalam [3,4), nilai dimensi "3"
  • bucket #5: nilai dalam [4,7), nilai dimensi "4-6"
  • bucket #6: nilai >= 7, nilai dimensi "7+"

CATATAN: Jika Anda menerapkan mutasi histogram pada dimensi apa pun, dan menggunakan dimensi tersebut dalam urutan, sebaiknya gunakan jenis pengurutan HISTOGRAM_BUCKET untuk tujuan tersebut. Tanpa atribut tersebut, nilai dimensi akan diurutkan sesuai dengan urutan kamus (leksikografis). Misalnya, urutan kamus menaik adalah:

"<50", "1001+", "121-1000", "50-120"

Dan urutan HISTOGRAM_BUCKET menaik adalah:

"<50", "50-120", "121-1000", "1001+"

Klien harus secara eksplisit meminta "orderType": "HISTOGRAM_BUCKET" untuk dimensi yang bermutasi histogram.

DimensionFilterKlausula

Sekelompok filter dimensi. Menetapkan nilai operator untuk menentukan cara filter digabungkan secara logis.

Representasi JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(DimensionFilter)
    }
  ]
}
Kolom
operator

enum(FilterLogicalOperator)

Operator untuk menggabungkan beberapa filter dimensi. Jika tidak ditentukan, properti ini akan diperlakukan sebagai OR.

filters[]

object(DimensionFilter)

Kumpulan filter yang berulang. Keduanya digabungkan secara logis berdasarkan operator yang ditentukan.

FilterLogicalOperator

Cara filter digabungkan secara logis.

Enumerasi
OPERATOR_UNSPECIFIED Operator belum ditetapkan. ID ini diperlakukan sebagai OR.
OR Operator OR logis.
AND Operator AND logis.

DimensiDimensi

Filter dimensi menentukan opsi pemfilteran pada dimensi.

Representasi JSON
{
  "dimensionName": string,
  "not": boolean,
  "operator": enum(Operator),
  "expressions": [
    string
  ],
  "caseSensitive": boolean
}
Kolom
dimensionName

string

Dimensi yang akan digunakan untuk memfilter. DimensionFilter harus berisi dimensi.

not

boolean

Operator logis NOT. Jika boolean ini ditetapkan ke true, nilai dimensi yang cocok akan dikecualikan dalam laporan. Secara default, nilainya adalah false.

operator

enum(Operator)

Cara mencocokkan dimensi dengan ekspresi. Defaultnya adalah REGEXP.

expressions[]

string

String atau ekspresi reguler yang akan dicocokkan. Hanya nilai pertama dari daftar yang digunakan untuk perbandingan kecuali jika operatornya adalah IN_LIST. Jika operator IN_LIST, seluruh daftar digunakan untuk memfilter dimensi seperti yang dijelaskan dalam deskripsi operator IN_LIST.

caseSensitive

boolean

Apakah kecocokannya harus peka huruf besar/kecil? Defaultnya adalah false (salah).

Operator

Jenis pencocokan yang berbeda didukung.

Enumerasi
OPERATOR_UNSPECIFIED Jika jenis pencocokan tidak ditentukan, nilai tersebut akan diperlakukan sebagai REGEXP.
REGEXP Ekspresi pencocokan diperlakukan sebagai ekspresi reguler. Semua jenis pencocokan tidak diperlakukan sebagai ekspresi reguler.
BEGINS_WITH Mencocokkan nilai yang dimulai dengan ekspresi pencocokan yang diberikan.
ENDS_WITH Mencocokkan nilai yang diakhiri dengan ekspresi pencocokan yang diberikan.
PARTIAL Pencocokan substring.
EXACT Nilai harus sepenuhnya cocok dengan ekspresi pencocokan.
NUMERIC_EQUAL

Filter perbandingan bilangan bulat. Sensitivitas huruf besar dan kecil diabaikan untuk hal ini dan ekspresi diasumsikan sebagai string yang mewakili bilangan bulat. Kondisi kegagalan:

  • Jika ekspresi bukan int64 yang valid, klien akan menemukan error.
  • Dimensi input yang bukan nilai int64 yang valid tidak akan pernah cocok dengan filter.
NUMERIC_GREATER_THAN Memeriksa apakah dimensi secara numerik lebih besar dari ekspresi pencocokan. Baca deskripsi untuk NUMERIC_EQUALS guna mengetahui batasan.
NUMERIC_LESS_THAN Memeriksa apakah dimensi secara numerik lebih kecil dari ekspresi pencocokan. Baca deskripsi untuk NUMERIC_EQUALS guna mengetahui batasan.
IN_LIST

Opsi ini digunakan untuk menentukan filter dimensi yang ekspresinya dapat mengambil nilai apa pun dari daftar nilai yang dipilih. Hal ini membantu menghindari evaluasi beberapa filter dimensi pencocokan persis yang merupakan OR'ed untuk setiap baris respons tunggal. Contoh:

expressions: ["A", "B", "C"]

Setiap baris respons yang dimensinya memiliki nilai sebagai A, B, atau C, cocok dengan DimensionFilter ini.

Metrik

Metrik adalah pengukuran kuantitatif. Misalnya, metrik ga:users menunjukkan jumlah total pengguna untuk jangka waktu yang diminta.

Representasi JSON
{
  "expression": string,
  "alias": string,
  "formattingType": enum(MetricType)
}
Kolom
expression

string

Ekspresi metrik dalam permintaan. Ekspresi dibuat dari satu atau beberapa metrik dan angka. Operator yang diterima mencakup: Plus (+), Minus (-), Negation (Unary -), Dibagi dengan (/), Dikalikan dengan (*), Tanda kurung, Angka kardinal positif (0-9), dapat mencakup desimal dan dibatasi hingga 1024 karakter. Contoh ga:totalRefunds/ga:users, dalam sebagian besar kasus, ekspresi metrik hanyalah satu nama metrik seperti ga:users. Menambahkan MetricType campuran (misalnya, Metrik CURRENCY + PERCENTAGE) akan memberikan hasil yang tidak terduga.

alias

string

Alias untuk ekspresi metrik adalah nama alternatif untuk ekspresi tersebut. Alias dapat digunakan untuk pemfilteran dan pengurutan. Kolom ini bersifat opsional dan berguna jika ekspresi tersebut bukan metrik tunggal, tetapi ekspresi kompleks yang tidak dapat digunakan dalam pemfilteran dan pengurutan. Alias juga digunakan di header kolom respons.

formattingType

enum(MetricType)

Menentukan cara ekspresi metrik harus diformat, misalnya INTEGER.

Jenis Metrik

Jenis metrik.

Enumerasi
METRIC_TYPE_UNSPECIFIED Jenis metrik tidak ditentukan.
INTEGER Metrik bilangan bulat.
FLOAT Metrik float.
CURRENCY Metrik mata uang.
PERCENT Metrik persentase.
TIME Metrik waktu dalam format HH:MM:SS.

MetricFilterClause

Mewakili grup filter metrik. Menetapkan nilai operator untuk menentukan cara filter digabungkan secara logis.

Representasi JSON
{
  "operator": enum(FilterLogicalOperator),
  "filters": [
    {
      object(MetricFilter)
    }
  ]
}
Kolom
operator

enum(FilterLogicalOperator)

Operator untuk menggabungkan beberapa filter metrik. Jika tidak ditentukan, properti ini akan diperlakukan sebagai OR.

filters[]

object(MetricFilter)

Kumpulan filter yang berulang. Keduanya digabungkan secara logis berdasarkan operator yang ditentukan.

MetrikMetrik

MetricFilter menentukan filter pada metrik.

Representasi JSON
{
  "metricName": string,
  "not": boolean,
  "operator": enum(Operator),
  "comparisonValue": string
}
Kolom
metricName

string

Metrik yang akan difilter. MetrikFilter harus berisi nama metrik. Nama metrik dapat berupa alias yang sebelumnya ditetapkan sebagai metrik atau juga dapat berupa ekspresi metrik.

not

boolean

Operator logis NOT. Jika boolean ini ditetapkan ke true, nilai metrik yang cocok akan dikecualikan dalam laporan. Secara default, nilainya adalah false.

operator

enum(Operator)

Apakah metrik EQUAL, LESS_THAN, atau GREATER_THAN adalah perbandinganValue, default-nya adalah EQUAL. Jika operator adalah IS_MISSING, periksa apakah metrik tidak ada dan akan mengabaikanperbandinganValue.

comparisonValue

string

Nilai untuk dibandingkan.

Operator

Opsi jenis perbandingan yang berbeda.

Enumerasi
OPERATOR_UNSPECIFIED Jika tidak ditentukan, operator akan diperlakukan sebagai EQUAL.
EQUAL Jika nilai metrik harus sama persis dengan nilai perbandingan.
LESS_THAN Jika nilai metrik kurang dari nilai perbandingan.
GREATER_THAN Jika nilai metrik harus lebih besar dari nilai perbandingan.
IS_MISSING Memvalidasi jika metrik tidak ada. Tidak mempertimbangkan perbandinganValue.

Urutkan Oleh

Menentukan opsi pengurutan.

Representasi JSON
{
  "fieldName": string,
  "orderType": enum(OrderType),
  "sortOrder": enum(SortOrder)
}
Kolom
fieldName

string

Kolom yang akan diurutkan. Tata urutan default menaik. Contoh: ga:browser. Perhatikan bahwa Anda hanya dapat menentukan satu kolom untuk pengurutan di sini. Misalnya, ga:browser, ga:city tidak valid.

orderType

enum(OrderType)

Jenis pesanan. orderType default-nya adalah VALUE.

sortOrder

enum(SortOrder)

Urutan pengurutan untuk kolom.

JenisPesanan

OrderType mengontrol cara menentukan tata urutan.

Enumerasi
ORDER_TYPE_UNSPECIFIED Jenis pesanan yang tidak ditetapkan akan diperlakukan sebagai pengurutan berdasarkan nilai.
VALUE Tata urutan didasarkan pada nilai kolom yang dipilih; hanya melihat pada rentang tanggal pertama.
DELTA Tata urutan didasarkan pada perbedaan nilai kolom yang dipilih antara dua rentang tanggal pertama. Dapat digunakan hanya jika ada tepat dua rentang tanggal.
SMART Tata urutan didasarkan pada nilai berbobot kolom yang dipilih. Jika kolom memiliki format n/d, nilai berbobot rasio ini akan (n + totals.n)/(d + totals.d) Dapat digunakan hanya untuk metrik yang mewakili rasio.
HISTOGRAM_BUCKET Jenis urutan histogram hanya berlaku untuk kolom dimensi dengan bucket histogram yang tidak kosong.
DIMENSION_AS_INTEGER Jika dimensinya adalah angka dengan panjang tetap, pengurutan biasa akan berfungsi dengan baik. DIMENSION_AS_INTEGER dapat digunakan jika dimensinya adalah angka panjang variabel.

SortOrder

Tata urutan pengurutan.

Enumerasi
SORT_ORDER_UNSPECIFIED Jika tata urutan tidak ditentukan, defaultnya adalah menaik.
ASCENDING Urutan mendaki. Kolom ini akan diurutkan secara menaik.
DESCENDING Urutkan menurun. Kolom ini akan diurutkan secara menurun.

Segmen

Definisi segmen, jika laporan perlu disegmentasikan. Segmen adalah subkumpulan data Analytics. Misalnya, dari seluruh kumpulan pengguna, satu Segmen mungkin adalah pengguna dari negara atau kota tertentu.

Representasi JSON
{

  // Union field dynamicOrById can be only one of the following:
  "dynamicSegment": {
    object(DynamicSegment)
  },
  "segmentId": string
  // End of list of possible types for union field dynamicOrById.
}
Kolom
Kolom union dynamicOrById. Segmen dapat ditentukan secara dinamis menggunakan DynamicSegmen atau dengan menggunakan ID segmen bawaan atau kustom. dynamicOrById hanya dapat berupa salah satu dari berikut:
dynamicSegment

object(DynamicSegment)

Definisi segmen dinamis dalam permintaan.

segmentId

string

ID segmen dari segmen bawaan atau kustom, misalnya gaid::-3.

Segmen Dinamis

Definisi segmen dinamis untuk menentukan segmen dalam permintaan. Segmen dapat memilih pengguna, sesi, atau keduanya.

Representasi JSON
{
  "name": string,
  "userSegment": {
    object(SegmentDefinition)
  },
  "sessionSegment": {
    object(SegmentDefinition)
  }
}
Kolom
name

string

Nama segmen dinamis.

userSegment

object(SegmentDefinition)

Segmen Pengguna untuk memilih pengguna untuk disertakan dalam segmen.

sessionSegment

object(SegmentDefinition)

Segmen Sesi untuk memilih sesi untuk disertakan dalam segmen.

Definisi Segmen

SegmentDefinition menentukan segmen sebagai kumpulan SegmenFilters yang digabungkan dengan operasi AND yang logis.

Representasi JSON
{
  "segmentFilters": [
    {
      object(SegmentFilter)
    }
  ]
}
Kolom
segmentFilters[]

object(SegmentFilter)

Segmen ditentukan oleh kumpulan filter segmen yang digabungkan bersama dengan operasi AND yang logis.

SegmenSegmen

SegmenFilter menentukan segmen sebagai segmen sederhana atau urutan. Kondisi segmen sederhana berisi kondisi dimensi dan metrik untuk memilih sesi atau pengguna. Kondisi segmen urutan dapat digunakan untuk memilih pengguna atau sesi berdasarkan kondisi berurutan.

Representasi JSON
{
  "not": boolean,

  // Union field simpleOrSequence can be only one of the following:
  "simpleSegment": {
    object(SimpleSegment)
  },
  "sequenceSegment": {
    object(SequenceSegment)
  }
  // End of list of possible types for union field simpleOrSequence.
}
Kolom
not

boolean

Jika benar, cocokkan dengan pelengkap segmen sederhana atau urutan. Misalnya, untuk mencocokkan semua kunjungan yang tidak berasal dari "New York", kami dapat menentukan segmen sebagai berikut:

  "sessionSegment": {
    "segmentFilters": [{
      "simpleSegment" :{
        "orFiltersForSegment": [{
          "segmentFilterClauses":[{
            "dimensionFilter": {
              "dimensionName": "ga:city",
              "expressions": ["New York"]
            }
          }]
        }]
      },
      "not": "True"
    }]
  },

Kolom union simpleOrSequence. Apakah definisi segmen sederhana atau segmen urutan. simpleOrSequence hanya dapat berupa salah satu dari berikut:
simpleSegment

object(SimpleSegment)

Kondisi segmen Sederhana terdiri dari satu atau beberapa kondisi dimensi/metrik yang dapat digabungkan

sequenceSegment

object(SequenceSegment)

Kondisi urutan terdiri dari satu atau beberapa langkah, yang setiap langkahnya ditentukan oleh satu atau beberapa kondisi dimensi/metrik. Beberapa langkah dapat digabungkan dengan operator urutan khusus.

SegmenSederhana

Kondisi segmen Sederhana terdiri dari satu atau beberapa kondisi dimensi/metrik yang dapat digabungkan.

Representasi JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ]
}
Kolom
orFiltersForSegment[]

object(OrFiltersForSegment)

Daftar grup filter segmen yang digabungkan dengan operator AND yang logis.

AtauFilterUntukSegmen

Daftar filter segmen dalam grup OR digabungkan dengan operator OR yang logis.

Representasi JSON
{
  "segmentFilterClauses": [
    {
      object(SegmentFilterClause)
    }
  ]
}
Kolom
segmentFilterClauses[]

object(SegmentFilterClause)

Daftar filter segmen yang akan digabungkan dengan operator OR.

SegmenFilterKlausul

Klausul Filter untuk digunakan di definisi segmen, dapat tanpa filter metrik atau dimensi.

Representasi JSON
{
  "not": boolean,

  // Union field dimensionOrMetricFilter can be only one of the following:
  "dimensionFilter": {
    object(SegmentDimensionFilter)
  },
  "metricFilter": {
    object(SegmentMetricFilter)
  }
  // End of list of possible types for union field dimensionOrMetricFilter.
}
Kolom
not

boolean

Cocok dengan pelengkap (!) filter.

Kolom union dimensionOrMetricFilter. Dimensi atau filter metrik. dimensionOrMetricFilter hanya dapat berupa salah satu dari berikut:
dimensionFilter

object(SegmentDimensionFilter)

Filter Dimensi untuk definisi segmen.

metricFilter

object(SegmentMetricFilter)

Filter Metrik untuk definisi segmen.

SegmenDimensionFilter

Filter dimensi menentukan opsi pemfilteran pada dimensi.

Representasi JSON
{
  "dimensionName": string,
  "operator": enum(Operator),
  "caseSensitive": boolean,
  "expressions": [
    string
  ],
  "minComparisonValue": string,
  "maxComparisonValue": string
}
Kolom
dimensionName

string

Nama dimensi tempat filter diterapkan.

operator

enum(Operator)

Operator yang akan digunakan untuk mencocokkan dimensi dengan ekspresi.

caseSensitive

boolean

Jika kecocokan peka huruf besar/kecil, abaikan operator IN_LIST.

expressions[]

string

Daftar ekspresi, hanya elemen pertama yang digunakan untuk semua operator

minComparisonValue

string

Nilai perbandingan minimum untuk BETWEEN jenis pencocokan.

maxComparisonValue

string

Nilai perbandingan maksimum untuk BETWEEN jenis pencocokan.

Operator

Jenis pencocokan yang berbeda didukung.

Enumerasi
OPERATOR_UNSPECIFIED Jika jenis pencocokan tidak ditentukan, nilai tersebut akan diperlakukan sebagai REGEXP.
REGEXP Ekspresi pencocokan diperlakukan sebagai ekspresi reguler. Semua jenis pencocokan lainnya tidak diperlakukan sebagai ekspresi reguler.
BEGINS_WITH Mencocokkan nilai yang dimulai dengan ekspresi pencocokan yang disediakan.
ENDS_WITH Mencocokkan nilai yang diakhiri dengan ekspresi pencocokan yang diberikan.
PARTIAL Pencocokan substring.
EXACT Nilai harus sepenuhnya cocok dengan ekspresi pencocokan.
IN_LIST

Opsi ini digunakan untuk menentukan filter dimensi yang ekspresinya dapat mengambil nilai apa pun dari daftar nilai yang dipilih. Hal ini membantu menghindari evaluasi beberapa filter dimensi pencocokan persis yang merupakan OR'ed untuk setiap baris respons tunggal. Contoh:

expressions: ["A", "B", "C"]

Setiap baris respons yang dimensinya memiliki nilai sebagai A, B, atau C, cocok dengan DimensionFilter ini.

NUMERIC_LESS_THAN

Filter perbandingan bilangan bulat. Sensitivitas huruf besar dan kecil diabaikan untuk hal ini dan ekspresi diasumsikan sebagai string yang mewakili bilangan bulat. Kondisi kegagalan:

  • jika ekspresi bukan int64 yang valid, klien akan menemukan error.
  • dimensi input yang bukan nilai int64 yang valid tidak akan pernah cocok dengan filter.

Memeriksa apakah dimensi secara numerik lebih kecil dari ekspresi pencocokan.

NUMERIC_GREATER_THAN Memeriksa apakah dimensi secara numerik lebih besar dari ekspresi pencocokan.
NUMERIC_BETWEEN Periksa apakah dimensi numerik secara numerik antara minimum dan maksimum ekspresi pencocokan, batas dikecualikan.

SegmenMetricFilter

Filter metrik yang akan digunakan di klausa filter segmen.

Representasi JSON
{
  "scope": enum(Scope),
  "metricName": string,
  "operator": enum(Operator),
  "comparisonValue": string,
  "maxComparisonValue": string
}
Kolom
scope

enum(Scope)

Cakupan untuk metrik menentukan tingkat tempat metrik tersebut ditentukan. Cakupan metrik yang ditentukan harus sama dengan atau lebih besar dari cakupan utamanya seperti yang ditetapkan dalam model data. Cakupan utama ditentukan jika segmen memilih pengguna atau sesi.

metricName

string

Metrik yang akan difilter. metricFilter harus berisi nama metrik.

operator

enum(Operator)

Menentukan adalah operasi yang dilakukan untuk membandingkan metrik. Defaultnya adalah EQUAL.

comparisonValue

string

Nilai untuk dibandingkan. Jika operator adalah BETWEEN, nilai ini diperlakukan sebagai nilai perbandingan minimum.

maxComparisonValue

string

Nilai perbandingan maksimal hanya digunakan untuk operator BETWEEN.

Cakupan

Cakupan untuk metrik menentukan tingkat saat metrik ditentukan - PRODUCT, HIT, SESSION, atau USER. Nilai metrik juga dapat dilaporkan pada cakupan yang lebih besar dari cakupan utamanya. Misalnya, ga:pageviews dan ga:transactions dapat dilaporkan di tingkat SESSION dan USER cukup dengan menambahkannya untuk setiap hit yang terjadi dalam sesi tersebut atau untuk pengguna tersebut.

Enumerasi
UNSPECIFIED_SCOPE Jika cakupannya tidak ditentukan, cakupan kondisi ditetapkan secara default ke USER atau SESSION, bergantung pada apakah segmen mencoba memilih pengguna atau sesi.
PRODUCT Cakupan produk.
HIT Cakupan hit.
SESSION Cakupan sesi.
USER Cakupan pengguna.

Operator

Opsi jenis perbandingan yang berbeda.

Enumerasi
UNSPECIFIED_OPERATOR Operator yang tidak ditetapkan akan diperlakukan sebagai operator LESS_THAN.
LESS_THAN Memeriksa apakah nilai metrik kurang dari nilai perbandingan.
GREATER_THAN Memeriksa apakah nilai metrik lebih besar dari nilai perbandingan.
EQUAL Operator sama dengan.
BETWEEN Untuk kedua operator, nilai minimum dan maksimum bersifat eksklusif. Kita akan menggunakan LT dan GT untuk perbandingan.

SequenceSegmen

Kondisi urutan terdiri dari satu atau beberapa langkah, yang setiap langkahnya ditentukan oleh satu atau beberapa kondisi dimensi/metrik. Beberapa langkah dapat digabungkan dengan operator urutan khusus.

Representasi JSON
{
  "segmentSequenceSteps": [
    {
      object(SegmentSequenceStep)
    }
  ],
  "firstStepShouldMatchFirstHit": boolean
}
Kolom
segmentSequenceSteps[]

object(SegmentSequenceStep)

Daftar langkah dalam urutan.

firstStepShouldMatchFirstHit

boolean

Jika ditetapkan, kondisi langkah pertama harus cocok dengan hit pertama pengunjung (dalam rentang tanggal).

SegmenSequenceStep

Definisi urutan segmen.

Representasi JSON
{
  "orFiltersForSegment": [
    {
      object(OrFiltersForSegment)
    }
  ],
  "matchType": enum(MatchType)
}
Kolom
orFiltersForSegment[]

object(OrFiltersForSegment)

Urutan ditentukan dengan daftar filter Atau yang dikelompokkan yang digabungkan dengan operator AND.

matchType

enum(MatchType)

Menentukan apakah langkah akan segera mendahului atau dapat kapan saja sebelum langkah berikutnya.

Jenis Kecocokan

Jenis pencocokan untuk urutan.

Enumerasi
UNSPECIFIED_MATCH_TYPE Jenis pencocokan yang tidak ditetapkan diperlakukan sebagai awalan.
PRECEDES Operator menunjukkan bahwa langkah sebelumnya mendahului langkah berikutnya.
IMMEDIATELY_PRECEDES Operator menunjukkan bahwa langkah sebelumnya langsung mendahului langkah berikutnya.

Pivot

Pivot menjelaskan bagian pivot dalam permintaan. Pivot membantu mengatur ulang informasi dalam tabel untuk laporan tertentu dengan membuat pivot data dalam dimensi kedua.

Representasi JSON
{
  "dimensions": [
    {
      object(Dimension)
    }
  ],
  "dimensionFilterClauses": [
    {
      object(DimensionFilterClause)
    }
  ],
  "metrics": [
    {
      object(Metric)
    }
  ],
  "startGroup": number,
  "maxGroupCount": number
}
Kolom
dimensions[]

object(Dimension)

Daftar dimensi untuk ditampilkan sebagai kolom pivot. Pivot dapat memiliki maksimal 4 dimensi. Dimensi pivot adalah bagian dari pembatasan jumlah total dimensi yang diizinkan dalam permintaan.

dimensionFilterClauses[]

object(DimensionFilterClause)

DimensionFilterKlausuls digabungkan secara logis dengan operator AND: hanya data yang disertakan oleh semua DimensionFilterKlausuls ini yang berkontribusi pada nilai-nilai dalam region pivot ini. Filter dimensi dapat digunakan untuk membatasi kolom yang ditampilkan di area pivot. Misalnya, jika Anda memiliki ga:browser sebagai dimensi yang diminta di area pivot, dan Anda menentukan filter kunci untuk membatasi ga:browser hanya "IE" atau "Firefox", hanya dua browser tersebut yang akan muncul sebagai kolom.

metrics[]

object(Metric)

Metrik pivot. Metrik pivot adalah bagian dari pembatasan jumlah total metrik yang diizinkan dalam permintaan.

startGroup

number

Jika metrik k diminta, respons akan berisi beberapa kolom k yang bergantung pada data dalam laporan. Misalnya, jika Anda melakukan pivot pada dimensi ga:browser, Anda akan mendapatkan k kolom untuk "Firefox", k kolom untuk "IE", k kolom untuk "Chrome", dsb. Urutan grup kolom ditentukan oleh urutan menurun dari "total" untuk nilai k pertama. Dasi rusak dengan pengurutan leksikografis dimensi pivot pertama, lalu pengurutan leksikografis dimensi pivot kedua, dan seterusnya. Misalnya, jika total untuk nilai pertama untuk Firefox, IE, dan Chrome masing-masing adalah 8, 2, 8, urutan kolomnya adalah Chrome, Firefox, IE.

Berikut adalah cara memilih grup kolom k yang disertakan dalam respons.

maxGroupCount

number

Menentukan jumlah grup maksimum yang akan ditampilkan. Nilai defaultnya adalah 10, juga nilai maksimumnya adalah 1.000.

Kelompok Kelompok

Menentukan grup kelompok. Contoh:

"cohortGroup": {
  "cohorts": [{
    "name": "cohort 1",
    "type": "FIRST_VISIT_DATE",
    "dateRange": { "startDate": "2015-08-01", "endDate": "2015-08-01" }
  },{
    "name": "cohort 2"
     "type": "FIRST_VISIT_DATE"
     "dateRange": { "startDate": "2015-07-01", "endDate": "2015-07-01" }
  }]
}
Representasi JSON
{
  "cohorts": [
    {
      object(Cohort)
    }
  ],
  "lifetimeValue": boolean
}
Kolom
cohorts[]

object(Cohort)

Definisi kelompok.

lifetimeValue

boolean

Aktifkan Nilai Waktu Kehidupan (LTV). LTV mengukur nilai umur untuk pengguna yang diperoleh melalui berbagai saluran. Lihat: Analisis Kelompok dan Nilai Umur Jika nilaiLifetimeValue salah:

  • Nilai metrik serupa dengan nilai di laporan kelompok antarmuka web.
  • Rentang tanggal definisi kelompok harus selaras dengan minggu dan bulan kalender, yaitu saat meminta ga:cohortNthWeek, startDate dalam definisi kelompok harus berupa hari Minggu dan endDate harus berupa hari Sabtu berikutnya, dan untuk ga:cohortNthMonth, startDate harus merupakan tanggal 1 dalam sebulan dan endDate harus merupakan hari terakhir dari bulan tersebut.

Jika LifeValue bernilai true:

  • Nilai metrik akan sesuai dengan nilai di laporan nilai antarmuka LifeTime.
  • Laporan Nilai Umur menampilkan bagaimana pertumbuhan nilai pengguna (Pendapatan) dan engagement (Tampilan Aplikasi, Sasaran Tercapai, Sesi, dan Durasi Sesi) selama 90 hari setelah pengguna diperoleh.
  • Metrik dihitung sebagai rata-rata kumulatif per pengguna per penambahan waktu.
  • Rentang tanggal definisi kelompok tidak perlu diselaraskan dengan batas minggu dan bulan kalender.
  • viewId harus berupa ID tampilan aplikasi

Kelompok

Menentukan kelompok. Kelompok adalah sekumpulan pengguna berkarakteristik sama. Misalnya, semua pengguna dengan tanggal akuisisi yang sama disertakan ke dalam kelompok yang sama.

Representasi JSON
{
  "name": string,
  "type": enum(Type),
  "dateRange": {
    object(DateRange)
  }
}
Kolom
name

string

Nama unik untuk kelompok. Jika nama yang tidak ditentukan akan dibuat secara otomatis dengan nilai kohor_[1234...].

type

enum(Type)

Jenis kelompok. Satu-satunya jenis yang didukung saat ini adalah FIRST_VISIT_DATE. Jika kolom ini tidak ditentukan, kelompok akan diperlakukan sebagai kelompok jenis FIRST_VISIT_DATE.

dateRange

object(DateRange)

Ini digunakan untuk kelompok FIRST_VISIT_DATE, kelompok ini memilih pengguna yang tanggal kunjungan pertamanya antara tanggal mulai dan tanggal akhir yang ditentukan di DateRange. Rentang tanggal harus diselaraskan untuk permintaan kelompok. Jika permintaan berisi ga:cohortNthDay, panjangnya harus tepat satu hari, jika ga:cohortNthWeek harus sesuai dengan batas minggu (mulai hari Minggu dan berakhir Sabtu), dan untuk ga:cohortNthMonth rentang tanggal harus sejajar dengan bulan (dimulai dari hari pertama dan berakhir pada hari terakhir setiap bulan). Untuk permintaan LTV, tidak ada batasan tersebut. Anda tidak perlu memberikan rentang tanggal untuk kolom reportsRequest.dateRanges.

Jenis

Jenis kelompok.

Enumerasi
UNSPECIFIED_COHORT_TYPE Jika tidak ditentukan, maka akan diperlakukan sebagai FIRST_VISIT_DATE.
FIRST_VISIT_DATE Kelompok yang dipilih berdasarkan tanggal kunjungan pertama.

Laporkan

Respons data yang sesuai dengan permintaan.

Representasi JSON
{
  "columnHeader": {
    object(ColumnHeader)
  },
  "data": {
    object(ReportData)
  },
  "nextPageToken": string
}
Kolom
columnHeader

object(ColumnHeader)

Header kolom.

data

object(ReportData)

Data respons.

nextPageToken

string

Token halaman untuk mengambil halaman hasil berikutnya dalam daftar.

Header Kolom

Header kolom.

Representasi JSON
{
  "dimensions": [
    string
  ],
  "metricHeader": {
    object(MetricHeader)
  }
}
Kolom
dimensions[]

string

Nama dimensi dalam respons.

metricHeader

object(MetricHeader)

Header metrik untuk metrik dalam respons.

Header Metrik

Header untuk metrik.

Representasi JSON
{
  "metricHeaderEntries": [
    {
      object(MetricHeaderEntry)
    }
  ],
  "pivotHeaders": [
    {
      object(PivotHeader)
    }
  ]
}
Kolom
metricHeaderEntries[]

object(MetricHeaderEntry)

Header untuk metrik dalam respons.

pivotHeaders[]

object(PivotHeader)

Header untuk pivot dalam respons.

MetricHeaderEntry

Header untuk metrik.

Representasi JSON
{
  "name": string,
  "type": enum(MetricType)
}
Kolom
name

string

Nama header.

type

enum(MetricType)

Jenis metrik, misalnya INTEGER.

PivotHeader

Header untuk setiap bagian pivot yang ditentukan dalam permintaan.

Representasi JSON
{
  "pivotHeaderEntries": [
    {
      object(PivotHeaderEntry)
    }
  ],
  "totalPivotGroupsCount": number
}
Kolom
pivotHeaderEntries[]

object(PivotHeaderEntry)

Header bagian pivot tunggal.

totalPivotGroupsCount

number

Jumlah total grup untuk pivot ini.

PivotHeaderEntry

Header untuk setiap kolom metrik yang sesuai dengan metrik yang diminta di bagian pivot respons.

Representasi JSON
{
  "dimensionNames": [
    string
  ],
  "dimensionValues": [
    string
  ],
  "metric": {
    object(MetricHeaderEntry)
  }
}
Kolom
dimensionNames[]

string

Nama dimensi dalam respons pivot.

dimensionValues[]

string

Nilai untuk dimensi dalam pivot.

metric

object(MetricHeaderEntry)

Header metrik untuk metrik dalam pivot.

DataLaporan

Bagian data dari laporan.

Representasi JSON
{
  "rows": [
    {
      object(ReportRow)
    }
  ],
  "totals": [
    {
      object(DateRangeValues)
    }
  ],
  "rowCount": number,
  "minimums": [
    {
      object(DateRangeValues)
    }
  ],
  "maximums": [
    {
      object(DateRangeValues)
    }
  ],
  "samplesReadCounts": [
    string
  ],
  "samplingSpaceSizes": [
    string
  ],
  "isDataGolden": boolean,
  "dataLastRefreshed": string
}
Kolom
rows[]

object(ReportRow)

Terdapat satu ReportRow untuk setiap kombinasi dimensi yang unik.

totals[]

object(DateRangeValues)

Untuk setiap rentang tanggal yang diminta, untuk kumpulan semua baris yang cocok dengan kueri, setiap format nilai yang diminta akan mendapatkan total. Total untuk format nilai dihitung dengan terlebih dahulu menjumlahkan metrik yang disebutkan dalam format nilai, lalu mengevaluasi format nilai sebagai ekspresi skalar. Misalnya, "totals" untuk 3 / (ga:sessions + 2) kita akan menghitung 3 / ((sum of all relevant ga:sessions) + 2). Total dihitung sebelum penomoran halaman.

rowCount

number

Jumlah total baris yang cocok untuk kueri ini.

minimums[]

object(DateRangeValues)

Nilai minimum dan maksimum yang terlihat di semua baris yang cocok. Keduanya kosong saat hideValueRanges dalam permintaan salah, atau saat rowCount nol.

maximums[]

object(DateRangeValues)

Nilai minimum dan maksimum yang terlihat di semua baris yang cocok. Keduanya kosong saat hideValueRanges dalam permintaan salah, atau saat rowCount nol.

samplesReadCounts[]

string (int64 format)

Jika hasilnya diambil sampelnya, ini akan menampilkan jumlah total sampel yang dibaca, satu entri per rentang tanggal. Jika hasilnya tidak diambil sampelnya, kolom ini tidak akan ditentukan. Lihat panduan developer untuk mengetahui detailnya.

samplingSpaceSizes[]

string (int64 format)

Jika hasilnya diambil sampelnya, ini akan menampilkan jumlah total sampel yang ada, satu entri per rentang tanggal. Jika hasilnya tidak diambil sampelnya, kolom ini tidak akan ditentukan. Lihat panduan developer untuk mengetahui detailnya.

isDataGolden

boolean

Menunjukkan apakah respons permintaan ini berwarna emas atau tidak. Data dianggap berwarna emas jika permintaan yang sama persis tidak memberikan hasil baru jika diminta pada waktu mendatang.

dataLastRefreshed

string (Timestamp format)

Terakhir kali data di laporan dimuat ulang. Semua hit yang diterima sebelum stempel waktu ini disertakan dalam penghitungan laporan.

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

BarisLaporan

Baris dalam laporan.

Representasi JSON
{
  "dimensions": [
    string
  ],
  "metrics": [
    {
      object(DateRangeValues)
    }
  ]
}
Kolom
dimensions[]

string

Daftar dimensi yang diminta.

metrics[]

object(DateRangeValues)

Daftar metrik untuk setiap DateRange yang diminta.

DateRangeValues

Digunakan untuk menampilkan daftar metrik untuk kombinasi Rentang Tanggal / dimensi tunggal

Representasi JSON
{
  "values": [
    string
  ],
  "pivotValueRegions": [
    {
      object(PivotValueRegion)
    }
  ]
}
Kolom
values[]

string

Setiap nilai sesuai dengan setiap Metrik dalam permintaan.

pivotValueRegions[]

object(PivotValueRegion)

Nilai setiap region pivot.

PivotValueRegion

Nilai metrik di region pivot.

Representasi JSON
{
  "values": [
    string
  ]
}
Kolom
values[]

string

Nilai metrik di setiap wilayah pivot.

ResourceQuotasSisa

Token kuota resource yang tersisa untuk properti setelah permintaan selesai.

Representasi JSON
{
  "dailyQuotaTokensRemaining": number,
  "hourlyQuotaTokensRemaining": number
}
Kolom
dailyQuotaTokensRemaining

number

Sisa kuota resource harian.

hourlyQuotaTokensRemaining

number

Token kuota resource per jam tersisa.

Cobalah!