GameAnalytics

https://docs.gameanalytics.com
Admin
GameAnalytics is a data and insights platform for game developers that provides player behavior...
Tokens:473,221
Snippets:3,219
Trust Score:10
Update:19 hours ago
Show doc for...
Tokens:
Raw
### Full initialization example in OnStart method

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/c-sharp/

Common example placed in an OnStart method called at game start. Enables info and verbose logs, sets build version, configures available resource currencies and item types, sets custom dimensions, then initializes the SDK.

```cs
using GameAnalyticsSDK.Net;

namespace MyGame
{
    public class MyGameClass
    {
        // ... other code from your project ...
        void OnStart()
        {
            GameAnalytics.SetEnabledInfoLog(true);
            GameAnalytics.SetEnabledVerboseLog(true);

            GameAnalytics.ConfigureBuild("0.10");

            GameAnalytics.ConfigureAvailableResourceCurrencies("gems", "gold");
            GameAnalytics.ConfigureAvailableResourceItemTypes("boost", "lives");

            GameAnalytics.ConfigureAvailableCustomDimensions01("ninja", "samurai");
            GameAnalytics.ConfigureAvailableCustomDimensions02("whale", "dolpin");
            GameAnalytics.ConfigureAvailableCustomDimensions03("horde", "alliance");

            GameAnalytics.Initialize("[game key]", "[secret key]");
        }
    }
}
```

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

### Session Setup with Configuration (C++, JavaScript, Lua)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/

Full example of initializing a session, including enabling info and verbose logs, configuring build version, available resource currencies and item types, and custom dimensions. The SDK automatically handles session changes on mobile and UWP platforms when the app goes to background.

```cpp
#include "GameAnalytics.h"

bool AppDelegate::applicationDidFinishLaunching() {
    // ... other code from your project ...

    gameanalytics::cocos2d::GameAnalytics::setEnabledInfoLog(true);
    gameanalytics::cocos2d::GameAnalytics::setEnabledVerboseLog(true);

    gameanalytics::cocos2d::GameAnalytics::configureBuild("0.10");

    gameanalytics::cocos2d::GameAnalytics::configureAvailableResourceCurrencies({"gems", "gold"});
    gameanalytics::cocos2d::GameAnalytics::configureAvailableResourceItemTypes({"boost", "lives"});

    gameanalytics::cocos2d::GameAnalytics::configureAvailableCustomDimensions01({"ninja", "samurai"});
    gameanalytics::cocos2d::GameAnalytics::configureAvailableCustomDimensions02({"whale", "dolphin"});
    gameanalytics::cocos2d::GameAnalytics::configureAvailableCustomDimensions03({"horde", "alliance"});

    gameanalytics::cocos2d::GameAnalytics::initialize("[game key]", "[secret key]");

    return true;
}
```

```javascript
cc.game.onStart = function(){
    // ... other code from your project ...

    ga.GameAnalytics.setEnabledInfoLog(true);
    ga.GameAnalytics.setEnabledVerboseLog(true);

    ga.GameAnalytics.configureBuild("0.10");

    ga.GameAnalytics.configureAvailableResourceCurrencies(["gems", "gold"]);
    ga.GameAnalytics.configureAvailableResourceItemTypes(["boost", "gold"]);
    ga.GameAnalytics.configureAvailableCustomDimensions01(["ninja", "samurai"]);
    ga.GameAnalytics.configureAvailableCustomDimensions02(["whale", "dolphin"]);
    ga.GameAnalytics.configureAvailableCustomDimensions03(["horde", "alliance"]);

    ga.GameAnalytics.initialize([game key]", "[secret key]);
};
```

```lua
require("ga_enums")

local MyApp = class("MyApp", cc.load("mvc").AppBase)

function MyApp:onCreate()
    -- ... other code from your project ...

    ga.GameAnalytics:setEnabledInfoLog(true)
    ga.GameAnalytics:setEnabledVerboseLog(true)

    ga.GameAnalytics:configureBuild("0.10")

    ga.GameAnalytics:configureAvailableResourceCurrencies({"gems", "gold"})
    ga.GameAnalytics:configureAvailableResourceItemTypes({"boost", "lives"})
    ga.GameAnalytics:configureAvailableCustomDimensions01({"ninja", "samurai"})
    ga.GameAnalytics:configureAvailableCustomDimensions02({"whale", "dolphin"})
    ga.GameAnalytics:configureAvailableCustomDimensions03({"horde", "alliance"})

    ga.GameAnalytics:initialize([game key]", "[secret key])
end
```

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

