Quick Tracking:API Penyematan

1. Bagaimana cara saya melihat solusi pelacakan?

Sebelum menanamkan titik, Anda perlu menentukan lokasi dan jenis titik yang akan ditanamkan, serta menyusun persyaratan jelas untuk penanaman tersebut. Di platform Quick Tracking, kebutuhan pelacakan eksplisit disebut solusi pelacakan, dengan template spesifikasi dirancang sesuai. Contoh:

Dalam skema titik penguburan, titik yang diperlukan adalah sebagai berikut:

1. Subjek acara: mengacu pada "siapa" yang memicu acara ini, dibagi menjadi ID perangkat dan ID akun. Acara yang dilaporkan harus memiliki salah satu dari keduanya.

• ID Perangkat: ID perangkat default untuk perangkat macOS adalah ID unik di tingkat aplikasi. ID perangkat secara otomatis dihasilkan oleh SDK Quick Tracking atau dikonfigurasi dengan memanggil operasi setCustomDeviceId.

• ID Akun: ID akun pengguna klien untuk masuk ke sistem. Ketika pengguna masuk dari perangkat yang berbeda, ID perangkat berubah, tetapi ID akun tetap sama. Misalnya, seorang pengguna masuk menggunakan dua komputer masing-masing.

2. Atribut Pengguna: atribut dari ID akun, misalnya, pengguna dengan ID akun "testdemo@111", memiliki "tanggal lahir" "1999-02-13" dan "tingkat keanggotaan" "platinum". "Tanggal lahir" dan "peringkat keanggotaan" adalah atribut pengguna.

3. Atribut Global: atribut yang dibawa oleh setiap acara setelah pengaturan global sekali.

4. Acara penelusuran halaman: acara yang dilaporkan selama pemuatan halaman (acara dengan kode halaman sama dengan kode acara dalam skema pelacakan juga merupakan acara yang ditandai dengan warna biru).

5. Klik, paparan, dan acara kustom: acara yang dilaporkan ketika pengguna klien berinteraksi dengan klien.

Catatan instruksi

• Batas ukuran parameter input:

2. Terapkan acara prefab

2.1 untuk memicu acara startup aplikasi secara manual

Fungsi antarmuka:

// Secara manual memicu acara startup aplikasi.
-(void)trackAppStart:(NSDictionary *_Nullable)properties;

Parameter:

Contoh:

NSDictionary *appStartProperties = @{
    @"appStartTest": @"appStartTest",
    @"times": @1024,
    @"subContents": @[@"test1", @"test2", @"test3"]
};
[[QuickTrackingSDK sharedInstance] trackAppStart:appStartProperties];

2.2 acara keluar aplikasi yang dipicu secara manual

Fungsi antarmuka:

// Secara manual memicu acara keluar aplikasi.
-(void)trackAppEnd:(NSDictionary *_Nullable)properties;

Parameter:

Contoh:

NSDictionary *appEndProperties = @{
    @"appEndTest": @"appEndTest"
};
[[QuickTrackingSDK sharedInstance] trackAppEnd:appEndProperties];

3 ID Perangkat

SDK mendukung ID perangkat kustom. Jika ingin menggunakan ID perangkat kustom, atur parameter API setCustomDeviceId ke nilai yang valid. Nilai defaultnya adalah pengenal unik perangkat terenkripsi.

3.1 ID Perangkat Kustom

Fungsi antarmuka:

// Tentukan ID perangkat kustom.
-(void)setCustomDeviceId:(NSString *_Nonnull)customDeviceID;

Parameter:

Contoh:

[[QuickTrackingSDK sharedInstance] setCustomDeviceId:@"your_deviceId"];

3.2 Baca ID Perangkat

Fungsi antarmuka:

// Baca ID perangkat.
-(NSString *_Nullable)getDeviceID;

Contoh:

NSString *deviceID = [[QuickTrackingSDK sharedInstance] getDeviceID];

Catatan:

Metode ini bergantung pada penyelesaian inisialisasi SDK dan mungkin mengembalikan nilai null.

4 ID Akun

4.1 Login Pengguna

