报告的结构及内容如有更改,恕不另行通知。

例如,可以添加新列或更改工作表的名称。

市场推广帐目报告

方法适用于所有模式.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
  • finance-and-accounting — 查看财务信息和报告
  • all-methods — 全面管理账户
  • all-methods:read-only — 查看所有数据

开始生成营销客户报告。

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.

报告列说明:

表单Полки(文件advertiser_operations_shelf

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Буст продаж, оплата за показы(文件advertiser_operations_cpm_boost

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Товарные баннеры(文件advertiser_operations_product_banners

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Буст продаж, оплата за продажи(文件advertiser_operations_cpa_auction_promotion

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Баннеры (бронирование)(文件advertiser_operations_package_banners

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Баннеры (аукцион)(文件advertiser_operations_auction_banners

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Баннеры кликаут (бронирование)(文件advertiser_operations_package_banners_clickout

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Баннеры кликаут (аукцион)(文件advertiser_operations_auction_banners_clickout

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Пуши (бронирование)(文件advertiser_operations_package_pushes

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Пуши (аукцион)(文件advertiser_operations_auction_pushes

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Поп-ап уведомления (бронирование)(文件advertiser_operations_package_popups

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Поп-ап уведомления (аукцион)(文件advertiser_operations_auction_popups

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

DEDUCTED_BONUSES

deductedBonuses

Списано бонусов

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Полки с оплатой по дням(文件advertiser_operations_cpd_promotion

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

CAMPAIGN_NAME

campaignName

Кампания

string

SURFACE

surface

Площадки

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Рекламные материалы(文件advertiser_operations_marketing_promo_yandex_market

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Реклама на внешних площадках(文件advertiser_operations_marketing_promo_web

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Реклама на внешних площадках-М(文件advertiser_operations_marketing_promo_web_mark

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单ТВ реклама(文件advertiser_operations_marketing_promo_tv

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Рассылка по сегментам(文件advertiser_operations_marketing_promo_mailing

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Организация и проведение маркет(文件advertiser_operations_marketing_promo_for_sales

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Специальные размещения(文件advertiser_operations_marketing_promo_adfox

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

SERVICE_TYPE

serviceType

Тип услуги

string

CAMPAIGN_NAME

campaignName

Кампания

string

OPERATION_TYPE

operationType

Тип операции

string

CABINET_TYPE

cabinetType

Тип кабинета

string

CABINET_NAME

cabinetName

Название кабинета

string

表单Отзывы за баллы(文件advertiser_operations_paid_opinion

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

DATE

date

Дата

string

SUM

sum

Сумма (с НДС), ₽

number

BRAND

brand

Бренд

string

CATEGORY

category

Категория

string

MODEL

model

Товар

string

MARKET_URL

marketUrl

Ссылка на Маркет

string

⚙️ 没有订阅的限制: 1 请求 在 2 分钟
⭐️ 使用中等订阅限制: 1 请求 每分钟

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/reports/marketing-detalization/generate

Path parameters

Name

Description

businessId

Type: integer

内阁ID。 要找到答案,请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店?

Min value: 1

Query parameters

Name

Description

format

Type: string

报告或文档的格式。 报告格式:

  • FILE — 电子表格文件(XLSX).
  • CSV — 每个报告表都有一个包含CSV文件的ZIP存档。
  • JSON — 每个报告表都有一个带有JSON文件的ZIP压缩包.

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
  "monthOfYear": {
    "year": 2025,
    "month": 12
  }
}

Name

Description

monthOfYear

Type: object

month

Type: integer

月号。

Min value: 1

Max value: 12

year

Type: integer

年。

月份和年份。

Example
{
  "year": 2025,
  "month": 12
}

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。

Body

application/json
{
  "status": "OK",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

    • OK — 没有错误。
    • ERROR — 处理请求时出错。

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    estimatedGenerationTime

    Type: integer

    预计生成时间以毫秒为单位。

    reportId

    Type: string

    跟踪生成状态和接收完成的报告或文档所需的ID。

    Example: example

    跟踪生成状态和接收完成的报告或文档所需的ID。

    Example
    {
      "reportId": "example",
      "estimatedGenerationTime": 0
    }
    
    Example
    {
      "result": {
        "reportId": "example",
        "estimatedGenerationTime": 0
      }
    }
    

400 Bad Request

请求包含不正确的数据。 详细了解报告和文档中的错误

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

404 Not Found

找不到请求的资源。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }
    

500 Internal Server Error

Yandex的内部错误。 市场。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

      • OK — 没有错误。
      • ERROR — 处理请求时出错。

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

    Example
    {
      "status": "OK",
      "errors": [
        {
          "code": "example",
          "message": "example"
        }
      ]
    }