Изменение настроек
Изменяет текущие настройки экспорта Data Stream.
Формат запроса
POST https://api.appmetrica.yandex.ru/management/v1/application/{id}/datastream/settings
id | Идентификатор приложения. |
id | Идентификатор приложения. |
Формат тела запроса
{
"settings": {
"ui_checkbox_enabled": boolean,
"export_fields": [
{
"data_type": string,
"enabled": boolean,
"export_format": string,
"fields": [
"publisher_name",
"publisher_id",
"tracker_name",
"tracking_id",
"click_timestamp",
...
],
"include_events": [],
"exclude_events": []
},
{
"data_type": string,
"enabled": boolean,
"export_format": string,
"fields": [
"profile_id",
"os_name",
"event_name",
"event_json",
"event_timestamp",
...
],
"include_events": [
"My Helpful Event 1",
"My Helpful Event 2",
...
],
"exclude_events": [
"Ignored Event 1",
"Ignored Event 2",
...
]
}
]
}
}
settings
Объект с настройками.
ui_checkbox_enabled
Признак включения работы всего Data Stream для приложения.
export_fields
Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных.
data_type
Тип данных для экспорта.
Допустимые значения:
event
;installation
;session_start
;push_token
;crash
;error
;click
.
enabled
Признак включения экспорта для указанного типа данных.
export_format
Формат экспорта данных. Допустимые значения:
csv
, json
.fields
Список строковых имен полей, выбранных для экспорта. Подробнее о полях в статье Типы данных для экспорта.
include_events
«Белый список» имен событий. Если список не пуст, в экспорт попадут только те события,
event_name
которых присутствуют в списке. Ограничение: 10 тыс. элементов. exclude_events
«Черный список» имен событий. Из экспорта будут исключены события,
event_name
которых присутствуют в списке. Ограничение: 10 тыс. элементов. Формат ответа
{ "settings": { "ui_checkbox_enabled": boolean, "export_fields": [ { "data_type": string, "enabled": boolean, "export_format": string, "fields": [ "publisher_name", "publisher_id", "tracker_name", "tracking_id", "click_timestamp", ... ], "include_events": [], "exclude_events": [] }, { "data_type": string, "enabled": boolean, "export_format": string, "fields": [ "profile_id", "os_name", "event_name", "event_json", "event_timestamp", ... ], "include_events": [ "My Helpful Event 1", "My Helpful Event 2", ... ], "exclude_events": [ "Ignored Event 1", "Ignored Event 2", ... ] } ] } }
Скопировано
settings
Ответ API.
ui_checkbox_enabled
Признак включения работы всего Data Stream для приложения.
export_fields
Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных.
data_type
Тип данных для экспорта.
Допустимые значения:
event
;installation
;session_start
;push_token
;crash
;error
;click
.
enabled
Признак включения экспорта для указанного типа данных.
export_format
Формат экспорта данных. Допустимые значения:
csv
, json
.fields
Список строковых имен полей, выбранных для экспорта. Подробнее о полях в статье Типы данных для экспорта.
include_events
«Белый список» имен событий. Если список не пуст, в экспорт попадут только те события,
event_name
которых присутствуют в списке. Ограничение: 10 тыс. элементов. exclude_events
«Черный список» имен событий. Из экспорта будут исключены события,
event_name
которых присутствуют в списке. Ограничение: 10 тыс. элементов. Пример
Запрос:
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", ... ], "include_events": [], "exclude_events": [] }, { "data_type": "event", "enabled": true, "export_format": "csv", "fields": [ "profile_id", "os_name", "event_name", "event_json", "event_timestamp", ... ], "include_events": [ "My Helpful Event 1", "My Helpful Event 2", ... ], "exclude_events": [ "Ignored Event 1", "Ignored Event 2", ... ] } ] } }'
Скопировано
Ответ:
{ "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_json", "event_timestamp", ... ], "include_events": [ "My Helpful Event 1", "My Helpful Event 2", ... ], "exclude_events": [ "Ignored Event 1", "Ignored Event 2", ... ] } ] } }
Скопировано