Pemicu Google Analytics untuk Firebase

Beta

Fitur ini tercakup dalam Persyaratan Penawaran Pra-GA dari Persyaratan Layanan Google Cloud. Fitur pra-GA mungkin memiliki dukungan terbatas, dan perubahan pada fitur pra-GA mungkin tidak kompatibel dengan versi pra-GA lainnya. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Secara khusus, perhatikan bahwa CloudEvents yang dihasilkan oleh pemicu Beta dapat berubah format dari waktu ke waktu. Atribut Source dan Subject, atribut ekstensi tambahan, dan format data (payload) dapat berubah sewaktu-waktu.

Catatan: Konten ini hanya berlaku untuk fungsi Cloud Run (generasi ke-1)—sebelumnya Cloud Functions (generasi ke-1).

Cloud Run Functions saat ini tidak mendukung pemicu dari Google Analytics for Firebase.

Google Analytics for Firebase menyediakan laporan peristiwa yang dapat membantu Anda memahami cara pengguna berinteraksi dengan aplikasi Anda. Dengan fungsi Cloud Run, Anda dapat mengakses peristiwa konversi yang telah dicatat dalam log dari perangkat Apple dan Android serta memicu fungsi berdasarkan peristiwa tersebut.

Peringatan: Hanya platform Apple dan peristiwa Android yang ditandai sebagai peristiwa konversi yang didukung oleh fungsi Cloud Run; Peristiwa konversi web tidak tersedia. Anda dapat menentukan peristiwa mana yang merupakan peristiwa konversi di tab Peristiwa pada panel Analytics di Firebase console.

Catatan: Tidak seperti kebanyakan peristiwa fungsi Cloud Run lainnya, peristiwa Google Analytics for Firebase tidak bersifat real-time dan dapat tertunda. Lihat postingan blog ini untuk informasi selengkapnya.

Jenis peristiwa

Google Analytics for Firebase memicu peristiwa log. Ini adalah jenis peristiwa yang efektif, karena setiap tindakan yang dilakukan pengguna di aplikasi Anda dapat dicatat ke dalam log dan kemudian memicu suatu fungsi.

Jenis Peristiwa	Pemicu
providers/google.firebase.analytics/eventTypes/event.log	Dipicu saat peristiwa konversi dicatat.

Fungsi Cloud Run dapat merespons logging peristiwa konversi Google Analytics for Firebase. Misalnya, jika pengguna melakukan pembelian dalam aplikasi, peristiwa konversi in_app_purchase akan dicatat ke dalam log dan dapat digunakan oleh fungsi Cloud Run.

Struktur peristiwa

Pemicu ini memanggil fungsi Anda dengan peristiwa yang mirip dengan yang ditampilkan di bawah ini:

{
    "eventDim": [ // Contains a single event
        {
            "date": "20090213",
            "name": "screen_view",
            "params": {
                "firebase_conversion": {
                    "intValue": "1"
                },
                "firebase_event_origin": {
                    "stringValue": "auto"
                },
                "firebase_previous_class": {
                    "stringValue": "MainActivity"
                },
                "firebase_previous_id": {
                    "intValue": "1928209043426257906"
                },
                "firebase_previous_screen": {
                    "stringValue": "id-D-D"
                },
                "firebase_screen": {
                    "stringValue": "id-C-C"
                },
                "firebase_screen_class": {
                    "stringValue": "MainActivity"
                },
                "firebase_screen_id": {
                    "intValue": "1234567890000"
                }
            },
            "previousTimestampMicros": "1234567890000",
            "timestampMicros": "1234567890000"
        }
    ],
    "userDim": {
        // A UserDimensions object
    }
}

Informasi pengguna, seperti informasi aplikasi atau informasi perangkat, dapat ditemukan di properti userDim. Informasi tentang peristiwa yang dicatat ke dalam log dapat ditemukan di array eventDim. Objek yang terdapat dalam array tersebut mencakup kolom name yang menyimpan nama peristiwa konversi (seperti in_app_purchase). Kolom kustom yang disiapkan di Google Analytics for Firebase juga ditampilkan di sini.

Contoh kode

Gunakan cuplikan berikut untuk memproses respons ini:

Node.js

/**
 * Background Function triggered by a Google Analytics for Firebase log event.
 *
 * @param {!Object} event The Cloud Functions event.
 */
