Загрузка данных о клиентах (CSV)

Выполняет загрузку данных о клиентах.

Данные передаются как multipart/form-data в формате CSV. В первой строке запроса необходимо передать названия колонок. Подробно о формате передаваемых данных.

Пример загружаемого файла

Синтаксис запроса

counterId — идентификатор счетчика, для которого вы хотите загрузить данные о клиентах.

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts
 ? merge_mode=<update_type>
 & [columns_mapping=<string>]
 & [delimiter_type=<delimiter_type>]

merge_mode *

Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

Допустимые значения:

SAVE — вся ранее переданная информация полностью заменяется новой. Подробно
UPDATE — обновляется только та информация, которую вы загружаете в данный момент. Подробно
APPEND — новая информация добавляется к ранее загруженной. Подробно

columns_mapping Соответствие названий столбцов названиям атрибутов.

delimiter_type

Вид разделителя столбцов в файле.

Значение по умолчанию: COMMA

Допустимые значения:

COMMA — разделитель "запятая"
SEMICOLON — разделитель "точка с запятой"

^* Обязательный параметр

В теле запроса


POST https://api-metrika.yandex.net/cdp/api/v1/counter/2215573/data/contacts?
    merge_mode=SAVE&
    columns_mapping=
        "uniq_id":"ИД",
        "name":"Имя",
        "emails":"Почта",
        "age":"Возраст"&
    delimiter_type=COMMA
Content-Type: multipart/form-data; boundary=------------------------7zDUQOAIAE9hEWoV
Context-Length: TBD

--------------------------7zDUQOAIAE9hEWoV
Content-Disposition: form-data; name="file"; filename="data.csv"
Content-Type: text/csv

ИД,Имя,Почта,Возраст
11,Иван И.,example@example.com,40
42,Михаил Л.,somebody@example.com,24
--------------------------7zDUQOAIAE9hEWoV--

Пример запроса

POST https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts?merge_mode=SAVE

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


{
    "uploading" : {
        "uploading_id" :  < string > ,
        "datetime" :  < local_date_time > ,
        "api_validation_status" :  < api_validation_status > ,
        "elements_count" :  < integer > ,
        "entity_type" :  < entity_type > ,
        "entity_subtype" :  < string > ,
        "uploading_format" :  < uploading_format > ,
        "uploading_source" :  < uploading_source > 
    }
}


Параметры	Описание
uploading	Информация о загрузке
uploading
uploading_id	Идентификатор загрузки
datetime	Время загрузки
api_validation_status	Статус валидации загрузки Возможные значения: PASSED — Валидация прошла успешно FAILED — Валидация прошла не успешно
elements_count	Количество элементов в загрузке
entity_type	Тип сущности Возможные значения: SYSTEM — Системная сущность, например контакты или заказы CUSTOM_LIST — Пользовательский список SYSTEM_LIST — Системный список, например товары
entity_subtype	Подтип сущности
uploading_format	Формат загрузки Возможные значения: JSON — JSON CSV — CSV
uploading_source	Источник загрузки Возможные значения: API — API


Параметры	Описание
uploading	Информация о загрузке
uploading
uploading_id	Идентификатор загрузки
datetime	Время загрузки
api_validation_status	Статус валидации загрузки Возможные значения: PASSED — Валидация прошла успешно FAILED — Валидация прошла не успешно
elements_count	Количество элементов в загрузке
entity_type	Тип сущности Возможные значения: SYSTEM — Системная сущность, например контакты или заказы CUSTOM_LIST — Пользовательский список SYSTEM_LIST — Системный список, например товары
entity_subtype	Подтип сущности
uploading_format	Формат загрузки Возможные значения: JSON — JSON CSV — CSV
uploading_source	Источник загрузки Возможные значения: API — API