{"__v":6,"_id":"543da24b31ca981a00a6ffe7","category":{"project":"542998547a6b69080076806e","version":"542998547a6b690800768071","_id":"54625de66d1f1010002f3901","pages":[],"__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-11T19:05:10.379Z","from_sync":false,"order":1,"slug":"basics","title":"Basics"},"is_link":false,"parentDoc":null,"project":"542998547a6b69080076806e","user":"542998207a6b690800768069","version":{"__v":9,"_id":"542998547a6b690800768071","project":"542998547a6b69080076806e","createdAt":"2014-09-29T17:35:16.249Z","releaseDate":"2014-09-29T17:35:16.249Z","categories":["542998547a6b690800768072","5433027990d63b1c0030c0f1","5433028190d63b1c0030c0f2","5433028d9a2b451a00ad4508","5433055790d63b1c0030c10a","5461417d37e5bc200049e1e4","54624066ddd31b0800a58db4","54625de66d1f1010002f3901","54d309955616470d0013cc55"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["54481aac8d7af31a00dd41b5","58077f036ddb35190060b166"],"next":{"pages":[],"description":""},"createdAt":"2014-10-14T22:23:07.864Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"What are \\\"points\\\"?\",\n  \"body\": \"In our documentation we frequently use the term \\\"points\\\" as a short-form for \\\"virtual currency\\\".  Either way, we mean the coins, gems, or credits that your players use.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Setting up your Virtual Currency\"\n}\n[/block]\nEvery app that you create in your [Dashboard](https://pub.superrewards.com) needs a virtual currency, so that we know what to give your players when they complete transactions.  We need two things:\n* **Virtual currency name** is the name of your currency, like *coins*, *tokens*, or *gold*.  It's best to enter a plural form, like *coins*, not *coin*.\n* **VC ratio** (virtual currency ratio) is the exchange rate we will use to award points to your users.  For example, if you sell a *100 coin* package to a user for $10.00, the VC Ratio is 10.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"US Dollars?\",\n  \"body\": \"Currently your VC ratio is an exchange rate compared to US Dollars.  Soon we plan to allow you to link it to other currencies if that's better for your users.\"\n}\n[/block]\nBoth settings can be found in your App Settings for each app, and you are asked for these when you [Create an App](doc:creating-an-app):\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/3mPse1iORIWhFBfDVSq5_Screenshot%202014-10-14%2019.15.55.png\",\n        \"Screenshot 2014-10-14 19.15.55.png\",\n        \"681\",\n        \"205\",\n        \"#3d3d3e\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What should my VC Ratio be?\"\n}\n[/block]\nThis is different for every app, but you probably have an idea of how you want to price your packages.  We commonly see values from 8 VC per US Dollar, to numbers in the thousands.  \n\nThe most important recommendation we can make though is:\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"VC Ratios affect how many offers your users see\",\n  \"body\": \"Our system will only show an offer to your users if it's worth at least 0.2 of your currency.  So for example, if your VC Ratio is 10 (10 points = $1), one point is $0.10, and we would show anything worth at least $0.02.  \\n\\nIf however, your VC Ratio is 4 (4 points = $1), one point is worth $0.25, and we would only show offers that pay out $0.05 or more.\\n\\nThis sounds like a small difference, but it affects some offers greatly - many of our popular video offers have low payouts, but are completed in very high volume by your users.  \\n\\n**We recommend keeping your VC Ratio at 10 or higher, to ensure the highest availability of offers for your users.**\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How do partial points work?\"\n}\n[/block]\nAs mentioned above, we show offers that will pay out 0.2 units of your currency or more.  Don't worry, we don't send you a postback for those fractions, instead we let them add up, and send you a postback when there is one or more whole units earned.\n\nYour users see this information on the wall as \"Pending Coins\" (or whatever yours are called):\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/fBYuJmJSKaiol5txxO9a_Screenshot%202014-10-14%2019.32.00.png\",\n        \"Screenshot 2014-10-14 19.32.00.png\",\n        \"303\",\n        \"107\",\n        \"#3d94b7\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nHere's an example to illustrate how it works:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Event\",\n    \"h-1\": \"Change in Coins balance\",\n    \"0-0\": \"User first visits the wall\",\n    \"0-1\": \"0.00\",\n    \"1-0\": \"User watches a video for a 0.5 \\\"coin\\\" payout\",\n    \"1-1\": \"0.50\",\n    \"2-0\": \"User watches a video for a 0.75 \\\"coin\\\" payout\",\n    \"2-1\": \"0.75\",\n    \"3-0\": \"SuperRewards postback to your app of 1.0 earned \\\"coins\\\"\",\n    \"h-2\": \"\\\"Pending Coins\\\" Balance\",\n    \"0-2\": \"0.00\",\n    \"1-2\": \"0.50\",\n    \"2-2\": \"1.25\",\n    \"3-2\": \"0.25\",\n    \"3-1\": \"-1.00\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]","excerpt":"Our system is well-tuned for virtual currency games and apps, here's how to use it best.","slug":"basics-points-and-currency","type":"basic","title":"Basics: Points And Currency"}

Basics: Points And Currency

Our system is well-tuned for virtual currency games and apps, here's how to use it best.

[block:callout] { "type": "info", "title": "What are \"points\"?", "body": "In our documentation we frequently use the term \"points\" as a short-form for \"virtual currency\". Either way, we mean the coins, gems, or credits that your players use." } [/block] [block:api-header] { "type": "basic", "title": "Setting up your Virtual Currency" } [/block] Every app that you create in your [Dashboard](https://pub.superrewards.com) needs a virtual currency, so that we know what to give your players when they complete transactions. We need two things: * **Virtual currency name** is the name of your currency, like *coins*, *tokens*, or *gold*. It's best to enter a plural form, like *coins*, not *coin*. * **VC ratio** (virtual currency ratio) is the exchange rate we will use to award points to your users. For example, if you sell a *100 coin* package to a user for $10.00, the VC Ratio is 10. [block:callout] { "type": "info", "title": "US Dollars?", "body": "Currently your VC ratio is an exchange rate compared to US Dollars. Soon we plan to allow you to link it to other currencies if that's better for your users." } [/block] Both settings can be found in your App Settings for each app, and you are asked for these when you [Create an App](doc:creating-an-app): [block:image] { "images": [ { "image": [ "https://files.readme.io/3mPse1iORIWhFBfDVSq5_Screenshot%202014-10-14%2019.15.55.png", "Screenshot 2014-10-14 19.15.55.png", "681", "205", "#3d3d3e", "" ] } ] } [/block] [block:api-header] { "type": "basic", "title": "What should my VC Ratio be?" } [/block] This is different for every app, but you probably have an idea of how you want to price your packages. We commonly see values from 8 VC per US Dollar, to numbers in the thousands. The most important recommendation we can make though is: [block:callout] { "type": "danger", "title": "VC Ratios affect how many offers your users see", "body": "Our system will only show an offer to your users if it's worth at least 0.2 of your currency. So for example, if your VC Ratio is 10 (10 points = $1), one point is $0.10, and we would show anything worth at least $0.02. \n\nIf however, your VC Ratio is 4 (4 points = $1), one point is worth $0.25, and we would only show offers that pay out $0.05 or more.\n\nThis sounds like a small difference, but it affects some offers greatly - many of our popular video offers have low payouts, but are completed in very high volume by your users. \n\n**We recommend keeping your VC Ratio at 10 or higher, to ensure the highest availability of offers for your users.**" } [/block] [block:api-header] { "type": "basic", "title": "How do partial points work?" } [/block] As mentioned above, we show offers that will pay out 0.2 units of your currency or more. Don't worry, we don't send you a postback for those fractions, instead we let them add up, and send you a postback when there is one or more whole units earned. Your users see this information on the wall as "Pending Coins" (or whatever yours are called): [block:image] { "images": [ { "image": [ "https://files.readme.io/fBYuJmJSKaiol5txxO9a_Screenshot%202014-10-14%2019.32.00.png", "Screenshot 2014-10-14 19.32.00.png", "303", "107", "#3d94b7", "" ] } ] } [/block] Here's an example to illustrate how it works: [block:parameters] { "data": { "h-0": "Event", "h-1": "Change in Coins balance", "0-0": "User first visits the wall", "0-1": "0.00", "1-0": "User watches a video for a 0.5 \"coin\" payout", "1-1": "0.50", "2-0": "User watches a video for a 0.75 \"coin\" payout", "2-1": "0.75", "3-0": "SuperRewards postback to your app of 1.0 earned \"coins\"", "h-2": "\"Pending Coins\" Balance", "0-2": "0.00", "1-2": "0.50", "2-2": "1.25", "3-2": "0.25", "3-1": "-1.00" }, "cols": 3, "rows": 4 } [/block]