exports.helloAnalytics = event => {
  const {resource} = event;
  console.log(`Function triggered by the following event: ${resource}`);

  const [analyticsEvent] = event.data.eventDim;
  console.log(`Name: ${analyticsEvent.name}`);
  console.log(`Timestamp: ${new Date(analyticsEvent.timestampMicros / 1000)}`);

  const userObj = event.data.userDim;
  console.log(`Device Model: ${userObj.deviceInfo.deviceModel}`);
  console.log(`Location: ${userObj.geoInfo.city}, ${userObj.geoInfo.country}`);
};

Python

from datetime import datetime

def hello_analytics(data, context):
    """Triggered by a Google Analytics for Firebase log event.
    Args:
           data (dict): The event payload.
           context (google.cloud.functions.Context): Metadata for the event.
    """
    trigger_resource = context.resource
    print(f"Function triggered by the following event: {trigger_resource}")

    event = data["eventDim"][0]
    print(f'Name: {event["name"]}')

    event_timestamp = int(event["timestampMicros"][:-6])
    print(f"Timestamp: {datetime.utcfromtimestamp(event_timestamp)}")

    user_obj = data["userDim"]
    print(f'Device Model: {user_obj["deviceInfo"]["deviceModel"]}')

    geo_info = user_obj["geoInfo"]
    print(f'Location: {geo_info["city"]}, {geo_info["country"]}')

Go

// Package p contains a Google Analytics for Firebase Cloud Function.
package p

import (
	"context"
	"fmt"
	"log"

	"cloud.google.com/go/functions/metadata"
)

// AnalyticsEvent is the payload of an Analytics log event.
type AnalyticsEvent struct {
	EventDimensions []EventDimensions `json:"eventDim"`
	UserDimensions  interface{}       `json:"userDim"`
}

// EventDimensions holds Analytics event dimensions.
type EventDimensions struct {
	Name                    string      `json:"name"`
	Date                    string      `json:"date"`
	TimestampMicros         string      `json:"timestampMicros"`
	PreviousTimestampMicros string      `json:"previousTimestampMicros"`
	Params                  interface{} `json:"params"`
}

// HelloAnalytics handles Firebase Mobile Analytics log events.
func HelloAnalytics(ctx context.Context, e AnalyticsEvent) error {
	meta, err := metadata.FromContext(ctx)
	if err != nil {
		return fmt.Errorf("metadata.FromContext: %w", err)
	}
	log.Printf("Function triggered by Google Analytics event: %v", meta.Resource)
	log.Printf("%+v", e)
	return nil
}

C#

using CloudNative.CloudEvents;
using Google.Cloud.Functions.Framework;
using Google.Events.Protobuf.Firebase.Analytics.V1;
using Microsoft.Extensions.Logging;
using System;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;

namespace FirebaseAnalytics;

public class Function : ICloudEventFunction<AnalyticsLogData>
{
    private readonly ILogger _logger;

    public Function(ILogger<Function> logger) =>
        _logger = logger;

    public Task HandleAsync(CloudEvent cloudEvent, AnalyticsLogData data, CancellationToken cancellationToken)
    {
        _logger.LogInformation("Event source: {source}", cloudEvent.Source);
        _logger.LogInformation("Event count: {count}", data.EventDim.Count);

        var firstEvent = data.EventDim.FirstOrDefault();
        if (firstEvent is object)
        {
            _logger.LogInformation("First event name: {name}", firstEvent.Name);
            DateTimeOffset timestamp = DateTimeOffset.FromUnixTimeMilliseconds(firstEvent.TimestampMicros / 1000);
            _logger.LogInformation("First event timestamp: {timestamp:u}", timestamp);
        }

        var userObject = data.UserDim;
        if (userObject is object)
        {
            _logger.LogInformation("Device model: {device}", userObject.DeviceInfo?.DeviceModel);
            _logger.LogInformation("Location: {city}, {country}", userObject.GeoInfo?.City, userObject.GeoInfo.Country);
        }
        // In this example, we don't need to perform any asynchronous operations, so the
        // method doesn't need to be declared async.
        return Task.CompletedTask;
    }
}

Ruby

require "functions_framework"

