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 terpisah. Maksimal 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) akan diatur oleh biaya komputasi permintaan. Perhatikan bahwa penggunaan kuota berbasis biaya akan mengaktifkan frekuensi sampling yang lebih tinggi. (10 Juta untuk SMALL, 100 jt 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 dipotong untuk mengeksekusi 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

ReportRequest

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 tempat mengambil data. Setiap ReportRequest dalam metode batchGet harus berisi viewId yang sama.

dateRanges[]

object(DateRange)

Rentang tanggal dalam permintaan. Permintaan dapat memiliki maksimum 2 rentang tanggal. Respons akan berisi kumpulan nilai metrik untuk setiap kombinasi dimensi bagi setiap rentang tanggal dalam permintaan. Jadi, jika ada dua rentang tanggal, akan ada dua kumpulan nilai metrik, satu untuk rentang tanggal asli dan satu lagi untuk rentang tanggal kedua. Kolom reportRequest.dateRanges tidak boleh ditentukan untuk permintaan nilai umur atau kelompok. Jika rentang tanggal tidak diberikan, rentang tanggal default adalah (startDate: 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, level sampling 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 filter dimensi untuk memfilter Nilai Dimensi. Keduanya secara logis dikombinasikan dengan operator AND. Perhatikan bahwa pemfilteran terjadi sebelum dimensi digabungkan, sehingga metrik yang ditampilkan hanya mewakili total untuk dimensi yang relevan.

metrics[]

object(Metric)

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

metricFilterClauses[]

object(MetricFilterClause)

Klausa filter metrik. Keduanya secara logis dikombinasikan dengan operator AND. Filter metrik hanya melihat rentang tanggal pertama, bukan rentang tanggal perbandingan. Perhatikan bahwa pemfilteran 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 diawali dengan Firefox; ga:browser=~^Firefox. Untuk mengetahui informasi selengkapnya tentang filter dimensi dan metrik, lihat Referensi filter.

orderBys[]

object(OrderBy)

Mengurutkan urutan pada baris output. Untuk membandingkan dua baris, elemen berikut diterapkan secara berurutan hingga ditemukan perbedaan. Semua rentang tanggal dalam 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 dikaitkan 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 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 reports.batchGet.

pageSize

number

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

includeEmptyRows

boolean

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

hideTotals

boolean

Jika ditetapkan ke true, akan menyembunyikan total semua metrik untuk semua baris yang cocok, untuk setiap rentang tanggal. Nilai defaultnya salah dan akan menampilkan jumlah total.

hideValueRanges

boolean

Jika ditetapkan ke true, akan menyembunyikan nilai minimum dan maksimum di semua baris yang cocok. Nilai defaultnya adalah false dan rentang nilai ditampilkan.

Pengambilan Sampel

Nilai untuk tingkat pengambilan sampel.

Enum
SAMPLING_UNSPECIFIED Jika kolom samplingLevel tidak ditentukan, level sampling DEFAULT akan digunakan.
DEFAULT Menampilkan respons dengan ukuran sampel yang menyeimbangkan kecepatan dan akurasi.
SMALL Fungsi ini menampilkan respons yang cepat dengan ukuran sampel yang lebih kecil.
LARGE Menampilkan respons yang lebih akurat menggunakan ukuran sampel yang besar. Namun, hal ini dapat menyebabkan respons menjadi 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 menempatkan nilai dimensi ke dalam bucket setelah string ke int64. Nilai dimensi yang bukan merupakan representasi string dari nilai integral akan dikonversi menjadi nol. Nilai bucket harus dalam urutan yang meningkat. 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 jatuh dalam bucket akan diubah ke nilai dimensi baru. Misalnya, jika kita memberikan daftar "0, 1, 3, 4, 7", maka kita akan menampilkan 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 secara berurutan, sebaiknya gunakan jenis pengurutan HISTOGRAM_BUCKET untuk tujuan tersebut. Tanpanya, 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.

DimensionFilterClause

Grup filter dimensi. Tetapkan nilai operator untuk menentukan bagaimana filter dikombinasikan secara logis.

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

enum(FilterLogicalOperator)

Operator untuk menggabungkan beberapa filter dimensi. Jika tidak ditentukan, atribut tersebut akan diperlakukan sebagai OR.

filters[]

object(DimensionFilter)

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

FilterLogicalOperator

Cara filter digabungkan secara logis.

Enum
OPERATOR_UNSPECIFIED Operator tidak ditentukan. Ini diperlakukan sebagai OR.
OR Operator OR logis.
AND Operator AND logis.

DimensionFilter

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 difilter. DimensionFilter harus berisi dimensi.

not

boolean

Operator NOT logis. Jika boolean ini ditetapkan ke benar (true), nilai dimensi yang cocok akan dikecualikan dalam laporan. Default-nya adalah salah.

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 operatornya adalah IN_LIST. Jika operator IN_LIST, seluruh daftar akan digunakan untuk memfilter dimensi seperti yang dijelaskan dalam deskripsi operator IN_LIST.

caseSensitive

boolean

Apakah pencocokan harus peka huruf besar/kecil? Defaultnya adalah false.

Operator

Jenis pencocokan berbeda didukung.

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

Filter perbandingan bilangan bulat. Kepekaan huruf besar/kecil diabaikan untuk filter ini dan ekspresi dianggap sebagai string yang mewakili bilangan bulat. Kondisi kegagalan:

  • Jika ekspresi bukan int64 yang valid, klien akan mengalami 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 untuk batasan.
NUMERIC_LESS_THAN Memeriksa apakah dimensi secara numerik lebih kecil dari ekspresi pencocokan. Baca deskripsi untuk NUMERIC_EQUALS untuk batasan.
IN_LIST

Opsi ini digunakan untuk menentukan filter dimensi yang ekspresinya dapat mengambil nilai apa pun dari daftar nilai yang dipilih. Hal ini akan membantu menghindari evaluasi beberapa filter dimensi pencocokan persis yang diberi nilai ATAU untuk setiap baris respons. Contoh:

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

Semua baris respons yang dimensinya memilikinya adalah nilai sebagai A, B, atau C, cocok dengan DimensionFilter ini.

Metrik

Metrik adalah pengukuran kuantitatif. Misalnya, metrik ga:users menunjukkan jumlah total pengguna selama 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 (-), Negasi (Unary -), Dibagi dengan (/), Dikalikan dengan (*), Kurung, bilangan kardinal positif (0-9), dapat mencakup desimal dan dibatasi hingga 1024 karakter. Contoh ga:totalRefunds/ga:users, dalam sebagian besar kasus, ekspresi metrik hanya berupa nama metrik tunggal seperti ga:users. Menambahkan MetricType campuran (Mis., metrik CURRENCY + PERCENTAGE) akan memberikan hasil yang tidak diharapkan.

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 bukan merupakan metrik tunggal, tetapi merupakan ekspresi kompleks yang tidak dapat digunakan dalam pemfilteran dan pengurutan. Alias juga digunakan di header kolom respons.

formattingType

enum(MetricType)

Menentukan cara ekspresi metrik seharusnya diformat, misalnya INTEGER.

MetricType

Jenis-jenis metrik.

Enum
METRIC_TYPE_UNSPECIFIED Jenis metrik belum ditetapkan.
INTEGER Metrik bilangan bulat.
FLOAT Metrik mengambang.
CURRENCY Metrik mata uang.
PERCENT Metrik persentase.
TIME Metrik waktu dalam format HH:MM:SS.

MetricFilterClause

Mewakili grup filter metrik. Tetapkan nilai operator untuk menentukan bagaimana filter dikombinasikan secara logis.

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

enum(FilterLogicalOperator)

Operator untuk menggabungkan beberapa filter metrik. Jika tidak ditentukan, atribut tersebut akan diperlakukan sebagai OR.

filters[]

object(MetricFilter)

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

MetricFilter

MetricFilter menentukan filter pada metrik.

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

string

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

not

boolean

Operator NOT logis. Jika boolean ini ditetapkan ke benar (true), nilai metrik yang cocok akan dikecualikan dalam laporan. Default-nya adalah salah.

operator

enum(Operator)

Apakah metrik EQUAL, LESS_THAN, atau GREATER_THAN adalahComparisonValue, default-nya adalah EQUAL. Jika operatornya adalah IS_MISSING, memeriksa apakah metrik tidak ada dan akan mengabaikan benchmarkValue.

comparisonValue

string

Nilai untuk dibandingkan.

Operator

Berbagai opsi jenis perbandingan.

Enum
OPERATOR_UNSPECIFIED Jika operator tidak ditentukan, operator akan diperlakukan sebagai EQUAL.
EQUAL Apakah nilai metrik harus sama persis dengan nilai perbandingan.
LESS_THAN Jika nilai metrik lebih kecil dari nilai perbandingan.
GREATER_THAN Jika nilai metrik lebih besar dari nilai perbandingan.
IS_MISSING Memvalidasi apakah metrik tidak ada. Tidak mempertimbangkan pembandingValue.

OrderBy

Menentukan opsi pengurutan.

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

string

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

orderType

enum(OrderType)

Jenis pesanan. OrderType default adalah VALUE.

sortOrder

enum(SortOrder)

Urutan penyortiran untuk {i>field<i}.

OrderType

OrderType mengontrol cara tata urutan ditentukan.

Enum
ORDER_TYPE_UNSPECIFIED Jenis urutan yang tidak ditentukan akan diperlakukan sebagai pengurutan berdasarkan nilai.
VALUE Tata urutan didasarkan pada nilai kolom yang dipilih; hanya melihat rentang tanggal pertama.
DELTA Urutan penyortiran didasarkan pada perbedaan nilai kolom yang dipilih di antara dua rentang tanggal pertama. Hanya dapat digunakan jika ada tepat dua rentang tanggal.
SMART Tata urutan didasarkan pada nilai tertimbang dari kolom yang dipilih. Jika kolom memiliki format n/d, nilai tertimbang 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 berupa angka dengan panjang yang tetap, pengurutan biasa akan berfungsi dengan baik. DIMENSION_AS_INTEGER dapat digunakan jika dimensinya adalah angka dengan panjang variabel.

SortOrder

Urutan penyortiran dari penyortiran.

Enum
SORT_ORDER_UNSPECIFIED Jika tata urutan tidak ditentukan, defaultnya adalah menaik.
ASCENDING Urutkan naik. Kolom akan diurutkan secara menaik.
DESCENDING Urutkan dari atas ke bawah. Kolom akan diurutkan dengan cara 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 DynamicSegment atau dengan menggunakan ID segmen bawaan atau kustom. dynamicOrById hanya ada berupa salah satu diantara berikut:
dynamicSegment

object(DynamicSegment)

Definisi segmen dinamis dalam permintaan.

segmentId

string

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

DynamicSegment

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 yang akan disertakan dalam segmen.

sessionSegment

object(SegmentDefinition)

Segmen Sesi untuk memilih sesi yang akan disertakan dalam segmen.

SegmentDefinition

SegmentDefinition menentukan segmen untuk menjadi kumpulan SegmentFilters yang digabungkan bersama dengan operasi AND yang logis.

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

object(SegmentFilter)

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

SegmentFilter

SegmentFilter menentukan segmen menjadi 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 true (benar), cocokkan dengan pelengkap segmen sederhana atau urutan. Misalnya, untuk mencocokkan semua kunjungan yang bukan dari "New York", kami dapat menetapkan segmen sebagai berikut:

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

Kolom union simpleOrSequence. Apakah itu segmen sederhana atau definisi segmen urutan. simpleOrSequence hanya ada berupa salah satu diantara 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 langkah ditentukan oleh satu atau beberapa kondisi dimensi/metrik. Beberapa langkah dapat digabungkan dengan operator urutan khusus.

SimpleSegment

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 logis.

OrFiltersForSegment

Daftar filter segmen dalam grup OR digabungkan dengan operator logika OR.

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

object(SegmentFilterClause)

Daftar filter segmen yang akan digabungkan dengan operator OR.

SegmentFilterClause

Klausul Filter yang akan digunakan dalam definisi segmen, dapat tanpa metrik atau filter 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. Filter dimensi atau metrik. dimensionOrMetricFilter hanya ada berupa salah satu diantara berikut:
dimensionFilter

object(SegmentDimensionFilter)

Filter Dimensi untuk definisi segmen.

metricFilter

object(SegmentMetricFilter)

Filter Metrik untuk definisi segmen.

SegmentDimensionFilter

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 sedang diterapkan.

operator

enum(Operator)

Operator yang akan digunakan untuk mencocokkan dimensi dengan ekspresi.

caseSensitive

boolean

Jika pencocokan peka huruf besar/kecil, diabaikan untuk 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 jenis pencocokan BETWEEN.

Operator

Jenis pencocokan berbeda didukung.

Enum
OPERATOR_UNSPECIFIED Jika jenis pencocokan tidak ditentukan, jenis pencocokan ini diperlakukan sebagai REGExp.
REGEXP Ekspresi pencocokan diperlakukan sebagai ekspresi reguler. Semua jenis pencocokan lainnya tidak diperlakukan sebagai ekspresi reguler.
BEGINS_WITH Cocok dengan nilai yang dimulai dengan ekspresi pencocokan yang diberikan.
ENDS_WITH Cocok dengan nilai yang diakhiri dengan ekspresi pencocokan yang diberikan.
PARTIAL Kecocokan 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 akan membantu menghindari evaluasi beberapa filter dimensi pencocokan persis yang diberi nilai ATAU untuk setiap baris respons. Contoh:

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

Semua baris respons yang dimensinya memilikinya adalah nilai sebagai A, B, atau C, cocok dengan DimensionFilter ini.
NUMERIC_LESS_THAN

Filter perbandingan bilangan bulat. Kepekaan huruf besar/kecil diabaikan untuk filter ini dan ekspresi dianggap sebagai string yang mewakili bilangan bulat. Kondisi kegagalan:

  • jika ekspresi bukan int64 yang valid, klien akan mengalami 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 Memeriksa apakah dimensi secara numerik berada di antara minimum dan maksimum ekspresi pencocokan, batas dikecualikan.

SegmentMetricFilter

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 ditentukan dalam model data. Cakupan utama ditentukan berdasarkan apakah segmen memilih pengguna atau sesi.

metricName

string

Metrik yang akan difilter. metricFilter harus berisi nama metrik.

operator

enum(Operator)

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

comparisonValue

string

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

maxComparisonValue

string

Nilai perbandingan maks hanya digunakan untuk operator BETWEEN.

Cakupan

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

Enum
UNSPECIFIED_SCOPE Jika cakupan tidak ditentukan, cakupan default akan ditetapkan ke cakupan kondisi, 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

Berbagai opsi jenis perbandingan.

Enum
UNSPECIFIED_OPERATOR Operator yang tidak ditentukan 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 antar operator, nilai minimum dan maksimum adalah eksklusif. Kita akan menggunakan LT dan GT sebagai perbandingan.

SequenceSegment

Kondisi urutan terdiri dari satu atau beberapa langkah, yang setiap langkah 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).

SegmentSequenceStep

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 berada tepat sebelum atau dapat berupa waktu sebelum langkah berikutnya.

MatchType

Jenis pencocokan untuk urutan.

Enum
UNSPECIFIED_MATCH_TYPE Jenis pencocokan yang tidak ditentukan diperlakukan sebagai awalan.
PRECEDES Operator menunjukkan bahwa langkah sebelumnya mendahului langkah berikutnya.
IMMEDIATELY_PRECEDES Operator menunjukkan bahwa langkah sebelumnya tepat mendahului langkah berikutnya.

Pivot

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

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

object(Dimension)

Daftar dimensi yang akan 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)

