Pinpoint

17min

Summary
Official websites
Site
URL
Website
﻿https://aws.amazon.com/pinpoint/﻿
Documentation
﻿https://aws.amazon.com/de/developer/﻿
Documentation (Pinpoint)
﻿https://docs.aws.amazon.com/pinpoint/latest/userguide/welcome.html﻿
Developer integrations
Platform
URL
Android
﻿https://github.com/aws-amplify/aws-sdk-android﻿
iOS
﻿https://github.com/aws-amplify/aws-sdk-ios﻿
Web
﻿not supported by Purple﻿
Tracking service
Event support matrix
Overview of the supported events and their configuration.
﻿
Templates
Parameter
﻿Actions﻿
﻿action﻿
﻿supported﻿
﻿Purchases﻿*﻿
﻿none﻿
﻿not supported﻿
﻿Attributes﻿
﻿name﻿
﻿not supported﻿
﻿Views are not supported.
﻿*) Tracking of Purchases is not supported in a freely configurable way. More detailed information can be found below in the description of the event configuration for purchases.
General structure in tracking_config.json
Tracking service key name in "tracking_config.json" is:
"pinpoint"
General structure
{
  
  "pinpoint": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": false,
    "purchasesEnabledByDefault": true,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {},
    
    "purchases": {
      // your configured list of events
    },
    
    "attributes": {
      // your configured list of attributes
    } 
    
  }
  
}
{
  
  "pinpoint": {
    "eventsEnabledByDefault": true,
    "viewsEnabledByDefault": false,
    "purchasesEnabledByDefault": true,
    "attributesEnabledByDefault": true,
    
    "events": {
      // your configured list of events
    },
    
    "views": {},
    
    "purchases": {
      // your configured list of events
    },
    
    "attributes": {
      // your configured list of attributes
    } 
    
  }
  
}
﻿
Event configuration
Actions
Pinpoint support action events.
Action event
Example
"ISSUE_DOWNLOADED": {
  "templates": {
    "action": "issue_downloaded_{{ISSUE_NAME}}"
  }
}
"ISSUE_DOWNLOADED": {
  "templates": {
    "action": "issue_downloaded_{{ISSUE_NAME}}"
  }
}
﻿
Views
Pinpoint does not support view events.
Purchases
Pinpoint does not support custom purchase events, but purchases can still be tracked and it is recommend configuring the purchase events.
Purchase event
Example
"STOREFRONT_SUBSCRIPTION_PURCHASED": {
  "templates": {}
}
"STOREFRONT_SUBSCRIPTION_PURCHASED": {
  "templates": {}
}
﻿
Templates
Pinpoint offers a limited API to track purchases. Thus only the following data is sent:
API
Value
﻿quantity﻿
1
﻿productId﻿
The product id of the purchase.
﻿itemPrice﻿
The price of the product.
﻿currency﻿
The currency of the price.
As a result, no template needs to be configured. 
Attributes
Pinpoint support attributes.
Attribute
Example
"attribute_key": {
  "templates": {
    "name": "value of template"
  }
}
"attribute_key": {
  "templates": {
    "name": "value of template"
  }
}
﻿
Additional supported functionality
Push
﻿https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-push.html﻿
This feature is enabled as provided by Pinpoint.
How to configure
Native Purple App
Any native Tracking Service is configured in the Purple Manager.﻿
Enable SDK
Settings location
"Your app" => "Consent/Push/Analytics" => "Analytics (General/iOS/Android/Web)"
Setting
Description
Enable Pinpoint
To enable the Pinpoint SDK in your app, activate this checkbox.
Amazon Pinpoint Configuration-JSON
The aws configuration file. This file is provided by Pinpoint.
Apple privacy / ATT
Settings location
"Your app" => "Consent/Push/Analytics" => "Privacy"
Consent management
Settings location:
"Your app" => "Consent/Push/Analytics" => "Consent Management"
Setting
Description
Vendor-ID for Pinpoint
The Vendor-ID is provided by the consent management platform.
Web integration
Purple does not support Pinpoint web integration.

Site	URL
Website	https://aws.amazon.com/pinpoint/
Documentation	https://aws.amazon.com/de/developer/
Documentation (Pinpoint)	https://docs.aws.amazon.com/pinpoint/latest/userguide/welcome.html

Platform	URL
Android	https://github.com/aws-amplify/aws-sdk-android
iOS	https://github.com/aws-amplify/aws-sdk-ios
Web	not supported by Purple

	Templates	Parameter
Actions	action	supported
Purchases*	none	not supported
Attributes	name	not supported

API	Value
quantity	1
productId	The product id of the purchase.
itemPrice	The price of the product.
currency	The currency of the price.

Setting	Description
Enable Pinpoint	To enable the Pinpoint SDK in your app, activate this checkbox.
Amazon Pinpoint Configuration-JSON	The aws configuration file. This file is provided by Pinpoint.

Setting	Description
Vendor-ID for Pinpoint	The Vendor-ID is provided by the consent management platform.

Updated 19 Jul 2024

Did this page help you?

Matomo

Tracking Configuration