1.1 Installing the SDK #

Install with npm

npm install @datarangers/sdk-mp

1.2 Domain name configuration preparation #

Configure "Mini Program Background - Development - Development Settings - Server Domain Name", for details, please refer to the corresponding official documentation of the Mini Program.
Privatization business : Add the data reporting domain name of the private deployment to the "request legal domain name" in the background of the Mini Program. If you don't know this domain name, please contact your project manager or customer success manager.

2.1 Get the appid. #

• In the SaaS-cloud native scenario, you can find the corresponding application in "Project Center" > "Project Management" > "Project Details", click "Access Data", and view the application ID (APPID) and APP URL of the application in the application details. For details, please refer to Project Management.
  

2.2 Initializing the SDK example #

2.2.1 SaaS business #

//Initialize the SDK on the entry page
// app.js
import $$Rangers from '@datarangers/sdk-mp';

$$Rangers.init({
    app_id: 0000, //Replace with the app_id of the application, refer to Section 2.1 to obtain, note that the type is number rather than string
    log: true, //After opening, the console will print the log, which is helpful to view the event tracking report process during the development stage
    auto_report: true, //Some predefined events will be reported after opening, such as app_launch, app_terminate, etc
});
$$Rangers.config({
    mp_name: 'xyz Mini Program', //Some predefined properties can be set through config
    mp_version: '1.1.1',
});
$$Rangers.send();

App({
    onLaunch: function () {
        this.$$Rangers = $$Rangers;
    
        //If you want to set the user ID, such as using open_id to identify the user, you can set the value to user_unique_id after obtaining the open_id
        this.$$Rangers.config({
            user_unique_id: 'acquired open_id', //can be open_id, can also be union_id and other business sense can be used to identify the user uniqueness value
        });

        //Call the event method to report a specific event
        this.$$Rangers.event('test_event', {
            from: 'launch', //Supports arbitrary properties, values support numbers, strings, etc
        });
    }
});

Other pages report events, such as:
// pages/index/index.js
Page({
    onLoad() {
        getApp().$$Rangers.event('bind_view_tap', {
            'title': 'chart',
        });
    }
});

2.2.2 Privatization business #

Privatization requires a clear data reporting domain name. If you are unsure of this domain name, please contact your project manager or customer success manager.

//Initialize the SDK on the entry page
// app.js
import $$Rangers from '@datarangers/sdk-mp';

$$Rangers.init({
    app_id: 0000, //Replace with the app_id of the application, refer to Section 2.1 to obtain, note that the type is number rather than string
    channel_domain: "{{DOMAIN}}", //Set up a private deployment data upload domain name, if you don't know this address, please contact your project manager or customer success manager
    log: true, //After opening, the console will print the log, which is helpful to view the event tracking report process during the development stage
    auto_report: true, //Some predefined events will be reported after opening, such as app_launch, app_terminate, etc
});
$$Rangers.config({
    mp_name: 'xyz Mini Program', //Some predefined properties can be set through config
    mp_version: '1.1.1',
});
$$Rangers.send();

App({
    onLaunch: function () {
        this.$$Rangers = $$Rangers;
    
        //If you want to set the user ID, such as using open_id to identify the user, you can set the value to user_unique_id after obtaining the open_id
        this.$$Rangers.config({
            user_unique_id: 'acquired open_id', //can be open_id, can also be union_id and other business sense can be used to identify the user uniqueness value
        });

        //Call the event method to report a specific event
        this.$$Rangers.event('test_event', {
            from: 'launch', //Supports arbitrary properties, values support numbers, strings, etc
        });
    }
});
 
Other pages report events, such as:
// pages/index/index.js
Page({
    onLoad() {
        getApp().$$Rangers.event('bind_view_tap', {
            'title': 'chart',
        });
    }
});

3.1 init #

Supported initialization parameters

Example

//Parameter: InitParams
//return value: void
$$Rangers.init({
    app_id: 1338,
    log: true,
    auto_report: true,
    enable_ab_test: true,
    clear_ab_cache_on_user_change: true,
    // ...
});

3.2 config #

The config method can be called multiple times, and subsequent settings will overwrite the same property fields as before

Example

//Parameters: ConfigParams
//return value: void
$$Rangers.config({
    city: '南京', //Nanjing
    custom_name: 'vikings',
    // ...
});

3.3 send #

After the initialization setting is completed, the send method must be called before the SDK is truly initialized, and no data will be reported before.
Example

Parameters: None
//return value: void
$$Rangers.send();

3.4 event #

Incident reporting.
Event naming convention:

• Event naming only supports letters, numbers and underscores, do not use app_launch, app_terminate and other SDKs to automatically report event names
• It is recommended that event names and attributes be lowercase
• Event property values accept only number and string types
• Do not nest objects in event properties, that is, the property value does not accept the object type
• If you want to express the meaning of event property value null, it is recommended to use "be_null", not "or"

Example

//Parameters: name: string, params: object
//return value: void
$$Rangers.event('start_event', {
    start_time: 1630986183813,
    path: '...'
});