Content Egg Wordpress Plugin

Руководство пользователя

Project: www.keywordrush.com/contenteggEmail: support @ keywordrush . com

ОглавлениеУстановка плагина............................................................................3Настройка плагина............................................................................4Контент-модули.................................................................................5Bing Images модуль...........................................................................5Flickr модуль......................................................................................6Freebase модуль...............................................................................8Google Books модуль........................................................................9Market модуль...................................................................................9Offer модуль......................................................................................9Pixabay модуль................................................................................11Related Keywords модуль...............................................................11Twitter модуль..................................................................................11Youtube модуль...............................................................................13Модули партнерских программ......................................................14Affiliatewindow модуль.....................................................................14Admitad Coupons модуль................................................................14Affilinet Coupons модуль.................................................................15Affilinet Products модуль..................................................................15Aliexpress модуль............................................................................16Amazon модуль...............................................................................17CJ Links модуль...............................................................................18CJ Products модуль.........................................................................19Ebay модуль....................................................................................19Envato модуль.................................................................................20Flipkart модуль.................................................................................21GdeSlon модуль..............................................................................22Impactradius модуль........................................................................22Optimisemedia модуль.....................................................................22Linkshare модуль.............................................................................23Shareasale модуль..........................................................................23

Tradedoubler Coupons модуль........................................................23Tradedoubler Products модуль........................................................24Tradetracker Coupons модуль.........................................................24Tradetracker Products модуль.........................................................25Udemy модуль.................................................................................25Zanox модуль..................................................................................26Работа с плагином..........................................................................28Автоматические обновления плагина............................................29Пользовательские шаблоны..........................................................30Локализация шаблонов..................................................................31Для разработчиков..........................................................................32

Установка плагина

Убедитесь, что программное обеспечение отвечает требованиям Conten Egg плагина:

● PHP 5.3 или старше (обратите внимание, Wordpress без плагина требует PHP 5.2.4или старше).

● Wordpress 4.2.2 или старше.

Если вы хотите обновить бесплатную версию на Content Egg Pro:

1. Убедитесь, что у вас установлена последняя доступная версия плагина, если это не так, сначала обновитесь до последней версии. Это необходимо для того, чтобы все ваши сохраненные данные и настройки корректно были перенесены в Pro версию плагина.

2. Деактивируйте и затем удалите бесплатную версию плагина. Затем приступайте к обычной установке, описанной ниже.

Ручная установка плагина не отличается от установки любых других Wordpress плагинов:

1. Скачайте ZIP архив плагина в вашей панели пользователя.2. Разархивируйте файлы и переместите директорию плагина в "wp-content/plugins/"

директорию Wordpress на вашем сервере.3. Активируйте Content Egg плагин на вкладке "Плагины" в админ-панели Wordpress.4. Введите действующий ключ лицензии. Найти ключ вы можете в своей панели

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

Внимание: Не запускайте процесс автоматического обновления плагина, когда он находится в неактивном состоянии. В этом случаи обновление произойдет с репозитория Wordpress на бесплатную версию плагина.

Настройка плагина

Прежде чем вы сможете начать работу с Content Egg, вам необходимо активировать и настроить модули плагина. Для этого перейдите из главного меню Content Egg → Настройки.

Большинство модулей Content Egg получают данные через API различных сервисов. Ниже вы найдете инструкции, как получить API ключи для различных модулей.

Контент-модули

Некоторые контент-модули имеют поддержку мультиязычности, другие работают только содним или несколькими определенными языками. Выберите язык сайта на странице Content Egg → Настройки → Общие настройки. Модули с поддержкой мультиязычности будут отдавать предпочтение контенту на этом языке. Кроме того, эта настройка указывает на язык для локализации шаблонов модулей (подробнее см. раздел "Локализация шаблонов").

Bing Images модуль

Получение Subscription Key.

1. Зарегистрируйтесь в Windows Cognitive Services: https://www.microsoft.com/cognitive-services/en-us/sign-up. Войдите в свой аккаунт.

