/api/segment/v1/export/create.json?idSegment=1&requestFields=gaid,idfa
Создайте запрос на выгрузку сегмента в CSV-файлы.
Выгружать сегменты могут только владельцы аккаунта и те пользователи, которым выдано разрешение на выгрузку. Подробнее см. раздел Управление пользователями.
POST https://tracker.my.com/api/segment/v1/export/create.json
Название | Значение | Описание | Примечание |
---|---|---|---|
idSegment * | Идентификатор одного из доступных вам сегментов Например: 1 или idSegment=1 |
ID выгружаемого сегмента | |
requestFields | Несколько значений выгружаемых полей, через запятую или в виде
массива Например: requestFields=gaid,idfa |
Список идентификаторов, которые будут включены в выгрузку. Если список пуст или не передан, то будут выгружены все возможные поля | Список возможных полей зависит от типа аудитории в сегменте. Сегмент по пользователям:
|
includeHeaderLine | Одно из значений: 0 — выкл. 1 — вкл. (по умолчанию) Например: includeHeaderLine=1 |
Добавление первой строки с названиями колонок в первый файл | |
registerType | Одно из значений: 0 — Без изменений (по умолчанию) 1 — Общепринятый 2 — Нижний регистр 3 — Верхний регистр Например: registerType=1 |
Выбор регистра идентификаторов | Регистр можно выбрать только для идентификаторов в сегменте по устройствам:
|
hashType | Одно из значений: 0 — Без хеширования (по умолчанию) 1 — MD5 2 — SHA256 Например: hashType=1 |
Хеширование идентификаторов | Список хешируемых идентификаторов зависит от типа аудитории в сегменте. Сегмент по пользователям:
|
maxBatchFileSize | Целое число. Максимальный размер одного файла в архиве в MБ | Разделение файла выгрузки в ZIP-архиве на несколько файлов | Размер файла в диапазоне от 10 до 4 095 МБ |
* — обязательные параметры
Таблица содержит описание идентификаторов, которые можно выгрузить с помощью параметра requestFields
.
Сегмент по устройствам | |
---|---|
idApp | Идентификатор приложения в MyTracker |
idProfile | Идентификатор устройства в приложении. Определяет пару приложение+отдельное устройство |
gaid | Рекламный идентификатор Android (advertisingId) |
idfa | Рекламный идентификатор iOS |
oaid | Рекламный идентификатор Huawei |
Сегмент по пользователям | |
idProject | Идентификатор проекта в MyTracker |
idProjectUser | Идентификатор пользователя в проекте. Определяет пару проект+пользователь (idProject + CustomUserId) |
CustomUserID | Идентификатор пользователя, переданный через SDK. Определяет отдельно взятого пользователя |
Выгрузка идентификаторов gaid
и idfa
по сегменту с id
=1:
/api/segment/v1/export/create.json?idSegment=1&requestFields=gaid,idfa
Если запрос создан успешно, вы получите код ответа 200.
Идентификатор запроса будет указан в поле
idSegmentExport
:
{
"code": 200,
"message": "Ok",
"data": {
"idSegmentExport": "1"
}
}
При ошибках в передаваемых параметрах вы получите код ответа 400. Например:
{
"code": 400,
"message": "Bad Request",
"data": {
"error": {
"detail": "Argument 'idSegment' is invalid"
}
}
}
{
"code": 403,
"message": "Access denied",
"data": null
}
{
"code": 400,
"message": "Bad Request",
"data": {
"error": {
"detail": "Maximum number of simultaneous requests reached. Wait until there is space available in the queue.",
"info": {
"exports": [
{
"idSegmentExport": "1"
}
]
}
}
}
}
{
"code": 400,
"message": "Bad Request",
"data": {
"error": {
"detail": "This segment is already being exported"
}
}
}