Изменение настроек
Изменяет текущие настройки экспорта Data Stream.
Формат запроса
POST https://api.appmetrica.yandex.ru/management/v1/application/{id}/datastream/settings
|
Идентификатор приложения. |
Формат тела запроса
{
"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",
...
]
}
]
}
}
|
Объект с настройками. |
|
Признак включения работы всего Data Stream для приложения. |
|
Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных. |
|
Тип данных для экспорта. Допустимые значения:
|
|
Признак включения экспорта для указанного типа данных. |
|
Формат экспорта данных. Допустимые значения: |
|
Содержит список наборов полей CSV, которые были использованы для формирования окон данных. |
|
|
|
|
Формат ответа
{
"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",
...
]
}
]
}
}
|
Ответ API. |
|
Признак включения работы всего Data Stream для приложения. |
|
Список объектов-настроек экспорта. Один объект настроек соответствует одному типу выгружаемых данных. |
|
Тип данных, из которых сформирован поток. Допустимые значения:
|
|
Признак включения экспорта для указанного типа данных. |
|
Формат экспорта данных. Допустимые значения: |
|
Содержит список наборов полей CSV, которые были использованы для формирования окон данных. |
|
|
|
|
Пример
Запрос:
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",
...
]
}
]
}
}
Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.