Quick Tracking:Memperkenalkan dan mengonfigurasi SDK

Informasi dasar SDK

Petunjuk Pengoperasian

1. Integrasi cepat

Di latar belakang QuickTracking, kode integrasi khusus dihasilkan untuk setiap mini program, yang dapat diintegrasikan sesuai dengan panduan dalam produk tersebut.

Jalur Produk

Quick Tracking > "Home" > "management console". Pada "management console", buka fungsi "organization list". Daftar organisasi menampilkan organisasi yang telah dibuat. Temukan organisasi tempat aplikasi berada, lalu klik fungsi "management application" untuk menuju halaman "application management". Klik aplikasi yang telah dibuat untuk masuk ke bagian "integration".

Klik tombol "Deintegrate" untuk melompat ke halaman baru guna mendapatkan kode integrasi khusus. Klik Selanjutnya dan ikuti panduan untuk masuk ke "Verifikasi Integrasi" untuk memeriksa apakah integrasi berhasil.

2 Detail kode integrasi

Jika halaman sebelumnya tidak dapat dicapai karena alasan tertentu, Anda perlu merujuk dokumen terlebih dahulu sebelum melakukan integrasi. Kode integrasi spesifik adalah sebagai berikut:

2.1 Persiapan Parameter

appkey: Diperoleh dari daftar aplikasi.

Nama domain pengumpulan: Diperoleh di modul "Konsol Manajemen-Informasi Pengumpulan".

Tautan SDK: Diperoleh di modul Konsol Manajemen-Informasi Pengumpulan.

2.2 Pengenalan SDK

Klik tautan SDK untuk mengimpor file JS di tautan ke proyek. (Jalur impor yang direkomendasikan adalah src/utils).

const aplusConfig = {
  metaInfo: {
    'appKey': "", // Appkey yang Anda masukkan saat membuat aplikasi di sistem platform. Parameter ini diperlukan.
    'trackDomain': "", // Diperlukan. Nama domain untuk pengumpulan dan pelaporan log.
    'DEBUG': true, // Menentukan apakah akan menampilkan log pengumpulan.
  },
};
// Setelah fungsi initQTSDK dieksekusi, SDK dipasang di bawah konteks mini program, seperti WeChat wx, byte tt, dan Alipay my.
// Variabel lingkungan aplus dan aplus_queue
import { initQTSDK } from "./utils/qt_mini.umd.js";
initQTSDK(aplusConfig);

Catatan: Tempatkan kode inisialisasi di file entri, bukan di fungsi siklus hidup.

2.3 Atur ID Perangkat

Karena pembatasan kerangka kerja mini program, QuickTracking SDK tidak secara otomatis menghasilkan ID perangkat apa pun. Anda perlu memberi otorisasi kepada pengembang untuk secara otomatis mendapatkan openid, atau secara manual mengunggah ID resmi mini program seperti openid/unionid sebagai ID perangkat. Jika tidak, QT SDK tidak akan dapat melaporkan log apa pun.

Anda dapat menggunakan salah satu metode berikut untuk mengunggah data secara manual:

Catatan: Contoh kode digunakan untuk memanggil mini program WeChat. Mini program lain memiliki logika platform yang serupa.

const aplusConfig = {
  metaInfo: {
  ... // Konfigurasikan SDK.
  '_hold': 'BLOCK' // Pelaporan log diblokir hingga openid dan unionid diperoleh.
  ... // Konfigurasikan SDK.
  }
};
// Setelah fungsi initQTSDK dieksekusi, SDK dipasang di bawah konteks mini program, seperti WeChat wx, byte tt, dan Alipay my.
// Variabel lingkungan aplus dan aplus_queue
import { initQTSDK } from "./utils/qt_mini.umd.js";
initQTSDK(aplusConfig);

wx.login({
  success: (res) => {
    // Gunakan code untuk menukar OpenID.
    if (res.code) {
      wx.request({
        url: antarmuka yang digunakan oleh backend di sisi layanan pelanggan untuk mendapatkan openid,
        method: "post",
        data: {
          code: res.code,
        },
        success: (res) => {
          if (res.data && res.data.openid) {
            // Simpan OpenID yang diperoleh ke storage untuk penggunaan selanjutnya.
            wx.setStorageSync("openId", res.data.openid);
            wx.setStorageSync("unionId", res.data.unionid);

            wx.aplus_queue.push({
              action: "aplus.setMetaInfo",
              arguments: ["_anony_id", res.data.openid],
            });
          } else {
            wx.aplus_queue.push({
              action: "aplus.setMetaInfo",
              arguments: ["_anony_id", pseudo-id yang diimplementasikan di sisi bisnis],
            });
          }
        },
      });
    }
  },
  fail: () => {
    // Pesan kegagalan.
  },
  complete: () => {
    wx.aplus_queue.push({
      action: "aplus.setMetaInfo",
      arguments: ["_hold", "START"],
    });
  },
});

