promotion

Публичный доменный пакет SDK: promotion.

Enum

• CampaignType
• PromotionOrderServiceStatus
• PromotionOrderStatus
• PromotionStatus
• TargetActionBudgetType
• TargetActionSelectedType

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutostrategyBudget

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

Аргументы

campaign_type: тип автостратегии или рекламной кампании. start_time: дата и время начала кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AutostrategyBudget с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignActionResult

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

Аргументы

campaign_type: тип автостратегии или рекламной кампании. title: название кампании. budget: бюджет кампании. budget_bonus: бонусный бюджет кампании. budget_real: реальный бюджет кампании. calc_id: идентификатор расчета или прогноза кампании. description: описание кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. start_time: дата и время начала кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignActionResult

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

Аргументы

version: версия кампании для optimistic locking или согласованного обновления. campaign_id: идентификатор кампании. budget: бюджет кампании. calc_id: идентификатор расчета или прогноза кампании. description: описание кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. start_time: дата и время начала кампании. title: название кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get

get(
    *,
    campaign_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignDetailsResult

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

Аргументы

campaign_id: идентификатор кампании. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignDetailsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete

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

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

Аргументы

version: версия кампании для optimistic locking или согласованного обновления. campaign_id: идентификатор кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignsResult

Возвращает кампании автостратегии с фильтрами и пагинацией.

Аргументы

limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. status_id: фильтрует результат по числовому статусу. order_by: задает порядок сортировки результата. updated_from: фильтрует записи, обновленные не раньше указанного времени. updated_to: фильтрует записи, обновленные не позже указанного времени. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignsResult с типизированными данными ответа API.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_stat

get_stat(
    *,
    campaign_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutostrategyStat

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

Аргументы

campaign_id: идентификатор кампании. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AutostrategyStat с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get_forecasts

get_forecasts(
    *,
    items: list[BbipItem],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> BbipForecastsResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

BbipForecastsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_order

create_order(
    *,
    items: list[BbipItem],
    dry_run: bool = False,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_suggests

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

BbipSuggestsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get_user_bids

get_user_bids(
    *,
    from_item_id: int | None = None,
    batch_size: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaAuctionBidsResult

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

Аргументы

from_item_id: идентификатор объявления, с которого начинается выборка. batch_size: размер пакетной выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CpaAuctionBidsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_item_bids

create_item_bids(
    *,
    items: list[CpaAuctionBidInput],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get_service_dictionary

get_service_dictionary(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionServiceDictionary

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionServiceDictionary с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_services

list_services(
    *,
    item_ids: list[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionServicesResult

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

Аргументы

item_ids: передает идентификаторы объявлений или товаров. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionServicesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_orders

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

Возвращает заказы продвижения по объявлениям или идентификаторам заказов.

Аргументы

item_ids: передает идентификаторы объявлений или товаров. order_ids: передает идентификаторы заказов. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionOrdersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_order_status

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

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

Аргументы

order_ids: идентификаторы заказов продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionOrderStatusResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

get_bids

get_bids(
    *,
    item_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> TargetActionGetBidsResult

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

Аргументы

item_id: идентификатор объявления. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TargetActionGetBidsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_promotions_by_item_ids

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TargetActionPromotionsByItemIdsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete

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

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

Аргументы

item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

action_type_id: идентификатор целевого действия. budget_penny: бюджет в копейках. budget_type: тип бюджета кампании. item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом 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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

action_type_id: идентификатор целевого действия. bid_penny: ставка в копейках. limit_penny: лимит расходов в копейках. item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: DomainObject

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

apply

apply(
    *,
    items: list[TrxItem],
    dry_run: bool = False,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

Запускает TrxPromo.

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete

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

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

Аргументы

item_ids: список идентификаторов объявлений. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_commissions

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TrxCommissionsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

create_budget async

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

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

Аргументы

campaign_type: тип автостратегии или рекламной кампании. start_time: дата и время начала кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AutostrategyBudget с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignActionResult

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

Аргументы

campaign_type: тип автостратегии или рекламной кампании. title: название кампании. budget: бюджет кампании. budget_bonus: бонусный бюджет кампании. budget_real: реальный бюджет кампании. calc_id: идентификатор расчета или прогноза кампании. description: описание кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. start_time: дата и время начала кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignActionResult

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

Аргументы

version: версия кампании для optimistic locking или согласованного обновления. campaign_id: идентификатор кампании. budget: бюджет кампании. calc_id: идентификатор расчета или прогноза кампании. description: описание кампании. finish_time: дата и время окончания кампании. items: элементы запроса с объявлениями, ставками или настройками продвижения. start_time: дата и время начала кампании. title: название кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get async

get(
    *,
    campaign_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignDetailsResult

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

Аргументы

campaign_id: идентификатор кампании. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignDetailsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete async

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

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

Аргументы

version: версия кампании для optimistic locking или согласованного обновления. campaign_id: идентификатор кампании. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CampaignsResult

Возвращает кампании автостратегии с фильтрами и пагинацией.

Аргументы

limit: ограничивает размер возвращаемой выборки. offset: задает смещение первой записи в выборке. status_id: фильтрует результат по числовому статусу. order_by: задает порядок сортировки результата. updated_from: фильтрует записи, обновленные не раньше указанного времени. updated_to: фильтрует записи, обновленные не позже указанного времени. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CampaignsResult с типизированными данными ответа API.

Поведение

Параметры пагинации ограничивают объем данных без изменения модели ответа. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_stat async

get_stat(
    *,
    campaign_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutostrategyStat

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

Аргументы

campaign_id: идентификатор кампании. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

AutostrategyStat с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_forecasts async

get_forecasts(
    *,
    items: list[BbipItem],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> BbipForecastsResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

BbipForecastsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_order async

create_order(
    *,
    items: list[BbipItem],
    dry_run: bool = False,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_suggests async

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

BbipSuggestsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_user_bids async

get_user_bids(
    *,
    from_item_id: int | None = None,
    batch_size: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CpaAuctionBidsResult

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

Аргументы

from_item_id: идентификатор объявления, с которого начинается выборка. batch_size: размер пакетной выборки. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

CpaAuctionBidsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

create_item_bids async

create_item_bids(
    *,
    items: list[CpaAuctionBidInput],
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_service_dictionary async

get_service_dictionary(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionServiceDictionary

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

Аргументы

timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionServiceDictionary с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_services async

list_services(
    *,
    item_ids: list[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionServicesResult

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

Аргументы

item_ids: передает идентификаторы объявлений или товаров. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionServicesResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

list_orders async

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

Возвращает заказы продвижения по объявлениям или идентификаторам заказов.

Аргументы

item_ids: передает идентификаторы объявлений или товаров. order_ids: передает идентификаторы заказов. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionOrdersResult с типизированными данными ответа API.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_order_status async

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

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

Аргументы

order_ids: идентификаторы заказов продвижения. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionOrderStatusResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

get_bids async

get_bids(
    *,
    item_id: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> TargetActionGetBidsResult

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

Аргументы

item_id: идентификатор объявления. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TargetActionGetBidsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_promotions_by_item_ids async

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TargetActionPromotionsByItemIdsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete async

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

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

Аргументы

item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_auto async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

action_type_id: идентификатор целевого действия. budget_penny: бюджет в копейках. budget_type: тип бюджета кампании. item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

update_manual async

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,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

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

Аргументы

action_type_id: идентификатор целевого действия. bid_penny: ставка в копейках. limit_penny: лимит расходов в копейках. item_id: идентификатор объявления. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

Bases: AsyncDomainObject

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

apply async

apply(
    *,
    items: list[TrxItem],
    dry_run: bool = False,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> PromotionActionResult

Запускает TrxPromo.

Аргументы

items: элементы запроса с объявлениями, ставками или настройками продвижения. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

delete async

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

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

Аргументы

item_ids: список идентификаторов объявлений. dry_run: если True, метод собирает payload и возвращает результат без вызова транспорта. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

PromotionActionResult с типизированными данными ответа.

Поведение

При dry_run=True payload строится без вызова транспорта. idempotency_key передается в Idempotency-Key и должен быть стабильным для одного логического write-вызова. timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.

get_commissions async

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

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

Аргументы

item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

TrxCommissionsResult с типизированными данными ответа.

Поведение

timeout и retry действуют только на этот вызов и не меняют настройки клиента.

Исключения

AvitoError: ошибка SDK с контекстом operation, status, request_id, attempt, method и endpoint.