DimensionFilterClauses digabungkan secara logis dengan operator AND: hanya data yang disertakan oleh semua DimensionFilterClauses ini yang berkontribusi pada nilai di wilayah pivot ini. Filter dimensi dapat digunakan untuk membatasi kolom yang ditampilkan di wilayah pivot. Misalnya, jika Anda memiliki ga:browser sebagai dimensi yang diminta di wilayah pivot, dan Anda menentukan filter kunci untuk membatasi ga:browser hanya ke "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", dll. Urutan grup kolom ditentukan oleh urutan menurun dari "total" untuk pertama dari nilai k. Ikatan diputus oleh urutan leksikografis dimensi pivot pertama, kemudian urutan leksikografis dimensi pivot kedua, dan seterusnya. Contoh, jika total nilai pertama untuk Firefox, IE, dan Chrome masing-masing adalah 8, 2, 8, urutan kolomnya adalah Chrome, Firefox, IE.

Berikut ini memungkinkan Anda memilih grup kolom k mana yang akan disertakan dalam respons.
maxGroupCount

number

Menentukan jumlah maksimum grup yang akan ditampilkan. Nilai {i>default<i} adalah 10, juga nilai maksimum adalah 1.000.

CohortGroup

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 untuk kelompok.

lifetimeValue

boolean

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

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