Contoh berikut menunjukkan cara otomatis mendapatkan OpenID mini program WeChat:

Saat ini, QuickTracking mendukung pengumpulan otomatis openid mini program WeChat, yang perlu diotorisasi di dalam Produk. Metode otorisasi adalah sebagai berikut. Klik dan isi konten sesuai kebutuhan.

Setelah diberi otorisasi, atur mode kode ID perangkat menjadi:

const aplusConfig = {
  metaInfo: {
  ... // Konfigurasikan SDK.
  'autoGetOpenid': true // Aktifkan pengumpulan otomatis OpenID  
  ... // Konfigurasikan SDK.
  }
};

// Setelah fungsi initQTSDK dieksekusi, SDK dipasang di bawah konteks mini program, seperti WeChat wx, byte tt, dan Alipay my.
// Variabel lingkungan aplus dan aplus_queue
import { initQTSDK } from './utils/qt_mini.umd.js';
initQTSDK(aplusConfig);

Jika openid manual telah digunakan sebelumnya, dan sekarang Anda ingin beralih ke QuickTracking di atas untuk secara otomatis mengumpulkan openid mini program WeChat, Anda juga perlu memperhatikan hal berikut:

1. Hapus logika pelaporan blokir SDK with_hold=BLOCK di metainfo.

2. Komentari kode logika untuk menyetel "_anony_id=openid" secara manual sebelumnya, yaitu hapus kode untuk mendapatkan openid dari wx.login.

3. Perhatikan bahwa penting untuk memastikan bahwa konten tentang menyetel appKey dan nama domain penerima tidak terpengaruh.

Contoh kode adalah sebagai berikut:

// di dalam app.js
const aplusConfig = {
  metaInfo: {
  ... // Konfigurasikan SDK.
  
  //1. Hapus logika pelaporan pemblokiran SDK dengan _hold=BLOCK
  //'_hold: 'BLOCK' // Pelaporan log diblokir hingga openid dan unionid diperoleh.
  
  ... // Konfigurasikan SDK.
  }
};
// Setelah fungsi initQTSDK dieksekusi, SDK dipasang di bawah konteks mini program, seperti WeChat wx, byte tt, dan Alipay my.
// Variabel lingkungan aplus dan aplus_queue
import { initQTSDK } from './utils/qt_mini.umd.js';
initQTSDK(aplusConfig);

/**
2. Hapus kode terkait pengambilan openid di wx.login.
wx.login({
  success: (res) => {
  // Gunakan code untuk menukar OpenID.
  if (res.code) {
  wx.request({
  url: antarmuka yang digunakan oleh backend di sisi layanan pelanggan untuk mendapatkan openid,
  method: "post",
  data: {
  code: res.code,
  },
  success: (res) => {
  if (res.data && res.data.openid) {
  // Simpan OpenID yang diperoleh ke storage untuk penggunaan selanjutnya.
  wx.setStorageSync("openId", res.data.openid);
  wx.setStorageSync("unionId", res.data.unionid);

  wx.aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['_anony_id', res.data.openid]
  });

  } else {
  wx.aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['_anony_id', pseudo-id yang diimplementasikan oleh sisi bisnis]
  });
  }
  },
  });
  }
  },
  fail: () => {
  // Pesan kegagalan.
  },
  complete: () => {
  wx.aplus_queue.push({
  action: 'aplus.setMetaInfo',
  arguments: ['_hold', 'START']
  });
  },
});
*/

2.4 nama domain daftar putih

Ambil mini program WeChat sebagai contoh: Masuk ke latar belakang mini program, pergi ke Pengaturan Pengembangan > Daftar Putih Nama Domain Server, dan tambahkan nama domain Anda ke daftar putih.

3 FAQ

3.1 Bagaimana cara saya mendapatkan SDK offline?

Setelah mendapatkan tautan SDK di modul informasi pengumpulan-Konsol Manajemen di latar belakang QuickTracking, klik tautan SDK dan "ctrl + s" atau "command + s" untuk mengunduh dan menyimpannya.