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 perlu membuat kueri yang menentukan tampilan (profil) dan setidaknya satu metrik. Anda juga dapat memberikan parameter kueri tambahan seperti dimensi dan filter untuk menyaring kueri. Kueri ini dikirim ke Real Time Reporting API yang menampilkan data dalam bentuk tabel.

Jika Anda baru menggunakan API ini, baca Ringkasan Real Time Reporting API untuk mengetahui pengantar Real Time Reporting API dan data yang disediakannya.

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 ini, hentikan dan baca Tutorial API Google Analytics yang Halo, yang memandu Anda melalui langkah-langkah awal pembuatan aplikasi Google Analytics API. Setelah itu, Anda mengetahui cara menggunakan API untuk mendapatkan data Google Analytics.

Menggunakan Real Time Reporting API

Untuk menggunakan Real Time Reporting API, aplikasi:

  1. Membuat kueri 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 menentukan kueri, panggil metode execute-nya untuk mengirim kueri tersebut 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 tertentu dan pesan yang menjelaskan error tersebut. Semua aplikasi harus menemukan dan menangani error. Lihat Respons Error untuk melihat daftar error yang mendetail dan rekomendasi percobaan ulang.

Contoh Kode

Bagian Example di halaman Real Time Data: get memberikan kode contoh dalam berbagai bahasa pemrograman untuk mengkueri Real Time Reporting API 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 dijelaskan dalam Batas dan Kuota, ada kuota harian untuk Real Time Reporting API yang digunakan bersama dengan Google Analytics API lain. Jika melakukan polling Real Time Reporting API dalam interval singkat, Anda akan mencapai batas kuota harian dengan sangat cepat. Jika hal itu terjadi, permintaan dari Google Analytics API lainnya juga akan berhenti berfungsi hingga kuota dimuat ulang.

Beberapa contoh implementasi yang dapat menghabiskan kuota dengan sangat cepat adalah:

  • Anda memiliki beberapa dasbor realtime yang mengkueri data untuk satu tampilan (profil) Google Analytics pada 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 membuat kueri Google Analytics secara langsung, bukan menggunakan cache.

Untuk meminimalkan penggunaan kuota dan mengelolanya secara efisien:

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

Contoh: Menghitung Interval Pembaruan

Jika ingin membuat permintaan rutin untuk data real time, Anda harus memilih interval pembaruan yang wajar berdasarkan perkiraan penggunaan Anda.

Misalnya, satu tampilan (profil) Google Analytics memiliki batas kuota harian 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 kuota 4.000 permintaan yang tersisa 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 refresh untuk setiap dasbor harus lebih besar dari 65 detik (86.400 / 1.333) agar jumlah total permintaan harian untuk tampilan (profil) berada di bawah batas harian 4.000.