SDK Pelacakan Cepat menggunakan perangkat sebagai standar saat menghitung pengguna. Jika Anda perlu menghitung akun sendiri, gunakan metode berikut.

Fungsi antarmuka:

// Masuk ke aplikasi.
- (void)onProfileSignIn:(NSString *_Nonnull)userId;

Parameter:

Contoh:

[[QuickTrackingSDK sharedInstance] onProfileSignIn:@"your_userId"];

4.2 Logout Pengguna

Jika tidak lagi perlu mengikat akun pengguna, panggil metode logout pengguna yang disediakan oleh SDK. Setelah metode logout dipanggil, SDK tidak lagi mengirimkan konten terkait akun pengguna.

Fungsi antarmuka:

// Keluar.
- (void)onProfieSignOff;

Contoh:

[[QuickTrackingSDK sharedInstance] onProfieSignOff];

5. Unggah atribut pengguna

Pengkodean acara tetap sebagai $$_user_profile unggahan acara kustom, dan atribut acara yang dibawa oleh acara ditempatkan di tabel pengguna sebagai atribut pengguna.

Fungsi antarmuka:

// Unggah properti pengguna.
- (void)uploadUserProfile:(NSDictionary *_Nullable)properties;

Parameter:

Contoh:

NSDictionary *userProfile = @{
  @"name": @"your_name",
  @"email": @"example@example.com"
};
[[QuickTrackingSDK sharedInstance] uploadUserProfile:userProfile];

Catatan:

SDK tidak menyimpan cache atribut pengguna. Untuk melaporkan atribut pengguna, Anda harus memanggil akun pengguna untuk mengatur API onProfileSignIn demi memastikan akurasi data.

6. Atribut global

6.1 Daftarkan Atribut Global

Fungsi antarmuka:

// Tetapkan properti global.
-(void)registerGlobalProperties:(NSDictionary * _Nonnull)properties;

Parameter:

Contoh:

[[QuickTrackingSDK sharedInstance] registerGlobalProperties:@{
    @"content": @"Test",
    @"times": @1024,
    @"subContents": @[@"abc", @"def", @"ghi"]
}];

Catatan:

Jika kunci atribut global yang ada sama dengan kunci atribut global baru, nilai yang ada diperbarui. Jika kunci atribut global yang ada berbeda dari kunci atribut global baru, atribut global baru dimasukkan.

6.2 hapus atribut global

Fungsi antarmuka:

// Hapus atribut global berdasarkan kunci.
-(void)unregisterGlobalProperty:(NSString *_Nonnull)propertyName;

Parameter:

Contoh:

[[QuickTrackingSDK sharedInstance] unregisterGlobalProperty:@"your_key"];

6.3 untuk mendapatkan atribut global tunggal berdasarkan kunci

Fungsi antarmuka:

// Dapatkan properti global berdasarkan kunci.
-(id _Nullable)getGlobalProperty:(NSString *_Nonnull)propertyName;

Parameter:

Nilai kembali:

Contoh:

id value = [[QuickTrackingSDK sharedInstance] getGlobalProperty:@"your_key"];

6.4 Dapatkan Semua Atribut Global

Fungsi antarmuka:

// Dapatkan semua atribut global.
-(NSDictionary *_Nullable)getGlobalProperties;

Nilai kembali:

Contoh:

NSDictionary *globalProperties = [[QuickTrackingSDK sharedInstance] getGlobalProperties];

6.5 Bersihkan Semua Atribut Global

Fungsi antarmuka:

// Bersihkan semua atribut global.
-(void)clearGlobalProperties;

Contoh:

[[QuickTrackingSDK sharedInstance] clearGlobalProperties];

7. Acara penelusuran halaman

Sebelum digunakan, silakan pergi ke modul manajemen pelacakan -> manajemen acara di latar belakang manajemen QuickTracking untuk membuat acara halaman yang sesuai, lalu masukkan kode halaman yang sesuai (page_name).

7.1 startup halaman

Fungsi antarmuka:

