- Permintaan HTTP
- Parameter lokasi
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- ResponseMetaData
- SchemaRestrictionResponse
- ActiveMetricRestriction
- RestrictedMetricType
- Cobalah!
Mengambil konten tugas laporan. Setelah meminta reportTasks.create
, Anda dapat mengambil konten laporan setelah laporan tersebut AKTIF. Metode ini akan menampilkan error jika status tugas laporan bukan ACTIVE
. Respons kueri akan menampilkan baris tabel & nilai kolom laporan.
Permintaan HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/reportTasks/*}:query
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
name |
Wajib. Nama sumber laporan. Format: |
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
Representasi JSON |
---|
{ "offset": string, "limit": string } |
Kolom | |
---|---|
offset |
Opsional. Jumlah baris untuk baris awal dalam laporan. Baris pertama dihitung sebagai baris 0. Saat melakukan paging, permintaan pertama tidak menentukan offset; atau yang setara, mengatur offset ke 0; permintaan pertama menampilkan Untuk mempelajari lebih lanjut parameter penomoran halaman ini, lihat Penomoran halaman. |
limit |
Opsional. Jumlah baris yang akan ditampilkan dari laporan. Jika tidak ditentukan, total 10.000 baris akan ditampilkan. API ini menampilkan maksimum 250.000 baris per permintaan, berapa pun jumlah yang Anda minta. API juga dapat menampilkan lebih sedikit baris daripada Untuk mempelajari lebih lanjut parameter penomoran halaman ini, 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 ( |
Kolom | |
---|---|
dimensionHeaders[] |
Mendeskripsikan kolom dimensi. Jumlah DimensionHeader dan urutan DimensionHeader cocok dengan dimensi yang ada dalam baris. |
metricHeaders[] |
Menjelaskan kolom metrik. Jumlah MetricHeader dan urutan MetricHeader cocok dengan metrik yang ada dalam baris. |
rows[] |
Baris kombinasi nilai dimensi dan nilai metrik dalam laporan. |
totals[] |
Total nilai metrik jika diminta. |
maximums[] |
Jika diminta, nilai maksimum metrik. |
minimums[] |
Jika diminta, nilai minimum metrik. |
rowCount |
Jumlah total baris dalam hasil kueri. |
metadata |
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,
"schemaRestrictionResponse": {
object ( |
Kolom | |
---|---|
dataLossFromOtherRow |
Jika benar, mengindikasikan beberapa bucket kombinasi dimensi digabungkan ke "(other)" baris. Hal ini dapat terjadi untuk laporan kardinalitas tinggi. Data parameter metadata LossFromOtherRow 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 di sessionSource = google. Parameter ini akan tetap diisi jika terdapat hilangnya data dari baris lain dalam data gabungan input yang digunakan untuk membuat laporan ini. Untuk mempelajari lebih lanjut, lihat artikel Tentang baris (other) dan sampling data. |
schemaRestrictionResponse |
Menjelaskan pembatasan skema yang diterapkan secara aktif dalam pembuatan laporan ini. Untuk mempelajari lebih lanjut, lihat Pengelolaan akses dan batasan data. |
currencyCode |
Kode mata uang yang digunakan dalam laporan ini. Ditujukan untuk digunakan dalam memformat metrik mata uang seperti 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 |
Zona waktu properti saat ini. Ditujukan untuk digunakan untuk menafsirkan dimensi berbasis waktu seperti |
emptyReason |
Jika alasan kosong ditentukan, laporan kosong karena alasan ini. |
subjectToThresholding |
Jika |
SchemaRestrictionResponse
Pembatasan skema diterapkan secara aktif saat pembuatan laporan ini. Untuk mempelajari lebih lanjut, lihat Pengelolaan akses dan batasan data.
Representasi JSON |
---|
{
"activeMetricRestrictions": [
{
object ( |
Kolom | |
---|---|
activeMetricRestrictions[] |
Semua batasan secara aktif diterapkan saat membuat laporan. Misalnya, |
ActiveMetricRestriction
Metrik secara aktif dibatasi dalam pembuatan laporan.
Representasi JSON |
---|
{
"restrictedMetricTypes": [
enum ( |
Kolom | |
---|---|
restrictedMetricTypes[] |
Alasan pembatasan metrik ini. |
metricName |
Nama metrik yang dibatasi. |
RestrictedMetricType
Kategori data yang mungkin tidak dapat Anda lihat di properti GA4 tertentu.
Enum | |
---|---|
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Jenis tidak ditentukan. |
COST_DATA |
Metrik biaya seperti adCost . |
REVENUE_DATA |
Metrik pendapatan seperti purchaseRevenue . |