SDK methods

Requirement 1.19

The initialization of the Yandex Games SDK and the use of its methods are carried out in strict accordance with the documentation and game requirements:

The SDK is initialized exactly as described on the Installation and usage page.
At the moment when the user can start playing the game, the LoadingAPI.ready() method from Game Ready must be called.
The use of gameplay markup is optional; however, if the GameplayAPI.start() and GameplayAPI.stop() methods are used in the game, the timing of event dispatches must strictly correspond to those described in section Gameplay.
Tracking game_api_pause and game_api_resume events is optional. However, if ysdk.on() and ysdk.off() methods are used in the game, the event handling logic must strictly follow the description in section Pause and Resume Events.

SDK Initialization

1.19.1. The SDK is initialized exactly as specified on the Installation and usage page. For the requirement to be considered fulfilled, the current loader must be used.

Loader Version Check

Start the game with the debug panel.
Using the developer console

Using the address bar
1. Open the Yandex Games console.
2. Select the game you need.
3. In the top left corner, click on Open with debug panel.
1. Open the required game.
2. Add &debug-mode=16 to the end of the browser's address bar.
On the debug panel to the left of the Game Ready indicator, find two letters:
- IF (init false) — the game supports the old loader. Hovering over IF will display Is loader: false.
- IT (init true) — the game supports the new loader. Hovering over IT will display Is loader: true.

Examples

Loader	Comment
	Old loader. Displayed on the debug panel `IF`.
	Old loader. Displayed on the debug panel `IF`.
	New loader. Displayed on the debug panel `IT`.
	New loader. Displayed on the debug panel `IT`.

Game Ready

1.19.2. When the user is ready to start the game, call the LoadingAPI.ready() method from Game Ready.

To fulfill the requirement, the LoadingAPI.ready() method must be called at the correct moment.

Game Ready Check Logic

Preparation

Start the game with the debug panel.
Using the developer console

Using the address bar
1. Open the Yandex Games console.
2. Select the game you need.
3. In the top left corner, click on Open with debug panel.
1. Open the required game.
2. Add &debug-mode=16 to the end of the browser's address bar.
On the debug panel, find the Game Ready indicator .

General Principle of the Check

Verify that the blue indicator changes to green within 90 seconds.
Reload the game.
Recheck at what moment the indicator changes color.

Game Ready Works Correctly

The blue indicator changes to green at the moment:

when the menu is available;
when the game is playable (including the initial animation).

Game Ready	Comment
	The green indicator appears at the moment when the menu becomes available.
	The green indicator appears at the moment when the menu becomes available.
	The green indicator appears at the moment when the menu becomes available.
	The green indicator appears at the moment when the game is available for interaction.
	The green indicator appears at the moment when the game is available for interaction.
	The green indicator appears at the moment when the game is available for interaction.

Game Ready is not working correctly

The blue indicator changed to green :

before the game became available for interaction (there are progress bars, spinners, black screen, etc.);
a few seconds after the game became available for interaction.

Game Ready	Comment
	The green indicator appears before the game becomes available for interaction.
	The green indicator appears before the game becomes available for interaction.
	The green indicator appears before the game becomes available for interaction.
	The green indicator appeared only a few seconds after the game became available for interaction.
	The green indicator appeared only a few seconds after the game became available for interaction.

Game Ready is not integrated

The indicator turned red after 90 seconds.

Game Ready	Comment
	The indicator turned red — Game Ready is not integrated.

Gameplay Markup

1.19.3. The methods GameplayAPI.start() and GameplayAPI.stop() allow marking the start and stop of the gameplay. If they are used in the game, then the moments of event sending strictly correspond to the descriptions in the section Gameplay.

Checking Gameplay Markup

Preparation

Start the game with the debug panel.
Using the developer console

Using the address bar
1. Open the Yandex Games console.
2. Select the game you need.
3. In the top left corner, click on Open with debug panel.
1. Open the required game.
2. Add &debug-mode=16 to the end of the browser's address bar.
On the debug panel, find the gamepad button 🎮.

General Checking Principle

Track the status of the gameplay indicator depending on actions:

When a player starts the gameplay or resumes it after a pause, the method GameplayAPI.start() must be called. The gameplay indicator should turn green — gameplay is in progress.
When a player finishes the gameplay or pauses it, the method GameplayAPI.stop() must be called. The gameplay indicator should turn red — gameplay is paused.

Scenarios that are considered during the check:

Starting and finishing a level.
Opening and closing the game menu.
Opening and closing the purchase menu.
Starting and closing advertisements.
Losing focus on the game and returning to it (switching to another browser tab or a different window).

Tip

To find out where the focus is (on the game or on another window), track the events game_api_resume and game_api_pause.

Gameplay Correctly Marked

The indicator color changes depending on the scenario.

Game	Comment
	At the start of a new level, the indicator is green.
	Level completed, the indicator turns red.
	When navigating to the menu and then returning to the gameplay, the indicator changes.
	When navigating to the menu and then returning to the gameplay, the indicator changes.
	When navigating to the purchase menu and then returning to the gameplay, the indicator changes.
	The ad is closed, the indicator color changes from red to green.
	When shifting focus from the browser tab to another window and then returning to the gameplay, the indicator color changes.

Gameplay marked incorrectly

The indicator color does not change depending on the scenario.

Game	Comment
	Level completed, the indicator color did not change from green to red.
	When navigating to the menu, the indicator color did not change from green to red.
	The ad is closed, the indicator color did not change from red to green.
	When shifting focus from the browser tab to another window, the indicator color does not change.

Contact Moderation

If you believe you are using the SDK methods correctly and your game was incorrectly unpublished or denied, please fill out the form below.

The quality control service of moderation will recheck the decision and return the game if it was unfairly blocked.

Open the form

Was the article helpful?

Basic violations

Game mechanics