Ringkasan Google Analytics Data API

Anda dapat menggunakan Data API untuk mengakses data laporan Google Analytics secara terprogram.

Pelajari properti Google Analytics lebih lanjut.

Data yang ditampilkan oleh API konsisten dengan data yang ditampilkan di antarmuka pengguna Google Analytics dan sepenuhnya mematuhi setelan Identitas pelaporan--seperti Gabungan, Diamati, atau Berbasis perangkat--yang dikonfigurasi untuk properti Google Analytics Anda.

Berikut beberapa contoh yang dapat Anda laporkan menggunakan Google Analytics Data API v1:

  • Berapa banyak pengguna aktif harian yang menggunakan aplikasi Android Anda dalam seminggu terakhir.
  • Jumlah tayangan halaman yang diperoleh 10 halaman teratas di situs Anda dalam 28 hari terakhir.
  • Jumlah pengguna aktif per negara yang menggunakan aplikasi iOS Anda dalam 30 menit terakhir.

Anda juga dapat menggunakan Google Analytics Data API v1 untuk melakukan hal berikut:

  • Membuat dasbor kustom guna menampilkan data Google Analytics.
  • Mengotomatiskan tugas pelaporan yang kompleks untuk menghemat waktu.
  • Mengintegrasikan data Google Analytics Anda dengan aplikasi bisnis lainnya.

Konsistensi data dan identitas pelaporan

Google Analytics Data API v1 mengakses data laporan yang sama dengan antarmuka Google Analytics. Data yang ditampilkan oleh API sepenuhnya mematuhi setelan Identitas Pelaporan yang dikonfigurasi untuk properti Google Analytics Anda sehingga jumlah pengguna, penghapusan duplikat, dan pemodelan data selaras dengan ruang identitas yang dipilih—seperti Gabungan, Diamati, atau Berbasis Perangkat—dalam setelan properti Anda.

Untuk mempelajari lebih lanjut pengaruh berbagai ruang identitas terhadap laporan Anda, lihat Identitas pelaporan.

Mulai

Untuk mulai menggunakan library klien di Java, Python, Node.js, PHP, C#, Go, atau Ruby, lihat panduan memulai library klien. Untuk mempelajari cara membuat kueri, memfilter dimensi, dan membaca respons, lihat Membuat laporan, atau uji kueri secara interaktif di Query Explorer.

Contoh permintaan dan respons runReport

Untuk mengkueri data peristiwa melalui REST, kirim permintaan POST ke endpoint runReport dengan isi JSON RunReportRequest yang menentukan dateRanges, dimensions, dan metrics Anda:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

Atau, jalankan perintah curl yang setara menggunakan Kredensial Default Aplikasi:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

API menampilkan RunReportResponse yang berisi header kolom dan baris data:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

Metode yang tersedia

Berikut daftar metode Data API. Untuk mengetahui detail selengkapnya, lihat dokumentasi referensi.

  • runReport Metode ini menampilkan laporan kustom data peristiwa Google Analytics Anda dan merupakan metode yang direkomendasikan untuk kueri laporan sederhana.
  • batchRunReports Ini adalah versi batch metode runReport yang memungkinkan Anda membuat beberapa laporan menggunakan satu panggilan API.
  • runPivotReport Metode ini menampilkan laporan pivot yang disesuaikan untuk data peristiwa Google Analytics Anda. Laporan pivot adalah format yang lebih canggih dan ekspresif daripada laporan biasa. Setiap pivot mendeskripsikan baris dan kolom dimensi yang terlihat dalam respons laporan.
  • batchRunPivotReports Ini adalah versi batch metode runPivotReport yang memungkinkan Anda membuat beberapa laporan menggunakan satu panggilan API.
  • getMetadata Metode ini menampilkan metadata untuk dimensi dan metrik yang tersedia dalam metode pelaporan. Digunakan untuk menjelajahi dimensi dan metrik. Respons metode ini juga mencakup Dimensi dan metrik kustom yang tersedia untuk properti Google Analytics yang ditentukan.
  • checkCompatibility Metode ini mencantumkan dimensi dan metrik yang dapat ditambahkan ke permintaan laporan dan mempertahankan kompatibilitas.
  • runRealtimeReport Metode ini menampilkan laporan data peristiwa real-time yang disesuaikan untuk properti Anda. Peristiwa muncul dalam laporan real-time beberapa detik setelah dikirim ke Google Analytics. Laporan Realtime menampilkan data peristiwa dan penggunaan untuk jangka waktu mulai dari saat ini hingga 30 menit yang lalu (hingga 60 menit untuk properti Google Analytics 360).
  • properties.audienceExports Sekelompok metode yang memungkinkan Anda membuat Ekspor Audiens, yang mencakup ringkasan data pengguna dalam audiens.
  • properties.recurringAudienceLists (Pratinjau awal) Sekelompok metode yang memungkinkan Anda mengelola Ekspor Audiens berulang. Ekspor audiens berulang menghasilkan daftar audiens baru setiap hari.
  • runFunnelReport (Pratinjau awal) Metode ini menampilkan laporan funnel yang disesuaikan untuk data peristiwa Google Analytics Anda. Eksplorasi funnel memungkinkan Anda memvisualisasikan langkah-langkah yang diambil pengguna untuk menyelesaikan tugas dan dengan cepat melihat performa keberhasilan atau kegagalan mereka di setiap langkah.
  • properties.chat (Pratinjau awal) Metode ini memberikan akses percakapan terprogram ke Ask Advisor di Google Analytics. Anda dapat mengajukan pertanyaan dalam bahasa alami tentang data peristiwa, mendiagnosis perubahan performa, dan menerima insight tabular serta narasi terstruktur.

Dimensi dan metrik yang didukung

Untuk mengetahui daftar semua dimensi dan metrik yang didukung oleh Data API, lihat dokumentasi skema API.