ads

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

Enum

• AdAnalyticsGrouping
• AdSpendingsGrouping
• AdsActionStatus
• AutoloadAvitoStatus
• AutoloadFieldType
• AutoloadItemStatus
• AutoloadItemStatusDetail
• AutoloadReportStatus
• ListingStatus

Bases: DomainObject

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

get

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> Listing

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list

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

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

Аргументы

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

Возвращает

Ленивый PaginatedList[Listing]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

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

Исключения

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

update_price

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

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

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

get_vas_prices

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

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

apply_vas

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

Применяет дополнительные услуги к объявлению.

Аргументы

vas_id: идентификатор VAS-услуги. 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.

apply_vas_package

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

Применяет пакет дополнительных услуг.

Аргументы

package_code: код пакета продвижения. 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.

apply_vas_direct

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

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

Аргументы

slugs: slug-идентификаторы узлов дерева категорий. 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

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

get_calls_stats

get_calls_stats(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallsStatsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_item_stats

get_item_stats(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    item_ids: list[int] | None = None,
    fields: list[str] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ItemStatsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_item_analytics

get_item_analytics(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    metrics: list[str],
    grouping: AdAnalyticsGroupingInput,
    limit: int,
    offset: int,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ItemAnalyticsResult

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

Аргументы

date_from: начальная дата или дата-время периода. date_to: конечная дата или дата-время периода. metrics: список метрик статистики, которые нужно вернуть. grouping: группировка статистики или расходов. limit: максимальное количество элементов в ответе. offset: смещение выборки. item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

get_account_spendings

get_account_spendings(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    spending_types: list[str],
    grouping: AdSpendingsGroupingInput,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountSpendings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

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

get_profile

get_profile(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadProfileSettings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

save_profile

save_profile(
    *,
    is_enabled: bool,
    upload_url: str,
    report_email: str,
    schedule_rate: int,
    schedule_weekdays: list[int] | None = None,
    schedule_time_slots: list[int] | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AdsActionResult

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

Аргументы

is_enabled: включает или отключает профиль автозагрузки. upload_url: URL фида автозагрузки. report_email: email для отправки отчетов автозагрузки. schedule_rate: ставка расписания продвижения. schedule_weekdays: дни недели для расписания; если не передано, используется полный недельный набор. schedule_time_slots: временные интервалы расписания; если не передано, используется первый слот. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

get_last_completed_report

get_last_completed_report(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LegacyAutoloadReport

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_report

get_report(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LegacyAutoloadReport

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

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

get

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadProfileSettings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

save

save(
    *,
    is_enabled: bool,
    feed_url: str,
    report_email: str,
    schedule_rate: int,
    schedule_weekdays: list[int] | None = None,
    schedule_time_slots: list[int] | None = None,
    feed_name: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AdsActionResult

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

Аргументы

is_enabled: включает или отключает профиль автозагрузки. feed_url: URL фида автозагрузки. report_email: email для отправки отчетов автозагрузки. schedule_rate: ставка расписания продвижения. schedule_weekdays: дни недели для расписания; если не передано, используется полный недельный набор. schedule_time_slots: временные интервалы расписания; если не передано, используется первый слот. feed_name: имя фида автозагрузки. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

upload_by_url

upload_by_url(
    *,
    url: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> UploadResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_tree

get_tree(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadTreeResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_node_fields

get_node_fields(
    *,
    node_slug: str,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadFieldsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: DomainObject

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

get

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportDetails

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list

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

Возвращает отчеты Автозагрузки с ленивой пагинацией.

Аргументы

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

Возвращает

Ленивый PaginatedList[AutoloadReportSummary]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

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

Исключения

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

get_last_completed

get_last_completed(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportDetails

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_items

get_items(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportItemsResult

Возвращает позиции выбранного отчета Автозагрузки.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_fees

get_fees(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadFeesResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_ad_ids_by_avito_ids

get_ad_ids_by_avito_ids(
    *,
    avito_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> IdMappingResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_avito_ids_by_ad_ids

get_avito_ids_by_ad_ids(
    *,
    ad_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> IdMappingResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_items_info

get_items_info(
    *,
    item_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportItemsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get async

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> Listing

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list async

list(
    *,
    status: ListingStatus | str | None = None,
    limit: int | None = None,
    page_size: int | None = None,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AsyncPaginatedList[Listing]

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

Аргументы

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

Возвращает

Ленивый AsyncPaginatedList[Listing]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

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

Исключения

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

update_price async

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

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get_vas_prices async

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

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

apply_vas async

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

Применяет дополнительные услуги к объявлению.

Аргументы

vas_id: идентификатор VAS-услуги. 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.

apply_vas_package async

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

Применяет пакет дополнительных услуг.

Аргументы

package_code: код пакета продвижения. 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.

apply_vas_direct async

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

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

Аргументы

slugs: slug-идентификаторы узлов дерева категорий. 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

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

get_calls_stats async

get_calls_stats(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> CallsStatsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_item_stats async

get_item_stats(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    item_ids: list[int] | None = None,
    fields: list[str] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ItemStatsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_item_analytics async

get_item_analytics(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    metrics: list[str],
    grouping: AdAnalyticsGroupingInput,
    limit: int,
    offset: int,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> ItemAnalyticsResult

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

Аргументы

date_from: начальная дата или дата-время периода. date_to: конечная дата или дата-время периода. metrics: список метрик статистики, которые нужно вернуть. grouping: группировка статистики или расходов. limit: максимальное количество элементов в ответе. offset: смещение выборки. item_ids: список идентификаторов объявлений. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

get_account_spendings async

get_account_spendings(
    *,
    date_from: StatsDate,
    date_to: StatsDate,
    spending_types: list[str],
    grouping: AdSpendingsGroupingInput,
    item_ids: list[int] | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AccountSpendings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get_profile async

get_profile(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadProfileSettings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

save_profile async

save_profile(
    *,
    is_enabled: bool,
    upload_url: str,
    report_email: str,
    schedule_rate: int,
    schedule_weekdays: list[int] | None = None,
    schedule_time_slots: list[int] | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AdsActionResult

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

Аргументы

is_enabled: включает или отключает профиль автозагрузки. upload_url: URL фида автозагрузки. report_email: email для отправки отчетов автозагрузки. schedule_rate: ставка расписания продвижения. schedule_weekdays: дни недели для расписания; если не передано, используется полный недельный набор. schedule_time_slots: временные интервалы расписания; если не передано, используется первый слот. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

get_last_completed_report async

get_last_completed_report(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LegacyAutoloadReport

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_report async

get_report(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> LegacyAutoloadReport

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get async

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadProfileSettings

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

save async

save(
    *,
    is_enabled: bool,
    feed_url: str,
    report_email: str,
    schedule_rate: int,
    schedule_weekdays: list[int] | None = None,
    schedule_time_slots: list[int] | None = None,
    feed_name: str | None = None,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AdsActionResult

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

Аргументы

is_enabled: включает или отключает профиль автозагрузки. feed_url: URL фида автозагрузки. report_email: email для отправки отчетов автозагрузки. schedule_rate: ставка расписания продвижения. schedule_weekdays: дни недели для расписания; если не передано, используется полный недельный набор. schedule_time_slots: временные интервалы расписания; если не передано, используется первый слот. feed_name: имя фида автозагрузки. idempotency_key: ключ идемпотентности для безопасного повтора write-операции. timeout: переопределяет таймауты HTTP-запроса для этого вызова. retry: переопределяет retry-политику операции: default, enabled или disabled.

Возвращает

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

Поведение

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

Исключения

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

upload_by_url async

upload_by_url(
    *,
    url: str,
    idempotency_key: str | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> UploadResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_tree async

get_tree(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadTreeResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_node_fields async

get_node_fields(
    *,
    node_slug: str,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadFieldsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

Bases: AsyncDomainObject

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

get async

get(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportDetails

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

list async

list(
    *,
    limit: int | None = None,
    offset: int | None = None,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AsyncPaginatedList[AutoloadReportSummary]

Возвращает отчеты Автозагрузки с ленивой пагинацией.

Аргументы

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

Возвращает

Ленивый AsyncPaginatedList[AutoloadReportSummary]; первая страница загружается при создании, следующие страницы - при итерации.

Поведение

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

Исключения

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

get_last_completed async

get_last_completed(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportDetails

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_items async

get_items(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportItemsResult

Возвращает позиции выбранного отчета Автозагрузки.

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_fees async

get_fees(
    *,
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadFeesResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_ad_ids_by_avito_ids async

get_ad_ids_by_avito_ids(
    *,
    avito_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> IdMappingResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_avito_ids_by_ad_ids async

get_avito_ids_by_ad_ids(
    *,
    ad_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> IdMappingResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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

get_items_info async

get_items_info(
    *,
    item_ids: Sequence[int],
    timeout: ApiTimeouts | None = None,
    retry: RetryOverride | None = None,
) -> AutoloadReportItemsResult

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

Аргументы

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

Возвращает

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

Поведение

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

Исключения

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