# Triggered by a Google Analytics for Firebase log event.
FunctionsFramework.cloud_event "hello_analytics" do |event|
  # Event-triggered Ruby functions receive a CloudEvents::Event::V1 object.
  # See https://cloudevents.github.io/sdk-ruby/latest/CloudEvents/Event/V1.html
  # The Analytics event payload can be obtained from the `data` field.
  payload = event.data

  logger.info "Function triggered by the following event: #{event.source}"

  event = payload["eventDim"].first
  logger.info "Name: #{event['name']}"

  event_timestamp = Time.at(event["timestampMicros"].to_i / 1_000_000).utc
  logger.info "Timestamp: #{event_timestamp.strftime '%Y-%m-%dT%H:%M:%SZ'}"

  user_obj = payload["userDim"]
  logger.info "Device Model: #{user_obj['deviceInfo']['deviceModel']}"

  geo_info = user_obj["geoInfo"]
  logger.info "Location: #{geo_info['city']}, #{geo_info['country']}"
end

PHP

use Google\CloudFunctions\CloudEvent;

function firebaseAnalytics(CloudEvent $cloudevent): void
{
    $log = fopen(getenv('LOGGER_OUTPUT') ?: 'php://stderr', 'wb');

    $data = $cloudevent->getData();

    fwrite($log, 'Function triggered by the following event:' . $data['resource'] . PHP_EOL);

    $analyticsEvent = $data['eventDim'][0];
    $unixTime = $analyticsEvent['timestampMicros'] / 1000;

    fwrite($log, 'Name: ' . $analyticsEvent['name'] . PHP_EOL);
    fwrite($log, 'Timestamp: ' . gmdate("Y-m-d\TH:i:s\Z", $unixTime) . PHP_EOL);

    $userObj = $data['userDim'];
    fwrite($log, sprintf(
        'Location: %s, %s' . PHP_EOL,
        $userObj['geoInfo']['city'],
        $userObj['geoInfo']['country']
    ));

    fwrite($log, 'Device Model: %s' . $userObj['deviceInfo']['deviceModel'] . PHP_EOL);
}

Men-deploy fungsi Anda

Untuk men-deploy fungsi, tentukan jenis peristiwa dan project tempat Anda mengonfigurasi Firebase Auth. Di konsol, ada kolom untuk Jenis Peristiwa yang berisi log—satu-satunya opsi—dan Nama Peristiwa Log, yang merupakan atribut peristiwa konversi yang akan memicu fungsi tersebut.

Pada command line, string khusus harus digunakan untuk menetapkan parameter ini. Perintah Google Cloud CLI berikut men-deploy fungsi yang terpicu saat pengguna melakukan pembelian dalam aplikasi:

gcloud functions deploy FUNCTION_NAME \
  --no-gen2 \
  --entry-point ENTRY_POINT \
  --trigger-event providers/google.firebase.analytics/eventTypes/event.log \
  --trigger-resource projects/YOUR_PROJECT_ID/events/in_app_purchase \
  --runtime RUNTIME

Catatan: Saat Anda men-deploy fungsi menggunakan Google Cloud CLI, perintah tersebut harus menyertakan nama fungsi yang ada dalam kode Anda yang ingin dijalankan oleh perintah deploy. Anda dapat menentukan fungsi tersebut menggunakan FUNCTION_NAME atau flag --entry-point opsional, bergantung pada kebutuhan implementasi Anda. Lihat panduan deployment untuk diskusi lebih lanjut.

Argumen	Deskripsi
FUNCTION_NAME	Nama Cloud Run Function yang terdaftar yang sedang Anda deploy. Ini dapat berupa nama fungsi dalam kode sumber Anda, atau string arbitrer. Jika FUNCTION_NAME adalah string arbitrer, Anda harus menyertakan flag --entry-point.
--entry-point ENTRY_POINT	Nama fungsi atau class dalam kode sumber Anda. Opsional, kecuali jika Anda tidak menggunakan FUNCTION_NAME untuk menentukan fungsi dalam kode sumber yang akan dijalankan selama deployment. Dalam hal ini, Anda harus menggunakan --entry-point untuk memberikan nama fungsi yang dapat dieksekusi.
--trigger-event NAME	Nama jenis peristiwa yang ingin diterima fungsi. Untuk Google Analytics for Firebase, kolom ini selalu providers/google.firebase.analytics/eventTypes/event.log.
--trigger-resource NAME	Nama peristiwa Google Analytics yang sepenuhnya memenuhi syarat, termasuk informasi project Anda. Formatnya adalah: projects/YOUR_PROJECT_ID/events/CONVERSION_EVENT_NAME
--runtime RUNTIME	Nama runtime yang Anda gunakan. Untuk daftar lengkapnya, lihat referensi gcloud.