ads¶

Источник API: Автозагрузка.json, Объявления.json.

Enum¶

Пакет ads.

Ad `dataclass` ¶

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

Bases: DomainObject

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

get ¶

get() -> Listing

Получает объявление по item_id.

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

list ¶

list(
    *,
    status: ListingStatus | str | None = None,
    limit: int | None = None,
    offset: int | None = None,
) -> PaginatedList[Listing]

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

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

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

update_price ¶

update_price(
    *,
    price: int | float,
    idempotency_key: str | None = None,
) -> UpdatePriceResult

Обновляет цену текущего объявления.

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

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

AdPromotion `dataclass` ¶

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

Bases: DomainObject

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

get_vas_prices ¶

get_vas_prices(
    *, item_ids: list[int], location_id: int | None = None
) -> VasPricesResult

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

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

apply_vas ¶

apply_vas(
    *,
    codes: list[str],
    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.

apply_vas_package ¶

apply_vas_package(
    *,
    package_code: str,
    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.

apply_vas_direct ¶

apply_vas_direct(
    *,
    codes: list[str],
    dry_run: bool = False,
    idempotency_key: str | None = None,
) -> PromotionActionResult

Применяет услуги продвижения через прямой v2 endpoint.

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

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

AdStats `dataclass` ¶

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

Bases: DomainObject

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

get_calls_stats ¶

get_calls_stats(
    *,
    item_ids: list[int] | None = None,
    date_from: datetime | None = None,
    date_to: datetime | None = None,
) -> CallsStatsResult

Получает статистику звонков.

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

get_item_stats ¶

get_item_stats(
    *,
    item_ids: list[int] | None = None,
    date_from: datetime | None = None,
    date_to: datetime | None = None,
    fields: list[str] | None = None,
) -> ItemStatsResult

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

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

get_item_analytics ¶

get_item_analytics(
    *,
    item_ids: list[int] | None = None,
    date_from: datetime | None = None,
    date_to: datetime | None = None,
    fields: list[str] | None = None,
) -> ItemAnalyticsResult

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

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

get_account_spendings ¶

get_account_spendings(
    *,
    item_ids: list[int] | None = None,
    date_from: datetime | None = None,
    date_to: datetime | None = None,
    fields: list[str] | None = None,
) -> AccountSpendings

Получает статистику расходов профиля.

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

AutoloadArchive `dataclass` ¶

AutoloadArchive(
    transport: Transport, report_id: int | str | None = None
)

Bases: DomainObject

Доменный объект архивных операций автозагрузки.

get_profile ¶

get_profile() -> AutoloadProfileSettings

Получает архивный профиль автозагрузки.

    Deprecated: используйте `autoload_profile().get`; удаление в версии 1.3.0.

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

save_profile ¶

save_profile(
    *,
    is_enabled: bool | None = None,
    email: str | None = None,
    callback_url: str | None = None,
    idempotency_key: str | None = None,
) -> AdsActionResult

Сохраняет архивный профиль автозагрузки.

    Deprecated: используйте `autoload_profile().save`; удаление в версии 1.3.0.

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

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

get_last_completed_report ¶

get_last_completed_report() -> LegacyAutoloadReport

Получает архивную статистику по последней выгрузке.

    Deprecated: используйте `autoload_report().get_last_completed`; удаление в версии 1.3.0.

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

get_report ¶

get_report() -> LegacyAutoloadReport

Получает архивную статистику по конкретной выгрузке.

    Deprecated: используйте `autoload_report().get`; удаление в версии 1.3.0.

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

AutoloadProfile `dataclass` ¶

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

Bases: DomainObject

Доменный объект профиля автозагрузки.

get ¶

get() -> AutoloadProfileSettings

Получает профиль автозагрузки.

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

save ¶

save(
    *,
    is_enabled: bool | None = None,
    email: str | None = None,
    callback_url: str | None = None,
    idempotency_key: str | None = None,
) -> AdsActionResult

Сохраняет профиль автозагрузки.

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

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

upload_by_url ¶

upload_by_url(
    *, url: str, idempotency_key: str | None = None
) -> UploadResult

Загружает файл по ссылке.

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

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

get_tree ¶

get_tree() -> AutoloadTreeResult

Получает дерево категорий.

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

get_node_fields ¶

get_node_fields(*, node_slug: str) -> AutoloadFieldsResult

Получает поля категории.

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

AutoloadReport `dataclass` ¶

AutoloadReport(
    transport: Transport, report_id: int | str | None = None
)

Bases: DomainObject

Доменный объект отчета автозагрузки.

get ¶

get() -> AutoloadReportDetails

Получает конкретный отчет v3.

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

list ¶

list(
    *, limit: int | None = None, offset: int | None = None
) -> PaginatedList[AutoloadReportSummary]

Получает список отчетов автозагрузки.

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

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

get_last_completed ¶

get_last_completed() -> AutoloadReportDetails

Получает последний завершенный отчет.

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

get_items ¶

get_items() -> AutoloadReportItemsResult

Получает объявления из отчета.

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

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

get_fees ¶

get_fees() -> AutoloadFeesResult

Получает списания по объявлениям отчета.

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

get_ad_ids_by_avito_ids ¶

get_ad_ids_by_avito_ids(
    *, avito_ids: Sequence[int]
) -> IdMappingResult

Получает ad ids по avito ids.

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

get_avito_ids_by_ad_ids ¶

get_avito_ids_by_ad_ids(
    *, ad_ids: Sequence[int]
) -> IdMappingResult

Получает avito ids по ad ids.

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

get_items_info ¶

get_items_info(
    *, item_ids: Sequence[int]
) -> AutoloadReportItemsResult

Получает информацию по объявлениям автозагрузки.

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

AdsActionStatus ¶

Bases: str, Enum

Статус мутационной операции ads.

AutoloadFieldType ¶

Bases: str, Enum

Тип поля автозагрузки.

AutoloadReportStatus ¶

Bases: str, Enum

Статус отчета автозагрузки.

ListingStatus ¶

Bases: str, Enum

Статус объявления.

AccountSpendings `dataclass` ¶

AccountSpendings(
    items: list[SpendingRecord], total: float | None = None
)

Bases: SerializableModel

Статистика расходов профиля.

AdsActionResult `dataclass` ¶

AdsActionResult(success: bool, message: str | None = None)

Bases: SerializableModel

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

AdsListResult `dataclass` ¶

AdsListResult(
    items: list[Listing], total: int | None = None
)

Bases: SerializableModel

Результат списка объявлений.

AutoloadFee `dataclass` ¶

AutoloadFee(
    item_id: int | None,
    amount: float | None,
    service: str | None,
)

Bases: SerializableModel

Списание по объявлению в отчете автозагрузки.

AutoloadFeesResult `dataclass` ¶

AutoloadFeesResult(
    items: list[AutoloadFee], total: float | None = None
)

Bases: SerializableModel

Списания по объявлениям отчета.

AutoloadField `dataclass` ¶

AutoloadField(
    slug: str | None,
    title: str | None,
    type: AutoloadFieldType | None,
    required: bool | None,
)

Bases: SerializableModel

Поле категории автозагрузки.

AutoloadFieldsResult `dataclass` ¶

AutoloadFieldsResult(items: list[AutoloadField])

Bases: SerializableModel

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

AutoloadProfileSettings `dataclass` ¶

AutoloadProfileSettings(
    user_id: int | None,
    is_enabled: bool | None,
    upload_url: str | None,
)

Bases: SerializableModel

Профиль пользователя автозагрузки.

AutoloadReportDetails `dataclass` ¶

AutoloadReportDetails(
    report_id: int | None,
    status: AutoloadReportStatus | None,
    created_at: datetime | None,
    finished_at: datetime | None,
    errors_count: int | None,
    warnings_count: int | None,
)

Bases: SerializableModel

Детальная информация по отчету автозагрузки.

AutoloadReportItem `dataclass` ¶

AutoloadReportItem(
    item_id: int | None,
    avito_id: int | None,
    status: AutoloadReportStatus | None,
    title: str | None,
)

Bases: SerializableModel

Объявление внутри отчета автозагрузки.

AutoloadReportItemsResult `dataclass` ¶

AutoloadReportItemsResult(
    items: list[AutoloadReportItem],
    total: int | None = None,
)

Bases: SerializableModel

Список объявлений из отчета автозагрузки.

AutoloadReportsResult `dataclass` ¶

AutoloadReportsResult(
    items: list[AutoloadReportSummary],
    total: int | None = None,
)

Bases: SerializableModel

Список отчетов автозагрузки.

AutoloadReportSummary `dataclass` ¶

AutoloadReportSummary(
    report_id: int | None,
    status: AutoloadReportStatus | None,
    created_at: datetime | None,
    finished_at: datetime | None,
    processed_items: int | None,
)

Bases: SerializableModel

Краткая информация по отчету автозагрузки.

AutoloadTreeNode `dataclass` ¶

AutoloadTreeNode(
    slug: str | None,
    title: str | None,
    children: list[AutoloadTreeNode] = list(),
)

Bases: SerializableModel

Узел дерева категорий автозагрузки.

AutoloadTreeResult `dataclass` ¶

AutoloadTreeResult(items: list[AutoloadTreeNode])

Bases: SerializableModel

Дерево категорий автозагрузки.

CallsStatsResult `dataclass` ¶

CallsStatsResult(items: list[CallStats])

Bases: SerializableModel

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

CallStats `dataclass` ¶

CallStats(
    item_id: int | None,
    calls: int | None,
    answered_calls: int | None,
    missed_calls: int | None,
)

Bases: SerializableModel

Статистика звонков по объявлению.

ItemAnalyticsResult `dataclass` ¶

ItemAnalyticsResult(
    items: list[ListingStats], period: str | None = None
)

Bases: SerializableModel

Аналитика по профилю или объявлениям.

ItemStatsResult `dataclass` ¶

ItemStatsResult(items: list[ListingStats])

Bases: SerializableModel

Статистика по списку объявлений.

LegacyAutoloadReport `dataclass` ¶

LegacyAutoloadReport(
    report_id: int | None,
    status: AutoloadReportStatus | None,
)

Bases: SerializableModel

Legacy-ответ автозагрузки.

Listing `dataclass` ¶

Listing(
    item_id: int | None,
    user_id: int | None,
    title: str | None,
    description: str | None,
    status: ListingStatus | None,
    price: float | None,
    url: str | None,
)

Bases: SerializableModel

Объявление пользователя.

ListingStats `dataclass` ¶

ListingStats(
    item_id: int | None,
    views: int | None,
    contacts: int | None,
    favorites: int | None,
)

Bases: SerializableModel

Статистические показатели объявления.

SpendingRecord `dataclass` ¶

SpendingRecord(
    item_id: int | None,
    amount: float | None,
    service: str | None,
)

Bases: SerializableModel

Запись статистики расходов по объявлению.

UpdatePriceResult `dataclass` ¶

UpdatePriceResult(
    item_id: int | None,
    price: float | None,
    status: AdsActionStatus | None,
)

Bases: SerializableModel

Результат обновления цены объявления.

UploadResult `dataclass` ¶

UploadResult(success: bool, report_id: int | None = None)

Bases: SerializableModel

Результат запуска загрузки файла.

VasApplyResult `dataclass` ¶

VasApplyResult(
    success: bool, status: AdsActionStatus | None = None
)

Bases: SerializableModel

Результат применения услуг продвижения.

VasPricesResult `dataclass` ¶

VasPricesResult(items: list[VasPrice])

Bases: SerializableModel

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

ads¶

Enum¶

Ad dataclass ¶

get ¶

list ¶

update_price ¶

AdPromotion dataclass ¶

get_vas_prices ¶

apply_vas ¶

apply_vas_package ¶

apply_vas_direct ¶

AdStats dataclass ¶

get_calls_stats ¶

get_item_stats ¶

get_item_analytics ¶

get_account_spendings ¶

AutoloadArchive dataclass ¶

get_profile ¶

save_profile ¶

get_last_completed_report ¶

get_report ¶

AutoloadProfile dataclass ¶

get ¶

save ¶

upload_by_url ¶

get_tree ¶

get_node_fields ¶

AutoloadReport dataclass ¶

get ¶

list ¶

get_last_completed ¶

get_items ¶

get_fees ¶

get_ad_ids_by_avito_ids ¶

get_avito_ids_by_ad_ids ¶

get_items_info ¶

AdsActionStatus ¶

AutoloadFieldType ¶

AutoloadReportStatus ¶

ListingStatus ¶

AccountSpendings dataclass ¶

AdsActionResult dataclass ¶

AdsListResult dataclass ¶

AutoloadFee dataclass ¶

AutoloadFeesResult dataclass ¶

AutoloadField dataclass ¶

AutoloadFieldsResult dataclass ¶

AutoloadProfileSettings dataclass ¶

AutoloadReportDetails dataclass ¶

AutoloadReportItem dataclass ¶

AutoloadReportItemsResult dataclass ¶

AutoloadReportsResult dataclass ¶

AutoloadReportSummary dataclass ¶

AutoloadTreeNode dataclass ¶

AutoloadTreeResult dataclass ¶

CallsStatsResult dataclass ¶

CallStats dataclass ¶

ItemAnalyticsResult dataclass ¶

ItemStatsResult dataclass ¶

LegacyAutoloadReport dataclass ¶

Listing dataclass ¶

ListingStats dataclass ¶

SpendingRecord dataclass ¶

UpdatePriceResult dataclass ¶

UploadResult dataclass ¶

VasApplyResult dataclass ¶

VasPricesResult dataclass ¶

Ad `dataclass` ¶

AdPromotion `dataclass` ¶

AdStats `dataclass` ¶

AutoloadArchive `dataclass` ¶

AutoloadProfile `dataclass` ¶

AutoloadReport `dataclass` ¶

AccountSpendings `dataclass` ¶

AdsActionResult `dataclass` ¶

AdsListResult `dataclass` ¶

AutoloadFee `dataclass` ¶

AutoloadFeesResult `dataclass` ¶

AutoloadField `dataclass` ¶

AutoloadFieldsResult `dataclass` ¶

AutoloadProfileSettings `dataclass` ¶

AutoloadReportDetails `dataclass` ¶

AutoloadReportItem `dataclass` ¶

AutoloadReportItemsResult `dataclass` ¶

AutoloadReportsResult `dataclass` ¶

AutoloadReportSummary `dataclass` ¶

AutoloadTreeNode `dataclass` ¶

AutoloadTreeResult `dataclass` ¶

CallsStatsResult `dataclass` ¶

CallStats `dataclass` ¶

ItemAnalyticsResult `dataclass` ¶

ItemStatsResult `dataclass` ¶

LegacyAutoloadReport `dataclass` ¶

Listing `dataclass` ¶

ListingStats `dataclass` ¶

SpendingRecord `dataclass` ¶

UpdatePriceResult `dataclass` ¶

UploadResult `dataclass` ¶

VasApplyResult `dataclass` ¶

VasPricesResult `dataclass` ¶