Документация о виджете комментариев

Добавить на Ваш сайт виджет комментариев ВКонтакте можно в три шага:

http://vk.com/pages?oid=-1&p=%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F_%D0%BE_%D0%B2%D0%B8%D0%B4%D0%B6%D0%B5%D1%82%D0%B5_%D0%BA%D0%BE%D0%BC%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%80%D0%B8%D0%B5%D0%B2
http://vk.com/developers.php?o=-1&p=Comments

При помощи виджета ВКонтакте Вы можете за 5 минут добавить на Ваш сайт возможность комментирования статей и других материалов. Пользователи смогут комментировать Ваши материалы без дополнительной регистрации.

При желании, каждый оставленный комментарий может транслироваться на страницу комментатора ВКонтакте со ссылкой на исходную статью. Со страницы автора и из раздела Новости о статье узнают друзья автора и смогут присоединиться к дискуссии.

В этом случае комментарии второго уровня будут синхронизироваться между ВКонтакте и виджетом на Вашем сайте, так что обсуждение будет происходить одновременно на двух площадках, привлекая внимание новых участников.

Все преимущества виджета для комментариев ВКонтакте

1. Масштаб. Необходимость регистрации является дополнительной преградой при оставлении комментария, в результате чего общение часто приобретает анонимный или ограниченный характер. ВКонтакте зарегистрированы практически все пользователи Рунета, поэтому любой читатель сможет сразу прокомментировать Ваш материал от своего настоящего имени – с фотографией и ссылкой на подробную информацию о себе.

2. Вирусность. Каждый комментарий, оставленный через виджет, может автоматически транслироваться на страницу прокомментировавшего, а также попадает в Новости для его друзей. Такой комментарий всегда содержит ссылку на исходную статью. В результате о комментарии и существовании статьи узнают друзья комментатора, которые смогут присоединиться к дискуссии. Об их комментариях в свою очередь будут оповещены уже их друзья – и так далее. Дальше информация может распространяться лавинообразно.

3. Многомерность. Виджет ВКонтакте предусматривает возможность ответа на комментарии, причем ответы одновременно появляются как на странице статьи, так и на странице автора комментария, а также в новостях у его друзей. Автоматическая синхронизация ответов на комментарии приводит к тому, что Ваш материал обсуждается сразу на нескольких площадках, каждая из которых приносит внимание новых пользователей к исходной статье.

4. Скорость. В отличие от других возможностей социализации, виджет ВКонтакте очень прост в установке и может быть внедрен на все страницы Вашего сайта в течение 5 минут. Для достижения высокой скорости установки и работы виджета мы применили новейшие технологии и задействовали десятки наиболее мощных серверов ВКонтакте.

5. Контроль. Администратор сайта, устанавливающий код виджета, имеет возможность модерировать дискуссию прямо со страниц своего ресурса, удаляя нежелательные комментарии. Администратор также может назначать любое количество дополнительных модераторов, которые смогут обеспечивать порядок через удобный интерфейс.

6. Цитируемость. Каждый комментарий может становиться статусом пользователя ВКонтакте и содержит ссылку на Ваш ресурс. Комментарий появляется не только в новостях у друзей пользователя, но и в поиске по статусам ВКонтакте. Благодаря партнерству между ВКонтакте и Яндексом данные статусы в течение месяца будут индексироваться в поиске Яндекса в режиме реального времени, что станет источником дополнительной посещаемости для сайтов, разместивших виджет.

7. Независимость. Тексты всех комментариев хранятся и обрабатываются на серверах ВКонтакте, однако мы предоставляем API для администраторов сайтов, который позволяет сохранять все комментарии и на собственных серверах. Это не только предоставляет расширенные возможности для анализа комментариев, но и позволяет, в случае возникновения необходимости, отказаться от интеграции с ВКонтакте.

8. Гибкость. Предложив ряд уникальных преимуществ, мы постарались сделать виджет комментариев максимально привлекательным для администраторов и пользователей сайтов. Однако мы понимаем, что российские новостные и развлекательные ресурсы могут нуждаться в дополнительных возможностях настройки виджета. Мы всегда готовы пойти навстречу владельцам сайтов. Для реализации конкретных интересных предложений, пожалуйста, обращайтесь в нашу пресс-службу press@vkontakte.ru.

Подключение комментариев к Вашему сайту

Для добавления виджета на Ваш сайт просто скопируйте код для вставки на страницу, куда Вы хотите подключить виджет.

Название сайта:

Адрес сайта:

Основной домен сайта:

Количество комментариев:

5

10

15

20

Медиа:

Включить расширенные комментарии (подробнее)

Ширина:

px

Код для вставки:

Для более гибкой настройки Вы можете прочитать полную документацию по работе виджета.

 

 

1. В тег <head> на странице Вашего сайта необходимо добавить следующий код:

<script src="http://userapi.com/js/api/openapi.js" type="text/javascript" charset="windows-1251"></script>

2. В тело страницы сайта необходимо добавить следующий код:

<script type="text/javascript">
  VK.init({
    apiId: ВАШ_API_ID,
    onlyWidgets: true
  });
</script>

Более подробно про инициализацию транспорта читайте в разделе Open API.

3. В тело страницы необходимо добавить элемент DIV, в котором будут отображаться комментарии, задать ему уникальный id и добавить в него код инициализации виджета. Например:

