Multi-Channel Funnel Reporting API - Panduan Referensi

Dokumen ini memberikan referensi lengkap baik untuk kueri maupun respons untuk Multi-Channel Funnel Reporting API.

Pengantar

Multi-Channel Funnel Reporting API memungkinkan Anda meminta data laporan Funnel Multisaluran Google Analytics. Setiap laporan berisi statistik yang berasal dari data yang dikirim kembali oleh kode pelacakan ke Analytics, yang diatur sebagai dimensi dan metrik. Dengan memilih kombinasi dimensi dan metrik sendiri, Anda dapat menggunakan Reporting API untuk membuat laporan yang disesuaikan dengan spesifikasi Anda sendiri.

API tersebut berisi satu metode yang meminta data laporan: report.get. Dengan metode ini, Anda memberikan ID tabel yang sesuai dengan tampilan (profil) yang datanya ingin Anda ambil. Selain itu, Anda menentukan hal berikut:

• Kombinasi dimensi dan metrik.
• Rentang tanggal.
• Kumpulan parameter opsi yang mengontrol data yang ditampilkan

API membuat metode report.get tersedia di endpoint REST: https://www.googleapis.com/analytics/v3/data/mcf. Bagian berikut menampilkan contoh permintaan dan menjelaskan setiap parameter.

Permintaan

API ini menyediakan satu metode untuk meminta data:

analytics.data.mcf.get()

API juga dapat dikueri sebagai endpoint REST:

Authorization: Bearer {oauth2-token}

GET https://www.googleapis.com/analytics/v3/data/mcf
  ?ids=ga:12345
  &metrics=mcf:totalConversions,mcf:totalConversionValue
  &start-date=2011-10-01
  &end-date=2011-10-31

Setiap parameter kueri URL menentukan parameter kueri API yang harus dienkode ke URL.

Semua Permintaan ke Multi-Channel Funnel Reporting API harus diberi otorisasi, sebaiknya melalui OAuth 2.0.

Ringkasan Parameter Kueri

Tabel berikut meringkas semua parameter kueri yang diterima oleh Multi-Channel Funnel Reporting API. Klik setiap nama parameter untuk melihat deskripsi mendetail.

Detail Parameter Kueri

ids

Kembali ke Atas

tanggal-mulai

  &start-date=7daysAgo
  &end-date=yesterday

Kembali ke Atas

tanggal-akhir

  &start-date=9daysAgo
  &end-date=today

Kembali ke Atas

dimensi

Kembali ke Atas

metrics

Kembali ke Atas

sort

sort=mcf:source,mcf:medium

sort=mcf:medium,mcf:source

Kembali ke Atas

filter

https://www.googleapis.com/analytics/v3/data/mcf
?ids=mcf:12134
&dimensions=mcf:source
&metrics=mcf:totalConversions
&filters=mcf:medium%3D%3Dreferral
&start-date=2011-10-01
&end-date=2011-10-31

Kembali ke Atas

samplingLevel

Kembali ke Atas

max-results

Kembali ke Atas

Respons

Jika berhasil, permintaan ini akan menampilkan isi respons dengan struktur JSON yang ditentukan di bawah ini.

Catatan: istilah "results" mengacu pada seluruh kumpulan baris yang cocok dengan kueri, sedangkan "respons" mengacu pada kumpulan baris yang ditampilkan pada halaman hasil saat ini. Parameter dapat berbeda jika jumlah total hasil lebih besar dari ukuran halaman untuk respons saat ini, seperti yang dijelaskan dalam itemsPerPage.

Format Respons

{
  "kind": "analytics#mcfData",
  "id": string,
  "query": {
    "start-date": string,
    "end-date": string,
    "ids": string,
    "dimensions": [
      string
    ],
    "metrics": [
      string
    ],
    "sort": [
      string
    ],
    "filters": string,
    "samplingLevel": string,
    "start-index": integer,
    "max-results": integer
  },
  "itemsPerPage": integer,
  "totalResults": integer,
  "selfLink": string,
  "previousLink": string,
  "nextLink": string,
  "profileInfo": {
    "profileId": string,
    "accountId": string,
    "webPropertyId": string,
    "internalWebPropertyId": string,
    "profileName": string,
    "tableId": string
  },
  "containsSampledData": boolean,
  "sampleSize": string,
  "sampleSpace": string,
  "columnHeaders": [
    {
      "name": string,
      "columnType": string,
      "dataType": string
    }
  ],
  "totalsForAllResults": [
    {
      metricName: string,
      ...
    }
  ]
  "rows": [
    [
      McfData.Rows
    ]
  ],
}

Kembali ke Atas

Kolom Respons

Properti struktur isi respons didefinisikan sebagai berikut:

{
  "primitiveValue": "2183"
}

{
  "conversionPathValue": [
    {
      "interactionType" : "CLICK",
      "nodeValue" : "google"
    },
    {
      "interactionType" : "CLICK",
      "nodeValue" : "google"
    }
  ]
}

Kembali ke Atas

Kode Error