2. Нажмите кнопку Request new trials и подпишитесь на Bing Search API.

3. Перейдите на страницу My Account в Windows Cognitive Services и найдите свой ключ для соответсвующего API:

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

Flickr модуль

Получение API Key.1. Если у вас еще нет аккаунта yahoo, сначала создайте его:

https://edit.yahoo.com/registration2. Для получения ключа перейдите: https://www.flickr.com/services/apps/create/apply

"Некоммерческие" ключи выдаются автоматически, "коммерческие" – требуют длительное время для рассмотрения заявки.

3. Заполните поля формы по своему усмотрению.

4. На завершающем этапе вы получите доступ к своему API Key:

Freebase модульВнимание: Freebase API был закрыт, и возможно прямо сейчас вы уже не сможете подписаться на этот API в консоле google. Модуль оставлен для совместимости со старыми версиями плагина.

Получение API Key.

1. Зайдите в Google API console (у вас должен быть зарегестрирован аккаунт google): https://console.developers.google.com

2. Если вы еще не создали проект в API консоли, создайте его сейчас:

3. Перейдите Library и найдите с помощью поиска Freebase API в списке всех доступных API и активируйте его:

4. Перейдите Credentials → Вы берите ваш проект. Если вы еще не создали API Key (Server key) ранее, создайте его сейчас:

Google Books модульПолучение API Key для Google Books, полностью аналогично настройке Freebase модуля,только на 3-м этапе активируйте Google Books API.

Market модульФорма заявки для получение API Key находится здесь: http://feedback2.yandex.ru/api-market-content/key/

Изучите правила сервиса, подробно опишите свой проект и то, как вы планируете использовать данные, полученные с помощью API Маркета.

Offer модуль

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

Как задать Deeplink?

Эта настройка делает из обычной прямой ссылки на магазин партнерскую ссылку.Примеры валидных Deeplink, если вы работаете через CPA-сеть:

https://ad.admitad.com/g/9ca7893949f31c939d42c4d17e0/?ulp={{url_encoded}}https://ad.admitad.com/g/9ca7893949f31c939d42c4d17e0/?ulp=

Если вам нужно задать партнерский ID в качестве параметра, используйте следующий формат:partner=affiliate_ID{{url}}&partner=affiliate_ID

Как задать XPath селектор?

Этот раздел только для продвинутых пользователей. Вам потребуются некоторые технические знания для правильной настройки этой опции.

Если вы хотите, чтобы цена на товар автоматически обновлялась, необходимо задать XPath селектор для получения значения цены со страницы магазина.

Простой способ получения XPath селектора:

1. Отключите JavaScript в вашем Firefox браузере. Вы не можете парсить элементы, которые выводяnся диyамически на JavaScript.

2. Установите бесплатные расширения для FireFox: Firebug + .3. Откройте страницу с товаром, включите панель FirePath.4. С помощью указателя мыши щелкните по элементу, который содержит цену.5. Скопируйте значение XPath поля в настройки оффера.

Pixabay модульПолучение API Key

1. Создайте аккаунт на сайте pixabay: https://pixabay.com/accounts/register/2. Войдите в свой аккаунт.3. Перейдите по адресу: https://pixabay.com/api/docs/. Пролистайте страницу немного

внизу и найдите свой API Key, как показано на рисунке:

Related Keywords модульМодуль использует Bing API для получения данных и настраивается аналогично модулю Bing Images, только необходимо сделать подписку на Bing Autosuggest API

Twitter модульПолучение Consumer key, Consumer secret, Access token, Access token secret.

1. Перейдите https://dev.twitter.com/apps и нажмите кнопку Create a new application (Если у вас еще нет учетной записи Twitter, сначала потребуется создать её):

2. На странице Keys and Access Tokens вашего приложения найдите Consumer Key и Consumer Secret:

3. Внизу страницы нажмите кнопку Create my access token, чтобы сгенерировать Access token, Access token secret:

