Advertisement — различия между версиями

Материал из wiki.appsalutecreator.com
Перейти к: навигация, поиск
(→‎Параметры)
(не показана 21 промежуточная версия 5 участников)
Строка 1: Строка 1:
 
[[Object|Объект]] '''Advertisement''' позволяет отображать рекламу разных типов. Объект должен находиться на экране, на котором необходимо показать рекламу, либо на глобальном экране. Данный объект предназначен для соблюдения условий запуска рекламы. Огромный плюс, что большинство настроек, могут задавать удалённо маркетологи.
 
[[Object|Объект]] '''Advertisement''' позволяет отображать рекламу разных типов. Объект должен находиться на экране, на котором необходимо показать рекламу, либо на глобальном экране. Данный объект предназначен для соблюдения условий запуска рекламы. Огромный плюс, что большинство настроек, могут задавать удалённо маркетологи.
  
−
==Параметры для файла конфигурации==
 
  
 +
==Параметры==
  
−
*'''type''' - подтип рекламы: fullscreen=0, banner top=1, banner bottom=2, rewarded=3;
 
  
−
*'''startDays''' - количество дней, начиная с которого показывается реклама;
+
*'''синхронизация''' - не синхронизировать=0, синхронизировать=1;
  
−
*'''startSession''' - количество запусков, начиная с которого показывается реклама;
+
*'''сохранение параметров''' - нет=0, только объект=1, объект с подобъектами=2, только подобъекты=3;
  
−
*'''startGameplayTime''' - суммарное время геймплея, начиная с которого показывается реклама;
+
*'''placement''' - Идентификатор места показа рекламы в игре.
  
−
*'''showInterval''' - минимальный интервал (в секундах) между показами рекламы;
 
  
−
*'''showFirst''' - первый вызов показа рекламы, когда она покажется (в рамках одной сессии);
+
==Добавляемые параметры==
  
−
*'''showSkip''' - количество пропусков между показами рекламы (в рамках одной сессии);
 
  
−
*'''showMax''' - максимальное количество показов за сессию";
+
[[Файл:+.png]] '''реклама готова к показу: изменить состояние объекта'''
  
−
*'''events''' - количесто событий, достигая которого, реклама показывается принудительно;
+
*'''объект''' - Объект, состояние которого нужно изменить; '''!!! Объект должен находиться выше по дереву, чтобы успеть проинициализироваться до готовности рекламы !!!'''
  
 +
*'''состояние''' - Новое состояние объекта.
  
  
−
'''все параметры являются параметрами по-умолчанию, и при получении файла настроек рекламы, будут использоваться настройки рекламы из файла'''
+
[[Файл:+.png]] '''реклама готова к показу: изменить свойство объекта'''
  
 +
*'''объект''' - Объект, свойство которого нужно изменить; '''!!! Объект должен находиться выше по дереву, чтобы успеть проинициализироваться до готовности рекламы !!!'''
  
 +
*'''свойство''' - Свойство, которое нужно изменить.
  
−
Объект сам показывает рекламу если выполняются условия(текущее значение больше либо равно заданному). Условия '''дни''', '''запуски''', '''время сессии''', '''часы''' проверяются через логическое "и", то есть все 4 должны выполняться одновременно. '''события''' и временные условия проверяются через логическое "или". То есть банер покажется когда или выполняются временные условия, или когда количество событий совпадает с заданным значением или больше. После показа банера при совпадении количества событий - счётчик событий сбрасывается.
+
*'''значение''' - Новое значение свойства.
  
−
Показ рекламы можно включать и отключать через параметр ''ad'' в объекте типа [[Options]]
 
  
−
==Состояния==
+
[[Файл:+.png]] '''реклама успешно показана: изменить состояние объекта'''
  
−
*'''show''' - показать рекламу
+
*'''объект''' - Объект, состояние которого нужно изменить;
  
−
*'''hide''' - спрятать рекламу
+
*'''состояние''' - Новое состояние объекта.
  
