Рекламодатель

aiosubgram.types.advertiser.UserParameters

Bases: SubgramObject

Параметры таргетинга для заказа. Влияют на итоговую стоимость подписчика (коэффициенты).

Attributes

ages class-attribute instance-attribute

ages: Optional[List[int]] = None

ID категорий возраста. Коэффициенты: <10 (x1.2), 11-13 (x1.2), 14-15 (x1.5), 16-17 (x1.5), 18-24 (x2.0), >25 (x2.5).

cities class-attribute instance-attribute

cities: Optional[List[int]] = None

ID городов (из /filters). Коэффициент: x2.5

countries class-attribute instance-attribute

countries: Optional[List[int]] = None

ID стран (из /filters). Коэффициент: x2.5

devicesos class-attribute instance-attribute

devicesos: Optional[List[int]] = None

ID операционных систем. Коэффициент: x1.5

devicestype class-attribute instance-attribute

devicestype: Optional[List[str]] = None

Типы устройств (desktop, mobile). Коэффициент: x1.5

gender class-attribute instance-attribute

gender: Optional[Literal['male', 'female', 'all']] = None

Пол аудитории. По умолчанию 'all'.

has_bio class-attribute instance-attribute

has_bio: Optional[int] = None

Наличие Bio (1 - да). Коэффициент: x1.1

has_fake_check class-attribute instance-attribute

has_fake_check: Optional[int] = None

Прохождение анти-фрод проверки (1 - да). Коэффициент: x1.1

has_first_name class-attribute instance-attribute

has_first_name: Optional[int] = None

Наличие имени (1 - да). Коэффициент: x1.1

has_photo class-attribute instance-attribute

has_photo: Optional[int] = None

Наличие фото (1 - да). Коэффициент: x1.1

has_ru_name class-attribute instance-attribute

has_ru_name: Optional[int] = None

Наличие имени на кириллице (1 - да). Коэффициент: x1.1

has_username class-attribute instance-attribute

has_username: Optional[int] = None

Наличие юзернейма (1 - да). Коэффициент: x1.1

languages class-attribute instance-attribute

languages: Optional[List[int]] = None

ID языков (из /filters). По умолчанию [1,2,3,4,5] (RU/UZ/KZ/UA/BY). Null для всех языков.

old_account class-attribute instance-attribute

old_account: Optional[int] = None

Возраст аккаунта: 1 (>2 лет, x1.1), 2 (>3 лет, x1.2), 3 (>5 лет, x1.3), 4 (>7 лет, x1.4), 5 (>9 лет, x1.5).

only_premium class-attribute instance-attribute

only_premium: Optional[int] = None

Таргетинг по Premium: 0 - любой (default), 1 - только Premium, 2 - без Premium.

aiosubgram.types.advertiser.OrderSchedule

Bases: SubgramObject

Настройки расписания показов заказа.

Attributes

end_time class-attribute instance-attribute

end_time: Optional[time] = None

Время окончания показов ежедневно (HH:MM).

excluded_days class-attribute instance-attribute

excluded_days: Optional[List[int]] = None

Дни недели для исключения (1=Пн, ... 7=Вс).

start_datetime class-attribute instance-attribute

start_datetime: Optional[datetime] = None

Отложенный запуск (YYYY-MM-DD HH:MM:SS).

start_time class-attribute instance-attribute

start_time: Optional[time] = None

Время начала показов ежедневно (HH:MM).

Functions

serialize_datetime

serialize_datetime(v: Optional[datetime], _info)

Source code in aiosubgram\types\advertiser.py

@field_serializer('start_datetime')
def serialize_datetime(self, v: Optional[datetime], _info):
    if v:
        return v.strftime('%Y-%m-%d %H:%M:%S')
    return None

serialize_time

serialize_time(v: Optional[time], _info)

Source code in aiosubgram\types\advertiser.py

@field_serializer('start_time', 'end_time')
def serialize_time(self, v: Optional[time], _info):
    if v:
        return v.strftime('%H:%M')
    return None

validate_time classmethod

validate_time(v: Optional[Union[str, time]]) -> Optional[Union[str, time]]

Source code in aiosubgram\types\advertiser.py