Youtube модульПолучение API Key для Youtube, полностью аналогично настройке Freebase модуля, только на 3-м этапе активируйте Youtube API.

Модули партнерских программ

Модули партнерских программ работают точно также как контент-модули, т. е. вы можете искать товары на странице редактирования поста и добавлять выбранные товары к посту.Но для партнерских программ очень важно держать выдачу товаров в актуальном состоянии, поэтому вы можете задать в настройках модуля параметр "Автоматическое обновление". Это время в секундах, через которое необходимо сделать повторный поиск товаров и обновить товарную выдачу на сайте.

Теперь для того, чтобы список товаров автоматически обновился через заданный промежуток времени, нам осталось указать, какое ключевое слово использовать для поиска. Это поле называется "Ключевое слово для автоматического обновления". Если поле не задано, товары автоматически обновляться не будут.

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

Affiliatewindow модуль

Получение API Key.

1. Если у вас еще нет аккаунта в партнерской сети Affiliatewindow, сначала создайте его: https://darwin.affiliatewindow.com/affiliate-signup/account-details.

2. Зайдите в ваш аккаунт Affiliatewindow, дальше следуйте: Advanced → ProductServe API и найдите ваш API Key в колонке слева.

Подсказка: Если раздела API не существует в вашем кабинете, возможно доступ к API еще не активирован для вашего аккаунта. Обратитесь в поддержку Affiliatewindow по поводу данного вопроса.

Admitad Coupons модуль

1. URL для получения XML-файла.Если у вас еще нет аккаунта в партнерской сети Admitad, сначала создайте его: https://www.admitad.com.

2. Зайдите в ваш аккаунт Admitad, дальше следуйте: Инструменты → Скидки и купоны → Экспорт → Получить ссылку и найдите ваш URL для получения XML-файла.

Подсказка: вы можете воспользоваться любыми фильтрами на странице получения купонов, соответствующие параметры будут автоматически внесены в URL для получения XML. Не забудьте установить флажок "Только мои программы", чтобы получать вознаграждение по партнерским программам.

Affilinet Coupons модуль

Получение Publisher Webservice Password.

1. Если у вас еще нет аккаунта в партнерской сети Affilinet, сначала создайте его: https://www.affili.net/uk/publishers/register

2. Зайдите в ваш аккаунт Affilinet, дальше следуйте: Solutions → Web Services → Access Data и найдите ваш Publisher Webservice Password.

Обратите внимание, может потребоваться до 24 часов, чтобы новый ключ заработал.

Affilinet Products модуль

Получение Products Webservice Password.1. Если у вас еще нет аккаунта в партнерской сети Affilinet, сначала создайте его:

https://www.affili.net/uk/publishers/register2. Зайдите в ваш аккаунт Affilinet, дальше следуйте: Solutions → Web Services →

Access Data и найдите вашProduct Webservice Password.

Обратите внимание, может потребоваться до 24 часов, чтобы новый ключ заработал.

Aliexpress модуль

Получение API Key.

1. Если у вас еще нет аккаунта в партнерской программе aliexpress создайте его: http://portals.aliexpress.com/

2. Войдите в аккаунт, далее следуйте Ad Center → Api Settings и нажмите кнопку Apply Now.

3. После аппрува (обычно в течении нескольких дней) на этой же странице вы найдете свой API Key для доступа к API.

Получение Traking ID. Вам понадобится указать Traking ID, если вы хотите посылать трафик через "родную" партнерскую программу aliexpress.

1. Войдите в свой аккаунт на http://portals.aliexpress.com/2. Следуйте Settings → Traking ID

Amazon модуль

Получение Traking ID.

1. Если у вас еще нет аккаунта в партнерской программе amazon создайте его: http://affiliate-program.amazon.com/join/

2. Войдите в аккаунт и найдите свой параметр Traking ID. Это ваш партнерский идентификатор.

Получение Access Key ID и Secret Access Key.

