Mengintegrasikan alat analitis Anda dengan AMP
Important: this documentation is not applicable to your currently selected format email!
Gambaran Umum
Jika Anda mengoperasikan perangkat lunak sebagai alat layanan untuk penayang agar dapat lebih memahami lalu lintas dan pengunjungnya, Anda mungkin ingin mengintegrasikan layanan Anda ke dalam amp-analytics
. Ini akan memungkinkan pelanggan Anda untuk melihat pola lalu lintas untuk halaman HTML AMP mereka.
Sebelum Anda mulai
Sebelum Anda dapat menambahkan layanan analitis Anda ke runtime HTML AMP, Anda mungkin perlu untuk:
- Mengidentifikasi jenis variabel dan permintaan yang akan Anda butuhkan di dalam dokumen HTML AMP untuk layanan analitis Anda.
- Mengidentifikasi pemicu yang akan menghasilkan permintaan analitis dikirimkan dari halaman yang relevan dengan layanan Anda.
- Mempertimbangkan jika dan bagaimana Anda akan melacak pengguna konteks AMP pihak pertama dan pihak ketiga.
- Menentukan cara dasbor analitis Anda menangani lalu lintas AMP
- Mengidentifikasi fungsionalitas apa pun yang tidak ada di dalam
amp-analytics
, dan mengajukan permintaan untuk fitur-fitur yang dibutuhkan. - Analitis AMP mengirimkan variabelnya ke endpoint yang telah dikonfigurasi sebelumnya. Jika Anda belum mempunyai endpoint, kaji sampel ini untuk mengetahui gambaran umum tentang cara membuatnya.
- Untuk semua jenis transpor, kecuali
iframe
, variabel dikirimkan sebagai parameter untai kueri dalam permintaan HTTPS. - Untuk jenis transpor
iframe
sebuah iframe dibuat dan variabel dikirimkan ke sana melaluiwindow.postMessage
. Dalam hal ini, pesan tersebut tidak perlu berupa URL. Opsi ini hanya tersedia untuk vendor dengan akreditasi MRC. - Pertimbangkan bagaimana integrasi dengan
amp-analytics
mungkin berdampak pada kebijakan apa pun (khususnya kebijakan privasi Anda) atau perjanjian yang mungkin Anda miliki.
Menambahkan konfigurasi Anda ke runtime HTML AMP
- Buat masalah Rencana yang Ingin Diterapkan yang menyatakan bahwa Anda akan menambahkan konfigurasi layanan analitis Anda ke runtime HTML AMP. Pastikan untuk menyertakan cc @ampproject/wg-analytics di dalam deskripsi Anda.
- Kembangkan patch yang akan menerapkan yang berikut ini:
- Sebuah berkas JSON konfigurasi baru
${vendorName}.json
di dalam folder vendor, termasuk opsi apa pun di atas dan luar default, seperti:"vars": {}
untuk variabel default tambahan."requests": {}
untuk permintaan yang akan digunakan layanan Anda."optout":
jika diperlukan. Saat ini, kami tidak mempunyai sistem penolakan (opt-out) yang bagus, jadi silakan hubungi kami untuk membantu mendesain yang berfungsi dengan baik untuk Anda."warningMessage":
jika diperlukan. Menampilkan informasi peringatan dari vendor (seperti depresiasi atau migrasi) pada konsol.
- Jika Anda menggunakan transpor iframe, tambahkan juga baris baru ke ANALYTICS_IFRAME_TRANSPORT_CONFIG di dalam iframe-transport-vendors.js yang berisi
"*vendor-name*": "*url*"
- Contoh dalam referensi examples/analytics-vendors.amp.html.
- Pengujian dalam berkas extensions/amp-analytics/0.1/test/vendor-requests.json .
- Tambahkan layanan analitis Anda ke daftar vendor yang didukung dalam berkas extensions/amp-analytics/0.1/analytics-vendors-list.md. Sertakan jenis, deskripsi, dan tautan ke dokumentasi penggunaan Anda.
- Uji contoh baru yang Anda masukkan ke examples/analytics-vendors.amp.html untuk memastikan bahwa hasil dari contoh bekerja sesuai harapan. Contohnya, data yang diperlukan dikumpulkan dan ditampilkan di dasbor analitis Anda.
- Kirimkan Pull Request (Permintaan Perubahan) dengan patch ini, dengan merujuk masalah Rencana yang Ingin Diterapkan.
- Perbarui dokumentasi penggunaan layanan Anda dan sampaikan kepada pelanggan Anda.
- Sangat direkomendasikan untuk mempertahankan uji integrasi di luar repo AMP.
Manajer Tag
Layanan manajemen tag mempunyai dua pilihan untuk berintegrasi dengan Analitis AMP:
- Pendekatan endpoint: Bertindak sebagai endpoint tambahan bagi
amp-analytics
, dan melakukan manajemen pemasaran di backend. - Pendekatan konfig: Melakukan manajemen tag melalui berkas konfig JSON yang dihasilkan secara dinamis dan unik untuk setiap penayang.
Pendekatan endpoint sama dengan pendekatan standar yang diuraikan di dalam bagian sebelumnya. Pendekatan konfig berisi tentang pembuatan konfigurasi unik untuk amp-analytics yang spesifik untuk setiap penayang dan menyertakan semua paket analitis mereka yang kompatibel. Penayang akan menyertakan konfigurasi yang menggunakan sintaks yang serupa dengan ini:
<amp-analytics config="https://my-awesome-tag-manager.example.com/user-id.json" > </amp-analytics> >
Untuk mengambil pendekatan ini, kaji dokumentasi untuk integrasi penayang dengan Analitis AMP.
Sumber Daya Lebih Lanjut
- Kajian Mendalam: Mengapa tidak menggunakan iframe saja?
- Kajian Mendalam: Mengelola status pengguna yang belum disahkan dengan AMP
- Sampel amp-analytics
- Dokumentasi referensi amp-analytics
- Dokumentasi referensi variabel amp-analytics