Загрузка офлайн-конверсий

Выполняет загрузку офлайн-конверсий.

Совет

Сформируйте CSV-файл с информацией и передайте его с помощью данного метода. Также рекомендуем генерировать запросы к API в автоматическом режиме с помощью модулей языка программирования.

О том, какие данные передавать, и пример запроса см. в разделе Передача офлайн-конверсий.

Примечание

Обработка данных может занимать до двух часов.

Request

POST

https://api-metrika.yandex.net/management/v1/counter/{counterId}/offline_conversions/upload

Path parameters

Name

Description

counterId*

Type: integer<int32>

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

Query parameters

Name

Description

comment

Type: string

Комментарий. Максимальная длина — 255 символов. Допустимы цифры, латинские и кириллические буквы.

Body

multipart/form-data
{
    "file": null
}

Name

Description

file*

Type: string<binary>

Офлайн-конверсии, которые вы хотите загрузить, передаваемые как multipart/form-data.

Responses

200 OK

OK

Body

application/json
{
    "uploading": {
        "id": 0,
        "create_time": "2022-12-29T18:02:01Z",
        "source_quantity": 0,
        "line_quantity": 0,
        "comment": "string",
        "client_id_type": "USER_ID",
        "status": "string",
        "goal_not_found_quantity": 0,
        "user_not_found_quantity": 0
    }
}

Name

Description

uploading*

Type: OfflineConversionUploading

Информация о загрузке офлайн-конверсий.

OfflineConversionUploading

Информация о загрузке офлайн-конверсий.

Name

Description

client_id_type

Type: string

Тип идентификаторов посетителей. Возможные значения:

  • USER_ID — идентификатор посетителя сайта, назначенный владельцем сайта.
  • CLIENT_ID — идентификатор посетителя сайта, назначенный Яндекс Метрикой.
  • YCLID — идентификатор клика по рекламному объявлению Яндекс Директа, назначенный Яндекс Директом.

Example: USER_ID

comment

Type: string

Произвольный комментарий. Количество символов не должно превышать 255.

Min length: 0

Max length: 255

create_time

Type: string<date-time>

Время загрузки.

goal_not_found_quantity

Type: integer<int32>

Количество строк, для которых не были найдены цели.

id

Type: integer<int64>

Идентификатор загрузки.

line_quantity

Type: integer<int32>

Количество строк, прошедших валидацию при загрузке.

source_quantity

Type: integer<int32>

Количество строк в исходном файле.

status

Type: string

Статус загрузки:

  • PREPARED — загрузка подготовлена.
  • UPLOADED — загрузка завершена.
  • EXPORTED — загрузка экспортирована.
  • MATCHED — произведено сопоставление идентификаторов событий.
  • PROCESSED — загрузка успешно обработана.
  • LINKAGE_FAILURE — не удалось сопоставить ни один идентификатор посетителя. Если передана информация о статических звонках, они не будут привязаны к визитам в Метрике, но будут доступны в отчетах по звонкам.

user_not_found_quantity

Type: integer<int32>

Количество строк, для которых не были найдены подходящие посетители сайта.