Перейти к содержанию

promotion

Источник API: CPA-аукцион.json, TrxPromo.json, Автостратегия.json, Настройкаценыцелевогодействия.json, Продвижение.json.

Enum

Пакет promotion.

AutostrategyCampaign dataclass 

AutostrategyCampaign(
    transport: Transport,
    campaign_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект кампаний автостратегии.

create_budget 

create_budget(
    *,
    campaign_type: CampaignType | str,
    start_time: datetime | None = None,
    finish_time: datetime | None = None,
    items: list[int] | None = None,
) -> AutostrategyBudget

Рассчитывает бюджет кампании.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create 

create(
    *,
    campaign_type: CampaignType | str,
    title: str,
    budget: int | None = None,
    budget_bonus: int | None = None,
    budget_real: int | None = None,
    calc_id: int | None = None,
    description: str | None = None,
    finish_time: datetime | None = None,
    items: list[int] | None = None,
    start_time: datetime | None = None,
    idempotency_key: str | None = None,
) -> CampaignActionResult

Создает новую кампанию.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update 

update(
    *,
    version: int,
    campaign_id: int | None = None,
    budget: int | None = None,
    calc_id: int | None = None,
    description: str | None = None,
    finish_time: datetime | None = None,
    items: list[int] | None = None,
    start_time: datetime | None = None,
    title: str | None = None,
    idempotency_key: str | None = None,
) -> CampaignActionResult

Редактирует кампанию.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get 

get(
    *, campaign_id: int | None = None
) -> CampaignDetailsResult

Получает полную информацию о кампании.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

delete 

delete(
    *,
    version: int,
    campaign_id: int | None = None,
    idempotency_key: str | None = None,
) -> CampaignActionResult

Останавливает кампанию.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list 

list(
    *,
    limit: int = 100,
    offset: int | None = None,
    status_id: list[int] | None = None,
    order_by: list[tuple[str, str]] | None = None,
    updated_from: datetime | None = None,
    updated_to: datetime | None = None,
) -> CampaignsResult

Получает список кампаний.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_stat 

get_stat(
    *, campaign_id: int | None = None
) -> AutostrategyStat

Получает статистику кампании.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

BbipPromotion dataclass 

BbipPromotion(
    transport: Transport,
    item_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект BBIP-продвижения.

get_forecasts 

get_forecasts(
    *, items: list[BbipItemInput]
) -> BbipForecastsResult

Получает прогнозы BBIP.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_order 

create_order(
    *,
    items: list[BbipItemInput],
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Подключает BBIP-продвижение.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_suggests 

get_suggests(
    *, item_ids: list[int] | None = None
) -> BbipSuggestsResult

Получает варианты бюджета BBIP.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CpaAuction dataclass 

CpaAuction(
    transport: Transport, item_id: int | str | None = None
)

Bases: DomainObject

Доменный объект CPA-аукциона.

get_user_bids 

get_user_bids(
    *,
    from_item_id: int | None = None,
    batch_size: int | None = None,
) -> CpaAuctionBidsResult

Получает действующие и доступные ставки.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

create_item_bids 

create_item_bids(
    *,
    items: list[BidItemInput],
    idempotency_key: str | None = None,
) -> PromotionActionResult

Сохраняет новые ставки по объявлениям.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

PromotionOrder dataclass 

PromotionOrder(
    transport: Transport, order_id: int | str | None = None
)

Bases: DomainObject

Доменный объект заявок и словарей promotion API.

get_service_dictionary 

get_service_dictionary() -> PromotionServiceDictionary

Получает словарь услуг продвижения.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list_services 

list_services(
    *, item_ids: list[int]
) -> PromotionServicesResult

Получает список услуг продвижения по объявлениям.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

list_orders 

list_orders(
    *,
    item_ids: list[int] | None = None,
    order_ids: list[str] | None = None,
) -> PromotionOrdersResult

Получает список заявок на продвижение.

Пустой результат возвращается как пустая коллекция или None согласно аннотации метода.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_order_status 

get_order_status(
    *, order_ids: list[str] | None = None
) -> PromotionOrderStatusResult

Получает статусы заявок на продвижение.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

TargetActionPricing dataclass 

TargetActionPricing(
    transport: Transport,
    item_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект цены целевого действия.

get_bids 

get_bids(
    *, item_id: int | None = None
) -> TargetActionGetBidsResult

Получает детализированные цены и бюджеты.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_promotions_by_item_ids 

get_promotions_by_item_ids(
    *, item_ids: list[int] | None = None
) -> TargetActionPromotionsByItemIdsResult

Получает текущие настройки по нескольким объявлениям.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

delete 

delete(
    *,
    item_id: int | None = None,
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Останавливает продвижение.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_auto 

update_auto(
    *,
    action_type_id: int,
    budget_penny: int,
    budget_type: TargetActionBudgetType | str,
    item_id: int | None = None,
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Применяет автоматическую настройку.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

update_manual 

update_manual(
    *,
    action_type_id: int,
    bid_penny: int,
    limit_penny: int | None = None,
    item_id: int | None = None,
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Применяет ручную настройку.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

TrxPromotion dataclass 

TrxPromotion(
    transport: Transport,
    item_id: int | str | None = None,
    user_id: int | str | None = None,
)

Bases: DomainObject

Доменный объект TrxPromo.

apply 

apply(
    *,
    items: list[TrxItemInput],
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Запускает TrxPromo.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

delete 

delete(
    *,
    item_ids: list[int] | None = None,
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Останавливает TrxPromo.

Параметр idempotency_key задает ключ идемпотентности для безопасного повтора write-операции.

При dry_run=True payload строится без вызова транспорта.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

get_commissions 

get_commissions(
    *, item_ids: list[int] | None = None
) -> TrxCommissionsResult

Получает доступные комиссии TrxPromo.

Raises: AvitoError с полями operation, status, request_id, attempt, method и endpoint.

CampaignType

Bases: str, Enum

Тип автокампании.

PromotionStatus

Bases: str, Enum

Статус promotion-объекта или операции.

TargetActionBudgetType

Bases: str, Enum

Тип бюджета цены целевого действия.

TargetActionSelectedType

Bases: str, Enum

Выбранный тип продвижения цены целевого действия.

AutostrategyBudget dataclass 

AutostrategyBudget(
    calc_id: int | None,
    recommended: AutostrategyBudgetPoint | None,
    minimal: AutostrategyBudgetPoint | None,
    maximal: AutostrategyBudgetPoint | None,
    price_ranges: list[AutostrategyPriceRange],
)

Bases: SerializableModel

Расчет бюджета автокампании.

AutostrategyStat dataclass 

AutostrategyStat(
    items: list[AutostrategyStatItem],
    totals: AutostrategyStatTotals | None,
)

Bases: SerializableModel

Статистика автокампании.

AutostrategyStatItem dataclass 

AutostrategyStatItem(
    date: datetime | None,
    calls: int | None,
    views: int | None,
    calls_forecast: CampaignForecastRange | None = None,
    views_forecast: CampaignForecastRange | None = None,
)

Bases: SerializableModel

Статистика кампании за день.

AutostrategyStatTotals dataclass 

AutostrategyStatTotals(
    calls: int | None, views: int | None
)

Bases: SerializableModel

Суммарная статистика кампании.

BbipBudgetOption dataclass 

BbipBudgetOption(
    price: int | None,
    old_price: int | None,
    is_recommended: bool | None,
)

Bases: SerializableModel

Вариант бюджета BBIP.

BbipDurationRange dataclass 

BbipDurationRange(
    start: int | None,
    stop: int | None,
    recommended: int | None,
)

Bases: SerializableModel

Доступный диапазон длительности BBIP.

BbipForecastsResult dataclass 

BbipForecastsResult(items: list[PromotionForecast])

Bases: SerializableModel

Результат прогноза BBIP.

BbipItem dataclass 

BbipItem(
    item_id: int, duration: int, price: int, old_price: int
)

Bases: SerializableModel

Параметры BBIP по объявлению (прогноз или заявка).

BbipSuggest dataclass 

BbipSuggest(
    item_id: int | None,
    duration: BbipDurationRange | None,
    budgets: list[BbipBudgetOption],
)

Bases: SerializableModel

Варианты бюджета BBIP по объявлению.

BbipSuggestsResult dataclass 

BbipSuggestsResult(items: list[BbipSuggest])

Bases: SerializableModel

Результат вариантов бюджета BBIP.

CampaignActionResult dataclass 

CampaignActionResult(campaign: CampaignInfo | None)

Bases: SerializableModel

Результат операции с автокампанией.

CampaignDetailsResult dataclass 

CampaignDetailsResult(
    campaign: CampaignInfo | None,
    forecast: CampaignForecast | None,
    items: list[CampaignItem],
)

Bases: SerializableModel

Полный ответ ручки информации о кампании.

CampaignForecast dataclass 

CampaignForecast(
    calls: CampaignForecastRange | None,
    views: CampaignForecastRange | None,
)

Bases: SerializableModel

Прогноз кампании автостратегии.

CampaignForecastRange dataclass 

CampaignForecastRange(
    from_value: int | None, to_value: int | None
)

Bases: SerializableModel

Диапазон прогноза кампании.

CampaignInfo dataclass 

CampaignInfo(
    campaign_id: int | None,
    campaign_type: CampaignType | None,
    budget: int | None,
    balance: int | None,
    create_time: datetime | None,
    description: str | None,
    finish_time: datetime | None,
    items_count: int | None,
    start_time: datetime | None,
    status_id: int | None,
    title: str | None,
    update_time: datetime | None,
    user_id: int | None,
    version: int | None,
)

Bases: SerializableModel

Информация об автокампании.

CampaignItem dataclass 

CampaignItem(item_id: int | None, is_active: bool | None)

Bases: SerializableModel

Объявление внутри автокампании.

CampaignListFilter dataclass 

CampaignListFilter(
    by_update_time: CampaignUpdateTimeFilter | None = None,
)

Фильтр списка кампаний.

to_payload 

to_payload() -> dict[str, object]

Сериализует фильтр списка кампаний.

CampaignOrderBy dataclass 

CampaignOrderBy(column: str, direction: str)

Параметры сортировки списка кампаний.

to_payload 

to_payload() -> dict[str, object]

Сериализует сортировку списка кампаний.

CampaignsResult dataclass 

CampaignsResult(
    items: list[CampaignInfo],
    total_count: int | None = None,
)

Bases: SerializableModel

Список автокампаний.

CampaignUpdateTimeFilter dataclass 

CampaignUpdateTimeFilter(
    from_time: datetime | None = None,
    to_time: datetime | None = None,
)

Фильтр кампаний по времени обновления.

to_payload 

to_payload() -> dict[str, object]

Сериализует фильтр по времени обновления.

CpaAuctionBidsResult dataclass 

CpaAuctionBidsResult(items: list[CpaAuctionItemBid])

Bases: SerializableModel

Список ставок CPA-аукциона.

CreateItemBid dataclass 

CreateItemBid(item_id: int, price_penny: int)

Новая ставка CPA-аукциона.

to_payload 

to_payload() -> dict[str, object]

Сериализует одну ставку CPA-аукциона.

PromotionActionResult dataclass 

PromotionActionResult(
    action: str,
    target: dict[str, object] | None,
    status: PromotionStatus,
    applied: bool,
    request_payload: dict[str, object] | None = None,
    warnings: list[str] = list(),
    upstream_reference: str | None = None,
    details: dict[str, object] = dict(),
)

Bases: SerializableModel

Стабильный результат write-операции продвижения.

PromotionForecast dataclass 

PromotionForecast(
    item_id: int | None,
    min_views: int | None,
    max_views: int | None,
    total_price: int | None,
    total_old_price: int | None,
)

Bases: SerializableModel

Прогноз BBIP по объявлению.

PromotionOrderError dataclass 

PromotionOrderError(
    item_id: int | None,
    error_code: int | None,
    error_text: str | None,
)

Bases: SerializableModel

Ошибка по объявлению в ответе promotion API.

PromotionOrderInfo dataclass 

PromotionOrderInfo(
    order_id: str | None,
    item_id: int | None,
    service_code: str | None,
    status: PromotionStatus | None,
    created_at: datetime | None,
)

Bases: SerializableModel

Заявка на продвижение.

PromotionOrdersResult dataclass 

PromotionOrdersResult(items: list[PromotionOrderInfo])

Bases: SerializableModel

Список заявок на продвижение.

PromotionOrderStatusItem dataclass 

PromotionOrderStatusItem(
    item_id: int | None,
    price: int | None,
    slug: str | None,
    status: PromotionStatus | None,
    error_reason: str | None,
)

Bases: SerializableModel

Статус услуги внутри заявки на продвижение.

PromotionOrderStatusResult dataclass 

PromotionOrderStatusResult(
    order_id: str | None,
    status: PromotionStatus | None,
    total_price: int | None,
    items: list[PromotionOrderStatusItem],
    errors: list[PromotionOrderError],
)

Bases: SerializableModel

Статус заявки на продвижение.

PromotionService dataclass 

PromotionService(
    item_id: int | None,
    service_code: str | None,
    service_name: str | None,
    price: int | None,
    status: PromotionStatus | None,
)

Bases: SerializableModel

Услуга продвижения по объявлению.

PromotionServiceDictionary dataclass 

PromotionServiceDictionary(
    items: list[PromotionServiceType],
)

Bases: SerializableModel

Словарь услуг продвижения.

PromotionServicesResult dataclass 

PromotionServicesResult(items: list[PromotionService])

Bases: SerializableModel

Список услуг продвижения.

PromotionServiceType dataclass 

PromotionServiceType(code: str | None, title: str | None)

Bases: SerializableModel

Тип услуги продвижения.

TargetActionAutoBids dataclass 

TargetActionAutoBids(
    budget_penny: int | None,
    budget_type: TargetActionBudgetType | None,
    min_budget_penny: int | None,
    max_budget_penny: int | None,
    daily_budget: list[TargetActionBudget],
    weekly_budget: list[TargetActionBudget],
    monthly_budget: list[TargetActionBudget],
)

Bases: SerializableModel

Детали автоматического продвижения цены целевого действия.

TargetActionAutoPromotion dataclass 

TargetActionAutoPromotion(
    budget_penny: int | None,
    budget_type: TargetActionBudgetType | None,
)

Bases: SerializableModel

Текущий auto-budget по объявлению.

TargetActionBid dataclass 

TargetActionBid(
    value_penny: int | None,
    min_forecast: int | None,
    max_forecast: int | None,
    compare: int | None,
)

Bases: SerializableModel

Доступная цена целевого действия.

TargetActionBudget dataclass 

TargetActionBudget(
    budget_penny: int | None,
    min_forecast: int | None,
    max_forecast: int | None,
    compare: int | None,
)

Bases: SerializableModel

Диапазон доступных бюджетов цены целевого действия.

TargetActionGetBidsResult dataclass 

TargetActionGetBidsResult(
    action_type_id: int,
    selected_type: TargetActionSelectedType,
    auto: TargetActionAutoBids | None = None,
    manual: TargetActionManualBids | None = None,
)

Bases: SerializableModel

Ответ GET /cpxpromo/1/getBids/{itemId}.

TargetActionManualBids dataclass 

TargetActionManualBids(
    bid_penny: int | None,
    limit_penny: int | None,
    rec_bid_penny: int | None,
    min_bid_penny: int | None,
    max_bid_penny: int | None,
    min_limit_penny: int | None,
    max_limit_penny: int | None,
    bids: list[TargetActionBid],
)

Bases: SerializableModel

Детали ручной ставки цены целевого действия.

TargetActionManualPromotion dataclass 

TargetActionManualPromotion(
    bid_penny: int | None, limit_penny: int | None
)

Bases: SerializableModel

Текущая manual-настройка по объявлению.

TargetActionPromotion dataclass 

TargetActionPromotion(
    item_id: int,
    action_type_id: int,
    auto: TargetActionAutoPromotion | None = None,
    manual: TargetActionManualPromotion | None = None,
)

Bases: SerializableModel

Текущая настройка цены целевого действия по объявлению.

TargetActionPromotionsByItemIdsResult dataclass 

TargetActionPromotionsByItemIdsResult(
    items: list[TargetActionPromotion],
)

Bases: SerializableModel

Ответ POST /cpxpromo/1/getPromotionsByItemIds.

TrxCommissionsResult dataclass 

TrxCommissionsResult(items: list[TrxCommissionInfo])

Bases: SerializableModel

Список комиссий TrxPromo.

TrxItem dataclass 

TrxItem(
    item_id: int,
    commission: int,
    date_from: datetime,
    date_to: datetime | None = None,
)

Bases: SerializableModel

Параметры TrxPromo по объявлению.