Progress Bar Points Granted

An event triggered when a player is granted Progress Bar points. Event Data

string

Event name: webstore.offers.progress_bar.points.granted.

string

Event ID. Use this ID to deduplicate re-delivered events.

number

Event timestamp in Epoch time, represented in milliseconds. Example: 1754307361396.

string

The session ID of the player’s current session. Example: 345397c6-d963-4aa4-a0ba-2aaca6c3ee05.

string

ID assigned by Appcharge to each request sent to the publisher. Helps the publisher identify and debug failed requests.

string

Event result. This field is not currently in use.

string

Reason for the event result. This field is not currently in use.

integer

Number of points granted to the player upon offer purchase or collection.

map<any,any>

A key-value map used to label events for tracking personas or tests. Example: { "persona":"non_payer", "blackFridayTest":"Base_group" }

object

Information about the player.

Show properties

string

Player ID.

string

Deprecated. Player’s email address.

string

Deprecated. Reserved for the player’s name in future versions.

object

Information about the player’s geolocation.

Show properties

enum

Two-letter country code in ISO-3166 alpha-2 format. Example: US

string

Deprecated. Region or state.

string

Deprecated. IP address in IPv4 format. Example: 80.178.249.122.

string

Deprecated. Zip code.

object

UTM data.

Show properties

string

Source of the traffic. This is where the player came from before reaching the store. Example: Google.

string

Marketing channel used to bring in the traffic. Example: email.

string

Identifies the marketing campaign associated with the traffic. Example: black_friday.

string

Paid search keyword or term that generated the traffic. Example: buy+coins.

string

A label that identifies which version of content a player clicked to reach the web store. Useful for A/B testing and analyzing performance of different ad or link variations within the same campaign. Example: summer_sale_ad1

object

Information about the Progress Bar.

Show properties

string

Progress Bar external ID.

integer

Current mission index.

integer

Number of points the player has earned so far in the current mission.

[object]

List of products in the Progress Bar.

Show properties

string

Product external ID.

string

Product display name.

string

Product quantity.

integer

Total number of points required to complete the current mission.

object

Information about the trigger.

Show properties

enum

Trigger type. Supported values:

purchase: An offer was purchased.
collect: An offer was collected.

object

Reference to the order.

Show properties

string

Offer external ID.

integer

Offer index.

string

Order ID.

any

Session metadata for passing data to Appcharge to be returned later.

{
  "eventName": "webstore.offers.progress_bar.points.granted",
  "eventId": "3f5bffbc-369e-4599-8c4d-abfe0ae0ef96",
  "timestamp": 1754307361396,
  "sessionId": "345397c6-d963-4aa4-a0ba-2aaca6c3ee05",
  "requestId": null,
  "result": null,
  "reason": null,
  "pointsGranted": 20,
  "attributes": {
    "persona": "non_payer",
    "blackFridayTest": "Base_group"
  },
  "customer": {
    "id": "671e81bb-55ef-428b-97ba-f67783971e0d",
    "name": null,
    "email": null
  },
  "geolocation": {
    "countryCode2": "US",
    "region": null,
    "ipAddress": null,
    "zipCode": null
  },
  "utm": {
    "utmSource": "google",
    "utmMedium": "cpc",
    "utmCampaign": "spring_sale",
    "utmTerm": "buy+coins",
    "utmContent": "ad1"
  },
  "progressBar": {
    "progressBarExternalId": "my-progress-bar-1",
    "missionIndex": 2,
    "points": 100,
    "products": [
      {
        "productExternalId": "treasure-12",
        "displayName": "Treasure",
        "productQuantity": "200"
      }
    ],
    "pointsTarget": 500
  },
  "trigger": {
    "type": "purchase",
    "orderRef": {
      "offerExternalId": "promo-id",
      "offerIndex": 1,
      "orderId": "69b81f12861bf68900b9cdff"
    }
  },
  "sessionMetadata": { "abTest": "group1", "locale": "en-US" }
}

Overview

What's New

Web Store

Checkout

Game Portal

Media

Events Center

Translations