−
*'''event''' - увеличить счётчик событий на 1
+
[[Файл:+.png]] '''нужен запрос gdpr''' [https://ru.wikipedia.org/wiki/%D0%9E%D0%B1%D1%89%D0%B8%D0%B9_%D1%80%D0%B5%D0%B3%D0%BB%D0%B0%D0%BC%D0%B5%D0%BD%D1%82_%D0%BF%D0%BE_%D0%B7%D0%B0%D1%89%D0%B8%D1%82%D0%B5_%D0%B4%D0%B0%D0%BD%D0%BD%D1%8B%D1%85]
  
−
Есть возможность использовать внешний конфигурационный файл. Для этого необходимо в [[app.icf]] указать:
+
*'''объект''' - Объект, состояние которого нужно изменить;
−
<pre>
 
−
[Advertisement]
 
−
ConfigUrl="http://url_to_file"
 
−
</pre>
 
  
−
=Настройки=
+
*'''состояние''' - Новое состояние объекта.
  
−
==Google Mobile Ads (admob)==
+
Этот параметр позволит нам использовать персональные данные игроков при выдаче рекламы.
−
при добавлении в качестве провайдера в advertisiment необходимо указать рекламный id в добавляемое поле "имя"
 
  
−
Настройки для манифестов:
+
'''Внимание''': для триггера команды '''"нужен запрос gdpr"''' нужно, чтобы выли выполнены следующие условия:
  
−
<pre>
+
* Приехал рекламный конфиг из Европы (в логе "type":"Europe");
−
<meta-data android:name="com.google.android.gms.version" android:value="@integer/google_play_services_version" />
 
−
<!-- Activity required to show ad overlays. -->
 
−
<activity android:name="com.google.android.gms.ads.AdActivity" android:theme="@android:style/Theme.Translucent" android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize"/>
 
−
<activity android:name="com.facebook.ads.InterstitialAdActivity" android:configChanges="keyboardHidden|orientation|screenSize" />
 
−
<activity android:name="com.flurry.android.FlurryFullscreenTakeoverActivity" android:configChanges="keyboard|keyboardHidden|orientation|screenLayout|uiMode|screenSize|smallestScreenSize" />
 
−
<activity android:name="com.jirbo.adcolony.AdColonyOverlay" android:configChanges="keyboardHidden|orientation|screenSize" android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
 
−
<activity android:name="com.jirbo.adcolony.AdColonyFullscreen" android:configChanges="keyboardHidden|orientation|screenSize" android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" />
 
−
<activity android:name="com.jirbo.adcolony.AdColonyBrowser" android:configChanges="keyboardHidden|orientation|screenSize" android:theme="@android:style/Theme.Black.NoTitleBar.Fullscreen" />
 
−
</pre>
 
  
 +
* нет информации о согласии игрока (в таком случае в опциях не будет значения gdpr) или мы вручную сбросили его согласие в игре (установив значение ниже -10).
  
−
<pre>
+
Так как рекламный конфиг у нас приезжает неизвестно когда, мы не должны открывать окно через этот параметр. Вместо этого мы делаем небольшую машину, которая будет ставить флажок, сигнализируюющий о необходимости запросить у игрока его согласие на обработку персональных данных. А уже в самой логике игры мы можем вызывать окно на согласие о сборе персональной информации тогда, когда нам нужно, опираясь на этот флаг.
−
<!-- Used to request banner and interstitial ads. -->
 
−
<uses-permission android:name="android.permission.INTERNET"/>
 
−
<!-- Used to avoid sending an ad request if there is no connectivity. -->
 
−
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
 
−
<uses-permission android:name="com.google.android.providers.gsf.permission.READ_GSERVICES" />
 
−
<uses-permission android:name="com.google.android.providers.gsf.permission.WRITE_GSERVICES" />
 
−
<uses-permission android:name="android.permission.VIBRATE" />
 
−
</pre>
 
  
−
настройки app.icf:
+
==Состояния==
  
−
<pre>
+
*'''show''' - показать рекламу.
−
[s3eAbsGoogleMobileAds]
 
−
TestDevice0="device id" - id устройства. Можно получить с помощью приложения
 
−
(https://play.google.com/store/apps/details?id=pe.go_com.admobdeviceidfinder )
 
  
−
VideoUnitID="unit id" - ключ из админки
+
*'''startCache''' - запустить предварительное кеширование (для проектов с отложенным кешированием)
−
</pre>
 
  
−
==Playhaven==
+
*'''gdpr''' - при вызове этого состояния обьект '''advertisement''' запишет в параметр в опциях '''gdpr''' значение из '''param''' , которое мы передаем в сам обьект advertisement. Для стран, где действует GDPR, таргетированная реклама показывается, если мы установили значение параметра в 1, и нетаргетированная, если это значение установлено в 0.
  
−
[[Playhaven]]
+
Это состояние мы не вызываем без ведома игрока! Оно должно вызываться, когда игрок принимает или отклоняет запрос о сборе персональных данных. Этот запрос мы представляем ему в виде окна с двумя кнопками и без возможности его закрыть. Также после принятия или отказа от сбора, игрок может изменить свое решение, например, через checkbox в настройках игры.
  
−
==Chartboost==
+
==Коды ошибок==
  
−
[[Chartboost]]
+
*'''0''' - ''AD_ERROR_NONE          = 0'' - все хорошо, ошибок нет;
 +
*'''1''' - ''AD_ERROR_SKIP          = 1'' - показывать нечего (нет ни одного активного провайдера рекламы, нужно спрятать кнопки показа, пользовательские окна при этой ошибке показывать не нужно!!!);
 +
*'''2''' - ''AD_ERROR_INTERNET      = 2'' - ошибка отсутствия интернета;
 +
*'''3''' - ''AD_ERROR_NOT_FOUND      = 3'' - запрос на показ рекламы был отправлен, но реклама по данному запросу отсутствует;
 +
*'''4''' - ''AD_ERROR_CANCELED      = 4'' - показ рекламы был отменен пользователем.
 +
*'''5''' - ''AD_ERROR_UNKNOWN      = 5'' - неизвестная ошибка.
  
−
==Flurry==
+
Для обработки ошибок использовать [[Errormanager|ErrorManager]].
  
−
[[Flurry]]
+
==Симулятор==
  
−
==Amazon==
+
Для работы симулятора рекламы на редакторном вьювере необходимо добавить в app.icf параметры:
  
−
Для работы рекламы от Amazon должен быть указан соответствующий тип рекламы, а также указаны следующие настройки в [[app.icf]]:
+
  [Game]
 +
  bundle="%id_game"
 +
  [Game]
 +
  VersionMain=%m
 +
  VersionGraphic=%g
 +
  VersionLogic=%l
  
−
<pre>
+
где:
 +
%id_game - бандл игры, соответствующий файлу конфигурации рекламы,
 +
%m, %g, %l - номер версии игры, соответствующий файлу конфигурации рекламы.
  
−
[s3eAmazonAds]
+
При вызове состояния ''show'' объекту на экране появится черный прямоугольник с названием placement'а вызванной рекламы. Esc симулирует закрытие рекламы и вызов ''ошибки 4'' (показ рекламы отменен пользователем). Enter симулирует закрытие рекламы и вызов обработчика ''реклама успешно показана''.
−
app_key="sample-app-v1_pub-2"
 
−
logging=1
 
−
testing=1
 
  
−
</pre>
 
  
−
'''app_key''' - ключ для рекламы
+
[[Category:Options]]
 +
[[Category:Реклама]]
  
−
'''logging''' - вести логи показа, полезно для отладки
+
==GDPR==
  
−
'''testing''' - режим тестирования
+
Некоторые провайдеры требуют согласия на сбор и обработку персональных данных в европейских странах. Для корректной работы необходимо в app.icf добавить параметр:
  
−
По умолчанию logging и testing равны 1, поэтому при релизе значение обоих параметров необходимо принудительно устанавливать в 0.
+
  [Parameters]
 +
  gdpr=-1
  
−
В итоговый ''AndroidManifest.xml'' должны быть добавлены следующие строки:
+
Если этот параметр есть в app.icf, то мы даем игре знать, что хотим собирать персональные данные игрока. Тогда будет работать добавляемый параметр '''нужен запрос gdpr'''.
  
−
<pre>
+
Значения, которые может принимать параметр: -1 - не известно, 0 - не согласен, 1 - согласен (Провайдер AppLovin воспринимает 0/1, Chartboost -1/0/1, AdMob - 0/1).
 +
Значение по-умолчанию, с которым собирать проект -1.
  
−
<activity android:name="com.amazon.device.ads.MraidBrowser" android:configChanges="keyboardHidden|orientation"/>
+
==Подробное описание работы обьекта==
−
<activity android:name="com.amazon.device.ads.VideoActionHandler" android:configChanges="keyboardHidden|orientation|screenSize"/>
 
  
−
</pre>
+
Продолжение здесь: http://jira1:8090/pages/viewpage.action?pageId=23822337
−
 
 
−
('''с вьювера версии от 10.07.2014 должны быть следующие строки''':
 
−
 
 
−
<pre>
 
−
<activity android:name="com.amazon.device.ads.AdActivity" android:configChanges="keyboardHidden|orientation|screenSize"/>
 
−
</pre>
 
−
 
 
−
)
 
−
 
 
−
Также должны быть следующие разрешения:
 
−
 
 
−
<pre>
 
−
 
 
−
<uses-permission android:name="android.permission.INTERNET" />
 
−
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
 
−
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
 
−
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
 
−
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
 
−
 
 
−
</pre>
 
−
 
 
−
более подробно про рекламу от amazon: https://developer.amazon.com/sdk/mobileads/quick-start.html
 
−
 
 
−
=  Коды ошибок  =
 
−
 
 
−
Запись в логе:
 
−
I/GAdvertisement onAdFailed() onAdFailed() placement = more_games from chartboost with error code 3
 
−
 
 
−
Коды:
 
−
    0 -  ERROR_NONE = 0,    //!< все хорошо, ошибок нет
 
−
    1 -  ERROR_SKIP,    //!< показывать было нечего(нет ни одного активного провайдера рекламы)
 
−
    2 -  ERROR_INTERNET,    //!< ошибка отсутсвия интернета
 
−
    3 -  ERROR_AD_NOT_FOUND,      //!< запрос на рекламу был отправлен, но реклама по данному запросу отсутсвует
 
−
    4 -  ERROR_AD_CANCELED,      //!< реклама было отменена пользователем
 
−
    5 -  ERROR_OTHER              //!<другие ошибки для которых пока нет классификации
 
−
 
 
−
 
 
−
=Дополнительные сведения=
 
−
 
 
−
* ''AndroidManifest.xml'' находится обычно в каталоге ''%s3e_dir%\deploy\plugins\android''
 
−
 
 
−
* Также можно вместо ''AndroidManifest.xml'' вносить соответствующие настройки  в ''android-extra-application-manifest.xml'' и ''android-extra-manifest.xml'', которые находятся в каталоге
 
−
''%каталог_редактора%\system\marmalade\conf\%марект%(к примеру android)''
 
−
 
 
−
* Объект при загрузке экрана не переводится автоматически в состояние show, в это состояние его надо переводить машиной или другим объектом.
 
−
 
 
−
* Если выбран режим банера '''fullscreen''', то при показе банера все действия в приложении "ставятся на паузу", возврат в игру возможен только при закрытии банера, если выбран другой режим отображения - приложение во время показа "на паузу" не ставится, то есть все действия продолжают выполняться.
 
−
 
 
−
* <span style="background-color:yellow">Для работы Chartboost на ios необходима версия ос не ниже 6-й</span>
 
−
 
 
−
[[Category:Options]]
 
−
[[Category:Реклама]]
 

Версия 11:31, 29 мая 2019

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


Параметры

  • синхронизация - не синхронизировать=0, синхронизировать=1;
  • сохранение параметров - нет=0, только объект=1, объект с подобъектами=2, только подобъекты=3;
  • placement - Идентификатор места показа рекламы в игре.


Добавляемые параметры

+.png реклама готова к показу: изменить состояние объекта

  • объект - Объект, состояние которого нужно изменить; !!! Объект должен находиться выше по дереву, чтобы успеть проинициализироваться до готовности рекламы !!!
  • состояние - Новое состояние объекта.


+.png реклама готова к показу: изменить свойство объекта

  • объект - Объект, свойство которого нужно изменить; !!! Объект должен находиться выше по дереву, чтобы успеть проинициализироваться до готовности рекламы !!!
  • свойство - Свойство, которое нужно изменить.
  • значение - Новое значение свойства.


+.png реклама успешно показана: изменить состояние объекта

  • объект - Объект, состояние которого нужно изменить;
  • состояние - Новое состояние объекта.

+.png нужен запрос gdpr [1]

  • объект - Объект, состояние которого нужно изменить;
  • состояние - Новое состояние объекта.

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

Внимание: для триггера команды "нужен запрос gdpr" нужно, чтобы выли выполнены следующие условия:

  • Приехал рекламный конфиг из Европы (в логе "type":"Europe");
  • нет информации о согласии игрока (в таком случае в опциях не будет значения gdpr) или мы вручную сбросили его согласие в игре (установив значение ниже -10).

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

Состояния

  • show - показать рекламу.
  • startCache - запустить предварительное кеширование (для проектов с отложенным кешированием)
  • gdpr - при вызове этого состояния обьект advertisement запишет в параметр в опциях gdpr значение из param , которое мы передаем в сам обьект advertisement. Для стран, где действует GDPR, таргетированная реклама показывается, если мы установили значение параметра в 1, и нетаргетированная, если это значение установлено в 0.

Это состояние мы не вызываем без ведома игрока! Оно должно вызываться, когда игрок принимает или отклоняет запрос о сборе персональных данных. Этот запрос мы представляем ему в виде окна с двумя кнопками и без возможности его закрыть. Также после принятия или отказа от сбора, игрок может изменить свое решение, например, через checkbox в настройках игры.

Коды ошибок

  • 0 - AD_ERROR_NONE = 0 - все хорошо, ошибок нет;
  • 1 - AD_ERROR_SKIP = 1 - показывать нечего (нет ни одного активного провайдера рекламы, нужно спрятать кнопки показа, пользовательские окна при этой ошибке показывать не нужно!!!);
  • 2 - AD_ERROR_INTERNET = 2 - ошибка отсутствия интернета;
  • 3 - AD_ERROR_NOT_FOUND = 3 - запрос на показ рекламы был отправлен, но реклама по данному запросу отсутствует;
  • 4 - AD_ERROR_CANCELED = 4 - показ рекламы был отменен пользователем.
  • 5 - AD_ERROR_UNKNOWN = 5 - неизвестная ошибка.

Для обработки ошибок использовать ErrorManager.

Симулятор

Для работы симулятора рекламы на редакторном вьювере необходимо добавить в app.icf параметры: 

 [Game]
 bundle="%id_game"
 [Game]
 VersionMain=%m
 VersionGraphic=%g
 VersionLogic=%l

где: %id_game - бандл игры, соответствующий файлу конфигурации рекламы, %m, %g, %l - номер версии игры, соответствующий файлу конфигурации рекламы.

При вызове состояния show объекту на экране появится черный прямоугольник с названием placement'а вызванной рекламы. Esc симулирует закрытие рекламы и вызов ошибки 4 (показ рекламы отменен пользователем). Enter симулирует закрытие рекламы и вызов обработчика реклама успешно показана.

GDPR

Некоторые провайдеры требуют согласия на сбор и обработку персональных данных в европейских странах. Для корректной работы необходимо в app.icf добавить параметр: 

 [Parameters]
 gdpr=-1

Если этот параметр есть в app.icf, то мы даем игре знать, что хотим собирать персональные данные игрока. Тогда будет работать добавляемый параметр нужен запрос gdpr.

Значения, которые может принимать параметр: -1 - не известно, 0 - не согласен, 1 - согласен (Провайдер AppLovin воспринимает 0/1, Chartboost -1/0/1, AdMob - 0/1). Значение по-умолчанию, с которым собирать проект -1.

Подробное описание работы обьекта

Продолжение здесь: http://jira1:8090/pages/viewpage.action?pageId=23822337

Источник — «https://wiki.appsalutecreator.com/index.php?title=Advertisement&oldid=9809»