Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mcalegaris/gameapi-as3

Official Playtomic API for ActionScript 3 games
https://github.com/mcalegaris/gameapi-as3

Last synced: about 2 months ago
JSON representation

Official Playtomic API for ActionScript 3 games

Awesome Lists containing this project

README 

        
Playtomic ActionScript 3 API

-------------------------------------------------------------------------

This file is part of the official Playtomic API for Flash games using

ActionScript 3.  Playtomic is a real time analytics platform for casual 

games  and services that go in casual games.  If you haven't used it 

before check it out:



http://playtomic.com/



Created by ben at the above domain on 2/25/11.

Copyright 2011 Playtomic LLC. All rights reserved.



Documentation is available at:



http://playtomic.com/api/as3

PLEASE NOTE:

You may modify this SDK if you wish but be kind to our servers.  Be

careful about modifying the analytics stuff as it may give you 

borked reports.



If you make any awesome improvements feel free to let us know!



-------------------------------------------------------------------------

THIS SOFTWARE IS PROVIDED BY PLAYTOMIC, LLC "AS IS" AND ANY

EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR

CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.



-------------------------------------------------------------------------

GENERAL NOTES

-------------------------------------------------------------------------

Don't use crazy characters in your metric, level, leaderboard table etc 

names.  A very good idea is to use the same naming conventions for variables:



    - alphanumeric

    - keep them short (50 chars is the max)



Play time, country and source information is handled automatically, you do not 

need to do anything to collect that data.



Begin by logging a view which initializes the API, and then log any metrics you 

want.  Play time, repeat visitors etc are handled automatically.



-------------------------------------------------------------------------

Logging a view

-------------------------------------------------------------------------

Call this at the very start of your game loading:



	Playtomic.Log.View(swfid, guid, defaulturl)

	

		swfid = from your API page in Playtomic

		guid = from your API page in Playtomic

		defaulturl = path to the swf, should be root.loaderInfo.loaderUrl;



This registers that the player has viewed your game and initializes the

API.  You can track when the player actually starts playing (eg play button)

by calling this 0 or more times in your game:



	Playtomic.Log.Play();



-------------------------------------------------------------------------

CUSTOM METRICS

-------------------------------------------------------------------------



Custom metrics can track any general events you want to follow, like 

tracking who views your credits screen or anything else.



Call this to log any custom data you want to track.



	Playtomic.Log.CustomMetric(name, group, unique)

	

		name = your metric name, eg "ViewedCredits"

		group = optional, specify the group name for sorting in reports

		unique = optional, only count unique occurrences 



-------------------------------------------------------------------------

LEVEL METRICS

-------------------------------------------------------------------------



Level metrics can identify problems players are having with your difficulty 

or anything else by logging information like how many people begin vs. finish

each level.  They can help you identify major problems in your player retention.



These methods log the 3 types of level metrics - counters, ranged-value 

and average-value metrics.



- Counter metrics count how many times an event occurs across levels

- Ranged-value metrics track multiple values across a single event across levels

- Average-value metrics track the average of something across levels



Playtomic.Log.LevelCounterMetric(name, level, unique)



	name = your metric name

	level = either a level number (int > 0) or a level name

	unique = optional, only count unique-per-view occurrences



Playtomic.Log.LevelRangedMetric(name, level, value, unique)



	name = your metric name

	level = either a level number (int > 0) or a level name

	value = the value you want to track

	unique = optional, only count unique-per-view occurrences 



Playtomic.Log.LevelAverageMetric(name, level, value, unique)

	name = your metric name

	level = either a level number (int > 0) or a level name

	value = the value you want to track

	unique = optional, only count unique-per-view occurrences 



-------------------------------------------------------------------------

LINK TRACKING

-------------------------------------------------------------------------



Link tracking can give you information on how many people click the links 

in your games, including (Flash only) identifying sites that block links.



Playtomic.Link.Open(url, name, group)



	url = "http://playtomic.com/"

	name = link name

	group = specify the group name for this link (eg "sponsorlinks")



When you track links it automatically tracks the source and country for deep 

analysis in the dashboard, and it automatically tracks domain totals so if 

you have multiple links to the same site you can see each links effectiveness 

as well as the total uniques, clicks and fails for that domain.



The link tracking API does not alter the URL at all, players still go directly 

to the destination!



-------------------------------------------------------------------------

LEADERBOARDS, LEVEL SHARING, DATA AND GEOIP

-------------------------------------------------------------------------

This stuff gets a little more complicated.  Please check the documentation at

http://playtomic.com/api/as3