### Installs Ratio API Response Example

Source: https://docs.gameanalytics.com/products-and-features/pipeline-iq/metrics-api/api-specification/

Example response for a successful (200) Installs Ratio query. Shows the result structure with active_users, country_code, installs_ratio, new_users, and timestamp. The response type is InstallsRatioGroupQueryResult.

```json
{
  "result": [
    {
      "result": [
        {
          "active_users": 3,
          "country_code": "EH",
          "installs_ratio": 0.6666666666666666,
          "new_users": 2
        },
        {
          "active_users": 2,
          "country_code": "SJ",
          "installs_ratio": 0.5,
          "new_users": 1
        },
        {
          "active_users": 1008,
          "country_code": "CU",
          "installs_ratio": 0.49107142857142855,
          "new_users": 495
        }
      ],
      "timestamp": "2020-05-01T00:00:00.000Z"
    }
  ]
}
```

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

### Install devDependencies with npm install

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/javascript/

Run this command to install all devDependencies required for building the SDK from source. Requires Node.js and Gulp.

```sh
npm install
```

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

### Install GameAnalytics SDK via Wally

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/roblox/

Run this command to install the GameAnalytics SDK using Wally. Requires Wally to be installed.

```sh
wally install gameanalytics
```

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

### Start Session (C++, JavaScript, Lua)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/sdk-features/

Starts a new session if manual session handling is enabled and the SDK is initialized. If a session is already active, it ends the current session and starts a new one.

```cpp
// C++
gameanalytics::cocos2d::GameAnalytics::startSession();
```

```javascript
// JS
ga.GameAnalytics.startSession();
```

```lua
-- LUA
ga.startSession()
```

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

### Use IAnalyticsProvider to start a session

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/unreal/

Create an IAnalyticsProvider and start a session. The provider retrieves its configuration from Project Settings -> Plugins -> GameAnalytics. Starting the session invokes UGameAnalytics::Initialize on first call.

```cpp
TSharedPtr<IAnalyticsProvider> AnalyticsProvider = FGameAnalyticsModule::Get().CreateAnalyticsProvider(FGameAnalyticsModule::Delegate());

// start session will invoke UGameAnalytics::Initialize on first call
AnalyticsProvider->StartSession();
```

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

### Start session (Command Queue API)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/javascript/sdk-features/

Starts a new session using the command queue API. Use when a new session needs to be started during the game's lifetime.

```JavaScript
// start new session
GameAnalytics("startSession");
```

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

### Info Log Output Example

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/adobe-air/sdk-features/

Example console output when info log is enabled, showing design and error events.

```txt
 Info/GameAnalytics: Add DESIGN event: {eventId:someEvent, value:0}
 Info/GameAnalytics: Add DESIGN event: {eventId:someOtherEvent, value:100}
 Info/GameAnalytics: Add ERROR event: {severity:info, message:This is some in}
```

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

### Build SDK from source with setup.py

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/cpp/

Run setup.py with the required platform argument to generate the build project. Optional flags include --cfg for Release/Debug, --build, --test, and --coverage. The generated project is placed in the build folder.

```sh
python setup.py --platform {linux_x64,linux_x86,osx,win32,win64,uwp} [--cfg {Release,Debug}] [--build] [--test] [--coverage]
```

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

### Interval endpoint response sample (200)

Source: https://docs.gameanalytics.com/products-and-features/pipeline-iq/metrics-api/api-specification/

Example response for the GET /metrics/v1/interval endpoint, returning an ISO-8601 interval string.

```json
"2012-01-01T00:00:00.000/2012-01-03T00:00:00.000"
```

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

### Response payload for cumulative_playtime_per_user

Source: https://docs.gameanalytics.com/products-and-features/pipeline-iq/metrics-api/api-specification/

Example JSON response for a successful 200 request. Shows the result array with cumulative_playtime, day, total_unique_users, and value for each day since install.