@field_validator('start_time', 'end_time', mode='before')
@classmethod
def validate_time(cls, v: Optional[Union[str, time]]) -> Optional[Union[str, time]]:
    if isinstance(v, str):
        parts = v.split(':')
        if len(parts) > 0 and len(parts[0]) == 1:
            return f"0{v}"
    return v

aiosubgram.types.advertiser.OrderCoefficients

Bases: SubgramObject

Примененные коэффициенты стоимости к заказу.

Attributes

ages class-attribute instance-attribute

ages: Optional[float] = None

cities class-attribute instance-attribute

cities: Optional[float] = None

countries class-attribute instance-attribute

countries: Optional[float] = None

devicesos class-attribute instance-attribute

devicesos: Optional[float] = None

devicestype class-attribute instance-attribute

devicestype: Optional[float] = None

has_bio class-attribute instance-attribute

has_bio: Optional[float] = None

has_fake_check class-attribute instance-attribute

has_fake_check: Optional[float] = None

has_first_name class-attribute instance-attribute

has_first_name: Optional[float] = None

has_photo class-attribute instance-attribute

has_photo: Optional[float] = None

has_ru_name class-attribute instance-attribute

has_ru_name: Optional[float] = None

has_username class-attribute instance-attribute

has_username: Optional[float] = None

old_account class-attribute instance-attribute

old_account: Optional[float] = None

total class-attribute instance-attribute

total: Optional[float] = None

Итоговый множитель цены.

aiosubgram.types.advertiser.CreateOrderResult

Bases: SubgramObject

Attributes

order_id instance-attribute

order_id: int

aiosubgram.types.advertiser.CreateOrder

Bases: SubgramObject

Ответ метода create_order / update_order.

Attributes

code instance-attribute

code: int

message class-attribute instance-attribute

message: Optional[str] = None

response class-attribute instance-attribute

response: Optional[CreateOrderResult] = None

status instance-attribute

status: Literal['ok', 'warning', 'error']

aiosubgram.types.advertiser.OrderInfoData

Bases: SubgramObject

Полная информация о заказе.

Attributes

ads_type instance-attribute

ads_type: Literal['channel', 'bot', 'resource']

coefficients class-attribute instance-attribute

coefficients: Optional[OrderCoefficients] = None

in_archive instance-attribute

in_archive: int

is_lite instance-attribute

is_lite: int

is_on instance-attribute

is_on: int

link instance-attribute

link: str

name class-attribute instance-attribute

name: Optional[str] = None

old_price instance-attribute

old_price: float

Базовая цена (до коэффициентов).

order_id instance-attribute

order_id: int

order_schedule class-attribute instance-attribute

order_schedule: Optional[OrderSchedule] = None

quantity_all instance-attribute

quantity_all: int

Общее заказанное количество.

quantity_day class-attribute instance-attribute

quantity_day: Optional[int] = None

Дневной лимит.

quantity_now instance-attribute

quantity_now: int

Текущее количество выполненных подписок.

real_price instance-attribute

real_price: float

Итоговая цена за подписчика.

reason class-attribute instance-attribute

reason: Optional[str] = None

Причина отклонения (для Rejected).

remains instance-attribute

remains: int

Осталось выполнить.

status instance-attribute

status: Literal['Moderation', 'Processing', 'Stopped', 'Finished', 'Rejected', 'Archived']

Статус заказа: - Moderation: На модерации. - Processing: Активен. - Stopped: Остановлен вручную. - Finished: Выполнен (лимит достигнут). - Rejected: Отклонен (см. reason). - Archived: В архиве.

sub_speed class-attribute instance-attribute

sub_speed: Optional[int] = None

to_bot_member class-attribute instance-attribute

to_bot_member: Optional[int] = None

track_unsubscriptions class-attribute instance-attribute

track_unsubscriptions: Optional[bool] = None

user_parameters class-attribute instance-attribute

user_parameters: Optional[UserParameters] = None

aiosubgram.types.advertiser.OrderInfo

Bases: SubgramObject

Ответ метода get_order_info.

Attributes

code instance-attribute

code: int

message class-attribute instance-attribute

message: Optional[str] = None

response class-attribute instance-attribute

response: Optional[OrderInfoData] = None

status instance-attribute

status: Literal['ok', 'warning', 'error']