Create a data collection API

更新时间:
复制 MD 格式

Quick Audience integrates with Quick Tracking, an Alibaba Cloud user behavior analytics platform. This integration lets you collect user behavioral data from apps, Mini Programs, and web pages. The data is then synchronized to a specified Quick Audience data source for further analysis and operations. You can also use the collected user behaviors as events to trigger automated marketing tasks.

Note

You can also collect and report events to Quick Audience without using Quick Tracking. To do this, you can add scripts to your apps, Mini Programs, web pages, or third-party systems. These events can then be used for automated marketing. For more information, see Event Management.

The data collection flow using Quick Tracking is as follows:

  1. Configure the API for your data collection channels, such as an app, Mini Program, or web, and obtain an AccessKey. For instructions, see the sections below.

  2. Obtain the Quick Tracking software development kit (SDK). Use the AccessKey from the previous step to develop and deploy your data collection program. For the SDK and development specifications, see the Quick Tracking Developer Guide.

  3. Configure data return and log synchronization services. For more information, see Organization Settings.

  4. After processing, the collected user behavioral data is sent back to the data source configured in the previous step.

  5. In the User Insights module, use the data source to create a behavioral dataset. Then, use Behavior Filtering to create an audience for remarketing, which closes the loop for your marketing campaigns.

    Alternatively, you can configure the collected user behaviors as events to trigger automated marketing tasks.

Create an API

You can configure an API for a Quick Tracking data collection channel.

Applications with the same features on different platforms can be configured as a single channel. For example, you can configure the same Mini Program on WeChat and Alipay, the same app on Android and iOS, or the same web page loaded from different network domains as one channel.

Procedure:

  1. In the upper-right corner of the page, click image and choose Organization Management > API Management. Then, in the upper-right corner, click Create API > Create App API.

  2. Configure the parameters as described in the following table.

    Parameter

    Description

    Channel Name

    Enter a name for the data collection channel.

    Collected by Quick Tracking

    Select Yes.

    Do not select No. You do not need to configure this API if data is not collected by Quick Tracking.

    Application Type

    Select APP, Mini Program, or WEB.

    Platform Type Configuration

    For apps and Mini Programs, select the platform type, such as Android, iOS, WeChat mini program, or Alipay mini program.

    Click New Platform Configuration to add another platform type.

    Network Domain

    For web applications, enter the full network domain that starts with http or https.

    Click New Platform Configuration to add another network domain.

  3. Click OK to save the configuration.

Get an AccessKey and manage APIs

After you create the data collection API, a new record appears on the page, as shown in the following figure. You can obtain the AccessKey and APPKEY from the record for authentication in your data collection program.-q3

  • AccessKeyId: View and copy the ID.

  • AccessKeySecret: View, copy, and update the secret.

    Note

    After you update the AccessKeySecret, the previous secret becomes invalid. You must update your data collection program with the new AccessKeySecret.

  • Click Edit to modify the API configuration. The application type cannot be changed.

  • If you no longer need the API, click Remove to delete it.