Core Reporting API - Panduan Referensi

Saat menggunakan dimensions dalam permintaan data, perhatikan batasan berikut:

• Anda dapat memberikan maksimum 7 dimensi dalam kueri apa pun.
• Anda tidak dapat mengirim kueri yang hanya terdiri dari dimensi: Anda harus menggabungkan dimensi yang diminta dengan setidaknya satu metrik.
• Hanya dimensi tertentu yang dapat dikueri dalam kueri yang sama. Gunakan alat kombinasi yang valid dalam Referensi Dimensi dan Metrik untuk melihat dimensi mana yang dapat digunakan bersama.

• Setiap permintaan harus menyediakan setidaknya satu metrik; permintaan tidak boleh hanya terdiri dari dimensi.
• Anda dapat menyediakan maksimum 10 metrik untuk kueri apa pun.
• Sebagian besar kombinasi metrik dari beberapa kategori dapat digunakan bersama, asalkan tidak ada dimensi yang ditentukan.
• Metrik dapat digunakan bersama dimensi atau metrik lainnya, tetapi hanya jika kombinasi yang valid diterapkan untuk metrik tersebut. Lihat Referensi Dimensi dan Metrik untuk mengetahui detailnya.

Daftar metrik dan dimensi yang menunjukkan tata urutan dan arah pengurutan untuk data yang ditampilkan.

• Pengurutan urutan ditentukan oleh urutan kiri ke kanan metrik dan dimensi yang tercantum.
• Mengurutkan direction secara default adalah menaik dan dapat diubah menjadi menurun menggunakan awalan tanda minus (-) pada kolom yang diminta.

Mengurutkan hasil kueri memungkinkan Anda mengajukan berbagai pertanyaan tentang data. Misalnya, untuk menjawab pertanyaan "Apa negara teratas saya, dan browser mana yang paling sering mereka gunakan?" Anda dapat membuat kueri dengan parameter berikut. Pengurutan ini diurutkan pertama menurut ga:country, lalu menurut ga:browser, keduanya dalam urutan menaik:

sort=ga:country,ga:browser

sort=ga:browser,ga:country

Saat menggunakan parameter sort, perhatikan hal berikut:

• Hanya urutkan berdasarkan nilai dimensi atau metrik yang telah Anda gunakan dalam parameter dimensions atau metrics. Jika permintaan Anda mengurutkan pada kolom yang tidak ditunjukkan dalam parameter dimensi atau metrik, Anda akan menerima error.
• Secara default, string diurutkan dalam urutan abjad menaik dalam lokal en-US.
• Angka diurutkan dalam urutan numerik menaik secara default.
• Tanggal diurutkan dalam urutan menaik berdasarkan tanggal secara {i>default<i}.

Parameter string kueri filters membatasi data yang ditampilkan dari permintaan Anda. Untuk menggunakan parameter filters, berikan dimensi atau metrik yang akan difilter, diikuti dengan ekspresi filter. Misalnya, kueri berikut meminta ga:pageviews dan ga:browser untuk tampilan (profil) 12134, dengan dimensi ga:browser dimulai dengan string Firefox:

https://www.googleapis.com/analytics/v3/data/ga
?ids=ga:12134
&dimensions=ga:browser
&metrics=ga:pageviews
&filters=ga:browser%3D~%5EFirefox
&start-date=2007-01-01
&end-date=2007-12-31

Kueri yang difilter membatasi baris yang menyertakan (atau tidak) disertakan dalam hasil. Setiap baris dalam hasil diuji terhadap filter: jika filter cocok, baris akan dipertahankan, dan jika tidak cocok, baris akan dihapus.

• Encoding URL: Library klien Google API secara otomatis mengenkode operator filter.
• Pemfilteran dimensi: Pemfilteran terjadi sebelum dimensi apa pun digabungkan, sehingga metrik yang ditampilkan hanya mewakili total untuk dimensi yang relevan. Pada contoh di atas, jumlah kunjungan halaman hanya akan menunjukkan kunjungan halaman jika Firefox adalah browser.
• Pemfilteran metrik: Pemfilteran metrik terjadi setelah metrik digabungkan.
• Kombinasi yang valid: Anda dapat memfilter dimensi atau metrik yang bukan bagian dari kueri Anda, asalkan semua dimensi/metrik dalam permintaan dan filternya merupakan kombinasi yang valid. Misalnya, Anda mungkin ingin membuat kueri untuk daftar kunjungan halaman yang bertanggal, dengan memfilter di browser tertentu. Lihat Referensi Dimensi dan Metrik untuk informasi selengkapnya.

Filter Sintaksis

Satu filter menggunakan bentuk:

ga:name operator expression

Dalam sintaksis ini:

• name — nama dimensi atau metrik yang akan difilter. Misalnya: ga:pageviews memfilter metrik kunjungan halaman.
• operator — menentukan jenis pencocokan filter yang akan digunakan. Operator bersifat khusus untuk dimensi atau metrik.
• expression — menyatakan nilai yang akan disertakan dalam atau dikecualikan dari hasil. Ekspresi menggunakan sintaksis ekspresi reguler.

