This documentation is for Unity SDK 1.x through 3.x. If you are using Unity SDK 4.x or above, please visit our new documentation.

Jump to Content

Manual Beamable API Ask a Question Contact Us

Manual Beamable API Ask a Question

Manual Beamable API Ask a Question Contact Us Beamable.com

Manual

Content Restore

Welcome

Beamable Documentation
Installing Beamable (Unity)
Installing Beamable (Unreal)
Support Tiers

Script Reference

Client C# API
Server REST API

Unity SDK Features

Getting Started
Builds & Environments
Beamable Player Centric API
Dependency Injection
Autogenerated SDK
Offline Mode
Lightbeam Samples
- LightBeam Overview
- Account Management

UNREAL SDK FEATURES

Getting Started
Runtime Concepts
Unreal User Guide

Beam CLI

Beam CLI Commands
Guides

Cloud Services

Microservices
Microstorages
Scheduled Jobs
Unity

Identity

Identity
Frictionless Authentication
Username / Password
- Username / Password - Overview
- Username / Password - Code
Facebook Sign-In
Google Sign-In
- Google Sign-In - Overview
- Google Sign-In - Code
Apple Sign-In
Steam Integration
- Steam Integration - Overview
- Steam Integration - Guide
Extending Identity
- Adding HTML Sign-In
- Federated Identity
Google Play Game Services Sign-In
- Google Play Game Services Sign-In - Overview
- Google Play Game Services Sign-In - Code

Profile & Storage

Profile & Storage
Cloud Save
Content
Stats

Game Economy

Inventory
Stores
Virtual Currency
- Virtual Currency - Overview
- Virtual Currency - Code

Live Ops

Live Ops
Live Ops Prefabs
- Live Ops Prefabs - Overview
- Announcements - Prefab
Events
Announcements
- Announcements - Overview
- Announcements - Code
Notifications
- Notifications - Overview
- Notifications - Code
Mail
- Mail - Overview
- Mail - Code
Player Stats and Activities

Social & Networking

Social & Networking
Chat
- Chat - Overview
- Chat - Code
Connectivity
- Connectivity - Overview
- Connectivity - Code
  - Connectivity - Code - Reduce NoConnectivityException
Friends
- Friends - Overview
- Friends - Code
Groups
- Groups - Overview
- Groups - Code
Leaderboards
- Leaderboards - Overview
- Leaderboards - Code
Matchmaking
Multiplayer
Parties
- Parties - Overview
- Parties - Code
Lobbies
- Lobbies - Overview
- Lobbies - Code
Tournaments
- Tournaments - Overview
- Tournaments - Code

Business Intelligence

Business Intelligence
Telemetry
- Telemetry - Overview
- Telemetry - Code
Analytics
Segmentation
- Segmentation - Overview
- Segmentation - Guide
A/B Testing

Developer Tools

Unity

Integrations

Integrating WebGL

Marketplace

Amplitude Integration
Edgegap
Goplay Integration
Harbor
Hathora Cloud Integration
Idem Multiplayer Matchmaking API
Mixpanel Integration
Photon Fusion
Polygon Integration
Scenario Integration
Solana Integration
SUI Integration
Theta Network Integration
Venly Integration
Zebedee API
Zenject Integration
COMING SOON

Portal

Portal - Overview
Adding Developers
Granting Developer Permissions
Announcements
Campaigns
Cloud Data
Groups
In-App Purchases
Inventory
Leaderboards
Notify All Players
Players
Stats
Tournaments

Game Content Designer

Game Content Designer

Samples

Samples
Chat (GPW)
- Chat (GPW) - Overview
- Chat (GPW) - Guide
Chat & MicroStorage (GPW2)
- Chat & MicroStorage (GPW2) - Overview
- Chat & MicroStorage (GPW2) - Guide
Leaderboard (ABC)
- Leaderboard (ABC) - Overview
- Leaderboard (ABC) - Guide
Microservices (BBB)
- Microservices (BBB) - Overview
- Microservices (BBB) - Guide
Multiplayer (HATS)
- Multiplayer (HATS) - Overview
- Multiplayer (HATS) - Guide
Multiplayer (KOR)
- Multiplayer (KOR) - Overview
- Multiplayer (KOR) - Guide
Multiplayer (TBF)
- Multiplayer (TBF) - Overview
- Multiplayer (TBF) - Guide
Photon Multiplayer (RLGL)
- Photon Multiplayer (RLGL) - Overview
- Photon Multiplayer (RLGL) - Guide
SDK Examples
API Examples
- Beamable Web Access Example
Building a Battle Pass

Migration

Migrating Unity from 1.19.23 to 2.0.0
GameSparks Migration
Migrating Unity from 2.x to 3.0

Learning

Learning Fundamentals
Prototyping With Unity
Game Jams With Unity

Appendix

Pricing
- Best Practices for Pricing
Use Cases
Glossary
Security Overview
Performance & Scalability Overview

Content Restore

Restore content data based on a local snapshot, remote manifest ID or manifest file

Updated 5 months ago

Federation Local-settings Get IFederatedGameServer

Content Snapshot