Skip to content

Владелец бота

aiosubgram.types.publisher.Sponsor

Bases: SubgramObject

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

Attributes

ads_id instance-attribute 
ads_id: str

Уникальный ID рекламной кампании.

available_now instance-attribute 
available_now: bool

Флаг, активен ли спонсор в данный момент. Если False, его не следует показывать.

button_text instance-attribute 
button_text: str

Рекомендуемый текст для кнопки (например 'Подписаться').

link: str

Готовая ссылка для подписки/перехода.

resource_id class-attribute instance-attribute 
resource_id: Optional[Union[str, int]] = None

Уникальный ID ресурса (канала или бота) в Telegram.

resource_logo: Optional[str] = None

URL на логотип ресурса.

resource_name instance-attribute 
resource_name: str

Название ресурса (канала, бота).

status instance-attribute 
status: Literal['subscribed', 'unsubscribed', 'notgetted']

Текущий статус подписки: - subscribed: Подписан. - unsubscribed: Не подписан. - notgetted: Пользователь был подписан ранее и отписался (не уникальный). Telegram не засчитал вступление. Доступ можно давать, но оплата не начисляется.

type instance-attribute 
type: Literal['channel', 'bot', 'smart_link', 'resource']

Тип ресурса: - channel: Канал или чат. - bot: Telegram бот. - smart_link: Умный редирект. Спонсор определится при открытии ссылки. - resource: Внешний ресурс (miniapp, сайт) или канал/бот без проверки подписки.

aiosubgram.types.publisher.GetSponsors

Bases: SubgramObject

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

Attributes

message instance-attribute 
message: Optional[str]

Сообщение о статусе или ошибке.

sponsors class-attribute instance-attribute 
sponsors: List[Sponsor] = []

Список спонсоров для подписки.

status instance-attribute 
status: Literal['ok', 'warning', 'error']
  • ok: Можно пропускать пользователя (подписан или нет спонсоров).
  • warning: Не пропускать. Нужно выполнить действие (подписаться).
  • error: Произошла ошибка.

Functions

flatten_additional_data classmethod 
flatten_additional_data(data: Any) -> Any
Source code in aiosubgram\types\publisher.py 
65
66
67
68
69
70
71
72
73
@model_validator(mode='before')
@classmethod
def flatten_additional_data(cls, data: Any) -> Any:
    if isinstance(data, dict):
        additional = data.get('additional')
        if isinstance(additional, dict):
            if 'sponsors' in additional:
                data['sponsors'] = additional['sponsors']
    return data

aiosubgram.types.publisher.Bot

Bases: SubgramObject

Информация о боте (Publisher).

Attributes

age_question instance-attribute 
age_question: bool

Показывать вопрос о возрасте в анкете.

api_key instance-attribute 
api_key: str

API ключ бота.

bot_id instance-attribute 
bot_id: int

ID бота.

bot_name instance-attribute 
bot_name: str

Имя бота.

bot_nickname instance-attribute 
bot_nickname: str

Юзернейм бота (без @).

forbidden_themes class-attribute instance-attribute 
forbidden_themes: List[str] = []

Список исключенных тематик рекламы.

gender_question instance-attribute 
gender_question: bool

Показывать вопрос о поле в анкете.

get_links: bool

Получать ссылки по API (True) или авто-вывод SubGram (False).

image_op class-attribute instance-attribute 
image_op: Optional[str] = None

URL изображения для блока ОП.

is_on instance-attribute 
is_on: bool

Включен (True) или выключен (False) бот в системе.

max_sponsors instance-attribute 
max_sponsors: int

Макс. кол-во спонсоров в выдаче (1-10).

note class-attribute instance-attribute 
note: Optional[Any] = None

Примечание.

profit class-attribute instance-attribute 
profit: Optional[float] = 0.0

Общий доход.

profit_own_orders class-attribute instance-attribute 
profit_own_orders: Optional[float] = 0.0

Доход с собственных заказов.

show_quiz instance-attribute 
show_quiz: bool

Показывать Web App анкету (пол/возраст).

status class-attribute instance-attribute 
status: Optional[str] = None

Статус бота (например, active).

text_op class-attribute instance-attribute 
text_op: Optional[str] = None

Кастомный текст для блока ОП.

time_purge instance-attribute 
time_purge: int

Время (в минутах), на которое кешируется список спонсоров (5-4320).

aiosubgram.types.publisher.BotAddResult

Bases: SubgramObject

Attributes

api_key instance-attribute 
api_key: str

aiosubgram.types.publisher.Bots

Bases: SubgramObject

Ответ методов управления ботами (/bots).

Attributes

message class-attribute instance-attribute 
message: Optional[str] = None
result class-attribute instance-attribute 
result: Optional[Union[Bot, BotAddResult]] = None
status instance-attribute 
status: Literal['ok', 'warning', 'error']

aiosubgram.types.publisher.UserInfo

Bases: SubgramObject

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

Attributes

age_category instance-attribute 
age_category: int

ID возрастной категории: 0: Не определено, 1: <10, 2: 11-13, 3: 14-15, 4: 16-17, 5: 18-25, 6: >25.

age_category_info instance-attribute 
age_category_info: str

Текстовое описание возраста (например, '> 25').

city instance-attribute 
city: str

Город.

country instance-attribute 
country: str

Страна.

device_os instance-attribute 
device_os: str

ОС: Android, iOS, Mac OS, Windows.

device_type instance-attribute 
device_type: str

Тип устройства: mobile, desktop, tablet.

first_name instance-attribute 
first_name: str

Имя пользователя.

gender instance-attribute 
gender: str

Пол: male, female.

ip_address instance-attribute 
ip_address: str

IP адрес.

is_suspicious instance-attribute 
is_suspicious: bool

True — подозрение на мультиаккаунт/фрод. False — пользователь чист.

lang_code instance-attribute 
lang_code: str

Код языка (ru, en...).

last_name class-attribute instance-attribute 
last_name: Optional[str] = None

Фамилия пользователя.

username class-attribute instance-attribute 
username: Optional[str] = None

Юзернейм (без @).

aiosubgram.types.publisher.GetUserInfo

Bases: SubgramObject

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

Attributes

data class-attribute instance-attribute 
data: UserInfo = None
message class-attribute instance-attribute 
message: Optional[str] = None
status instance-attribute 
status: Literal['ok', 'warning', 'error']