Player

You are reading the documentation for Bridge SDK v2. If you need the obsolete v1 documentation, see Documentation (v1).

Player identity, profile data and platform authorization.

Authorization Support

Check this before showing a login button. Authorization support depends on the host platform.

bridge.player.isAuthorizationSupported

Platform support · 15 of 26 platforms

Supports: crazy_games, discord, facebook, huawei, microsoft_store, msn, ok, playdeck, playgama, samsung, telegram, tiktok, vk, y8, yandex

Does not support: dlightek, game_distribution, gamepush, gamesnacks, jio_games, lagged, poki, portal, reddit, xiaomi, youtube

Is the Player Currently Authorized

Use this to decide whether protected features are available right now, such as account-based saves, personalized content, or social actions.

bridge.player.isAuthorized

Is Guest

Returns true when the player has no persistent platform identity: they are not authorized, or the platform runs them as a guest account. Use it to decide whether to show a login prompt or to warn that progress may not sync across devices.

bridge.player.isGuest

Player ID

Returns the player's platform ID when available. Use it for display, analytics correlation, or backend verification.

bridge.player.id

Player Name

Returns the display name provided by the platform. Use it for profile UI, leaderboards, friend lists, or social prompts.

bridge.player.name

Returns null when no name is available; otherwise returns a string.

Player Avatar

Returns available player avatar URLs. Use the largest suitable image for profile UI, lobbies, or leaderboard rows.

bridge.player.photos

Possible values: an array of avatar URLs sorted by increasing resolution, or an empty array.

Player Extra Fields

Returns platform-specific authorization data. Properties vary by platform.

bridge.player.extra

Use this data on your backend to verify authorization. Playgama API verification currently supports only playgama, msn, and microsoft_store.

curl -X POST "https://playgama.com/api/bridge/v1/verify" \
  -H "Content-Type: application/json" \
  -d '{"platform":"<PLATFORM_ID>","type":"authorization","data":{  <...bridge.player.extra> }}'
  
#  Response:
#  {
#    success: boolean;
#    errorMessage?: string;

#    -- authorization --
#    playerId?: string;
#    publisherPlayerId?: string;
#  }

Player Authorization

Start the platform authorization flow. Call this from a direct player action, such as tapping a login button, before enabling account-only features.

// optional parameter
let options = { }

bridge.player.authorize(options)
    .then(() => {
        // player successfully authorized
    })
    .catch(error => {
        // error, something went wrong
    })

private void Start()
{
    var options = new Dictionary<string, object>();

    Bridge.player.Authorize(options, OnAuthorizePlayerCompleted);
}

private void OnAuthorizePlayerCompleted(bool success)
{
    if (success)
    {
        // Player successfully authorized
    }
    else
    {
        // Error, something went wrong
    }
}

In the event sheet:

On a trigger (e.g. Button → On clicked), add the Authorize Player action.
Add the On Authorize Player Completed condition. Inside it, check Is Last Action Completed Successfully for the success branch and its inverted form for the error branch.

Copy This Example

{"is-c3-clipboard-data":true,"type":"events","items":[{"eventType":"block","conditions":[{"id":"on-clicked","objectClass":"Button"}],"actions":[{"id":"authorize-player","objectClass":"PlaygamaBridge"}]},{"eventType":"block","conditions":[{"id":"on-authorize-player-completed","objectClass":"PlaygamaBridge"}],"actions":[],"children":[{"eventType":"block","conditions":[{"id":"is-last-action-completed-successfully","objectClass":"PlaygamaBridge"}],"actions":[{"type":"comment","text":"success"}]},{"eventType":"block","conditions":[{"id":"is-last-action-completed-successfully","objectClass":"PlaygamaBridge","isInverted":true}],"actions":[{"type":"comment","text":"error"}]}]}]}

In the events sheet:

On a trigger (e.g. Button is clicked), add the Authorize Player action.
Add the On Authorize Player Completed condition. Inside it, check Is Last Action Completed Successfully for the success branch and its inverted form for the error branch.

Copy This Example

{"000kind":"GDEVELOP_EventsAndInstructions_CLIPBOARD_KIND-jsBdHbLy912y8Rc","content":{"eventsList":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PanelSpriteButton::PanelSpriteButton::IsClicked"},"parameters":["Button",""]}],"actions":[{"type":{"value":"PlaygamaBridge::AuthorizePlayer"},"parameters":["",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::OnAuthorizePlayerCompleted"},"parameters":["",""]}],"actions":[],"events":[{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"value":"PlaygamaBridge::IsLastActionCompletedSuccessfully"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"success\"","\"info\"",""]}]},{"type":"BuiltinCommonInstructions::Standard","conditions":[{"type":{"inverted":true,"value":"PlaygamaBridge::IsLastActionCompletedSuccessfully"},"parameters":["",""]}],"actions":[{"type":{"value":"DebuggerTools::ConsoleLog"},"parameters":["\"error\"","\"info\"",""]}]}]}],"eventsCount":2,"actionsList":[],"actionsCount":0,"conditionsList":[],"conditionsCount":0}}

func _ready():
    var options = {}

    Bridge.player.authorize(options, funcref(self, "_on_player_authorize_completed"))

func _on_player_authorize_completed(success):
    if success:
        print("Authorized")
    else:
        print("Authorization error")

func _ready():
    var options = {}

    Bridge.player.authorize(options, Callable(self, "_on_player_authorize_completed"))

func _on_player_authorize_completed(success):
    if success:
        print("Authorized")
    else:
        print("Authorization error")

var options = { }

playgama_bridge_player_authorize(json_stringify(options))

// callback via Async Social Event
if async_load[? "type"] == "playgama_bridge_player_authorize_callback" {
    if async_load[? "success"] {
        // your logic
    }
}

async authorize() {
    const options: Record<string, any> = {};
    
    try {
        await bridge.player.authorize(options);
        // player successfully authorized
    } catch (error) {
        // error, something went wrong
    }
}

PreviousAdBlock NextPayments

Last updated 11 days ago