Multi-ChannelFunnel Reporting API menampilkan kode status HTTP 200 jika permintaan berhasil. Jika terjadi error saat memproses kueri, API akan menampilkan kode dan deskripsi error. Setiap aplikasi yang menggunakan analytics API harus menerapkan logika penanganan error yang tepat. Untuk mengetahui detail tentang kode error dan cara menanganinya, baca Panduan referensi Respons Error.

Kembali ke Atas

Kembali ke Atas

Pengambilan Sampel

Google Analytics menghitung kombinasi dimensi dan metrik tertentu dengan cepat. Untuk menampilkan data dalam waktu yang wajar, Google Analytics hanya dapat memproses sampel data.

Anda dapat menentukan tingkat pengambilan sampel yang akan digunakan untuk permintaan dengan menetapkan parameter samplingLevel.

Jika respons MCF Reporting API berisi sampel data, kolom respons containsSampledData akan menjadi true. Selain itu, 2 properti akan memberikan informasi tentang tingkat sampling untuk kueri: sampleSize dan sampleSpace. Dengan 2 nilai ini, Anda dapat menghitung persentase sesi yang digunakan untuk kueri. Misalnya, jika sampleSize adalah 201,000 dan sampleSpace adalah 220,000,laporan didasarkan pada (201.000 / 220.000) * 100 = 91,36% sesi.

Lihat bagian Pengambilan sampel untuk mengetahui deskripsi umum tentang pengambilan sampel dan cara penggunaannya di Google Analytics.

Kembali ke Atas

Menangani Hasil Data yang Besar

Jika Anda memperkirakan kueri akan menampilkan kumpulan hasil besar, gunakan panduan di bawah ini untuk membantu Anda mengoptimalkan kueri API, menghindari error, dan meminimalkan kelebihan kuota. Perhatikan bahwa kami menetapkan dasar pengukuran performa dengan mengizinkan maksimum 7 dimensi dan 10 metrik dalam satu permintaan API. Meskipun beberapa kueri yang menentukan sejumlah besar metrik dan dimensi mungkin membutuhkan waktu pemrosesan yang lebih lama daripada yang lain, membatasi jumlah metrik yang diminta mungkin tidak cukup untuk meningkatkan performa kueri. Sebagai gantinya, Anda dapat menggunakan teknik berikut untuk mendapatkan hasil performa terbaik.

Mengurangi Dimensi per Kueri

API memungkinkan penentuan hingga 7 dimensi dalam satu permintaan. Sering kali, Google Analytics harus menghitung hasil kueri kompleks ini dengan cepat. Proses ini dapat sangat memakan waktu jika jumlah baris yang dihasilkan tinggi. Misalnya, kueri untuk kata kunci, berdasarkan kota per jam mungkin cocok dengan jutaan baris data. Anda dapat meningkatkan performa dengan mengurangi jumlah baris yang perlu diproses Google Analytics dengan membatasi jumlah dimensi dalam kueri Anda.

Memisahkan Kueri berdasarkan Rentang Tanggal

Pertimbangkan untuk membuat kueri terpisah selama satu minggu — atau bahkan satu hari — pada satu waktu, bukan menelusuri hasil dengan kunci tanggal pada satu rentang tanggal yang panjang. Tentu saja, untuk set data besar, bahkan permintaan untuk data satu hari mungkin menampilkan lebih dari max-results, dalam hal ini paging tidak dapat dihindari. Namun, bagaimanapun juga, jika jumlah baris yang cocok untuk kueri Anda lebih tinggi dari max-results, memisahkan rentang tanggal dapat mengurangi total waktu untuk mengambil hasilnya. Pendekatan ini dapat meningkatkan performa kueri thread tunggal dan paralel.

Paging

Paging hasil dapat menjadi cara berguna untuk membagi kumpulan hasil yang besar menjadi potongan-potongan yang mudah dikelola. Kolom totalResults menunjukkan jumlah baris yang cocok, dan itemsPerPage menunjukkan jumlah maksimum baris yang dapat ditampilkan dalam hasil. Jika ada rasio totalResults terhadap itemsPerPage yang tinggi, setiap kueri mungkin akan memerlukan waktu lebih lama dari yang diperlukan. Jika hanya memerlukan baris dalam jumlah terbatas, seperti untuk tujuan tampilan, akan lebih mudah bagi Anda untuk menetapkan batas eksplisit ukuran respons melalui parameter max-results. Namun, jika aplikasi Anda perlu memproses sekumpulan besar hasil secara keseluruhan, meminta baris maksimum yang diizinkan mungkin lebih efisien.

Menggunakan gzip

Cara yang mudah dan praktis untuk mengurangi bandwidth yang diperlukan untuk setiap permintaan adalah dengan mengaktifkan kompresi gzip. Meskipun hal ini memerlukan waktu CPU tambahan untuk membuka hasil, namun kompromi dengan biaya jaringan biasanya menjadikannya sangat bermanfaat. Untuk menerima respons yang dienkode dengan gzip, Anda harus melakukan dua hal: Menetapkan header Accept-Encoding, dan mengubah agen pengguna Anda agar berisi string gzip. Berikut ini contoh header HTTP dengan format yang benar untuk mengaktifkan kompresi gzip:

Accept-Encoding: gzip
User-Agent: my program (gzip)