Panduan Developer

Dokumen ini menjelaskan cara menggunakan Real Time Reporting API untuk mendapatkan data Google Analytics.

Pengantar

Real Time Reporting API memungkinkan Anda melaporkan aktivitas yang terjadi di properti Anda saat ini. Untuk mengakses data real time, Anda dapat membuat kueri yang menentukan tampilan (profil) dan setidaknya satu metrik. Anda juga dapat menyediakan parameter kueri tambahan seperti dimensi dan filter untuk menyaring kueri Anda. Kueri ini dikirim ke Real Time Reporting API yang menampilkan data dalam bentuk tabel.

Jika Anda baru mengenal API ini, baca Ringkasan Real Time Reporting API untuk mengetahui pengantar tentang Real Time Reporting API dan data yang disediakan.

Prasyarat

Sebelum menggunakan Real Time Reporting API untuk mendapatkan data Google Analytics:

  • Baca halaman library klien untuk melihat daftar lengkap library klien khusus bahasa pemrograman yang berfungsi dengan API.
  • Baca Panduan Referensi untuk mempelajari cara menggunakan API saja (tanpa menggunakan library klien) untuk mendapatkan data Google Analytics.

Setiap library klien menyediakan satu objek layanan analisis untuk mengakses semua data Real Time Reporting API. Untuk membuat objek layanan:

  1. Daftarkan aplikasi Anda di Konsol API Google.
  2. Izinkan akses ke data Google Analytics.
  3. Buat objek layanan Analytics.

Jika Anda belum menyelesaikan langkah-langkah tersebut, hentikan dan baca Tutorial Hello Google Analytics API, yang akan memandu Anda melalui langkah-langkah awal pembuatan aplikasi Google Analytics API. Setelah itu, Anda akan mengetahui cara menggunakan API untuk mendapatkan data Google Analytics.

Menggunakan Real Time Reporting API

Untuk menggunakan Real Time Reporting API, aplikasi:

  1. Mengkueri Real Time Reporting API.
  2. Menangani Respons API.

Membuat kueri Real Time Reporting API

Objek layanan analisis menyediakan metode untuk membuat kueri Real Time Reporting API. Untuk detail tentang parameter kueri dan data yang tersedia untuk API, baca:

Setelah Anda menentukan kueri, panggil metode execute-nya untuk mengirim kueri ke server Google Analytics.

Menangani Respons API

Jika kueri ke Real Time Reporting API berhasil, API akan menampilkan data yang diminta sebagai bagian dari resource data real time. Lihat referensi Real Time Reporting API untuk mengetahui detail tentang struktur dan format respons API.

Jika terjadi error, API akan menampilkan kode status spesifik dan pesan yang menjelaskan error tersebut. Semua aplikasi harus menangkap dan menangani error. Lihat Respons Error untuk mengetahui daftar mendetail error dan coba lagi rekomendasi.

Contoh Kode

Bagian Contoh di halaman Data Real Time: get berisi kode contoh dalam berbagai bahasa pemrograman untuk mengkueri API Real Time Reporting dan menangani respons API.

Batasan Kueri

Berikut ini batasan pada kueri Real Time API:

  • Jika metrik rt:activeUsers disertakan dalam kueri dengan filter dimensi berikut, hanya operator AND dan jenis pencocokan kesetaraan (==) yang didukung.
    • rt:goalId
    • rt:eventAction
    • rt:eventCategory
    • rt:eventLabel

    Karena metrik rt:activeUsers hanya mengambil jumlah pengguna yang aktif di situs saat ini, jangan gunakan rt:minutesAgo dengan rt:activeUsers. Artinya, rt:activeUsers menyiratkan bahwa rt:minutesAgo adalah 0.

  • Tidak ada dukungan untuk filter metrik.
  • Tidak ada dukungan untuk parameter fields.

Pengelolaan Kuota

Seperti yang dijelaskan dalam Batas dan Kuota, ada kuota harian untuk Real Time Reporting API yang dibagikan dengan Google Analytics API lainnya. Jika Anda melakukan polling Real Time Reporting API dalam interval singkat, Anda mencapai batas kuota harian dengan sangat cepat. Jika hal itu terjadi, permintaan dari Google Analytics API lainnya juga berhenti berfungsi hingga kuota diperbarui.

Beberapa contoh penerapan yang dapat menggunakan kuota dengan sangat cepat adalah:

  • Anda memiliki beberapa dasbor realtime yang meminta data untuk satu tampilan (profil) Google Analytics dalam interval yang sangat singkat setiap hari.
  • Anda memiliki properti dengan banyak pengguna dan telah menerapkan widget real time. Setiap kali widget ditampilkan kepada pengguna, Anda mengkueri Google Analytics secara langsung, bukan menggunakan cache.

Untuk meminimalkan penggunaan kuota dan mengelolanya secara efisien:

  • Terapkan cache sisi server. Saat beberapa pengguna membuat permintaan untuk data real time yang sama, Anda harus menampilkan respons yang di-cache, bukan secara langsung membuat kueri Real Time Reporting API untuk setiap permintaan pengguna. Kemudian, refresh cache secara berkala dengan data real time terbaru pada interval pembaruan yang wajar agar tidak melebihi batas kuota harian.
  • Menggabungkan beberapa kueri dengan menentukan dimensi tambahan dan mengurai respons di sisi server atau klien.
  • Tingkatkan interval waktu saat Anda meminta data real time.

Contoh: Menghitung Interval Penyegaran

Jika Anda ingin membuat permintaan rutin untuk data real-time, sebaiknya pilih interval pembaruan yang wajar berdasarkan penggunaan yang diharapkan.

Misalnya, satu tampilan (profil) Google Analytics memiliki batas kuota harian sebanyak 10.000 permintaan per hari. Dalam satu hari, jika Anda ingin membuat 6.000 kueri ke Core Reporting API untuk satu tampilan (profil), Anda akan memiliki sisa kuota 4.000 permintaan untuk tampilan (profil) tersebut.

Misalkan Anda memutuskan untuk menggunakan Real Time Reporting API untuk menerapkan 3 dasbor real time yang menjalankan kueri sepanjang hari untuk data real-time dari tampilan (profil) yang sama. Setiap dasbor dapat membuat sekitar 1.333 kueri per hari (4.000 kueri / 3 dasbor). Ada 86.400 detik dalam sehari. Dengan demikian, interval pembaruan untuk setiap dasbor harus lebih besar dari 65 detik (86.400 / 1.333) sehingga jumlah total permintaan harian untuk tampilan (profil) di bawah batas harian 4.000.