<div id="vk_comments"></div>
<script type="text/javascript">
 VK.Widgets.Comments('vk_comments');
</script>

Приведенный код добавляет блок комментариев стандартного вида: изначально отображаются 10 последних комментариев. Ширина блока будет подобрана автоматически исходя из положения элемента с id="vk_comments". Идентификатор странице будет задан по её URL.

Дополнительные настройки

Метод VK.Widgets.Comments принимает четыре параметра.

Название параметра	Обязательный	Описание
element_id	✔	id элемента, который будет являться контейнером для блока комментариев
options		Опции блока комментариев. Объект Javascript. Возможные поля: width: задает ширину блока в пикселах (целое число > 300) limit: количество комментариев на странице (целое число 5-100) attach: задает возможность создания прикреплений к комментариям. Строка, содержащая перечисленные через запятую типы допустимых прикреплений либо false в случае отключения этой функции. Возможные типы: graffiti, photo, audio, video, link. Значение * включает все типы. Значение по умолчанию - *. autoPublish: автоматическая публикация комментария в статус пользователю (0 - выключена, 1 - включена). Значение по умолчанию - 1. mini: использовать ли минималистичный вид виджета - уменьшенный шрифт, уменьшенные миниатюры прикреплений, уменьшенные профильные изображения для комментариев 2го уровня. (1 - включено, 0 - выключено, 'auto' - выбирать автоматически в зависимости от доступной ширины). Значение по умолчанию - auto height: задает максимальную высоту виджета в пикселях. Целое число > 500. Если равно 0, то высота не ограничена. Если содержимое виджета больше, чем максимально допустимое, то появляется внутренняя прокрутка. Значение по умолчанию - 0. norealtime: отключает обновление ленты комментариев в реальном времени. (1 - отключено, 0 - включено). Значение по умолчанию - 0. pageUrl: адрес страницы с виджетом, на которую ссылается статус в случае, когда включена автоматическая трансляция комментария в статус. (Необязательный параметр)
page_id		Идентификатор страницы на Вашем сайте. Произвольная строка до 128 символов, либо число. Используется в том случае, если у одной и той же статьи может быть несколько адресов, а также на динамических сайтах, у которых меняется только хеш. Значение по умолчанию равно контрольной сумме от location.href.

События

При публикации комментария, а также при удалении, виджет передаёт событие widgets.comments.new_comment и widgets.comments.delete_comment используя VK.Observer. В функцию-обработчик будут переданы 4 параметра:

• num - количество комментариев
• last_comment - текст последнего комментария
• date - текущая дата в формате ISO 8601 (например, 2004-02-12T15:19:21+00:00)
• sign - контрольная сумма md5 от конкатенации 4х строк: api_secret, date, num, last_comment. В языке php может быть получена с помощью md5($api_secret.$date.$num.$last_comment).
  Защищенный секрет api_secret Вы можете узнать при редактировании своего приложения в графе "Защищенный ключ".

В большинстве случаев, можно игнорировать последние 2 параметра и обрабатывать только первые два. В случае необходимости, можно проверять корректность контрольной суммы.

Пример использования

<div id="vk_comments"></div>
<script type="text/javascript">
window.onload = function () {
 VK.init({apiId: 111, onlyWidgets: true});
 VK.Widgets.Comments('vk_comments', {width: 500, limit: 15}, 321);
}
</script>

Интеграция с сайтами, использующими технологию Open API

Вебмастерам сайтов, на которых авторизация производится через Open API, подключить виджет ещё проще. Достаточно просто добавить инициализацию виджета (пункт 3).

Администрирование виджета

Для модерации комментариев в интерфейсе виджета предусмотрена панель администрирования. Доступ к ней имеют все администраторы приложения ВКонтакте, к которому подключен виджет. Перейти к интерфейсу модерации можно по ссылке "администрирование" в шапке виджета на любой странице Вашего сайта.

Панель состоит из двух вкладок:

• Обзор. На этой вкладке отображаются недавние комментарии на Вашем сайте, отсортированные в порядке добавления, начиная с более новых. Возле каждого комментария есть ссылка на страницу, к которой он относится. Администратор может удалить любой комментарий. При этом при удалении 2 и более комментариев одного автора подряд администратору будет предложено удалить все остальные комментарии этого автора в приложении и добавить его в черный список.
• Черный список. На этой вкладке отображаются пользователи, добавленные в черный список. Пользователи, находящиеся в этом списке, не имеют возможности комментировать материалы на Вашем сайте через виджет ВКонтакте.

Интерфейс панели администрирования

Обзор комментариев

Функция VK.Widgets.CommentsBrowse позволяет отображать комментарии со всех страниц Вашего сайта единым потоком. У каждого комментария есть ссылка на страницу сайта, где он был опубликован.

Название параметра	Обязательный	Описание
element_id	✔	id элемента, который будет являться контейнером для блока комментариев
options		Опции блока комментариев. Объект Javascript. Возможные поля: width, limit, height, norealtime, mini подробно описаны в разделе "Дополнительные настройки".

Пример использования

<div id="vk_comments"></div>
<script type="text/javascript">
window.onload = function () {
 VK.init({apiId: 111, onlyWidgets: true});
 VK.Widgets.CommentsBrowse('vk_comments', {width: 500, limit: 5, mini: 0});
}
</script>