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

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

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

Примечание

Ограничение на размер файла — 1 Гб.

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

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

POST https://api-metrika.yandex.net/cdp/api/v1/counter/2215573/data/contacts/csv?
    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--

Request

POST

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/contacts/csv

Path parameters

Name

Description

counterId*

Type: integer<int32>

Идентификатор счетчика, для которого вы хотите загрузить данные о клиентах.
Example: 2215573

Query parameters

Name	Description
columns_mapping*	Type: string Соответствие названий столбцов названиям атрибутов. Example: `"uniq_id":"ИД","name":"Имя","birth_date":"Дата рождения"` Pattern: `"([^"]+)":"([^"]+)"`
merge_mode*	Type: string Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются. `SAVE` — вся ранее переданная информация полностью заменяется новой. Подробно. `UPDATE` – обновляется только та информация, которую вы загружаете в данный момент. Подробно. `APPEND` — новая информация добавляется к ранее загруженной. Подробно. Example: `SAVE`
delimiter_type	Type: string Вид разделителя столбцов в файле: `COMMA` — разделитель "запятая". `SEMICOLON` — разделитель "точка с запятой". Default: `COMMA`

Body

multipart/form-data

{
    "file": null
}

Name

Description

file*

Type: string<binary>

Ограничение на размер файла — 1 Гб.

Responses

200 OK

Body

application/json

{
    "uploading": {
        "uploading_id": "string",
        "datetime": "2022-12-29T18:02:01Z",
        "api_validation_status": "string",
        "elements_count": 0,
        "entity_type": "string",
        "uploading_format": "string",
        "uploading_source": "string"
    }
}

Name

Description

uploading

Type: UploadingMetaExternal

Информация о загрузке

UploadingMetaExternal

Информация о загрузке

Name	Description
api_validation_status	Type: string Статус валидации загрузки: `PASSED` — валидация прошла успешно. `FAILED` — валидация прошла не успешно.
datetime	Type: string<date-time> Время загрузки.
elements_count	Type: integer<int32> Количество элементов в загрузке.
entity_type	Type: string Тип сущности: `SYSTEM` — системная сущность, например, контакты или заказы. `CUSTOM_LIST` — пользовательский список. `SYSTEM_LIST` — системный список, например товары.
uploading_format	Type: string Формат загрузки. Возможные значения: `JSON`. `CSV`.
uploading_id	Type: string Идентификатор загрузки.
uploading_source	Type: string Источник загрузки. Возможные значения: `API`.

Была ли статья полезна?

Формат данных о клиентах

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