Google Cloud Platform (GCP)

πŸ“˜

What's New

CleverTap now supports adding multiple Google Cloud buckets and exporting data to respective buckets on the Google Cloud Platform (GCP).

Overview

The GCP Export feature enables you to bulk export your CleverTap event or profile data to a GCP bucket. You can export your CleverTap data to analyze it with Business Intelligence (BI) tools or store it in your data warehouse for future analysis.

πŸ“˜

Note

For more information and enable this feature for your account, contact your account manager at CleverTap.

Integrate GCP with CleverTap

The integration involves the following steps:

  1. Create a Service Account for your Project.
  2. Create a Bucket.
  3. Configure CleverTap Dashboard.

Create a Service Account for your Project

To create a service account:

  1. Log in to your GCP account and select the project where you want to export your CleverTap data. Create a new project if you do not have a project.
  2. From the left panel, select IAM and then navigate to Admin > Service Accounts.
  3. Create a new Service Account linked to the selected project and enter the Service account name and description, respectively.
    This is the account that you will use to authenticate and authorize CleverTap to upload exports to your GCP project.
2880

Create a New Service Account

  1. Navigate to Permissions > Storage Admin and continue.
2880

Navigate to Storage Admin

  1. Click + Create Key and select JSON for the Service account.
    The JSON key downloads to your machine automatically. Save this key because you will have to upload the key to the CleverTap dashboard later.
2880

Create Key

Create a Bucket

Create a bucket that will hold the export files from CleverTap. To do so:

  1. From the left panel, navigate to Storage and click Create Bucket.
2280

Navigate to Storage Browser from GCP Dashboard

On clicking, Create a bucket page opens.

  1. Name your bucket and fill in the other details as per your requirements.
2880

Enter your Bucket Details and Create a Bucket

  1. Click Create. Following is an image for a successfully created bucket:
2880

Bucket Created Successfully

Configure CleverTap Dashboard