```json
{
  "result": [
    {
      "result": {
        "days_since_install": [
          {
            "cumulative_playtime": 2473604,
            "day": "0",
            "total_unique_users": 3340,
            "value": 740.6
          },
          {
            "cumulative_playtime": 2621263,
            "day": "1",
            "total_unique_users": 806,
            "value": 923.8
          },
          {
            "cumulative_playtime": 2663643,
            "day": "7",
            "total_unique_users": 47,
            "value": 1116.1
          }
        ]
      },
      "timestamp": "2026-01-01T00:00:00Z"
    }
  ]
}
```

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

### Full initialization example with configuration

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/gamemaker/

Common example placed in the Creation code of a room. Enables info and verbose logs, configures build version, available resource currencies and item types, and custom dimensions before initializing.

```js
// ... other code from your project ...

ga_setEnabledInfoLog(true);
ga_setEnabledVerboseLog(true);

ga_configureBuild("0.10");

{
  var array = ga_array("gems", "gold");
  ga_configureAvailableResourceCurrencies(array);
}
{
  var array = ga_array("boost", "lives");
  ga_configureAvailableResourceItemTypes(array);
}
{
  var array = ga_array("ninja", "samurai");
  ga_configureAvailableCustomDimensions01(array);
}
{
  var array = ga_array("whale", "dolphin");
  ga_configureAvailableCustomDimensions02(array);
}
{
  var array = ga_array("horde", "alliance");
  ga_configureAvailableCustomDimensions03(array);
}

ga_initialize("[game key]", "[secret key]");
```

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

### Get Remote Configs Value as String

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/roblox/game-ops/

Retrieve a value from the remote configs using a key. The first example uses the normal default value, while the second shows how to specify a custom default value. If the key is not found, the default value is returned.

```lua
-- Without custom default value (using normal default value)
var value = GameAnalytics:getRemoteConfigsValueAsString(Player.UserId, {
    key = "key"
})
-- With custom default value
var valueWithCustomDefaultValue = GameAnalytics:getRemoteConfigsValueAsString(Player.UserId, {
    key = "key",
    defaultValue = "myDefaultValue"
})
```

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

### Common initialization example in GameInit method

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/adobe-air/

A full example of initializing the SDK inside a class constructor, including enabling info and verbose logs, setting build versions, resource currencies, item types, and custom dimensions, then calling init().

```java
import com.gameanalytics.sdk.*;

package my.package
{
    public class MyClass
    {
        public function MyClass()
        {
            // ... other code from your project ...

            GameAnalytics.setEnabledInfoLog(true);
            GameAnalytics.setEnabledVerboseLog(true);

            GameAnalytics.config
                .setBuildAndroid("0.1.0")
                .setBuildiOS("0.1.0")
                .setBuildMac("0.1.0")
                .setBuildWindows("0.1.0")
                .setResourceCurrencies(new <String>["gems", "coins"])
                .setResourceItemTypes(new <String>["boost", "lives"])
                .setCustomDimensions01(new <String>["ninja", "samurai"])
                .setCustomDimensions02(new <String>["whale", "dolphin"])
                .setCustomDimensions03(new <String>["horde", "alliance"])
                .setGameKeyAndroid("[android_game_key]")
                .setGameSecretAndroid("[android_secret_key]")
                .setGameKeyiOS("[ios_game_key]")
                .setGameSecretiOS("[ios_secret_key]")
                .setGameKeyMac("[mac_game_key]")
                .setGameSecretMac("[mac_secret_key]")
                .setGameKeyWindows("[windows_game_key]")
                .setGameSecretWindows("[windows_secret_key]");

            if(GameAnalytics.init())
            {
                // SDK has been initialized now and you can send events now
            }
    }
}
```

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

### POST /v1/orgs/{org_id}/adinsights/api/image/top - Request Payload

Source: https://docs.gameanalytics.com/products-and-features/marketIQ/ad-insights/api-specification/

Example JSON payload for the 'Get top images list' endpoint. It includes search keyword, creative list, product options, base options, and ad media type. The request body must be valid JSON and not exceed 8 MB.

