修改设置

更改当前 Data Stream 导出设置。

请求格式

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

id

App 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
            },
            ...
        ]
    }
}

设置

具有设置的对象。

设置.ui_checkbox_已启用

表示整个数据流是否已为应用启用。

设置.导出字段

导出设置对象列表。 一个设置对象对应一种导出的数据类型。

设置.export_fields[i].data_type

导出的数据类型。

可接受的值：

  • event
  • 安装
  • session_start
  • session_end
  • push_token
  • 崩溃
  • 错误
  • 点击
  • 收入
  • 电子商务
  • 广告收入
  • attributed_event
  • 深链

设置.导出字段[i].已启用

表示是否已为指定数据类型启用导出功能。

设置.导出字段[i].导出格式

数据导出格式。 可接受的值：csv、json。

设置.export_fields[i].fields

包含用于生成数据窗口的 CSV 字段集列表。

设置.导出字段[i].包含事件

事件名称白名单。 如果列表不为空，则仅导出 event_name 在列表中的事件。 限制：1 万项。

settings.export_fields[i].exclude_events

事件名称黑名单。 event_name 在列表中的事件将从导出中排除。 限制：1 万项。

设置.导出字段[i].事件归因

attributed_event 数据类型的归因模型。 可接受的值：

  • first_appmetrica — 就 AppMetrica 而言的"首次点击"；
  • last_appmetrica — 就 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
            },
            ...
        ]
    }
}

设置

API 响应。

设置.ui_复选框_已启用

表示整个数据流是否已为应用启用。

设置.导出字段

导出设置对象列表。 一个设置对象对应一种导出数据类型。

设置.导出字段[i].数据类型

构成流的数据类型。

可接受的值：

  • event
  • installation
  • session_start
  • session_end
  • push_token
  • crash
  • error
  • click
  • revenue
  • ecommerce
  • ad_revenue
  • attributed_event
  • deeplink

设置.导出字段[i].已启用

表示是否已为指定数据类型启用导出功能。

设置.导出字段[i].导出格式

数据导出格式。 可接受的值：csv、json。

设置.导出字段[i].字段

包含用于生成数据窗口的 CSV 字段集列表。

设置.导出字段[i].包含事件

事件名称白名单。 如果列表不为空，则仅导出 event_name 在列表中的事件。 限制：1 万项。

settings.export_fields[i].exclude_events

事件名称黑名单。 event_name 在列表中的事件将从导出中排除。 限制：1 万项。

设置.导出字段[i].事件归因

attributed_event 数据类型的归因模型。 可接受的值：

  • first_appmetrica — 就 AppMetrica 而言的"首次点击"；
  • last_appmetrica — 就 AppMetrica 而言的"最后一次点击"。

如果未指定，则使用默认值 last_appmetrica。

Example

请求：

curl -X POST 'https://api.appmetrica.yandex.com/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