Add the Service account credentials (created in Step 1 and bucket name to CleverTap. To configure the dashboard:

  1. Navigate to Settings > Partners from the CleverTap dashboard.
2848

Navigating to Partners

  1. Hover on the Google Cloud icon and click Integrate.
2400

Integrate Google Cloud

The Integrate analytics partner - Google Cloud window opens on the right side of the screen.

  1. Click + Google Cloud Bucket to add a bucket. You can also add multiple buckets from this popup.
  2. Enter the following details and click Save Credentials:
FieldDescription
Bucket nicknameEnter the nickname for your bucket.
Service Account KeyEnter the contents of the downloaded Service Account Key JSON file (obtained in Step 1) into the Service Key.
Bucket nameAdd the name of the bucket as given in the project.
2358

Enter Google Cloud Bucket Details

🚧

Error When Saving Credential

  1. Check if the bucket name is the same as in GCP. Bucket names need to be an exact match.
  2. Generate the Service Account key again, copy and paste the new key into the Service Account Key field on the Integrate analytics partner - Google Cloud window.
2540

Service Account Key

After successful integration, the Integrated tag displays against Google Cloud on the Partner List page.

2372

Google Cloud Integration Successful

Create a New Data Export

To create a new data export:

  1. Navigate to Settings > Partners > Exports from the CleverTap dashboard.
  2. Click + Export and select Google Cloud from the partners dropdown.
2376

Create Export

The Export to Google Cloud window displays on the right side of the screen.

2452

Enter Export Details

  1. Configure the following settings:

    • Type: Select the events from the available options to export.

      • All events: Export data for all events that have been defined, that is, system and custom events.
      • Select events: Exports only specific events.
      • All user profiles: Exports all your user profile data.
        • Export Priority for Event Identity: Select priority for user identities when exporting data. User Identifiers will be exported based on selected priority. For more information, refer to the Prioritize User Identity for Exports section.
    • Frequency: Select the frequency of export.

      • Once only: A single export for the selected export type. You can export data up to the last 60 days. You create an export for a specific day, date range, previous month, current month, and more.
      • Recurring: Set up a recurring export to export all the new events or user profiles captured in the last window. You can export as frequently as every 4 hours and up to once every 24 hours.
    • Format: Select from the following export formats: JSON, XML, CSV, and Parquet. For more information, refer to Export Format.

🚧

Stop Recurring Profile Export to do One Time Export

Before running a one-time profile export, you must stop any scheduled recurring profile export.

  1. Click Export. On clicking, the popup closes, and the Google export has initiated message displays at the top of the Exports page. CleverTap processes the export, and you can now see the newly-created export for Google Cloud.
2392

Google Export Initiated

To confirm that your event data was successfully exported, select Storage from the left panel of Google Cloud. Navigate to the Bucket details page and search with the requestid (available under the Exports page of the CleverTap dashboard). All the exported files are displayed.

2862

New Google Export Displays on Google Cloud

Edit an Export

You might need to modify an export to meet specific business requirements or while waiting for the next run. This section describes editing a Live Data Streaming and Recurring export in the Running and Pending (awaiting next run) state.

πŸ“˜

Points to Remember

  • In case of running exports, the new changes will apply to the next run.
  • You cannot edit a One-time export, regardless its status (running, pending, completed, or stopped).
  • You cannot change the export from User Profile to Event and vice-versa.
  • You cannot modify exports marked as Completed or Stopped.
  • Export changes for Live DataStreaming take 10-15 minutes to take effect.

To edit an export:

  1. On the CleverTap dashboard, go to Partners > Exports.
Ellipsis Icon to Edit the Export

Ellipsis Icon to Edit the Export

  1. Click the Ellipsis icon. The Edit and the Stop buttons appear.
Click the Edit Export Icon

Click the Edit Export Icon

  1. Click the Edit button. The Overview section appears.
Edit the Export

Edit the Export

  1. Edit the export details and click Update.

Export Format

This section provides information about the file format and the name format of the files being exported to the Google Cloud bucket.

File Name Format

  • File Name Format for Event Export
    The example below shows the file name format for event export:
    • Export request ID: Indicates the export request ID generated when you create a request in the CleverTap dashboard.
    • Timestamp of the export run: Indicates when the export was run.
    • Event name: Indicates the event type that is included in the file.
    • File index: We chunk the data across multiple files for larger exports. We limit file sizes to 100 MB chunks to make them more consumable. The file index indicates the file number in the file series.
    • Database ID: Indicates the database ID of the CleverTap from where the file was exported.
    • File format: Indicates the format of the file exported to the GCP bucket.
<export request id>-<timestamp of the export run>-<event name>-<yyyymmdd>-<file index>-<database-id>.json
  • File Name Format for User Profile Export:
    The example below shows the file name format for user profile export:
    • Account ID: Indicates the integer value for your CleverTap project ID.
    • Request ID: Indicates the export request ID generated when you create a request in the CleverTap dashboard.
    • Timestamp of the export run: Indicates when the export was run.
    • Database ID: Indicates the database ID of the CleverTap from where the file was exported.
    • File format: Indicates the format of the file exported to the GCP bucket.
<account id>-<request id>-<timestamp of the export run>-<database-id>-<file format>.gz

File Data Format

Export files are split by event names and date range for the specified event.

JSON

The first line of the file contains the event name. After the first line, each line is JSON describing the timestamp, object id, and event properties.

{
	"profile": {
		"identity": "dqsndckfk234"
	},
	"ts": 20171109000015,
	"eventProps": {
		"ct_connected_to_wifi": "false",
		"ct_bluetooth_version": "ble",
		"ct_bluetooth_enabled": "false",
		"ct_sdk_version": 30107,
		"ct_latitude": -6.1975594,
		"ct_longitude": 106.52913,
		"ct_os_version": "5.1.1",
		"ct_app_version": "2.30.1",
		"ct_network_carrier": "3",
		"ct_network_type": "4G"
	}
}

CSV

CSV files are comma-delimited and have each event in separate rows.

XML

XML files have the timeStamp, and eventName, followed by eventProperties.

<Event>
    <ts>20200220130735</ts>
    <eventName>Export Custom Event</eventName>
    <profile>
        <all_identities>[email protected]</all_identities>
        <platform>Web</platform>
        <email>[email protected]</email>
    </profile>
    <deviceInfo>
        <browser>Others</browser>
    </deviceInfo>
    <eventProps>
        <entry>
            <key>CT Source</key>
            <value>API</value>
        </entry>
        <entry>
            <key>Category</key>
            <value>Mens Watch</value>
        </entry>
        <entry>
            <key>Product name</key>
            <value>Casio Chronograph Watch</value>
        </entry>
        <entry>
            <key>Price</key>
            <value>59.99</value>
        </entry>
        <entry>
            <key>Currency</key>
            <value>USD</value>
        </entry>
    </eventProps>
</Event>

Parquet

Parquet has a timestamp, eventName, and eventProperties for each event.

πŸ“˜

Parquet File Format

Parquet is an open-source file format for Hadoop. Parquet stores nested data structures in a flat columnar format.

Prioritize User Identity for Exports

The export file includes an identity column with the user's Identity, Phone Number, or Email values. These values are set based on the identities configured in the CleverTap dashboard under the Settings > User Identity page. This feature lets you prioritize the identifier you want to export in the identity column.

Let us understand how the prioritization works based on the identities selected in the User Identity page:

  • If you select only Identity, export includes the identity value. The export file's identity column is empty if it is unavailable.
  • If you select multiple identifiers, you must set the priorities on the Export page. For instance, you set Priority 1 to Identity and Priority 2 to Email ID. When exporting data, the export prioritizes the Identity value for the identity column. If it is absent, the Email ID is exported under the identity column of the export file. If both are missing, the column remains empty.

πŸ“˜

Key Points to Remember

  • If you change the identity later, the export works according to the set priority. To prioritize the modified identities, edit your export.
  • This feature applies only to the following export types: All events and All user properties.
  • For the old running export, this configuration or prirotization is not applicable. You can add the prioritization by editing the running exports.

To prioritize user identity for exports:

  1. Go to Partners > Exports.
  2. Click Exports > GCP.
  3. Under Export Priority for Event Identity, click + Priority.
  4. Set up the Priority 1, 2, and 3 for the required identities from the drop-down list.
  5. Click Export.
Prioritize User Identities for Exports

Prioritize User Identities for Exports

FAQs

Q. How to secure the data exports from CleverTap to GCP?

A. You can whitelist IPs to ensure that CleverTap will only have access to push data to your GCP bucket. To get the list of whitelisted IP ranges, refer to the CleverTap IP Ranges documentation.

Q. How to resolve a 403: retentionPolicyNotMet error during data export to GCP?

A. A 403: retentionPolicyNotMet error can occur when exporting data to GCP. It could be because of a locked retention policy. To resolve this error:

  1. Open the GCP Console.
  2. Go to Menu > Cloud Storage > Buckets.
  3. Select the required bucket.
  4. Go to the Protection tab.
  5. Check the Retention policy (for compliance) section. If any policy is active, the Edit, Delete, and Lock icons are enabled.
  6. Click the Delete icon to delete the retention policy. If the Delete icon is not enabled, the retention policy is locked on the bucket. In this case, you have no option but to change the bucket to which CleverTap uploads export data.

Q. Do CleverTap data exports allow special characters?

A. Yes, CleverTap data exports allow the following special characters:

  • Supports Unicode (UTF-8) character encoding. It facilitates the accurate representation of text in various languages and scripts. For example, Indian regional languages, Arabic, Korean, Russian, Japanese, Chinese, Spanish, Greek, Indonesian, etc.
  • Replaces the following characters with a hyphen to avoid issues in output file generation: Whitespace, Tab, Slash, and null (\0).
  • Replaces control characters with ?. For more information, refer to Control Character.
  • Supports emoji characters; however, some emojis (UTF-16) may not render properly.