```json
{
  "keyWord": "Fortune Greedy Rabbit",
  "keyWordType": "0",
  "isNew": false,
  "creativeList": [
    {
      "creativeKey": "gs",
      "creativeValue": "2"
    }
  ],
  "appealTypeList": [],
  "languages": [
    "other"
  ],
  "productOption": {
    "productType": [
      "1"
    ],
    "selling": [
      "1",
      "-1"
    ],
    "monetization": [],
    "payType": [
      "2"
    ]
  },
  "baseOption": {
    "tradeLevel1": [],
    "tradeLevel2": [],
    "tradeLevel3": [
      "6022703"
    ],
    "subjectType": [],
    "countryLevel2": [
      "BR"
    ],
    "adfactionIds": [
      "1337338246"
    ],
    "mediaIds": [],
    "device": [
      "1"
    ],
    "dayMode": "D30",
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": "1",
    "sortRule": "desc"
  },
  "adMediaType": [
    "99194611"
  ]
}
```

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

### Enable Info Log and Example Output

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/flutter/sdk-features/

Enable the info log to see short messages about SDK actions. The output shows example log lines for design and error events. Remember to disable in production.

```txt
GameAnalytics.setEnabledInfoLog(true);
 Info/GameAnalytics: Add DESIGN event: {eventId:someEvent, value:0}
 Info/GameAnalytics: Add DESIGN event: {eventId:someOtherEvent, value:100}
 Info/GameAnalytics: Add ERROR event: {severity:info, message:This is some info}
```

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

### Start session (Traditional API)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/javascript/sdk-features/

Starts a new session by adding a session start event and starting periodic submission of queued events. Use when a new session needs to be started during the game's lifetime.

```JavaScript
// start new session
gameanalytics.GameAnalytics.startSession();
```

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

### GameAnalytics iOS SDK quick configuration in Swift

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/ios/

Swift example showing how to enable logs, set global custom event fields, configure user ID, resources, dimensions, and initialize the SDK.

```swift
// Enable log
GameAnalytics.setEnabledInfoLog(true)
GameAnalytics.setEnabledVerboseLog(true)
GameAnalytics.configureAutoDetectAppVersion(true)

let fields: [String: Any] = [
    "test": 666,
    "test_2": "global_hello_world"
]
GameAnalytics.setGlobalCustomEventFields(fields)

// Set user ID
GameAnalytics.configureUserId("userId12345")

// Configure available resources and dimensions
GameAnalytics.configureAvailableResourceCurrencies(["gems", "gold"])
GameAnalytics.configureAvailableResourceItemTypes(["boost", "lives"])
GameAnalytics.configureAvailableCustomDimensions01(["ninja"])

// Set custom dimension (persists across sessions)
GameAnalytics.setCustomDimension01("ninja")

// Initialize SDK
GameAnalytics.initialize(withGameKey: "gameKey", gameSecret: "secretKey")
```

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

### Common Initialization Example - Command Queue (main.js)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/javascript/

A common example of the code placed in a script called main.js. It enables info and verbose logs, configures build, available resource currencies, item types, custom dimensions, and initializes the SDK using the command queue.

```javascript
<!-- Command queue -->
function onStart() {

    GameAnalytics("setEnabledInfoLog", true);
    GameAnalytics("setEnabledVerboseLog", true);

    GameAnalytics("configureBuild", "0.10");

    GameAnalytics("configureAvailableResourceCurrencies", ["gems", "gold"]);
    GameAnalytics("configureAvailableResourceItemTypes", ["boost", "gold"]);
    GameAnalytics("configureAvailableCustomDimensions01", ["ninja", "samurai"]);
    GameAnalytics("configureAvailableCustomDimensions02", ["whale", "dolphin"]);
    GameAnalytics("configureAvailableCustomDimensions03", ["horde", "alliance"]);

    GameAnalytics("initialize", "[game key]", "[secret key]");
};
```

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

### GameAnalytics REST API v2 Java Example

Source: https://docs.gameanalytics.com/assets/files/Collection_API_v2_example-5d69612c91783931c6004ac89caaccf6.java

A complete Java class demonstrating how to use the GameAnalytics REST API v2 to collect events and fetch remote configs. It includes setup for game keys, device and user information, event creation for various categories, and handling of remote configs and A/B testing.

