Начало работы с Vungle (SDK v.1.0 - v.4.1) — Unity

Это руководство поможет вам быстро интегрировать подключаемый модуль Unity для Vungle в обычное приложение. Приведенный здесь исходный код доступен в нашем публичном репозитории на GitHub.

Содержание

  1. Перед началом работы
  2. Устанавливаем подключаемый модуль Unity для Vungle
  3. Добавляем код!
  4. Запускаем пример приложения Vungle
  5. Как экспортировать проект Xcode в Windows

Перед началом работы...

    1. Для подключаемого модуля Unity для Vungle требуется Java 1.7 для Android; доступна поддержка iOS 7+.
    2. Подключаемый модуль Unity для Vungle:
      - Для iOS SDK доступна поддержка Unity 4, Unity 5.3.2 или более поздних версий (для iOS SDK 4.0.6 или более поздних версий требуется Unity 5.4.1 или выше).
      - Для Android SDK доступна поддержка Unity 4, Unity 5.3.2 или более поздних версий.
      - Для Windows SDK (Universal 8.1 или Phone 8.1) доступна поддержка Unity 4, Unity 5.3.2 или более поздних версий.
      - Для Windows SDK (Windows 10 UWP) доступна поддержка Unity 5.3.2 или более поздних версий.

    3. Если вы используете Windows, установите Windows SDK, прежде чем выполнять остальные инструкции по установке подключаемого модуля Unity для Vungle. Разработка Windows может выполняться только на ПК с ОС Windows. Убедитесь, что для версии платформы, которая используется в разработке, установлен Windows SDK:

      - Скачать Windows SDK 8.1 - https://developer.microsoft.com/en-us/windows/downloads/windows-8-1- sdk

      - Скачать Windows SDK 10 - https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk

    4. Реклама Vungle в Windows N и KN: Пользователям специальных версий Windows N или KN для работы рекламы Vungle необходимо установить Пакет с мультимедийными функциями для Windows 10 N и Windows 10 KN.

    5. Для интеграции требуется учетная запись Vungle. Если у вас ее нет, создайте ее.

    6. Если вы еще этого не сделали, перейдите на нашу панель управления и добавьте ваше приложение в свою учетную запись. Это необходимо сделать, чтобы получить идентификатор приложения для добавления в приложение с помощью нашего SDK. Например, на изображении ниже идентификатор приложения обведен красным, и расположен на странице вашего приложения.

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

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

Устанавливаем подключаемый модуль Unity для Vungle

Открыв Unity и свой проект, дважды щелкните на загруженном файле VunglePlugin.unitypackage, чтобы добавить подключаемый модуль Unity для Vungle в свое приложение.

Нажмите Все, чтобы выбрать все элементы перед импортом.

Убедитесь, что указали правильную платформу в параметрах сборки.

Во избежание ошибок компиляции на следующем шаге убедитесь, что ваш проект Build Settings (cmd + Shift + B) предназначен для платформы iOS, Android или Windows.

Для Windows

При использовании Unity 5 для Windows в SDK будет отдельный файл VungleSDK.winmd для каждой из платформ Windows. Эти файлы расположены в каталогах, названных именем соответствующей платформы. Ориентируясь по приведенному ниже рисунку, задайте следующие параметры:

На вкладке Проект выберите нужный Vungle SDK. Убедитесь, что параметры на вкладке Inspector в разделах Выберите платформы для подключаемого модуля и Параметры платформы выставлены верно.

  • Для Assets/Plugins/metro/VungleSDKProxy.winmd:
    Платформа: WSAPlayer
    SDK: Любой SDK
    Заполнитель: Assets/Plugins/VungleSDKProxy.dll:

  • Для Assets/Plugins/metro/VungleSDK.winmd:
    Платформа: WSAPlayer
    SDK: SDK81

  • Для Assets/Plugins/metro/UWP/VungleSDK.winmd:
    Платформа: WSAPlayer
    SDK: UWP

  • Для Assets/Plugins/metro/WindowsPhone81/VungleSDK.winmd:
    Платформа: WSAPlayer
    SDK: Phone SDK81

