> For the complete documentation index, see [llms.txt](https://wiki.playgama.com/playgama/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.playgama.com/playgama/bridge-sdk/api.md).

# API

Reference for Playgama Bridge SDK modules.

The modules below are grouped by integration priority. If you're integrating Bridge for the first time, follow [Setup → Integration steps](/playgama/bridge-sdk/setup.md#integration-steps) first, then use this reference for exact methods.

## Required for every game

* [**Platform**](/playgama/bridge-sdk/api/platform.md) — language, platform ID, `sendMessage('game_ready')`, audio/pause/visibility state.
* [**Storage**](/playgama/bridge-sdk/api/storage.md) — save and load player progress.
* [**Advertisement → Interstitial**](/playgama/bridge-sdk/api/advertisement/interstitial.md) — required by all platforms for revenue share. Show at natural breakpoints (level transitions, game over).

## Extra monetization

* [**Advertisement → Rewarded**](/playgama/bridge-sdk/api/advertisement/rewarded.md), [**Banner**](/playgama/bridge-sdk/api/advertisement/banner.md), [**Advanced Banners**](/playgama/bridge-sdk/api/advertisement/advanced-banners.md), [**AdBlock detection**](/playgama/bridge-sdk/api/advertisement/adblock.md) — optional ad formats and diagnostics.
* [**Payments**](/playgama/bridge-sdk/api/payments.md) — in-game purchases (consumable and permanent).

## Engagement

* [**Leaderboards**](/playgama/bridge-sdk/api/leaderboards.md) — competitive scores (in-game, native, or native popup).
* [**Achievements**](/playgama/bridge-sdk/api/achievements.md) — milestones and rewards.
* [**Social**](/playgama/bridge-sdk/api/social.md) — share, invite friends, add to favorites, join community.

## Optional

* [**Player**](/playgama/bridge-sdk/api/player.md) — authorization, ID, name, avatar.
* [**Device**](/playgama/bridge-sdk/api/device.md) — device type (mobile / tablet / desktop / TV).
* [**Remote Config**](/playgama/bridge-sdk/api/remote-config.md) — manage game settings without a release.

{% hint style="warning" %}
In unsupported environments, such as local development without a host platform, Bridge falls back to a mock platform. Methods return safe defaults (`false`, `reject`, etc.) instead of throwing, so you can develop against the SDK before publishing.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.playgama.com/playgama/bridge-sdk/api.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.