```java
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.UUID;
import java.util.zip.GZIPOutputStream;

import javax.crypto.Mac;
import javax.crypto.spec.SecretKeySpec;

import org.apache.commons.codec.binary.Base64;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.methods.CloseableHttpResponse;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.entity.ByteArrayEntity;
import org.apache.http.entity.StringEntity;
import org.apache.http.impl.client.BasicResponseHandler;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClients;
import org.json.simple.JSONArray;
import org.json.simple.JSONObject;
import org.json.simple.parser.JSONParser;
import org.json.simple.parser.ParseException;

/*
 * Prerequisites:
 * httpclient and httpcore jars added to project from http://hc.apache.org/downloads.cgi
 * json-simple-1.x and up jar (may work with older versions too)
 */
enum EventCategory { user, design, business, progression, resource, error, session_end};
enum ProgressionStatus {Start, Fail, Complete};
enum ResourceFlowType {Sink, Source};
enum ErrorType {debug, info, warning, error, critical};

// structure for handling a config
final class Config{
	private static String key;
	private static String value;
	private static long start;
	private static long end;
	
	Config(){
		key = value ="";
		start = end = 0;
	}
	
	Config(String key, String value, long start, long end){
		this.key = key;
		this.value = value;
		this.start = start;
		this.end = end;
	}
}

public class GameAnalytics_REST_Example {
	
	//Add here real game keys. Sandbox game keys do not work with Command Center
	private static String game_key = "<game_key>";
	private static String secret_key = "<secret_key>";
	
	//sandbox API URLs. Change with live end-point when ready http://api.gameanalytics.com/v2/
	//private static String url = "http://sandbox-api.gameanalytics.com/v2/";
	private static String url = "http://api.gameanalytics.com/v2/"; //used to collect events
	private static String url_CC = "https://rubick.gameanalytics.com/v2/"; //used for init and for fetching remote configs
	
	//device information
	private static String platform = "mac_osx";
	private static String os_version = "mac_osx 10.12.6";
	private static String sdk_version =  "rest api v2";
	private static String device = "MacBookPro 12";
	private static String manufacturer = "apple";
	
	//game information
	private static String build = "alpha 0.0.1";
	
	//user information
	//The user_id needs to be persistent across all sessions! Use an ID the system can provide without losing it the next session
	private static String user_id = "aaaaa-bbbb";//"AEBE52E7-03EE-455A-B3C4-E57283966239"; //example
	private static String session_id;
	private static int session_num = 5;
	
	//event category
	private static EventCategory category;
	
	//SDK status
	private static boolean canSendEvents = false;
	private static List<JSONObject> queue = new ArrayList<JSONObject>();
	
	//Remote configs and A/B testing
	private static List<Config> configs = new ArrayList<Config>();
	
	private static String GenerateSessionID()
	{
		UUID sid = UUID.randomUUID();
		return sid.toString();
	}
	
	@SuppressWarnings("unchecked")
	private static JSONObject GetDefaultAnnotations()
	{
		JSONObject event = new JSONObject();
		event.put("platform", platform);
		event.put("os_version", os_version);
		event.put("sdk_version", sdk_version);
		event.put("device", device);
		event.put("manufacturer", manufacturer);
		event.put("build", build);
		event.put("user_id", user_id);
		event.put("session_id", session_id);
		event.put("session_num", session_num);
		event.put("v", 2);
		event.put("client_ts",System.currentTimeMillis() / 1000L);
		//event.put("client_ts",1526986757);
		return event;
	}
	
	@SuppressWarnings("unchecked")
	private static void CreateUserEvent()
	{
		JSONObject event = GetDefaultAnnotations();
		category = EventCategory.user;
		event.put("category", category.toString());
		queue.add(event);
	}
	
	@SuppressWarnings("unchecked")
	private static void CreateDesignEvent(String event_id)
	{
		JSONObject event = GetDefaultAnnotations();
		category = EventCategory.design;
		event.put("category", category.toString());
		event.put("event_id", event_id);
		queue.add(event);
	}
	
	@SuppressWarnings("unchecked")
	private static void CreateDesignEvent(String event_id, float amount)
	{
		JSONObject event = GetDefaultAnnotations();
		category = EventCategory.design;
		event.put("category", category.toString());
		event.put("event_id", event_id);
		event.put("amount", amount);
		queue.add(event);
	}
	
	@SuppressWarnings("unchecked")
	private static void CreateGenericBusinessEvent(String event_id, int amount, String currency, int transaction_num)
	{
		JSONObject event = GetDefaultAnnotations();

```

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

