Method: properties.reportTasks.query

Mengambil konten tugas laporan. Setelah meminta reportTasks.create, Anda dapat mengambil konten laporan setelah laporan AKTIF. Metode ini akan menampilkan error jika status tugas laporan bukan ACTIVE. Respons kueri akan menampilkan nilai baris & kolom tabel laporan.

Permintaan HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query

URL menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama sumber laporan. Format: properties/{property}/reportTasks/{report}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "offset": string,
  "limit": string
}
Kolom
offset

string (int64 format)

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

Saat paging, permintaan pertama tidak menentukan offset; atau setara, 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 baris yang akan ditampilkan dari laporan. 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. Jumlah baris yang tersedia untuk QueryReportTaskRequest lebih lanjut dibatasi oleh batas ReportTask terkait. Kueri dapat mengambil maksimal baris ReportTask.limit. Misalnya, jika ReportTask memiliki batas 1.000, permintaan reportTasks.query dengan offset=900 dan limit=500 akan menampilkan maksimal 100 baris.

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

Isi respons

Konten laporan yang sesuai dengan tugas laporan.

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)
  }
}
Kolom
dimensionHeaders[]

object (DimensionHeader)

Menjelaskan kolom dimensi. Jumlah DimensionHeaders dan pengurutan DimensionHeaders cocok dengan dimensi yang ada di baris.
metricHeaders[]

object (MetricHeader)

Menjelaskan kolom metrik. Jumlah MetricHeaders dan pengurutan MetricHeaders 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.
metadata

object (ResponseMetaData)

Metadata untuk laporan.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

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

ResponseMetaData

Metadata respons yang berisi informasi tambahan tentang konten laporan.

Representasi JSON 
{
  "dataLossFromOtherRow": boolean,
  "samplingMetadatas": [
    {
      object (SamplingMetadata)
    }
  ],
  "schemaRestrictionResponse": {
    object (SchemaRestrictionResponse)
  },
  "currencyCode": string,
  "timeZone": string,
  "emptyReason": string,
  "subjectToThresholding": boolean
}
Kolom
dataLossFromOtherRow

boolean

Jika benar, menunjukkan beberapa bucket kombinasi dimensi digabungkan ke dalam baris "(other)". Hal ini dapat terjadi untuk laporan berkardinalitas tinggi.

Parameter metadata dataLossFromOtherRow diisi berdasarkan tabel data gabungan yang digunakan dalam laporan. Parameter akan diisi secara akurat, terlepas dari filter dan batas dalam laporan.

Misalnya, baris (other) dapat dihapus dari laporan karena permintaan berisi filter pada sessionSource = google. Parameter ini akan tetap diisi jika ada kehilangan data dari baris lain dalam data gabungan input yang digunakan untuk membuat laporan ini.

Untuk mempelajari lebih lanjut, lihat Tentang baris (other) dan sampling data.
samplingMetadatas[]

object (SamplingMetadata)

Jika hasil laporan ini diambil sampelnya, ini menjelaskan persentase peristiwa yang digunakan dalam laporan ini. Satu samplingMetadatas diisi untuk setiap rentang tanggal. Setiap samplingMetadatas sesuai dengan rentang tanggal agar rentang tanggal ditentukan dalam permintaan.

Namun, jika hasilnya tidak diambil sampelnya, kolom ini tidak akan ditentukan.
schemaRestrictionResponse

object (SchemaRestrictionResponse)

Menjelaskan batasan skema yang diterapkan secara aktif dalam membuat laporan ini. Untuk mempelajari lebih lanjut, lihat Pengelolaan akses dan batasan data.
currencyCode

string

Kode mata uang yang digunakan dalam laporan ini. Dimaksudkan untuk digunakan dalam memformat metrik mata uang seperti purchaseRevenue untuk visualisasi. Jika currencyCode ditentukan dalam permintaan, parameter respons ini akan mencerminkan parameter permintaan; jika tidak, parameter respons ini adalah currencyCode properti saat ini.

Kode mata uang adalah encoding string jenis mata uang dari standar ISO 4217 (https://en.wikipedia.org/wiki/ISO_4217); misalnya "USD", "EUR", "JPY". Untuk mempelajari lebih lanjut, lihat https://support.google.com/analytics/answer/9796179.
timeZone

string

Zona waktu properti saat ini. Dimaksudkan untuk digunakan dalam menafsirkan dimensi berbasis waktu seperti hour dan minute. Diformat sebagai string dari database Zona Waktu IANA (https://www.iana.org/time-zones); misalnya "America/New_York" atau "Asia/Tokyo".
emptyReason

string

Jika alasan kosong ditentukan, laporan akan kosong karena alasan ini.
subjectToThresholding

boolean

Jika subjectToThresholding bernilai benar, laporan ini akan dikenai nilai minimum dan hanya menampilkan data yang memenuhi nilai minimum agregasi. Permintaan dapat dikenai pembatasan nilai minimum dan tidak ada data yang tidak ada dalam laporan, dan hal ini terjadi jika semua data berada di atas nilai minimum. Untuk mempelajari lebih lanjut, lihat Volume minimum data dan Tentang Demografi dan Minat.

SchemaRestrictionResponse

Pembatasan skema diterapkan secara aktif dalam pembuatan laporan ini. Untuk mempelajari lebih lanjut, lihat Pengelolaan akses dan batasan data.

Representasi JSON 
{
  "activeMetricRestrictions": [
    {
      object (ActiveMetricRestriction)
    }
  ]
}
Kolom
activeMetricRestrictions[]

object (ActiveMetricRestriction)

Semua batasan diterapkan secara aktif dalam pembuatan laporan. Misalnya, purchaseRevenue selalu memiliki jenis batasan REVENUE_DATA. Namun, batasan respons aktif ini hanya diisi jika peran kustom pengguna tidak mengizinkan akses ke REVENUE_DATA.

ActiveMetricRestriction

Metrik yang dibatasi secara aktif saat membuat laporan.

Representasi JSON 
{
  "restrictedMetricTypes": [
    enum (RestrictedMetricType)
  ],
  "metricName": string
}
Kolom
restrictedMetricTypes[]

enum (RestrictedMetricType)

Alasan pembatasan metrik ini.
metricName

string

Nama metrik yang dibatasi.

RestrictedMetricType

Kategori data yang mungkin tidak dapat Anda lihat di properti Google Analytics tertentu.

Enum
RESTRICTED_METRIC_TYPE_UNSPECIFIED Jenis tidak ditentukan.
COST_DATA Metrik biaya seperti adCost.
REVENUE_DATA Metrik pendapatan seperti purchaseRevenue.