Jika lifeValue bernilai benar (true):

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

Kelompok

Menentukan kelompok. Kelompok adalah sekelompok pengguna yang memiliki karakteristik yang sama. Misalnya, semua pengguna dengan tanggal akuisisi yang sama masuk ke dalam kelompok yang sama.

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

string

Nama unik untuk kelompok. Jika tidak ditentukan, nama akan otomatis dibuat 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 memilih pengguna yang tanggal kunjungan pertamanya berada di antara tanggal mulai dan tanggal akhir yang ditentukan di DateRange. Rentang tanggal harus disesuaikan untuk permintaan kelompok. Jika permintaan berisi ga:cohortNthDay, durasinya harus tepat satu hari, jika ga:cohortNthWeek, permintaan tersebut harus disejajarkan dengan batas minggu (dimulai pada hari Minggu dan berakhir hari Sabtu), dan untuk ga:cohortNthMonth rentang tanggal harus disejajarkan dengan bulan tersebut (dimulai dari pertama dan berakhir pada hari terakhir bulan tersebut). Untuk permintaan LTV, tidak ada pembatasan seperti itu. Anda tidak perlu memberikan rentang tanggal untuk kolom reportsRequest.dateRanges.

Jenis

Jenis kelompok.

Enum
UNSPECIFIED_COHORT_TYPE Jika tidak ditentukan, atribut tersebut 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)