1. Войдите в консоль AWS (используйте ваши email и пароль от партнерской программы): https://console.aws.amazon.com/iam/home?#security_credential

2. В появившемся всплывающем окне выберите "Continue to Security Credentials"3. В разделе "Access Keys (Access Key ID and Secret Access Key)" создайте НОВЫЙ

Access Key. Запишите значение Secret Access Key.

CJ Links модуль

Получение Developer Key.1. Если у вас еще нет аккаунта в партнерской сети CJ, сначала создайте его:

http://www.cj.com/publisher-sign 2. Для получения ключа перейдите: https://api.cj.com/sign_up.cj

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

Получение Website ID.

1. Зайдите в ваш аккаунт CJ, дальше следуйте: Account → Wesites и найдите ID соответствующего сайта:

CJ Products модуль

Этот модуль настраивается аналогично CJ Links модуля.

Ebay модуль

Получение Application ID.

1. Зарегистрируйтесь на eBay developer сайте: http://developer.ebay.com/join/Это необходимо, чтобы получить ключ для eBay API.

2. Войдите в свой eBay developer аккаунт и сгенерируйте eBay application ID (Production Key): https://developer.ebay.com/devzone/account/Default.aspx

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

Получение Campaign ID.

Это связь с партнерской программой EPN (eBay Partner Network) — "родной" партнерки отeBay.

1. Если у вас еще нет аккаунта в партнерской программе EPN, сначала зарегестрируйте его: https://www.ebaypartnernetwork.com/PublisherReg?js=true

2. Campaign ID можно найти на вкладке Campaigns в вашей EPN аккаунте.

Получение Skimlinks SiteID.

Укажите этот параметр, если хотите слать трафик через партнерскую программу Skimlinks.

1. Если у вас еще нет аккаунта в партнерской программе Skimlinks, создайте его сейчас.

2. Перейдите в раздел Account и найдите Site ID для соответствующего домена.

Получение Viglink ID.

Укажите этот параметр, если хотите слать трафик через партнерскую программу Viglink.1. Если у вас еще нет аккаунта в партнерской программе Viglink, создайте его сейчас.2. Перейдите в раздел Manage → Account и найдите ваш API Key.

Envato модуль

Получение Token.

1. Если у вас еще нет аккаунта в Envato, сначала зарегестрируйте его: https://themeforest.net/sign_up_sso2. Перейдите по ссылке и создайте ваш Token для доступа к Envato API.

Не забудьте указать ваш Envato username, чтобы генерировать партнерские ссылки и получать комиссию за продажи.

Flipkart модуль

Получение Affiliate Tracking ID и Token.

3. Если у вас еще нет аккаунта в партнерской программе Flipkar, сначала зарегестрируйте его: https://affiliate.flipkart.com/registerme4. Перейдите в раздел API → TOKEN и найдите ваши Affiliate Tracking ID и Token. Этиперменные используются для доступ а к API и отслеживания кликов по партнерским ссылкам.

GdeSlon модуль

Получение API ключ.

1. Если у вас еще нет аккаунта в партнерской программе Где Слон, создайте его сейчас.

2. Войдите в свой аккаунт Где Слон, далее следуйте: Инструменты → XML API и найдите свой ключ для доступа к API.

Impactradius модуль

Получение Account SID и Auth Token.

1. Если у вас еще нет аккаунта в партнерской сети Impactradius, создайте его сейчас.2. Войдите в свой аккаунт Impactradius, далее следуйте Settings → API Access и

найдите ваши ключи Account SID и Auth Token.

Optimisemedia модуль

Получение API Key и Private Key.

1. Если у вас еще нет аккаунта в партнерской программе Optimise Network, создайте его сейчас: https://www.optimisemedia.com/sign-up/

2. Войдите в свой аккаунт Optimise Network, далее следуйте:My Details → Account Details → API Key и найдите свои ключи API Key и Private Key.

Получение Affiliate ID.

