Изменение настроек

Изменяет текущие настройки экспорта Data Stream.

Формат запроса

POST https://api.appmetrica.yandex.ru/management/v1/application/{id}/datastream/settings

`id`	Идентификатор приложения.

Формат тела запроса

{
    "settings": {
        "ui_checkbox_enabled": boolean,
        "export_fields": [
            {
                "data_type": string,
                "enabled": boolean,
                "export_format": string,
                "fields": ["profile_id", "os_name", "event_name", "event_timestamp", ... ],
                "include_events": ["Useful Event 1", "Useful Event 2", ... ],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2", ... ],
                "event_attribution": string
            },
            ...
        ]
    }
}

`settings`	Объект с настройками.
`settings.ui_checkbox_enabled`	Признак включения работы всего Data Stream для приложения.
`settings.export_fields`	Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных.
`settings.export_fields[i].data_type`	Тип данных для экспорта. Допустимые значения: `event` `installation` `session_start` `session_end` `push_token` `crash` `error` `click` `revenue` `ecommerce` `ad_revenue` `attributed_event`
`settings.export_fields[i].enabled`	Признак включения экспорта для указанного типа данных.
`settings.export_fields[i].export_format`	Формат экспорта данных. Допустимые значения: `csv`, `json`.
`settings.export_fields[i].fields`	Содержит список наборов полей CSV, которые были использованы для формирования окон данных.
`settings.export_fields[i].include_events`	«Белый список» имен событий. Если список не пуст, в экспорт попадут только те события, `event_name` которых присутствуют в списке. Ограничение: 10 тыс. элементов.
`settings.export_fields[i].exclude_events`	«Черный список» имен событий. Из экспорта будут исключены события, `event_name` которых присутствуют в списке. Ограничение: 10 тыс. элементов.
`settings.export_fields[i].event_attribution`	Модель атрибуции для типа данных `attributed_event`. Допустимые значения: `first_appmetrica` — «first click» в терминах AppMetrica; `last_appmetrica` — «last click» в терминах AppMetrica. Если не указать, будет использоваться значение по умолчанию: `last_appmetrica`.

Формат ответа

{
    "settings": {
        "ui_checkbox_enabled": boolean,
        "export_fields": [
            {
                "data_type": string,
                "enabled": boolean,
                "export_format": string,
                "fields": ["profile_id", "os_name", "event_name", "event_timestamp", ... ],
                "include_events": ["Useful Event 1", "Useful Event 2", ... ],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2", ... ],
                "event_attribution": string
            },
            ...
        ]
    }
}

`settings`	Ответ API.
`settings.ui_checkbox_enabled`	Признак включения работы всего Data Stream для приложения.
`settings.export_fields`	Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных.
`settings.export_fields[i].data_type`	Тип данных, из которых сформирован поток. Допустимые значения: `event` `installation` `session_start` `session_end` `push_token` `crash` `error` `click` `revenue` `ecommerce` `ad_revenue` `attributed_event`
`settings.export_fields[i].enabled`	Признак включения экспорта для указанного типа данных.
`settings.export_fields[i].export_format`	Формат экспорта данных. Допустимые значения: `csv`, `json`.
`settings.export_fields[i].fields`	Содержит список наборов полей CSV, которые были использованы для формирования окон данных.
`settings.export_fields[i].include_events`	«Белый список» имен событий. Если список не пуст, в экспорт попадут только те события, `event_name` которых присутствуют в списке. Ограничение: 10 тыс. элементов.
`settings.export_fields[i].exclude_events`	«Черный список» имен событий. Из экспорта будут исключены события, `event_name` которых присутствуют в списке. Ограничение: 10 тыс. элементов.
`settings.export_fields[i].event_attribution`	Модель атрибуции для типа данных `attributed_event`. Допустимые значения: `first_appmetrica` — «first click» в терминах AppMetrica; `last_appmetrica` — «last click» в терминах AppMetrica. Если не указать, будет использоваться значение по умолчанию: `last_appmetrica`.

Пример

Запрос:

curl -X POST 'https://api.appmetrica.yandex.ru/management/v1/application/1111/datastream/settings' \
-H 'Content-Type: application/json' \
-H 'Authorization: OAuth oauth_token' \
-d '{
    "settings": {
        "ui_checkbox_enabled": true,
        "export_fields": [
            {
                "data_type": "installation",
                "enabled": true,
                "export_format": "csv",
                "fields": ["publisher_name", "publisher_id", "tracker_name", "tracking_id", "click_timestamp"]
            },
            {
                "data_type": "event",
                "enabled": true,
                "export_format": "csv",
                "fields": ["profile_id", "os_name", "event_name", "event_timestamp"],
                "include_events": ["Useful Event 1", "Useful Event 2"],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"]
            },
            {
                "data_type": "attributed_event",
                "enabled": true,
                "export_format": "csv",
                "fields": ["attributed_event_type", "event_name", "conversion_id", "conversion_name"],
                "include_events": ["Useful Event 1", "Useful Event 2" ],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"],
                "event_attribution": "last_appmetrica"
            }
        ]
    }
}'

Ответ:

{
    "settings": {
        "ui_checkbox_enabled": true,
        "export_fields": [
            {
                "data_type": "installation",
                "enabled": true,
                "export_format": "csv",
                "fields": ["publisher_name", "publisher_id", "tracker_name", "tracking_id", "click_timestamp"],
                "include_events": [],
                "exclude_events": []
            },
            {
                "data_type": "event",
                "enabled": true,
                "export_format": "csv",
                "fields": ["profile_id", "os_name", "event_name", "event_timestamp"],
                "include_events": ["Useful Event 1", "Useful Event 2"],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"]
            },
            {
                "data_type": "attributed_event",
                "enabled": true,
                "export_format": "csv",
                "fields": ["attributed_event_type", "event_name", "conversion_id", "conversion_name"],
                "include_events": ["Useful Event 1", "Useful Event 2"],
                "exclude_events": ["Ignored Event 1", "Ignored Event 2"],
                "event_attribution": "last_appmetrica"
            }
        ]
    }
}

Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.

Написать в службу поддержки

Была ли статья полезна?

Получение настроек

Post API