Важно! При использовании Unity версии 5.3.1 или выше в проекте под Universal 8.1 или Phone 8.1 следует отключить использование Assets/Plugins/metro/UWP/VungleSDK.winmd одним из следующих двух способов.

  • Способ 1: выберите Assets/Plugins/metro/UWP/VungleSDK.winmd и на вкладке Inspector в разделе Выберите платформы для подключаемого модуля снимите флажок с варианта WSAPlayer
  • Способ 2: удалите Assets/Plugins/metro/UWP/VungleSDK.winmd

При использовании Unity 4 перейдите в раздел Настройки проигрывателя --> Параметры публикации и измените следующие настройки:

  • Необрабатываемые подключаемые модули: Размер — 1
  • Элемент 0: VungleSDKProxy.dll

После публикации проекта Windows в Unity убедитесь, что у вашего проекта есть возможность internetClient в среде Unity. Откройте параметры сборки (shift + ctrl + b) --> выберите Магазин Windows в разделе Платформа --> нажмите Настройки проигрывателя. В разделе Параметры публикации, в меню Возможности, выберите вариант InternetClient, как показано на рисунке.

Добавляем код!

В этом руководстве рассматривается инициализация всего связанного с Vungle кода в сценарии, прикрепленном к главному игровому объекту, но вы можете вызвать подключаемый модуль Unity для Vungle из любых сценариев, которые посчитаете нужными. Лучше всего инициализировать подключаемый модуль Unity для Vungle как можно скорее, чтобы гарантировать, что включенные SDK Vungle завершили настройку вовремя, чтобы представить рекламу пользователю при вызове playAd.

Инициализация

Инициализацию требуется вызвать только один раз и использовать для подготовки подключаемого модуля Unity для Vungle к представлению рекламы пользователю *Попробуйте инициализировать Vungle SDK в вашем приложении как можно раньше, так как SDK требуется 30-45 секунд для инициализации и кэширования рекламы для воспроизведения*:

//Your App IDs and Placement IDs, they can be found in the Vungle Dashboard on your apps' pages
Vungle.init ("Test_Android", "Test_iOS", "vungleTest");

После инициализации пакет Vungle SDK автоматически запрашивает рекламное объявление для размещения, которое имеет статус Автокэширование на панели управления Vungle. Рекомендуем выбирать для автоматического кэширования самое часто просматриваемое размещение.

Воспроизведение рекламы

Воспроизвести рекламу можно с помощью следующего метода:

Vungle.playAd();

 

Параметры настройки

Метод playAd может также принимать словарь параметров, позволяющий настроить показ рекламы.

public static void playAd(Dictionary<string,object> options);

В словаре параметров могут содержаться следующие ключи:

Ключ Описание
orientation

Задает ориентацию рекламы.

  • Для iOS используйте VungleAdOrientation:
public enum VungleAdOrientation
{
Portrait = 1,
LandscapeLeft = 2,
LandscapeRight = 3,
PortraitUpsideDown = 4,
Landscape = 5,
All = 6,
AllButUpsideDown = 7
}
  • В Android установите значение true для параметра matchVideo и false для параметра autoRotate.
  • В Windows установите значение true для параметра autoRotate и false для параметра landscape. (Значение по умолчанию — autoRotate.)
userTag Пользователь ключа — передается в качестве пользователя в вызове S2S (при его наличии).
alertTitle Заголовок предупреждения, которое появляется при преждевременном закрытии стимулированной рекламы пользователем.
alertText Текст предупреждения, которое появляется при преждевременном закрытии стимулированной рекламы пользователем.
closeText Надпись на кнопке, закрывающей окно предупреждения, которое появляется при преждевременном закрытии стимулированной рекламы пользователем.
continueText Надпись на кнопке, закрывающей окно предупреждения, которое появляется при преждевременном закрытии стимулированной рекламы пользователем.
immersive Режим комфортного просмотра.

Функции OnPause и OnResume

