AsyncAPI for integration service 0.0.1 documentation
- Protobuf File Spec: ecommerce.proto
Published Messages (dlcSync)
The service publishes one of these messages below.
dlcSynced
Message is sent when a user's dlc is fulfilled or revoked. Contains fields from event and the following payload.
Example value
{
"payload": {
"dlc": {
"dlcId": "string",
"namespace": "string",
"obtainedAt": "2019-08-24T14:15:22Z",
"platform": "EPICGAMES",
"revokedAt": "2019-08-24T14:15:22Z",
"sources": [
"string"
],
"status": "FULFILLED",
"thirdPartyId": "string",
"transactionId": "string",
"userId": "string",
"version": 0
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
payload
Name | Type | Description |
---|---|---|
dlc | object | - |
payload.dlc
Name | Type | Description |
---|---|---|
dlcId | string | accelbyte dlc id |
namespace | string | namespace |
obtainedAt | string (date-time) | time when the dlc is obtained |
platform | string | dlc platform |
revokedAt | string (date-time) | time when the dlc is revoked |
sources | array | service labels for PSN |
status | string | dlc status |
thirdPartyId | string | third party (see 'platform') product id |
transactionId | string | accelbyte transaction id |
userId | string | accelbyte user id |
version | integer | dlc version |
Published Messages (iapConfigManagement)
The service publishes one of these messages below.
appleIAPConfigDeleted
Message is sent when apple IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
appleIAPConfigUpdated
Message is sent when apple IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
googleIAPConfigDeleted
Message is sent when google IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
googleIAPConfigUpdated
Message is sent when google IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
googleP12FileUpdated
Message is sent when google IAP certificate is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
playStationIAPConfigDeleted
Message is sent when psn IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
playStationIAPConfigUpdated
Message is sent when psn IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
steamIAPConfigUpdated
Message is sent when steam IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
steamIAPConfigDeleted
Message is sent when steam IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
xblIAPConfigDeleted
Message is sent when xbox IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
xblIAPConfigUpdated
Message is sent when xbox IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
xblBPCertFileUpdated
Message is sent when xbox IAP business partner cer is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
stadiaIAPJsonFileUpdated
This is deprecated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
stadiaIAPConfigDeleted
This is deprecated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
epicGamesIAPConfigDeleted
Message is sent when epic IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
epicGamesIAPConfigUpdated
Message is sent when epic IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
twitchIAPConfigUpdated
Message is sent when twitch IAP config is updated. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
twitchIAPConfigDeleted
Message is sent when twitch IAP config is deleted. Contains fields from event and the following payload.
Example value
{
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
id
This is a free-form object.
version
This is a free-form object.
name
This is a free-form object.
namespace
This is a free-form object.
parentNamespace
This is a free-form object.
timestamp
This is a free-form object.
clientId
This is a free-form object.
userId
This is a free-form object.
traceId
This is a free-form object.
sessionId
This is a free-form object.
Published Messages (iapNotification)
The service publishes one of these messages below.
notificationProcessed
The message is sent when AGS processes a valid Google or Apple IAP notification, such as when a subscription is renewed or refunded. For more Google/Apple notification details, please refer to the following links https://developer.android.google.cn/google/play/billing/rtdn-reference#sub-example & https://developer.apple.com/documentation/appstoreservernotifications/app_store_server_notifications_v2. Contains fields from event and the following payload.
Example value
{
"payload": {
"notification": {
"namespace": "string",
"userId": "string",
"notificationPlatform": "GOOGLE",
"notificationPayload": {},
"status": "PROCESSED",
"notificationType": "DID_CHANGE_RENEWAL_PREF"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
payload
Name | Type | Description |
---|---|---|
notification | object | - |
payload.notification
Name | Type | Description |
---|---|---|
namespace | string | AGS namespace |
userId | string | AGS user id. |
notificationPlatform | string | notification platform |
notificationPayload | object | notification payload |
status | string | status |
notificationType | string | notification type, Subscription/OneTimePurchase/VoidPurchase/Test/UNKNOWN belongs to Google Play, other belongs to Apple Store |
payload.notification.notificationPayload
This is a free-form object.
Published Messages (iapProcessing)
The service publishes one of these messages below.
iapProcessed
Message is sent when IAP order is fulfilled. Contains fields from event and the following payload.
Example value
{
"payload": {
"iap": {
"iapOrderNo": "string",
"namespace": "string",
"userId": "string",
"productId": "string",
"transactionId": "string",
"status": "VERIFIED",
"statusReason": "string",
"region": "string",
"language": "string",
"quantity": 0,
"sandbox": true,
"type": "APPLE",
"fulfilledTime": "2019-08-24T14:15:22Z",
"price": 0,
"currency": "string"
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
payload
Name | Type | Description |
---|---|---|
iap | object | - |
payload.iap
Name | Type | Description |
---|---|---|
iapOrderNo | string | iap order number |
namespace | string | namespace |
userId | string | user id |
productId | string | product id |
transactionId | string | transaction id |
status | string | status |
statusReason | string | reason of current status |
region | string | country value from ISO countries |
language | string | language value from language tag |
quantity | integer | number of items |
sandbox | boolean | a flag indicates whether the user has sanbox permission |
type | string | IAP type |
fulfilledTime | string (date-time) | time when fulfillment is completed |
price | number (double) | - |
currency | string | - |
Published Messages (iapItemConfigManagement)
The service publishes one of these messages below.
iapItemConfigUpdated
The message will be sent when AGS item mapping with third party platform is updated. Contains fields from event and the following payload.
Example value
{
"payload": {
"iapItemConfig": {
"namespace": "string",
"data": [
{
"itemIdentityType": "ITEM_SKU",
"itemIdentity": "string",
"platformProductIdMap": {
"property1": "string",
"property2": "string"
}
}
]
}
},
"id": "string",
"version": 0,
"name": "string",
"namespace": "string",
"parentNamespace": "string",
"timestamp": "2019-08-24T14:15:22Z",
"clientId": "string",
"userId": "string",
"traceId": "string",
"sessionId": "string"
}
payload
Name | Type | Description |
---|---|---|
iapItemConfig | object | - |
payload.iapItemConfig
Name | Type | Description |
---|---|---|
namespace | string | AGS namespace |
data | array<object> | Array of item mapping between AGS item and third party item |
payload.iapItemConfig.data[number]
Name | Type | Description |
---|---|---|
itemIdentityType | string | AGS item identity type, can be item id or sku |
itemIdentity | string | AGS item identity |
platformProductIdMap | object | Map that contains third party id and third party product id. The key will be third party id eg. XBOX, PLAYSTATION, APPLE, GOOGLE, etc. |
payload.iapItemConfig.data[number].platformProductIdMap
This is a free-form object.
Schemas
event
Name | Type | Description |
---|---|---|
id | string | event id |
version | integer | - |
name | string | event name |
namespace | string | event namespace |
parentNamespace | string | - |
timestamp | string (date-time) | - |
clientId | string | client id |
userId | string | the operator id |
traceId | string | trace id |
sessionId | string | session id |