Загрузка информации о клиентах и заказах (CSV)

Метод помогает отправлять в Метрику информацию о заказах и клиентах в CSV-файле без дополнительных настроек. Для сбора статистики достаточно передавать дату и время создания заказа в часовом поясе счетчика (create_date_time) и один из параметров клиентов (ClientID, номер телефона или адрес электронной почты). Вы можете передавать заказы в разных статусах с данными о выручке и себестоимости.

Отправленная информация учитывается в отчетах Сквозной аналитики. Кроме этого, вы можете использовать данные для ретаргетинга и оптимизации конверсий в Директе.

Подробно о формате передаваемых данных

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

При отправке данных о заказах в параметре merge_mode передавайте значение, соответствующее состоянию загружаемых заказов. Если при повторной отправке данных вы не уверены, какой именно статус нужно передавать, укажите значение SAVE.

  1. Синтаксис запроса
  2. В теле запроса
  3. Формат ответа

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

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

https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/simple_orders
 ? merge_mode=<update_type>
 & [delimiter_type=<delimiter_type>]
merge_mode *Режим сохранения данных. При любом из значений передавайте все обязательные поля — даже те, которые не меняются.

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

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

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

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

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

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

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

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

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

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

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

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


POST https://api-metrika.yandex.net/cdp/api/v1/counter/2215573/data/simple_orders?
    merge_mode=SAVE&
    columns_mapping=
        "client_uniq_id":"ИД клиента",
        "order_status":"id123",
        "create_date_time" : "2020-04-17 16:12:21",
        "emails" : ["exampl1@example.com","example2@example.com"],
        "phones" : ["88005553535", "83449932378"],
        "revenue":"Сумма"&
    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,paid,2020-06-11 12:30:00,43089.54
42,paid,2019-10-11 09:10:00,109999
42,created,2020-12-24 12:30:00,1004.17
--------------------------7zDUQOAIAE9hEWoV--

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

POST https://api-metrika.yandex.net/cdp/api/v1/counter/{counterId}/data/simple_orders?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