### POST /v2/<game_key>/init

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/api/setup/

Initializes a new session and retrieves remote configs, A/B testing IDs, and server timestamp. Should be called whenever a new session starts or at game launch.

```APIDOC
## POST /v2/<game_key>/init

### Description
Initializes a new session and retrieves remote configs, A/B testing IDs, and server timestamp. Should be called whenever a new session starts or at game launch.

### Method
POST

### Endpoint
`/v2/<game_key>/init`

### Parameters
#### Path Parameters
- **game_key** (string) - Required - Your specific game key.

#### Request Body
- **platform** (string) - Required - The platform of the client (e.g., "ios").
- **os_version** (string) - Required - The operating system version (e.g., "ios 8.1").
- **sdk_version** (string) - Required - The SDK version (e.g., "rest api v2").

### Request Example
```json
{"platform":"ios","os_version":"ios 8.1","sdk_version":"rest api v2"}
```

### Response
#### Success Response (200)
- **enabled** (boolean) - Whether the game is enabled.
- **server_ts** (integer) - Server timestamp.
- **flags** (array) - Remote config flags.

#### Response Example
```json
{"enabled":true,"server_ts":1431002142,"flags":[]}
```

### Headers
- **Authorization** (string) - Required - HMAC authentication hash.
- **Content-Type** (string) - Required - application/json.
- **Content-Encoding** (string) - Optional - gzip if payload is gzipped.
- **Content-Length** (string) - Optional - Length of payload.

### Notes
- The init call should be requested whenever a new session starts or at least when the game is launched.
- Use the init call to retrieve remote configs, A/B testing id, A/B testing variant id, and to adjust client timestamp.
- For first run (no configs hash), send the init request without the configs_hash parameter.
- After first run, include the configs_hash parameter obtained from the previous response.

### Alternative Endpoint for Remote Configs
`POST /remote_configs/v1/init?game_key=<game_key>&interval_seconds=<int>`

`POST /remote_configs/v1/init?game_key=<game_key>&interval_seconds=<int>&configs_hash=<configs_hash>`

```

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

### Install pods with pod install

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/ios/

Run this command in the terminal to install the CocoaPods dependencies. After running, open the generated .xcworkspace file.

```sh
pod install
```

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

### Initialize with Logging Settings

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/roblox/sdk-features/

Sets info and verbose log settings during SDK initialization via the GameAnalyticsServerInit script.

```lua
GameAnalytics:initialize({
    enableInfoLog = true,
    enableVerboseLog = false
    -- more settings
})
```

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

### GameAnalytics iOS SDK quick configuration in Objective-C

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/ios/

Objective-C example showing how to enable logs, set global custom event fields, configure user ID, resources, dimensions, and initialize the SDK.

```objc
// Enable log
[GameAnalytics setEnabledInfoLog:YES];
[GameAnalytics setEnabledVerboseLog:YES];

[GameAnalytics configureAutoDetectAppVersion:YES];

NSMutableDictionary *fields = [[NSMutableDictionary alloc] init];
fields[@"test"] = @666;
fields[@"test_2"] = @"global_hello_world";
[GameAnalytics setGlobalCustomEventFields:fields];

// Set user ID
[GameAnalytics configureUserId:@"userId12345"];

// Configure available resources and dimensions
[GameAnalytics configureAvailableResourceCurrencies:@[@"gems", @"gold"]];
[GameAnalytics configureAvailableResourceItemTypes:@[@"boost", @"lives"]];
[GameAnalytics configureAvailableCustomDimensions01:@[@"ninja"]];

// Set custom dimension (persists across sessions)
[GameAnalytics setCustomDimension01:@"ninja"];

// Initialize SDK
[GameAnalytics initializeWithGameKey:@"gameKey" gameSecret:@"secretKey"];
```

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

### Initialize the SDK with UGameAnalytics

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/unreal/

Get the UGameAnalytics instance from the module and initialize it with your game and secret keys.

