Documentation changelog
- 19.06
- Removed the section about the init function options. Configure the screen orientation in the developer console on the Draft tab.
- Added the
--tld
parameter to the description of the @yandex-games/sdk-dev-proxy package used to start and test the game from a local server. - Included a list of common requirements, the violation of which may lead to moderators rejecting the game for publication.
- Added an example of acceptable content to the calibration list for erotic content and revised the comment to the example of acceptable content (item 8.3.5).
- Added an example of acceptable content to the calibration list for unpleasant characters (item 8.3.6).
- 31.07
- Introduced a new SDK method to retrieve server time that's independent of client settings and resistant to manipulation and overrides.
- Supplemented information about who can view the Revenue and Average revenue per daily active user metrics in the Monetization metrics and Roles and access rights sections. By default, only the game owner can view the metrics. To allow other developers on your team to view them, assign them the View income role.
- Updated the descriptions for the Play time, Players, and Play time per player product metrics. The contribution of new players is now shown by a separate curve in the widgets.
- Added a notice regarding the need to enable the consumption method in the In-game purchases section (item 1.13.1). Be sure to verify unprocessed purchases even during testing to avoid moderation issues.
- Expanded requirement 1.10: resizing the window must not affect the correct display of a game.
- Expanded the clarification for requirement 4.4.1. examples of turn-based (conditional) games now include games with merge mechanics. The examples now include a GIF that illustrates such a game.
- 17.07
-
Updated requirement 8.2.3.6: added information and examples of cases where in-game text translation isn't required.
-
Expanded requirement 1.10.2: the use of swipe-to-refresh is now prohibited in games.
-
Supplemented the clarification for requirement 4.4.1: ads can be served once the game is loaded on the platform (after gameReadyAPI is triggered).
-
Expanded requirement 1.19 regarding the initialization of the Yandex Games SDK and the use of its methods.
-
Updated the information about connecting to the Yandex Games SDK: changed the path
https://yandex.ru/games/sdk/v2
to/sdk.js
and added options for setups on the developer's domain. Please follow the specific instructions on the SDK installation and use page for SDK initialization (item 1.19.1). -
Expanded the Game start page and renamed it to Game Loading and Gameplay Markup.
- Updated examples in the Game loading section. Calling the
ready()
method fromgameReadyAPI
when the user can start playing is now mandatory (item 1.19.2). - Added the Gameplay section with new SDK methods for reporting to the platform whether gameplay is active or not. When using
GameplayAPI
, make sure that you call its methods as described in the documentation (item 1.19.3).
- Updated examples in the Game loading section. Calling the
-
- 9.07
- Updated information on conversion metrics: Icon CTR is now divided into Icon CTR in recommendations and Icon CTR in "My games" to eliminate the effect of retention rate on CTR. The new metrics can be used to analyze the results of A/B tests for icons and covers.
- 3.07
- Following active feedback from the game development community, we shortened requirement 4.4.1 and revised its clarification.
- 2.07
- Updated the calibration list for interstitial ads (item 4.4.1). Added examples of when ads can be shown.
- Removed item 2.11 in favor of item 1.8 in the Game requirements section. For mobile devices, focus on adapting the sizes of in-game elements, buttons, and graphics (item 1.8) rather than on the size of the active field.
- 28.08
-
Added a calibration list for duplicate games (item 3.6). During duplicate checks, moderators assess a game's mechanics and setting. To be approved, a game must have unique mechanics or a distinct setting compared to other games.
-
Updated requirements:
-
Updated the note in the Monetization in Yandex Games section: ad units generate revenue for viewable impressions.
-
- 14.08
- We added a clarification for requirement 2.9 regarding in-game content duration.
- Added a clarification for requirement 4.4.1: the delay between a player's action and the ad display must not exceed 1/3 of a second.
- The documentation is now available in Vietnamese.
- 25.09
- Updated the clarification for requirement 1.19:
- The Game Ready call may take up to 90 seconds to return.
- If Game Ready isn't integrated, you'll see a red indicator
- Moved the loader validation logic into the SDK Initialization section.
- Updated the clarification for requirement 4.4.1: the maximum delay allowed between a user action and the ad display is 0.33 seconds, or 330 milliseconds.
- Removed Korean from the list of supported languages.
- Updated the answer to the question "What conditions affect the revenue from a game?"On the Monetization.
- Updated the clarification for requirement 1.19:
- 11.09
- Added a calibration list for Game Ready and the loader (item 1.19.2) to help verify the correct invocation of the
LoadingAPI.ready()
method in the game. - Updated the instructions on the Promotion in the catalog and on game pages.
- Replaced the example of a game with a timer in the clarification for requirement 4.4.1.
- Revised requirement 2.13: a game is considered popular if the Rating has been generated for it at least once in the last 100 days.
- Added a calibration list for Game Ready and the loader (item 1.19.2) to help verify the correct invocation of the
- 3.09
-
Revised the clarification for requirement 4.4.1 and updated the example of a game with merge mechanics.
-
Expanded the A/B icon testing section. Now you can:
- Launch testing for Russian-speaking, international, or the entire catalog audience. To gain the most accurate insights, choose A/B testing for the entire audience.
- Use the
- Based on the test results, select the audience for which you want to apply the experiment (when testing across the entire audience).
Testing is now limited to a 14-day period. To obtain statistically significant results, run the experiment for at least 7 days.
-
- 31.10
- Changed the maximum length of the field SEO description to 160 characters.
- Added requirements for desktop devices:
- Abolished requirement points 1.6.1.4 and 4.4.2.
- 23.10
- Added instruction for checking the delay before the advertisement for compliance with the requirements.
- 9.10
- Updated the Events page: added a section on
game_api_pause
andgame_api_resume
, which the platform uses to inform the game to pause or resume gameplay. They help comply with moderation requirements (sections 1.3 and 4.7). - Added new monetization metrics for in-game purchases: Paying Share and Average in-app revenue per paying user.
- Updated the Server Time page.
- Updated information in the explanation for requirements section 4.4.1: a level is considered long if an adult user spends more than five minutes to complete it without losses.
- Clarified the wording of requirement section 3.6.
- Updated the Events page: added a section on
- 2.10
- Documented the
GamesAPI.getAllGames()
andGamesAPI.getGameByID()
methods. Use them to get compliant links to other games (item 8.4.1). - Added a calibration list for game title matching across all materials (item 5.1.3).
- Described the debug panel, which you can use to test your game and check it for compliance with our guidelines.
- Updated the section If I don't want to add ads to my game, can I skip the SDK installation?
- Changed the parameter for getting the currency icon URL in the
getPriceCurrencyImage()
method.
- Documented the
- 27.11
- Shortened requirement section 8.2.3 and removed its subsections describing exceptions.
- Added a calibration list for basic violations (item 1.15).
- 19.11
- Supplemented the calibration list for correct display (item 1.10) with a section on Checking game adaptability. Use images of popular screen resolutions for self-checking.
- Changed requirement section 1.21: all game files do not exceed 100 MB in uncompressed form.
- 12.11
- Added requirement item 1.24: do not upload a completely different game as an update.
- Expanded requirement item 5.1.1:
- Added a section about the rules of advertising when opening dialogue windows in clarification of requirement 4.4.1.
- 27.12
- Added calibration list for game translation in various languages (item 8.2.3).
- Added new requirements for TV games: the application should not contain in-app purchases and links to other games (items 1.6.3.4 and 1.6.3.5).
- Added a page Methods for testing in-game purchases with descriptions of steps to verify game compliance with requirement item 1.13.
- 25.12
- Updated the page Quick Start.
- 23.12
- Examples with prohibited mechanics and elements have been moved to the section Pornography (item 8.3.5).
- 18.12
- Added an item about calls for nudity and examples to it to the forbidden erotic content list (item 8.3.5).
- 12.12
- Added a calibration checklist for gameplay markup (section 1.19.3), which will help verify the correct calling of
GameplayAPI.start()
andGameplayAPI.stop()
methods in the game. - Added requirement item 1.19.4: if
game_api_pause
andgame_api_resume
events are being tracked in the game, handle them as described in the Pause and Resume Events section. - Added information about debug panel functions:
- Change the game language using the Choose Game Lang parameter.
- Check compliance with requirement item 8.4.1 using the link icon 🔗.
- Updated information in the section Testing the game in different languages: test games with the debug panel enabled.
- Added a calibration checklist for gameplay markup (section 1.19.3), which will help verify the correct calling of
- 3.12
- Removed outdated examples from the calibration list regarding content duration in the Replayability, Both sections.
- 30.01
- Moved the information about technical messages to a new calibration list (item 1.14).
- Abolished requirement item 4.4.1, the information from it was transferred to 4.4.
- Added a verification description for requirement item 1.10.2: the game should not have system scrolling and swipe to refresh.
- 24.01
- Added a new metric Conversion To Play.
- 23.01
- Clarified the information about connecting Yandex Games SDK: specify the current path depending on the game placement method.
- 15.01
- Shortened requirement item 2.4.
- Added a calibration list for game mechanics (item 2.4).
- Abolished requirements clause 2.12.
- Abolished 7 requirements section.
- Updated the documentation structure.
- Added link to Unity SDK to help prepare the project for publication on Yandex Games.
- 28.02
- Removed outdated information about sound on iOS from the verification method of requirement item 1.3.
- 25.02
- Updated requirement item 5.1.1.1: it is prohibited to use gameplay from other games in promotional materials and identical promotional materials in different games.
- Gathered information about ad monetization on a single page.
- 21.02
- Described how to find the exchange rate of the portal currency to currencies of different countries.
- Modified requirement item 8.4.1: use SDK methods to add correct links to your other games.
- Added a verification method to requirement point 8.4.1.
- 18.02
- On the Events page, the outdated method
onEvent()
was replaced withon()
.
- On the Events page, the outdated method
- 14.02
- Updated the link to the repository of the PluginYG plugin for Unity.
- 06.02
- Clarified information about adding games to the platform:
- Replaced the name of the feature-meter scale with Card Completion Progress.
- Added clarifications to the requirements points:
- 28.03
- Wrote instructions on how to add the SDK to an application developed in TypeScript.
- Restored information about sound on iOS in the verification methodology of requirement item 1.3.
- 27.03
- Collected explanations for requirement items 1.2 and 1.2.1 on the Authorization page.
- 25.03
- Added a page about moderation.
- Added documentation for the Construct 3 plugin.
- 21.03
- Added the Purchase metrics page: purchase statistics can now be viewed through the Yandex Games console.
- 17.03
- Clarified that the choice of parameter in ysdk.getPayments() depends on where purchases are processed: on the client side (
signed: false
) or on the server side (signed: true
). - Changed requirement section 2.14: the game's language should be determined automatically through the SDK. Subsections have been abolished.
- Added requirement section 6.9. Information from the abolished subsections 2.14 was moved here: if the game's language can be selected manually, then there is no need to know the current language.
- Clarified that the choice of parameter in ysdk.getPayments() depends on where purchases are processed: on the client side (
- 12.03
- Updated information about the request for access to player data: the dialog box is no longer displayed, and the user specifies permissions in their profile.
- 10.03
- Added information about the limit for the method ysdk.getPlayer().
- Clarified the instructions for checking links to other games.
- 02.04
- Compiled general information about monetization on a single page.
- Added documentation for the Cocos Creator plugin.
- 06.05
- Clarified requirement point 8.4.3: links are only allowed to public communities.