Tajuk kolom.

data

object(ReportData)

Data respons.

nextPageToken

string

Token halaman untuk mengambil halaman hasil berikutnya dalam daftar.

ColumnHeader

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.

MetricHeader

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.

ReportData

Bagian data 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)

Ada 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 menjumlahkan metrik yang disebutkan dalam format nilai terlebih dahulu, lalu mengevaluasi format nilai sebagai ekspresi skalar. Mis., "Total" untuk 3 / (ga:sessions + 2) yang kita hitung 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 terlihat pada semua baris yang cocok. Keduanya kosong jika hideValueRanges dalam permintaan bernilai salah, atau jika rowCount nol.

maximums[]

object(DateRangeValues)

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

samplesReadCounts[]

string (int64 format)

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

samplingSpaceSizes[]

string (int64 format)

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

isDataGolden

boolean

Menunjukkan apakah respons terhadap permintaan ini bernilai emas atau tidak. Data dianggap berharga ketika permintaan yang sama persis tidak akan memberikan hasil baru jika diminta di lain waktu.

dataLastRefreshed

string (Timestamp format)

Terakhir kali data dalam laporan diperbarui. Semua hit yang diterima sebelum stempel waktu ini akan disertakan dalam penghitungan laporan.

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

ReportRow

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 DateRange / 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 wilayah pivot.

PivotValueRegion

Nilai metrik di wilayah pivot.

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

string

Nilai metrik di setiap wilayah pivot.

ResourceQuotasRemaining

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!