```cpp
UGameAnalytics* GameAnalytics = FGameAnalyticsModule::Get().GetInstance();

// initialize the SDK with your keys
GameAnalytics->Initialize(GAME_KEY, SECRET_KEY);
```

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

### Add Progression Start Event in Lua

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/event-tracking/

Adds a progression start event using the Lua API. Use this when the player starts a progression attempt.

```lua
-- LUA
ga.GameAnalytics:addProgressionEvent(ga.EGAProgressionStatus.Start, "world01", "stage01", "level01")
```

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

### GameAnalytics.init()

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/adobe-air/

Initializes the SDK with the previously configured game keys and settings. Must be called after configuration. Returns a boolean indicating success.

```APIDOC
## GameAnalytics.init()

### Description
Initializes the GameAnalytics SDK. Must be called after setting game keys and other configuration. Returns true if initialization succeeded.

### Method
init

### Parameters
None.

### Request Example
```java
if(GameAnalytics.init())
{
    // SDK has been initialized correctly now
}
```

### Response
- **success** (boolean) - True if initialization succeeded, false otherwise.
```

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

### Add Progression Start Event in JavaScript

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/event-tracking/

Adds a progression start event using the JavaScript API. Use this when the player starts a progression attempt.

```javascript
// JS
ga.GameAnalytics.addProgressionEvent(
  ga.EGAProgressionStatus.Start,
  "world01",
  "stage01",
  "level01"
);
```

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

### Common Initialization Example - Traditional Method (main.js)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/javascript/

A common example of the code placed in a script called main.js. It enables info and verbose logs, configures build, available resource currencies, item types, custom dimensions, and initializes the SDK.

```javascript
<!-- Traditional way -->
function onStart(){
    // ... other code from your project ...


    gameanalytics.GameAnalytics.setEnabledInfoLog(true);
    gameanalytics.GameAnalytics.setEnabledVerboseLog(true);

    gameanalytics.GameAnalytics.configureBuild("0.10");

    gameanalytics.GameAnalytics.configureAvailableResourceCurrencies(["gems", "gold"]);
    gameanalytics.GameAnalytics.configureAvailableResourceItemTypes(["boost", "gold"]);
    gameanalytics.GameAnalytics.configureAvailableCustomDimensions01(["ninja", "samurai"]);
    gameanalytics.GameAnalytics.configureAvailableCustomDimensions02(["whale", "dolphin"]);
    gameanalytics.GameAnalytics.configureAvailableCustomDimensions03(["horde", "alliance"]);

    gameanalytics.GameAnalytics.initialize("[game key]", "[secret key]");
}
```

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

### Add Progression Start Event in C++

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/event-tracking/

Adds a progression start event using the C++ API. Use this when the player starts a progression attempt.

```cpp
// C++
gameanalytics::cocos2d::GameAnalytics::addProgressionEvent(gameanalytics::cocos2d::EGAProgressionStatus::Start, "world01", "stage01", "level01");
```

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

### Configure the SDK

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/cpp/

Example configuration for the C++ SDK: enables info and verbose logs, sets build version, and configures available resource currencies, item types, and custom dimensions. Call these before initializing the SDK.

```c++
gameanalytics::GameAnalytics::setEnabledInfoLog(true);
gameanalytics::GameAnalytics::setEnabledVerboseLog(true);

gameanalytics::GameAnalytics::configureBuild("0.10");

{
    std::vector<std::string> list;
    list.push_back("gems");
    list.push_back("gold");
    gameanalytics::GameAnalytics::configureAvailableResourceCurrencies(list);
}
{
    std::vector<std::string> list;
    list.push_back("boost");
    list.push_back("lives");
    gameanalytics::GameAnalytics::configureAvailableResourceItemTypes(list);
}
{
    std::vector<std::string> list;
    list.push_back("ninja");
    list.push_back("samurai");
    gameanalytics::GameAnalytics::configureAvailableCustomDimensions01(list);
}
{
    std::vector<std::string> list;
    list.push_back("whale");
    list.push_back("dolphin");
    gameanalytics::GameAnalytics::configureAvailableCustomDimensions02(list);
}
{
    std::vector<std::string> list;
    list.push_back("horde");
    list.push_back("alliance");
    gameanalytics::GameAnalytics::configureAvailableCustomDimensions03(list);
}
```

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