Operator Filter

Ada enam operator filter untuk dimensi dan enam operator filter untuk metrik. Operator harus dienkode ke URL agar dapat disertakan dalam string kueri URL.

Tips: Gunakan Penjelajah Kueri Feed Data untuk mendesain filter yang memerlukan encoding URL, karena Penjelajah Kueri secara otomatis mengenkode URL yang berisi string dan spasi.

Ekspresi Filter

Ada beberapa aturan penting untuk ekspresi filter:

• Karakter yang dicadangkan URL — Karakter seperti & harus dienkode URL dengan cara biasa.
• Karakter yang dicadangkan — Titik koma dan koma harus di-escape garis miring terbalik saat muncul dalam ekspresi:
  • titik koma \;
  • koma \,
• Ekspresi Reguler — Anda juga dapat menggunakan ekspresi reguler dalam ekspresi filter menggunakan operator =~ dan !~. Sintaksisnya mirip dengan ekspresi reguler Perl dan memiliki aturan tambahan berikut:
  • Panjang maksimum 128 karakter — Ekspresi reguler yang lebih dari 128 karakter menghasilkan kode status 400 Bad Request yang ditampilkan dari server.
  • Peka huruf besar/kecil — Pencocokan ekspresi reguler tidak peka huruf besar/kecil.

Menggabungkan Filter

Filter dapat digabungkan menggunakan logika boolean OR dan AND. Hal ini memungkinkan Anda memperluas batas ekspresi filter sebanyak 128 karakter.

ATAU

Operator OR ditentukan menggunakan koma (,). Operator ini lebih diutamakan daripada operator AND dan TIDAK dapat digunakan untuk menggabungkan dimensi dan metrik dalam ekspresi yang sama.

DAN

Operator AND ditentukan menggunakan titik koma (;). Operator ini didahului oleh operator OR dan CANGGIH digunakan untuk menggabungkan dimensi dan metrik dalam ekspresi yang sama.

Untuk detail selengkapnya tentang cara meminta segmen di Core Reporting API, lihat Panduan Developer Segmen.

Untuk ringkasan konseptual tentang segmen, lihat Referensi Fitur Segmen dan Segmen di Pusat Bantuan.

Dimensi dan Metrik yang diizinkan dalam segmen.
Tidak semua dimensi dan metrik dapat digunakan dalam segmen. Untuk meninjau dimensi dan metrik yang diizinkan dalam segmen, kunjungi Penjelajah Dimensi dan Metrik.

• DEFAULT — Menampilkan respons dengan ukuran sampel yang menyeimbangkan kecepatan dan akurasi.
• FASTER — Menampilkan respons cepat dengan ukuran sampel yang lebih kecil.
• HIGHER_PRECISION — Menampilkan respons yang lebih akurat menggunakan ukuran sampel yang besar, tetapi hal ini dapat menyebabkan respons menjadi lebih lambat.

• json — Menghasilkan properti rows default dalam respons, yang berisi objek JSON.
• dataTable — Menghasilkan properti dataTable dalam respons, yang berisi objek Tabel Data. Objek Data Table ini dapat digunakan langsung dengan visualisasi Google Chart.

Menentukan kolom yang akan ditampilkan dalam respons sebagian. Jika Anda hanya menggunakan subset kolom dalam respons API, Anda dapat menggunakan parameter fields untuk menentukan kolom yang akan disertakan.

Format nilai parameter permintaan kolom umumnya didasarkan pada sintaksis XPath. Sintaksis yang didukung dirangkum di bawah ini.

• Gunakan daftar yang dipisahkan koma untuk memilih beberapa kolom.
• Gunakan a/b untuk memilih kolom b yang bertingkat dalam kolom a; gunakan a/b/c untuk memilih kolom c yang bertingkat di dalam b.
• Gunakan sub-selektor untuk meminta kumpulan sub-kolom spesifik dari array atau objek dengan menempatkan ekspresi dalam tanda kurung "( )".
  Misalnya: fields=columnHeaders(name,dataType) hanya menampilkan kolom name dan dataType dalam array columnHeaders. Anda juga dapat menentukan satu subkolom, dengan fields=columnHeader(name) setara dengan fields=columnHeader/name.

Menampilkan respons dalam format yang dapat dibaca manusia jika true. Nilai default: false.

Memungkinkan Anda menerapkan kuota per pengguna dari aplikasi sisi server meskipun alamat IP pengguna tidak diketahui. Hal ini dapat terjadi, misalnya, pada aplikasi yang menjalankan cron job di App Engine atas nama pengguna. Anda dapat memilih string arbitrer apa pun yang secara unik mengidentifikasi pengguna, tetapi dibatasi hingga 40 karakter.

Tindakan ini akan menggantikan userIp jika keduanya disediakan.