DecodedRealtimeRequestBody
The decoded request body the App Store sends to your server to request a real-time retention message.
Declaration
object DecodedRealtimeRequestBodyProperties
| Name | Type | Description |
|---|---|---|
originalTransactionId Required | originalTransactionId | The original transaction identifier of the customer’s subscription. |
appAppleId Required | appAppleId | The unique identifier of the app in the App Store. |
productId Required | productId | The unique identifier of the auto-renewable subscription. |
userLocale Required | locale | The device’s locale. |
requestIdentifier Required | requestIdentifier | A UUID the App Store server creates to uniquely identify each request. |
environment Required | environment | The server environment, either sandbox or production. |
signedDate Required | signedDate | The UNIX time, in milliseconds, that the App Store signed the JSON Web Signature (JWS) data. |
Mentioned in
Discussion
The App Store server sends a request to your Get Retention Message endpoint that includes a RealtimeRequestBody. The DecodedRealtimeRequestBody is the decoded version of that request body.
The DecodedRealtimeRequestBody provides information you can use to select a retention message for display. The request includes the customer’s original transaction identifier, the product identifier, and their locale. Consider this information, along with your business logic, to choose the best retention message for the customer.
For more information, see Responding to real-time retention messaging requests.