### Add Progression Start Event in Java

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cocos2d/event-tracking/

Adds a progression start event with the specified progression hierarchy. Use this when the player starts a progression attempt.

```java
GameAnalytics.addProgressionEventWithProgressionStatus(GAProgressionStatus.Start, "world01", "stage01", "level01");
```

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

### Initialize the SDK

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/open-source-sdks/cpp/

Call the initialize method with your Game Key and Secret Key to start using the SDK.

```c++
gameanalytics::GameAnalytics::initialize("<your game key>", "<your secret key>");
```

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

### Start a new session with GameAnalytics.startSession()

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cordova/sdk-features/

Call this to manually start a new session during the game's lifetime. It adds a session start event and starts periodic submission of queued events. The next event submit will fix any missing session_end event from earlier sessions.

```javascript
// start new session
GameAnalytics.startSession();
```

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

### Start session manually (Swift)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/ios/debug/

Starts a new session if manual session handling is enabled. If a session is active, it ends the current session and starts a new one.

```swift
// Swift
GameAnalytics.startSession()
```

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

### Start session manually (Objective-C)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/ios/debug/

Starts a new session if manual session handling is enabled. If a session is active, it ends the current session and starts a new one.

```objc
// Objective-C
[GameAnalytics startSession];
```

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

### Initialize GameAnalytics SDK with initServer

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/roblox/

Call this from your script to initialize the SDK with your game key and secret key.

```lua
GameAnalytics:initServer("[YOUR_GAME_KEY]", "[YOUR_SECRET_KEY]")
```

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

### User (session start) Event

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/api/event-types/

The user event acts as a session start and should be the first event in the first batch sent to the collectors. It is added each time a session starts.

```APIDOC
## User (session start) Event

### Description
The user event acts like a session start. It should always be the first event in the first batch sent to the collectors and added each time a session starts.

### Fields
- **category** (string) - Required - Must be `user`.
- Plus the default annotation fields.

### JSON Validation Schema
The collector servers will validate these fields and reject any event not passing.

```json
{
  "description": "Schema for user event",
  "id": "user",
  "type": "object",
  "extends": "shared",
  "properties": {
    "category": {
      "type": "string",
      "required": true,
      "pattern": "^user$"
    }
  }
}
```
```

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

### Full initialization example in onDeviceReady

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/game-engine-sdks/cordova/

Complete initialization process for the GameAnalytics Cordova SDK, typically placed in the onDeviceReady function. It enables info and verbose logs, configures build, custom dimensions, resource currencies and item types, then initializes with game key and secret key.

```JavaScript
onDeviceReady: function(){
    // ... other code from your project ...

    GameAnalytics.setEnabledInfoLog(true);
    GameAnalytics.setEnabledVerboseLog(true);

    GameAnalytics.configureBuild("0.1.1");

    GameAnalytics.configureAvailableCustomDimensions01(["ninja", "samurai"]);
    GameAnalytics.configureAvailableCustomDimensions02(["whale", "dolphin"]);
    GameAnalytics.configureAvailableCustomDimensions03(["horde", "alliance"]);
    GameAnalytics.configureAvailableResourceCurrencies(["gold", "gems"]);
    GameAnalytics.configureAvailableResourceItemTypes(["boost", "lives"]);

    GameAnalytics.initialize({
        gameKey: "[game key]",
        secretKey: "[secret key]"
    });

}
```

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

### GameAnalytics.initializeWithGameKey(Activity, String, String)

Source: https://docs.gameanalytics.com/event-tracking-and-integrations/sdks-and-collection-api/platform-sdks/android/

Initializes the SDK using the app's main activity, game key, and game secret. Recommended since version 2.1.0.

```APIDOC
## GameAnalytics.initializeWithGameKey(Activity, String, String)

### Description
Initializes the SDK using the app's main activity, game key, and game secret. Recommended since version 2.1.0.

### Method
initializeWithGameKey

### Parameters
- **activity** (Activity) - Required - The main activity of the app.
- **gameKey** (String) - Required - The game key for your game.
- **secretKey** (String) - Required - The secret key for your game.

### Request Example
```java
GameAnalytics.initializeWithGameKey(activity, "[game key]", "[secret key]");
```

### Response
No response is returned.
```
Tokens:
Raw