Method: properties.runReport

Menampilkan laporan yang disesuaikan untuk data peristiwa Google Analytics Anda. Laporan berisi statistik yang berasal dari data yang dikumpulkan oleh kode pelacakan Google Analytics. Data yang ditampilkan dari API berupa tabel dengan kolom untuk dimensi dan metrik yang diminta. Metrik adalah pengukuran individual aktivitas pengguna di properti Anda, seperti pengguna aktif atau jumlah peristiwa. Dimensi mengelompokkan metrik berdasarkan beberapa kriteria umum, seperti negara atau nama peristiwa.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runReport

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
property

string

Wajib. ID properti Google Analytics yang peristiwanya dilacak. Ditentukan di jalur URL, bukan isi. Untuk mempelajari lebih lanjut, lihat tempat menemukan ID Properti Anda. Dalam permintaan batch, properti ini tidak boleh ditentukan atau harus konsisten dengan properti tingkat batch.

Contoh: properties/1234

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "returnPropertyQuota": boolean,
  "comparisons": [
    {
      object (Comparison)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Kolom
dimensions[]

object (Dimension)

Opsional. Dimensi yang diminta dan ditampilkan.
metrics[]

object (Metric)

Opsional. Metrik yang diminta dan ditampilkan.
dateRanges[]

object (DateRange)

Opsional. Rentang tanggal data yang akan dibaca. Jika beberapa rentang tanggal diminta, setiap baris respons akan berisi indeks rentang tanggal berbasis nol. Jika dua rentang tanggal tumpang-tindih, data peristiwa untuk hari-hari yang tumpang-tindih akan disertakan dalam baris respons untuk kedua rentang tanggal. Dalam permintaan kohor, dateRanges ini tidak boleh ditentukan.
dimensionFilter

object (FilterExpression)

Opsional. Dengan filter dimensi, Anda dapat meminta hanya nilai dimensi tertentu dalam laporan. Untuk mempelajari lebih lanjut, lihat Dasar-Dasar Filter Dimensi untuk melihat contoh. Metrik tidak dapat digunakan dalam filter ini.
metricFilter

object (FilterExpression)

Opsional. Klausa filter metrik. Diterapkan setelah menggabungkan baris laporan, mirip dengan klausa having SQL. Dimensi tidak dapat digunakan dalam filter ini.
offset

string (int64 format)

Opsional. Jumlah baris dari baris awal. Baris pertama dihitung sebagai baris 0.

Saat melakukan penomoran halaman, permintaan pertama tidak menentukan offset; atau sama dengan, menetapkan offset ke 0; permintaan pertama menampilkan limit baris pertama. Permintaan kedua menetapkan offset ke limit permintaan pertama; permintaan kedua menampilkan limit baris kedua.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman.
limit

string (int64 format)

Opsional. Jumlah maksimum baris yang akan ditampilkan. Jika tidak ditentukan, 10.000 baris akan ditampilkan. API menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. limit harus positif.

API juga dapat menampilkan lebih sedikit baris daripada limit yang diminta, jika tidak ada nilai dimensi sebanyak limit. Misalnya, ada kurang dari 300 kemungkinan nilai untuk dimensi country, jadi saat melaporkan hanya country, Anda tidak bisa mendapatkan lebih dari 300 baris, meskipun Anda menetapkan limit ke nilai yang lebih tinggi.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman.
metricAggregations[]

enum (MetricAggregation)

Opsional. Agregasi metrik. Nilai metrik gabungan akan ditampilkan di baris tempat dimensionValues ditetapkan ke "RESERVED_(MetricAggregation)". Agregat yang mencakup perbandingan dan beberapa rentang tanggal akan diagregasi berdasarkan rentang tanggal.
orderBys[]

object (OrderBy)

Opsional. Menentukan cara baris diurutkan dalam respons. Permintaan yang menyertakan perbandingan dan beberapa rentang tanggal akan menerapkan pengurutan pada perbandingan.
currencyCode

string

Opsional. Kode mata uang dalam format ISO4217, seperti "AED", "USD", "JPY". Jika kolom kosong, laporan akan menggunakan mata uang default properti.
cohortSpec

object (CohortSpec)

Opsional. Grup kohor yang terkait dengan permintaan ini. Jika ada grup kohor dalam permintaan, dimensi 'kohor' harus ada.
keepEmptyRows

boolean

Opsional. Jika salah (false) atau tidak ditentukan, setiap baris dengan semua metrik sama dengan 0 tidak akan ditampilkan. Jika benar (true), baris ini akan ditampilkan jika tidak dihapus secara terpisah oleh filter.

Terlepas dari setelan keepEmptyRows ini, hanya data yang direkam oleh properti Google Analytics yang dapat ditampilkan dalam laporan.

Misalnya, jika properti tidak pernah mencatat peristiwa purchase, kueri untuk dimensi eventName dan metrik eventCount tidak akan memiliki baris eventName: "purchase" dan eventCount: 0.
returnPropertyQuota

boolean

Opsional. Mengalihkan apakah akan menampilkan status kuota properti Google Analytics ini saat ini. Kuota ditampilkan di PropertyQuota.
comparisons[]

object (Comparison)

Opsional. Konfigurasi perbandingan yang diminta dan ditampilkan. Permintaan hanya memerlukan kolom perbandingan untuk menerima kolom perbandingan dalam respons.
conversionSpec

object (ConversionSpec)

Opsional. Mengontrol pelaporan konversi. Kolom ini bersifat opsional. Jika kolom ini disetel atau ada metrik konversi yang diminta, laporan akan menjadi laporan konversi.

Isi respons

Tabel laporan respons yang sesuai dengan permintaan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Kolom
dimensionHeaders[]

object (DimensionHeader)

Mendeskripsikan kolom dimensi. Jumlah DimensionHeader dan pengurutan DimensionHeader cocok dengan dimensi yang ada di baris.
metricHeaders[]

object (MetricHeader)

Mendeskripsikan kolom metrik. Jumlah MetricHeader dan pengurutan MetricHeader cocok dengan metrik yang ada di baris.
rows[]

object (Row)

Baris kombinasi nilai dimensi dan nilai metrik dalam laporan.
totals[]

object (Row)

Jika diminta, nilai total metrik.
maximums[]

object (Row)

Jika diminta, nilai maksimum metrik.
minimums[]

object (Row)

Jika diminta, nilai minimum metrik.
rowCount

integer

Jumlah total baris dalam hasil kueri, terlepas dari jumlah baris yang ditampilkan dalam respons. Misalnya, jika kueri menampilkan 175 baris dan menyertakan limit = 50 dalam permintaan API, respons akan berisi rowCount = 175, tetapi hanya 50 baris.

Untuk mempelajari parameter penomoran halaman ini lebih lanjut, lihat Penomoran halaman.
metadata

object (ResponseMetaData)

Metadata untuk laporan.
propertyQuota

object (PropertyQuota)

Status kuota Properti Analytics ini termasuk permintaan ini.
kind

string

Mengidentifikasi jenis resource pesan ini. kind ini selalu berupa string tetap "analyticsData#runReport". Berguna untuk membedakan jenis respons dalam JSON.
nextPageToken

string

Token yang dapat dikirim sebagai pageToken untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

Perbandingan

Menentukan perbandingan individual. Sebagian besar permintaan akan menyertakan beberapa perbandingan sehingga laporan membandingkan antarperbandingan.

Representasi JSON 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Kolom
name

string

Setiap perbandingan menghasilkan baris terpisah dalam respons. Dalam respons, perbandingan ini diidentifikasi dengan nama ini. Jika nama tidak ditentukan, kami akan menggunakan nama tampilan perbandingan tersimpan.

Kolom union one_comparison.

one_comparison hanya dapat berupa salah satu dari hal berikut:
dimensionFilter

object (FilterExpression)

Perbandingan dasar.
comparison

string

Perbandingan tersimpan yang diidentifikasi oleh nama resource perbandingan. Misalnya, 'comparisons/1234'.

ConversionSpec

Mengontrol pelaporan konversi.

Representasi JSON 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Kolom
conversionActions[]

string

ID tindakan konversi yang akan disertakan dalam laporan. Jika kosong, semua konversi disertakan. ID tindakan konversi yang valid dapat diambil dari kolom conversionAction dalam daftar conversions di respons metode properties.getMetadata. Misalnya, 'conversionActions/1234'.
attributionModel

enum (AttributionModel)

Model atribusi yang akan digunakan dalam Laporan Konversi. Jika tidak ditentukan, DATA_DRIVEN akan digunakan.

AttributionModel

Model atribusi yang akan digunakan dalam Laporan Konversi

Enum
ATTRIBUTION_MODEL_UNSPECIFIED Model atribusi tidak ditentukan.
DATA_DRIVEN Atribusi didasarkan pada model berbasis data berbayar dan organik
LAST_CLICK Atribusi didasarkan pada model klik terakhir berbayar dan organik