This feature is in BETA version. For more information, contact your Customer Success Representative.
Insider Growth Management Platform (GMP) enables marketers to craft and deliver highly personalized customer journeys across various channels by leveraging unified data. With the Insider Export Integration, you can effortlessly sync multiple data types to Insider GMP, ensuring that the most up-to-date and comprehensive information powers your marketing efforts. The types of data you can sync include:
- User Attributes: Key information about your users, such as demographics, preferences, and behaviors.
- User Events: Actions and interactions your users have taken across your platforms.
- User Segments/Audiences: Groups of users that are categorized based on specific criteria and behaviors.
This synchronization enables you to harness the full potential of Insider GMP's capabilities, driving more effective and efficient marketing strategies.
In this documentation, we will guide you through the setup, configuration, and usage of the Insider GMP Export Integration, providing you with everything you need to start syncing your data with Insider GMP.
- Basic knowledge of Treasure Data
- Basic knowledge of Insider GMP
- Login credentials for your Insider Access
This integration uses batched requests to support high-volume data transfers to the vendor. Requests are queued until one of the following thresholds is met to deliver the data to Insider GMP:
- Maximum number of requests: 1000
- Maximum time since oldest request: 10 minutes
- Maximum size of requests: 5 MB
The maximum number of custom attributes Insider GMP allows is 255. You can't sync new attributes if your tenant has reached this number. To delete existing attributes from your tenant's data schema, contact Insider GMP's support.
Data Retention Policy for Custom Events: Insider stores custom events for three months by default. This means any custom events older than three months will be deleted unless you contact Insider support to increase the TTL. If you need to sync custom events that are older than three months, ensure you request a TTL extension from Insider.
The following data types are not allowed for user attributes and event parameters:
Json objects
An array of json objects
An array of booleans
An atrray of mixed types
You must create and configure the data connection in Treasure Data. As part of the data connection, you provide authentication credentials to access the integration.
Open the TD Console.
Navigate to Integrations Hub > Catalog.
Select the search icon on the far right of the Catalog screen, and type Insider.
Hover over the Insider catalog image and select Create Authentication.
Enter the required credentials.
Select Continue.
Enter a name for your connection.
Select **Done.**
| Field | Description |
|---|---|
| API Key | An API key is required to authorize your request. For information on generating a token, see the API Authentication Tokens guide. Ensure you generate a "UCD (Unified customer database)" API Key. |
| Partner Name | To copy and paste your partner name, navigate to Inone > Inone Settings > Account Preferences. |
The TD Console supports multiple ways to export data. Complete the following steps to export data from the Data Workbench.
- Navigate to Data Workbench > Queries.
- Select New Query, and define your query.
- Select Export Results to configure the data export.
- Select an existing Insider authentication or create a new one.
- Configure the exporting parameters as described below, and select Done.
The following table describes the configuration parameters for the Insider export integration.
| Field | Description |
|---|---|
| Export Mode |
|
| Attribute Operation | With the User Attributes export mode, select one of the supported attribute operation modes:
|
Audiences Operation | The User Audience export mode allows you to manage audience lists for users with three distinct options:
These options provide flexibility in managing which audience lists users are associated with, allowing for precise control over audience segmentation. |
| Custom Identifier Fields | The Custom Identifier Fields configuration allows users to specify custom identifiers for all export modes in addition to the default identifier:
|
| Enable triggering the data stream | Check this box to enable the triggering of live segments and campaigns in Insider GMP as part of the data synchronization process. |
| Skip invalid records | Check this box to enable the integration to continue syncing and ignore records that fail due to validation errors. If unchecked, the integration will halt the job upon encountering any failed records. |
To export data successfully, when defining your query, please make sure you follow the data specs/requirements:
- Requirement: All export modesThere must be at least one identifier (either default or custom) for
- Using Custom Identifiers: For a custom identifier to be valid, please do the following steps:
- Define a custom attribute in Insider's data schema.
- Define that custom attribute as a custom identifier in Insider's Identity Resolution Settings (may require contacting Insider's support to enable this).
- Input the custom identifier in the Custom IdentifierFieldsconfiguration.
- Insider has reserved a list of default user attributes, default events, and default event parameters. These naming conventions ensure consistency and compatibility with Insider GMP's API contact.
- Specifications:
- Follow the default data schema specs carefully regarding column name, data type, data format, and which fields are required.
- Refer to the official documentation for details on the default data schema:
- Default user attribute and default event parameters: Upsert User Data API
- Default event list: Default Events
- All column names should be in lowercase and may include underscores.
- All column names should match the regex pattern:
^[a-z][a-z0-9_]*$
- Requirement: If the query data columns include any fields that are not part of the default data schema (default user attributes, default events, and default event parameters), they will be synced to Insider GMP as custom user attributes (for User Attributes export mode) and custom event parameters (for User Events export mode).
- Requirement: When using User Audience export mode, only two default attributes can be used to sync:
td_audience_id(array of numbers)td_audience_name(array of strings)
- Specification: Ensure that the length of both attributes is equal.
- Requirement: For array data type columns (array of strings or array of numbers), ensure the column value is formatted correctly:
- Strings: Format the array as
['a', 'b', 'c']with each string enclosed in single quotes and separated by commas within square brackets. - Numbers: Format the array as
[1, 2, 3]with each number separated by commas within square brackets.
- Strings: Format the array as
- Specification: This precise format allows the integration to correctly parse and interpret the data as arrays of strings or numbers. Misformatted arrays may result in synchronization errors or misconstrued data.
The TD Toolbelt can trigger the Query Result exporting from a CLI. You need to specify the parameters for the exporting job using the --result option of the td query command. For more information, please refer to this article.
The format of the option is JSON, and the general structure is as follows.
Case: User Attributes{ "type": "insider", "api_key": "api_key", "partner_name": "partner_name", "export_mode": "USER_ATTRIBUTES", "attribute_operation": "UPSERT", "custom_identifier_fields": "custom_identifier_1,custom_identifier_2", "trigger_data_stream": false, "skip_invalid_records": false}Case: User Events{ "type": "insider", "api_key": "api_key", "partner_name": "partner_name", "export_mode": "USER_EVENTS", "custom_identifier_fields": "custom_identifier_1,custom_identifier_2", "trigger_data_stream": false, "skip_invalid_records": false}Case: User Audiences{ "type": "insider", "api_key": "api_key", "partner_name": "partner_name", "export_mode": "USER_AUDIENCES", "audience_operation": "APPEND", "custom_identifier_fields": "custom_identifier_1,custom_identifier_2", "trigger_data_stream": false, "skip_invalid_records": false}| Name | Description | Value | Default Value | Required |
|---|---|---|---|---|
| type | The destination of the export. | String: always "insider" | Yes | |
| api_key | Insider uses authentication to validate and process the incoming API calls. An API key is a unique code used to authenticate the API call where you are requesting a response. | String | Yes | |
| partner_name | The partner name generated in Insider | String | Yes | |
| export_mode | The mode for export | Enums - USER_ATTRIBUTES - USER_EVENTS - USER_AUDIENCES | USER_ATTRIBUTES | Yes |
| attribute_operation | The operation for user attributes | Enums - UPSERT - DELET_ATTRIBUTES - REPLACE_ATTRIBUTES - DELETE_IDENTIFIERS - DELETE_PII | UPSERT | Yes (if export_mode is USER_ATTRIBUTES) |
| audience_operation | The operation for user audiences | enums - APPEND - REPLACE - REMOVE | APPEND | Yes (when export_mode is USER_AUDIENCES) |
| custom_identifier_fields | Custom identifier fields This must be comma-separated lowercase values without spaces | String | No | |
| trigger_data_stream | The indicator flag to trigger a real-time campaign/segment in the Insider InOne Portal | Boolean | false | No |
| skip_invalid_records | The indicator flag to skip invalid records which are failed TD validation or Insider validation The process will be successful if enabled, although no valid records were provided. | Boolean | false | No |
| No | Case | Example |
|---|---|---|
| 1 | Upsert user attributes | td query \--database ${database_name} \--wait "SELECT * FROM ${table_name}" \--type presto \--result '{"type":"insider","api_key":"api_key","partner_name":"partner_name","export_mode":"USER_ATTRIBUTES","attribute_operation":"UPSERT","custom_identifier_fields":"custom_identifier_1,custom_identifier_2","trigger_data_stream":false,"skip_invalid_records":false}' |
| 2 | Upload user events | td query \--database ${database_name} \--wait "SELECT * FROM ${table_name}" \--type presto \--result '{"type":"insider","api_key":"api_key","partner_name":"partner_name","export_mode":"USER_EVENTS","custom_identifier_fields":"custom_identifier_1,custom_identifier_2","trigger_data_stream":false,"skip_invalid_records":false}' |
| 3 | Append user audiences | td query \--database ${database_name} \--wait "SELECT * FROM ${table_name}" \--type presto \--result '{"type":"insider","api_key":"api_key","partner_name":"partner_name","export_mode":"USER_AUDIENCES","audience_operation":"APPEND","custom_identifier_fields":"custom_identifier_1,custom_identifier_2","trigger_data_stream":false,"skip_invalid_records":false}' |
- You can create an activation in the Audience Studio to export segment data to this integration.
- You can use Scheduled Job with Result Export to periodically upload data to a target destination.