// Statistik perilaku masuk halaman
+(void)onPageStart:(id _Nonnull)pageContext page_name:(NSString * _Nonnull)page_name options:(NSDictionary *_Nullable)options;

Parameter:

Contoh:

NSDictionary *pageOptions = @{
    @"url": @"your_url",
    @"page_title": @"your_page_title"
};
[QuickTrackingSDK onPageStart:self page_name:@"your_page_name" options:pageOptions];

7.2 Halaman Keluar

Fungsi antarmuka:

// Hitung perilaku meninggalkan halaman.
+(void)onPageEnd:(id _Nonnull)pageContext page_name:(NSString * _Nonnull)page_name;

Parameter:

Contoh:

[QuickTrackingSDK onPageEnd:self page_name:@"your_page_name"];

7.3 pengaturan properti acara halaman

Fungsi antarmuka:

// Tetapkan properti acara halaman.
+(void)updatePageProperties:(id _Nonnull)pageContext page_name:(NSString *_Nonnull)page_name properties:(NSDictionary *_Nonnull)properties;

Parameter:

Contoh:

NSDictionary *pageProperties = @{
    @"page_type": @"main",
    @"user_role": @"admin"
};
[QuickTrackingSDK updatePageProperties:self page_name:@"your_name" properties:pageProperties];

8. Pelacakan acara

Acara kustom dapat digunakan untuk melacak perilaku pengguna dan mencatat detail spesifik terjadinya perilaku.

Sebelum digunakan, pergi ke modul Manajemen Pengumpulan Data > Manajemen Pelacakan > Manajemen Acara di latar belakang manajemen Quick Tracking, buat acara kustom, lalu masukkan kode acara yang sesuai dalam proyek.

Fungsi antarmuka:

// Melacak acara.
- (void)event:(NSString *_Nonnull)eventCode;
// Melacak acara dengan atribut acara.
- (void)event:(NSString *_Nonnull)eventCode properties:(NSDictionary *_Nullable)properties;
// Melacak acara dikodekan dengan kode halaman.
- (void)event:(NSString *_Nonnull)eventCode page_name:(NSString *_Nonnull)page_name;
// Lacak acara dengan kode halaman dan atribut acara
- (void)event:(NSString *_Nonnull)eventCode page_name:(NSString *_Nonnull)page_name properties:(NSDictionary *_Nullable)properties;

Parameter:

Contoh:

// Melacak acara.
NSString *eventCodeSimple = @"your_event_code";
[[QuickTrackingSDK sharedInstance] event:eventCodeSimple];

// Melacak acara dengan atribut halaman
NSString *eventCodeWithProperties = @"your_event_code";
NSDictionary *yourProperties = @{
    @"item_name": @"your_item_name",
    @"item_price": @20
};
[[QuickTrackingSDK sharedInstance] event:eventCodeWithProperties properties:yourProperties];

// Melacak acara dikodekan dengan kode halaman.
NSString *eventCodeWithPage = @"your_event_code";
NSString *page_name = @"homepage";
[[QuickTrackingSDK sharedInstance] event:eventCodeWithPage page_name:page_name];

// Lacak acara dengan kode halaman dan atribut acara
NSString *eventCodeWithPageWithProperties = @"your_event_code";
NSString *page_name = @"settings_page";
NSDictionary *properties = @{
    @"button_name": @"save_settings",
    @"user_id": @"test"
};
[[QuickTrackingSDK sharedInstance] event:eventCodeWithPageWithProperties page_name:page_name properties:properties];

9. Lainnya

9.1 untuk menonaktifkan SDK

Setelah Anda memanggil operasi ini, SDK tidak mengumpulkan acara dan tidak mengirim permintaan jaringan.

Fungsi antarmuka:

// Nonaktifkan SDK.
+(void)disableSDK;

Contoh:

[QuickTrackingSDK disableSDK];

9.2 aktifkan SDK

Jika SDK dinonaktifkan, fitur pengumpulan data dipulihkan setelah SDK dipanggil.

Fungsi antarmuka:

// Aktifkan SDK.
+(void)enableSDK;

Contoh:

[QuickTrackingSDK enableSDK];