1. Сгенерируйте любую партнерскую ссылку в партнерской сети Optimisemedia. Найдите в ссылке парасетр AID= - это ваш Affiliate ID.

Linkshare модуль

Получение Web Services Token.

1. Если у вас еще нет аккаунта в партнерской программе Linkshare, создайте его сейчас: https://signup.linkshare.com/publishers/registration/landing?ls-locale=us&host=linkshare

2. Войдите в свой аккаунт Linkshare, далее следуйте: LINKS → Webservices и найдитесвой ключ Web Services Token.

Shareasale модуль

Получение Token и Secret Key.

1. Войдите в свой аккаунт Shareasale, далее следуйте: Tools → Affiliate API и задайте IP адрес вашего сервера, с которого будут производится запросы, сохраните измненения. Уточните IP адрес у вашего хостинг провадйера, он может отличатьсяот IP, на котором расположен ваш домен.

2. Найдите ваши Token и Secret Key.

Получение Affiliate ID.

1. Найдите ваш Affiliate ID в верхнем левом углу экрана, после логина в панель Shareasale.

Tradedoubler Coupons модуль

Получение Token.

1. Войдите в свой аккаунт Tradedoubler и добавьте свой сайт, если вы этого не сделали ранее.

2. Далее следуйте: Account → Manage tokens и найдите ваш Token c пометкой VOUCHERS.

Tradedoubler Products модуль

Получение Token.

1. Войдите в свой аккаунт Tradedoubler и добавьте свой сайт, если вы этого не сделали ранее.

2. Далее следуйте: Account → Manage tokens и найдите ваш Token c пометкой PRODUCTS.

Tradetracker Coupons модуль

Получение Customer ID и Passphrase.

1. Войдите в свой аккаунт Tradetracker, далее следуйте: Creatives → Web Services и найдите ваши Customer ID и Passphrase в колонке справа. Вам может потребоваться сначала запросить доступ, нажав ссылку «request access».

Получение Affiliate Site ID.

1. Войдите в свой аккаунт Tradetracker и добавьте свой сайт, если вы этого не сделали ранее.

