---
metadata:
  - name: generator
    content: Diplodoc Platform v5.66.0
alternate:
  - https://yandex.com/dev/games/doc/en/console/promo-add.md
  - https://yandex.com/dev/games/doc/hi/console/promo-add.md
  - https://yandex.com/dev/games/doc/ko/console/promo-add.md
  - https://yandex.com/dev/games/doc/ru/console/promo-add.md
  - https://yandex.com/dev/games/doc/tr/console/promo-add.md
  - https://yandex.com/dev/games/doc/vi/console/promo-add.md
  - https://yandex.com/dev/games/doc/zh/console/promo-add.md
  - href: https://yandex.com/dev/games/doc/en/console/promo-add.md
    type: text/markdown
    title: Markdown version
  - href: https://yandex.com/dev/games/doc/en/llms.txt?revision=r21993288
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/games/doc/en/llms.txt?revision=r21993288

# Integration

<!-- source: en/_includes/script-common.md -->
<!-- source: en/_includes/script/index-js.md -->

<!-- endsource: en/_includes/script/index-js.md -->

<!-- source: en/_includes/script/requirements-js.md -->

<!-- endsource: en/_includes/script/requirements-js.md -->

<!-- source: en/_includes/script/image-modal-js.md -->

<!-- endsource: en/_includes/script/image-modal-js.md -->
<!-- endsource: en/_includes/script-common.md -->

For the promo to appear in the catalog:

1. [Add it to the game](#add-to-game){.arrow}
1. [Fill out the form in the Console](#activate){.arrow}

All events go through review — follow the [requirements](https://yandex.com/dev/games/doc/en/console/promo-rules.md) so your promo passes on the first try.

After the promo ends, [remove it from the game](#finish).



## Step 1. Add the promo to the game {#add-to-game}

1. Add to the game:

    - Promo content (for example, new levels, prizes, bundles).
    - Transition handling using [ysdk.environment.referrer](https://yandex.com/dev/games/doc/en/sdk/sdk-environment.md#structure-referrer).

2. Enable the promo using one of the following methods:

    - Via [remote configuration](https://yandex.com/dev/games/doc/en/config.md) — the recommended method, doesn't require re-moderation of the build.

        {% cut "How to set up" %}

        1. Plan promotions in your game in advance.
        1. In the [Developer Console](https://games.yandex.com/console){.external}, add [flags](https://yandex.com/dev/games/doc/en/config.md). You can configure them to activate at specific times or switch between configurations with and without the promo manually.
        1. Update the build: use the [ysdk.getFlags()](https://yandex.com/dev/games/doc/en/sdk/sdk-config.md) method to configure the promo display logic in the game.
        1. [Update the game](https://yandex.com/dev/games/doc/en/console/update-game.md) and pass moderation. A full review is only required once. After that, you can enable and disable promos using flags.
        1. Enable the required flag before the promo starts: moderation will additionally verify that the event has actually been added to the game. If the flag is not enabled at the time of review, the promo will not pass moderation.

        {% endcut %}

    - Via a [build update](https://yandex.com/dev/games/doc/en/console/update-game.md) without setting up conditions — suitable for one-time promos: moderation will be required each time.



## Step 2. Activate the promo in the Console {#activate}

1. In the [Yandex Games Console](https://games.yandex.com/console){.external}, go to the **Promos** tab and click **Create a promo**.

1. Fill out the fields:

    #|
    || **Field** | **Description** | **Required** ||
    || **Activated** | The option will be enabled if moderators approve the promo. |  ||
    || **Promo start** |

    Specify the date and time for the promo to start. The selected time must be no earlier than 30 days and no later than 72 hours from the current time. The actual promo start time may be delayed until moderation is complete.

    The system takes the user's timezone into account.

    |::{align="center"}

    ![SVG](../_images/icons/yes-button.svg)

    ||
    || **Promo end** |

    Specify the date and time for the promo to end. The maximum duration of the promo is 10 days.

    The system takes the user's timezone into account.

    |::{align="center"}

    ![SVG](../_images/icons/yes-button.svg)

    ||
    || **Promo type** |

    Affects how the promo is displayed on the storefront and in analytics.

    - **Event** — promos focused on gameplay mechanics: tasks, item collection, tournaments, leaderboards, new seasons. No purchase required to participate.
    - **Offer** — promos with a direct purchase benefit: discount percentage, multiplier, bonus amount, promo code, starter pack.

    {% note info %}

    If a promo combines mechanics and a discount, choose based on the primary content.

    "—" — a legacy option for old promos.

    {% endnote %}

    [Promo type comparison](https://yandex.com/dev/games/doc/en/console/promo-and-discounts.md#promo-types){.arrow}

    <!-- -->

    |::{align="center"}

    ![SVG](../_images/icons/yes-button.svg)

    ||
    || **Intent** | A custom hint for routing within the game and analytics. For example: `open_shop`, `open_starter_pack`. Passed to the [SDK](https://yandex.com/dev/games/doc/en/sdk/sdk-environment.md#structure-referrer) when navigating from the promo. |  ||
    || **In-app ID** | The [in-app purchase ID](https://yandex.com/dev/games/doc/en/console/purchases.md#add-purchases) linked to the promo in the game. The link allows the game to immediately open the platform's purchase dialog. Available when the **Offer** type is selected. |  ||
    || **Cover** |

    The event banner.

    Size — 928 × 540 pixels.

    Format — PNG.

    [Design requirements](https://yandex.com/dev/games/doc/en/console/promo-rules.md#banner){.arrow}

    <!-- -->

    |  ||
    || **Title** |

    Promo name.

    Maximum length — 50 characters (including punctuation).

    [Design requirements](https://yandex.com/dev/games/doc/en/console/promo-rules.md#name){.arrow}

    <!-- -->

    |::{align="center"}

    ![SVG](../_images/icons/yes-button.svg)

    ||
    || **Description** |

    Promo description.

    Maximum length — 120 characters (including punctuation).

    [Design requirements](https://yandex.com/dev/games/doc/en/console/promo-rules.md#description){.arrow}

    <!-- -->

    |::{align="center"}

    ![SVG](../_images/icons/yes-button.svg)

    ||
    |#

    {% note info %}

    By default, promos are set to Russian. For text fields (**Title** and **Description**), you can:

    - Add another language — click ![SVG](../_images/icons/add-purchase.svg) and select a language from the list.
    - Remove an unused language — click ![SVG](../_images/icons/delete-button.svg) to the right of it. Russian cannot be removed.

    {% endnote %}

1. Click **Submit for moderation**. Moderators will review the promo against the [requirements](https://yandex.com/dev/games/doc/en/console/promo-rules.md), which usually takes 1–3 business days.

You will see the review results in the [Console](https://games.yandex.com/console){.external}:

- Once moderation is complete, the promo will appear in the [Discounts and promos](https://games.yandex.com/promos){.external} section and other curated collections in the Yandex Games catalog.
- If the promo doesn't pass moderation, it won't appear in the catalog. We'll send the rejection reasons to the email address specified in the [developer profile](https://yandex.com/dev/games/doc/en/console/manage-account.md#profile-manage).



## After the promo ends {#finish}

- If you enabled it via remote configuration — disable the promo in the [Developer Console](https://games.yandex.com/console){.external}.
- If you updated the build — repeat the process: upload a new archive with the promo disabled and go through moderation.