Добавив код к функциям onPause и onResume, можно возобновлять показ рекламы, приостановленной при переходе приложения в фоновый режим.

void OnApplicationPause(bool pauseStatus) { if (pauseStatus) { Vungle.onPause(); } else { Vungle.onResume(); } }

Обработка событий

Вы можете настроить обработчики событий для всех 5 событий Vungle SDK, связанных с показом рекламы.

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

public static event Action<string> onAdStartedEvent;

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

public static event Action<string, AdFinishedEventArgs> onAdFinishedEvent;

Класс AdFinishedEventArgs состоит из следующих свойств, которые позволяют просмотреть результат воспроизведения рекламы:

public class AdFinishedEventArgs : EventArgs { //Represents a BOOL whether or not the user clicked the download button. public bool WasCallToActionClicked{ get; set;} //Represents a bool whether or not the video can be considered a completed view. public bool IsCompletedView{ get; set;} //The time in seconds that the user watched the video. public double TimeWatched{ get; set;} }


● Когда SDK изменяет статус доступности рекламы, запускается следующее событие. Логическое значение isAdPlayable обозначает новую возможность воспроизведения для конкретного идентификатора размещения.

public static event Action<string, bool> adPlayableEvent;



● После успешной инициализации SDK запускается следующее событие.

public static event Action onInitializeEvent;



● После создания журнала SDK запускается следующее событие.

public static event Action<string> onLogEvent;

Вот и все! Для получения дополнительной информации о подключаемых модулях Unity для Vungle изучите наши другие статьи о подключаемых модулях или просмотрите исходный код для нашего примера приложения Unity.

Примечание о тестировании приложения в режиме тестирования. В режиме тестирования скачивать рекламируемые приложения нельзя. Кроме того, на панели управления невозможно будет просмотреть количество показов. Это связано с тем, что тестовая реклама предназначена только для проверки правильности интеграции SDK. Эти функциональные возможности станут доступны после запуска приложения в активном режиме.

Запускаем пример приложения Vungle

Чтобы запустить пример приложения, скачайте пример приложения Unity. Создайте новый проект в Unity. Открыв Unity и свой проект, дважды щелкните на загруженном файле VunglePlugin.unitypackage, чтобы добавить подключаемый модуль Unity для Vungle в свое приложение.

Нажмите Все, чтобы выбрать все элементы перед импортом.

В окне проекта перейдите к папке Assets , проверьте, есть ли в этой папке все файлы скачанного проекта, выделенные красным цветом. Если все эти файлы не находятся в папке Assets в Unity, переместите их вручную, щелкнув правой кнопкой мыши по папке Assets в Unity и выбрав «открыть в Finder». В открывшемся окне Finder скопируйте и вставьте все файлы из скачанной папки ресурсов примера приложения в папку Assets в Unity и при необходимости замените файлы.

Screen_Shot_2017-06-27_at_5.43.12_PM.png

В Unity, навигатор проектов->Assets двойной щелчок на MainTitleScreen:

Screen_Shot_2017-06-27_at_6.01.39_PM.png

Нажмите GameObject, выберите TitleGUI внутри Inspector->Title GUI (сценарий):

Screen_Shot_2017-06-27_at_6.02.57_PM.png

Нажмите Command+Shift+B, чтобы открыть параметры сборки. Выберите iOS или Android, затем нажмите «Сменить платформу».

Screen_Shot_2017-06-27_at_6.14.34_PM.png

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

Screen_Shot_2017-06-27_at_6.16.56_PM.png

Теперь вернитесь к параметрам сборки и нажмите «Сборка», чтобы создать файл apk для Android или проект Xcode.

 

Как экспортировать проект Xcode в Windows

Для экспорта проекта Xcode из Unity на компьютер с Windows на компьютере должен быть установлен язык программирования Python. Вне зависимости от того, устанавливаете ли вы Python для этой цели или по причине возникновения ошибки при экспорте, найти последнюю версию Python можно на этой странице: https://www.python.org/.

 

Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 2 из 7
Еще есть вопросы? Отправить запрос

Комментарии