Приложение "Выгрузка ЦИАН 2": различия между версиями
Перейти к навигации
Перейти к поиску
Abushyk (обсуждение | вклад) |
Abushyk (обсуждение | вклад) |
||
| (не показано 19 промежуточных версий этого же участника) | |||
| Строка 1: | Строка 1: | ||
| − | |||
== Основные настройки == | == Основные настройки == | ||
| Строка 6: | Строка 5: | ||
! Параметр !! Название !! Описание | ! Параметр !! Название !! Описание | ||
|- | |- | ||
| − | | apps.cianexporter2.export_mark || Поле checkbox-типа для участия в выгрузке || | + | | apps.cianexporter2.export_mark || Поле checkbox-типа для участия в выгрузке || Системное имя поля типа checkbox отмеченное значение которого обозначает доступность для выгрузки в стандартном фиде. Ограничение работает одновременно с ограничением из настройки '''apps.cianexporter2.date_field'''. |
|- | |- | ||
| − | | apps.cianexporter2.standart_alias || Алиас стандартной выгрузки || | + | | apps.cianexporter2.standart_alias || Алиас стандартной выгрузки || Алиас стандартного фида. Может иметь произвольный вид, допустимый для URL страницы. Не указывается домен и протокол. Не используются лидирующие и замыкающие слеши. |
|- | |- | ||
| − | | apps.cianexporter2.externals || Дополнительные объекты || | + | | apps.cianexporter2.externals || Дополнительные объекты || Дополнительные объекты, собираемые вместе с данными об объявлении. См. [[#Дополнительные объекты]] |
|- | |- | ||
| − | | apps.cianexporter2.date_field || Ситемное имя поля ограничивающей даты || | + | | apps.cianexporter2.date_field || Ситемное имя поля ограничивающей даты || Системное имя поля типа date или dtdatetime, значение которого значение которого в будущем относительно текущего момента, обозначает доступность для выгрузки в стандартном фиде. Ограничение работает одновременно с ограничением из настройки '''apps.cianexporter2.export_mark'''. |
|- | |- | ||
| − | | apps.cianexporter2.commercial_by_days || Использовать ограничение доступности выгрузки по дням для коммерческой || | + | | apps.cianexporter2.commercial_by_days || Использовать ограничение доступности выгрузки по дням для коммерческой || Включает режим доступности выгрузки коммерческих объектов в определенные дни, указанные в настройке '''apps.cianexporter2.commerce_allowed_days'''. Если выгрузка происходит вне дней, указанных в настройке '''apps.cianexporter2.commerce_allowed_days''', то коммерческие объекты не будут выдаваться в нее |
|- | |- | ||
| − | | apps.cianexporter2.commerce_allowed_days || Дни доступности выгрузки коммерческой || | + | | apps.cianexporter2.commerce_allowed_days || Дни доступности выгрузки коммерческой || Указанные через запятую номера дней недели доступности коммерческих объектов. (1 - пн, 2 - вт, ... , 7 - вс). Например: ''1,2,3,4,5'' - с пн по пт. или ''1,3,5,7'' - пн, ср, пт, вс. Не допускается указание в виде диапазона (''1-5''). Если перечень дней доступности не будет указан, но будет включена настройка '''apps.cianexporter2.commercial_by_days''', то коммерческие объекты в фид не попадут. |
|- | |- | ||
| − | | apps.cianexporter2.use_user_limits || Использовать ограничение количества выгружаемых || | + | | apps.cianexporter2.use_user_limits || Использовать ограничение количества выгружаемых || Включение режима, ограничивающего количество выгружаемых объектов для каждого пользователя некоторым лимитом, указанным в данных его профиля (настройка '''apps.cianexporter2.user_profile_limit_field'''). |
|- | |- | ||
| − | | apps.cianexporter2.user_profile_limit_field || Системное имя поля с лимитом на выгрузку в профиле || | + | | apps.cianexporter2.user_profile_limit_field || Системное имя поля с лимитом на выгрузку в профиле || Системное имя поля в модели объекта user в котором хранится числовое значение лимита выгружаемых объектов в фид для каждого пользователя. Если включен режим ограничения лимитами и в этой настройке не указано значение системного поля-источника или указано, но само поле в модели не существует или существует, но имеет не числовое значение, то лимит для этого пользователя будет установлен в 0. |
|} | |} | ||
| + | |||
| + | == Дополнительные объекты == | ||
| + | |||
| + | Если возникает необходимость в Маппере приложения обозначить условия на основании значений данных не самого объекта, а связанных с ним объектов, то необходимо декларировать эти объекты в настройке '''apps.cianexporter2.externals'''.<br /> | ||
| + | Например, у нас в приложении Жилые комплексы, каждый комплекс имеет признак-checkbox с системным именем is_newbuild, который обозначает является ли ЖК новостройкой или нет. А объявления имеют признак complex_id, который ссылается на один из ЖК из списка строений в базе Жилых комплексов. В Маппере мы имеем возможность создать условие для определения является ли выгружаемый объект объектом в новостройке. Логично предположить, что "новостроечность" объекта будет обозначать случай, когда объект привязан к ЖК у которого свойство is_newbuild отмечено. Но это свойство не объекта, а связанного с ним объекта.<br /> | ||
| + | |||
| + | Для того, что бы реализовать такое условие, мы должны объявить подбор информации о связанном ЖК вместе с данными объявлений. Поэтому в настройке '''apps.cianexporter2.externals''' мы указываем следующую строку | ||
| + | |||
| + | <pre>complex_id=complex</pre> | ||
| + | |||
| + | Она означает, что при сборке данных об объявлении при выгрузке, будет получен связанный через поле complex_id объект и его данные будут интегрированы в данные объекта под псевдонимом complex. И в прописівании условий мі сможем использовать запись вида | ||
| + | |||
| + | <pre>complex.is_newbuild</pre> | ||
| + | |||
| + | А для доступа к имени ЖК | ||
| + | |||
| + | <pre>complex.name</pre> | ||
| + | |||
| + | == Маппер == | ||
== Дополнительные фиды == | == Дополнительные фиды == | ||
| + | |||
| + | С версии 0.3.2 есть возможность создавать дополнительные кастомные фиды. Стандартный фид продолжает существовать по алиасу из настройки '''apps.cianexporter2.standart_alias''' и подчиняться основным настройкам.<br /> | ||
| + | |||
| + | Для контроля за выгрузками используйте кнопку '''Выгрузки''' в странице приложения. Она ведет на страницу со списком всех ваших фидов. Для добавления нового фида используйте '''Создать новую выгрузку'''. Шаблон нового фида появляется ниже существующих. | ||
| + | |||
| + | Параметры фида | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Параметр !! Значение | ||
| + | |- | ||
| + | | Название || Произвольное текстовое имя фида. Не имеет отношения к процессу выгрузки и служит для более удобной идентификации | ||
| + | |- | ||
| + | | Адрес || Алиас фида. Может иметь произвольный вид, допустимый для URL страницы. Не указывается домен и протокол. Не используются лидирующие и замыкающие слеши. | ||
| + | |- | ||
| + | | Игнорировать лимиты пользователей || Выключает работу режима '''apps.cianexporter2.use_user_limits''' для данного фида. Если параметр не отмечен, то работает по текущим базовым настройкам | ||
| + | |- | ||
| + | | Активно || Включает\выключает активность фида | ||
| + | |- | ||
| + | | Тип объектов || Определяет выдавать ли в фид только активные объекты или выдавать все | ||
| + | |- | ||
| + | | Условия || Набор условий, определяющий какие объекты входят в набор выгружаемых. Условия задаются по аналогии с настройкой Маппера | ||
| + | |} | ||
Текущая версия на 13:21, 28 августа 2019
Основные настройки
| Параметр | Название | Описание |
|---|---|---|
| apps.cianexporter2.export_mark | Поле checkbox-типа для участия в выгрузке | Системное имя поля типа checkbox отмеченное значение которого обозначает доступность для выгрузки в стандартном фиде. Ограничение работает одновременно с ограничением из настройки apps.cianexporter2.date_field. |
| apps.cianexporter2.standart_alias | Алиас стандартной выгрузки | Алиас стандартного фида. Может иметь произвольный вид, допустимый для URL страницы. Не указывается домен и протокол. Не используются лидирующие и замыкающие слеши. |
| apps.cianexporter2.externals | Дополнительные объекты | Дополнительные объекты, собираемые вместе с данными об объявлении. См. #Дополнительные объекты |
| apps.cianexporter2.date_field | Ситемное имя поля ограничивающей даты | Системное имя поля типа date или dtdatetime, значение которого значение которого в будущем относительно текущего момента, обозначает доступность для выгрузки в стандартном фиде. Ограничение работает одновременно с ограничением из настройки apps.cianexporter2.export_mark. |
| apps.cianexporter2.commercial_by_days | Использовать ограничение доступности выгрузки по дням для коммерческой | Включает режим доступности выгрузки коммерческих объектов в определенные дни, указанные в настройке apps.cianexporter2.commerce_allowed_days. Если выгрузка происходит вне дней, указанных в настройке apps.cianexporter2.commerce_allowed_days, то коммерческие объекты не будут выдаваться в нее |
| apps.cianexporter2.commerce_allowed_days | Дни доступности выгрузки коммерческой | Указанные через запятую номера дней недели доступности коммерческих объектов. (1 - пн, 2 - вт, ... , 7 - вс). Например: 1,2,3,4,5 - с пн по пт. или 1,3,5,7 - пн, ср, пт, вс. Не допускается указание в виде диапазона (1-5). Если перечень дней доступности не будет указан, но будет включена настройка apps.cianexporter2.commercial_by_days, то коммерческие объекты в фид не попадут. |
| apps.cianexporter2.use_user_limits | Использовать ограничение количества выгружаемых | Включение режима, ограничивающего количество выгружаемых объектов для каждого пользователя некоторым лимитом, указанным в данных его профиля (настройка apps.cianexporter2.user_profile_limit_field). |
| apps.cianexporter2.user_profile_limit_field | Системное имя поля с лимитом на выгрузку в профиле | Системное имя поля в модели объекта user в котором хранится числовое значение лимита выгружаемых объектов в фид для каждого пользователя. Если включен режим ограничения лимитами и в этой настройке не указано значение системного поля-источника или указано, но само поле в модели не существует или существует, но имеет не числовое значение, то лимит для этого пользователя будет установлен в 0. |
Дополнительные объекты
Если возникает необходимость в Маппере приложения обозначить условия на основании значений данных не самого объекта, а связанных с ним объектов, то необходимо декларировать эти объекты в настройке apps.cianexporter2.externals.
Например, у нас в приложении Жилые комплексы, каждый комплекс имеет признак-checkbox с системным именем is_newbuild, который обозначает является ли ЖК новостройкой или нет. А объявления имеют признак complex_id, который ссылается на один из ЖК из списка строений в базе Жилых комплексов. В Маппере мы имеем возможность создать условие для определения является ли выгружаемый объект объектом в новостройке. Логично предположить, что "новостроечность" объекта будет обозначать случай, когда объект привязан к ЖК у которого свойство is_newbuild отмечено. Но это свойство не объекта, а связанного с ним объекта.
Для того, что бы реализовать такое условие, мы должны объявить подбор информации о связанном ЖК вместе с данными объявлений. Поэтому в настройке apps.cianexporter2.externals мы указываем следующую строку
complex_id=complex
Она означает, что при сборке данных об объявлении при выгрузке, будет получен связанный через поле complex_id объект и его данные будут интегрированы в данные объекта под псевдонимом complex. И в прописівании условий мі сможем использовать запись вида
complex.is_newbuild
А для доступа к имени ЖК
complex.name
Маппер
Дополнительные фиды
С версии 0.3.2 есть возможность создавать дополнительные кастомные фиды. Стандартный фид продолжает существовать по алиасу из настройки apps.cianexporter2.standart_alias и подчиняться основным настройкам.
Для контроля за выгрузками используйте кнопку Выгрузки в странице приложения. Она ведет на страницу со списком всех ваших фидов. Для добавления нового фида используйте Создать новую выгрузку. Шаблон нового фида появляется ниже существующих.
Параметры фида
| Параметр | Значение |
|---|---|
| Название | Произвольное текстовое имя фида. Не имеет отношения к процессу выгрузки и служит для более удобной идентификации |
| Адрес | Алиас фида. Может иметь произвольный вид, допустимый для URL страницы. Не указывается домен и протокол. Не используются лидирующие и замыкающие слеши. |
| Игнорировать лимиты пользователей | Выключает работу режима apps.cianexporter2.use_user_limits для данного фида. Если параметр не отмечен, то работает по текущим базовым настройкам |
| Активно | Включает\выключает активность фида |
| Тип объектов | Определяет выдавать ли в фид только активные объекты или выдавать все |
| Условия | Набор условий, определяющий какие объекты входят в набор выгружаемых. Условия задаются по аналогии с настройкой Маппера |