2. Далее следуйте: Account → My Sites. ID (без #) напротив вашего веб-сайта и будет ваш Affiliate Site ID.

Tradetracker Products модуль

Настройка этого модуля производится аналогично Tradetracker Coupon модулю.

Udemy модуль

Получение Client Id и Client Secret .

1. Если у вас еще нет аккаунта в Udemy, создайте его сейчас: https://www.udemy.com 2. Перейдите на API Clients страницу, нажмите кнопку Request API Client и создайте

ваш API Client.3. Найдите ваши Client Id и Client Secret и задайте настройки в плагине.

Внимание: Если вы не видите поля Client Id и Client Secret, переключите в своем профилеязык интерфейса на English.

Если вы хотите получать комиссию за продажи, вам необходимо задать параметр Deeplink для генерации партнерских ссылок. Партнерская программа Udemy работает в сети Rakuten Linkshare.

Получение Deeplink:

1. Если у вас еще нет аккаунта в Linkshare, создайте его сейчас: https://signup.linkshare.com/publishers/registration/landing?ls-locale=us&host=linkshare

2. Зайдите в свой publisher аккаунт, далее следуйте Links → Deep Linking и сгенерируйте Deeplink, как показано на картинке:

Zanox модуль

Получение Connect ID.

1. Если у вас еще нет аккаунта в партнерской программе zanox создайте его сейчас: https://marketplace.zanox.com/publisher-signup

2. Идите на http://apps.zanox.com, нажмите кнопку Connect with zanox, убедитесь что вы вошли в свой аккаунт.

3. Перейдите на вкладку Developers → My own Applications, затем кликните на имени приложения.

4. Выберите вкладку zanox keys и найдите ваш Connect ID.

Работа с плагином

После настройки и активации модулей на странице редактирования поста вы можете искать и добавлять различный контент. После сохранения постав се данные Content Egg плагина будут также сохранены в Custom Filds - стандартное хранилище Wordpress для метаданных поста. Это означает, что при желании вы можете тесно интегрировать свою Wordpress тему с данными плагина.

По-умолчанию, данные Content Egg будут автоматически "присоединены" в начале или в конце поста при отображении его на блоге. Еще один вариант интегрировать данные любого модуля Content Egg в произвольное место поста — добавить в пост соотвествующий шорткод, например:

[content-egg module=Flickr]

С помощью параметров шорткода, можно управлять некоторыми параметрами отображением данных модуля. Покажем на примерах.

Этот шорткод с параметром next выведет первую картинку модуля Flickr:

[content-egg module=Flickr next=1]

Если еще раз добавить такой же шорткод, то будет выведена следующая по счету картинка:

[content-egg module=Flickr next=1]

Пример шорткода, который выведет 3 картинки начиная со второй (параметры limit и offset, нумерация начинается с нуля):

[content-egg module=Flickr limit=3 offset=2]

С помощью параметра template можно переопределить шаблон по-умолчанию для модуля:

[content-egg module=Flickr template=justified_gallery]

Автоматические обновления плагина

Если ваша подписка на обновления плагина активна, вы будете получать уведомления или автоматические апдейты Conten Egg через стандартные механизмы обновлений Wordpress. Вы можете обновить плагин прямо из админ-панели Wordpress или вручную скачав архив с плагином.

Пользовательские шаблоны

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

Возьмите за основу стандартный шаблон модуля, например:wp-content/plugins/content-egg/application/modules/Flickr/templates/data_simple.php

Располагайте свои пользовательские шаблоны модуля в одной из директорий:wp-content/content-egg-templates/ИмяМодуля

wp-content/themes/ваша_тема/content-egg-templates/ИмяМодуля

wp-content/ваша_дочерняя_тема/content-egg-templates/ИмяМодуля

Имена файлов шаблонов для модуля всегда должны начинаться с префикса data_, например:

data_simple.php

Код шаблоны должен начинаться с php-комментария, где задается имя шаблона, например:

/*

Name: Простой

*/

Убедитесь, что ваш редактор использует UTF-8 кодировку при редактировании файлов.

Локализация шаблонов

Языковые файлы для шаблонов Content Egg находятся отдельно от файлов локализации админ-интерфейса плагина. Файл перевода подключается в соответствии с установкой опции Content Egg → Настройки → Общие настройки → Язык сайта.

Кроме перевода надписей на кнопках, подзаголовков и других подобных вещей, в этих переводах указываются формат для отображения чисел (цены товара). Настройки отображения даты производятся в стандартных настройках Wordpress.

Собственный перевод на требуемый язык можно создать на основе pot файла: content-egg/languages/tpl/content-egg-tpl.pot, например, с помощью программы Poedit. Вы можете прислать нам готовые po и mo файлы перевода, мы добавим их в дистрибутив, таким образом, вы не потеряете изменения при обновлении плагина.

Для разработчиков

Шаблоны для модулей могут храниться в директории темы. Таким образом, вы можете создать тему с специальным набором шаблонов под Content Egg. И возможно, вы захотите отключить частично или полностью стандартные шаблоны Content Egg. Используйте для этого фильтр:

add_filter('content_egg_module_templates', 'my_filter_function');

Первым параметром функции вы получите массив со списком шаблонов, вторым — название модуля.

Аналогично вы можете отключить некоторые модули:

add_filter('content_egg_modules', 'my_filter_function');

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

Данные Content Egg хранятся в стандартных Произвольных полях Wordpress. В своей теме или плагине вы можете получить доступ к данным каждого модуля, используя функцию:

get_post_meta($post_id, 'c_cegg_data_'. $module_id, true);

Вы также можете перехватить событие сохранения данных каждого модуля в произвольные поля, используя специальных хук:

add_action('content_egg_save_data', 'my_function', 10, 1, 2);

Ваша функция-обработчик должна иметь два параметра, первый — название модуля, второй — данные модуля в массиве.