post https://{publisher-server}/playerInfoSync
Player Data Sync V2 Webhook API
Response fields reference:
- status - request was valid / invalid, the value is Enum: valid / invalid.
- version - the used version 2.
- sessionMetadata - This entity serves as a versatile container for storing any pertinent information related to the player's session. It Will be sent back in the Player Orders Reporting web-hook, and Player Data Sync (if it's enabled). Can be of any data type.
- profileFrameId - This should correspond to the profile frame picture ID you upload to the asset library in Appcharge's dashboard; the frame picture will then be displayed above the user's profile picture.
- playerLevelName - This should align with the player level picture name / ID you upload to the asset library in Appcharge's dashboard; subsequently, the player level will be displayed alongside the footer.
- offers - The list of offers to show to the player
- offers.publisherOfferId - the publisher's offer id
- offers.productsSequence - the list of sequences in the offer. Only Daily Bonus offer can have more than 1 sequence.
- offers.productsSequence.index - the index of the sequence, index should always start from 1
- offers.productsSequence.playerAvailability - an object that contains the total and remaining number of times that the product can be purchased by the player. PlayerAvailability is supported only for Special Offers (Promotions).
- offers.productsSequence.playerAvailability.total - The total number of times that the product is available for the player. Type: int, should be greater than 0.
- offers.productsSequence.playerAvailability.remaining - The remaining number of times that the product is available for the player. Type: int, should be greater than or equal to 0.
- offers.productsSequence.products - the products in the sequence. Daily Bonus offers should have only 1 product per sequence.
- offers.productsSequence.products.publisherProductId - the product Id
- offers.productsSequence.products.quantity - the quantity of the product. Type: int, should be greater than 0.
- offers.productsSequence.products.badgeText - the product's badge text
- offers.productsSequence.products.rarityProductInfo - the rarity information of the product
- offers.productsSequence.products.rarityProductInfo.stars - The number of icons (stars) that are representing the rarity of the product and will displayed next to the product and inside the tooltip
- offers.productsSequence.products.rarityProductInfo.tooltipText - The text of the tooltip
- offers.productsSequence.products.rarityProductInfo.rarityText - The text that will appear next to the product and inside the tooltip, before the rarity icons (starts)
- offers.dynamicOfferUi - the dynamic OfferUi details
- soffers.dynamicOfferUi.badges - the list of badges in the offer
- offers.dynamicOfferUi.badges.publisherBadgeId - the publisher's badge id
- offers.dynamicOfferUi.badges.position - the position of the badge, left/right
- offers.dynamicOfferUi.salePercentage - the sale percentage of the offer
- soffers.dynamicOfferUi.badges - the list of badges in the offer
- segments - the list of segments of the player. Type: Array of strings.
- balances - a list of product balances of the player
- balances.publisherProductId - the publisher's product id
- balances.quantity - the quantity of the product. Type: int, should be greater than or equal to 0.
- focus
- focus.publisherBundleId - the id of the bundle to focus on in the web store