Integration of the Google Mobile Ads SDK: Difference between revisions

no edit summary
(Created page with "The purpose of this documentation is to explain the integration of the Google Mobile Ads SDK (GMA SDK) and the ad integration process of iq digital. It outlines the necessary...")
 
No edit summary
Line 115: Line 115:


iq digital uses certain key-value pairs, the most important of which are explained below:
iq digital uses certain key-value pairs, the most important of which are explained below:
;kw:Generelle Keyword Liste. Hier sind meist mehrere Werte mit Komma separiert. Üblich sind einige Legacy-Werte (z.B. digtransform,nospa,enozqi). Hinzu kommen Bezeichner für die App oder die Seite (z.B. Rheinischer_Kurier_app_ios_phone), sowie die Werbeplatzierungsbezeichnung (z.B. iqadtile3).
;kw:General keyword list: multiple values are generally separated by commas. Some legacy values are standard (e.g. digtransform, nospa, enozqi). There are also designators for the app or the page (e.g. Rheinischer_Kurier_app_ios_phone) as well as the ad position designation (e.g. iqadtile3).
;tile:Die Nummer der Werbeplatzierung. Im Falle eines iqadtile3 also als Wert 3.
;tile:The number of the ad position; in the case of an iqadtile3 therefore as value 3
;doc:Die Bezeichnung des Seitentyps. Gültige Werte sind homepage, index, artikel, bildgal
;doc:The designation of the page type; valid values are homepage, index, artikel, bildgal.
;iqadtype:Die Angabe der Plattform. Gültige Werte sind online, mew, app, amp
;iqadtype:Specification of the platform; valid values are online, mew, app, amp.
;appver:Die Bezeichnung der Appversions-Nummer (s.u.)
;appver:The designation of the app version number (see below).


Angaben welche Keywords für welche Platzierung verwendet werden sollen, finden sich in der creative_sizes_and_keywords.xlsc Tabelle, die von der iq digital zu Projektstart zur Verfügung gestellt wird.
You can find details of which keywords are used for which position in the creative_sizes_and_keywords.xlsc table provided by iq digital at the start of the project.


====Links zum CustomTargeting im Google Mobile Ads SDK====
====Links to CustomTargeting in the Google Mobile Ads SDK====
*https://developers.google.com/ad-manager/mobile-ads-sdk/ios/targeting#custom_targeting
*https://developers.google.com/ad-manager/mobile-ads-sdk/ios/targeting#custom_targeting
*https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting#custom_targeting
*https://developers.google.com/ad-manager/mobile-ads-sdk/android/targeting#custom_targeting


===Debugging===
===Debugging===
[[Datei:Easteregg dialog.png|300px|thumbnail|Beispiel aus einer Android App mit Textfeld für Keywords und Checkbox für USB Debugging]]
[[Datei:Easteregg dialog.png|300px|thumbnail|Example from an Android app with text field for keywords and checkbox for USB debugging]]
Es muss eine "Easter-Egg"-Funktion in die App eingebaut werden, damit die iq digital Probleme und neue Werbeformen innerhalb der Live App (Version aus dem App- bzw. Playstore) testen kann. Der Adserver DFP bietet die Möglichkeiten Testschaltungen über ein Keyword in der App auszuspielen.  
An "Easter-Egg" function must be integrated in the app so that iq digital can check for problems and test new ad formats within the live app (version from the app or play store). The ad server DFP provides the option of serving test insertions via a keyword in the app.
 
In a rarely frequented area of the app (such as the imprint), there should therefore be the option for “insiders” to call a small dialogue. This permits insiders to attach a self-selected keyword to every future ad request. The USB debug mode can be activated simultaneously or by ticking a checkbox to inspect the ad webviews in the Android app on Desktop Chrome.


In einem selten frequentierten Bereich der App, wie z.B. dem Impressum, sollte es daher die Möglichkeit für Eingeweihte geben, einen kleinen Dialog aufzurufen. Durch diesen kann man ein selbst gewähltes Keyword jedem zukünftigen Adrequest anhängen. Gleichzeitig oder durch das Aktivierung einer Checkbox kann der USB-Debug-Modus, um die Werbe Webviews in der Android App auf dem Desktop Chrome zu inspizieren, aktiviert werden.
<pre>
<pre>
WebView.setWebContentsDebuggingEnabled(true);
WebView.setWebContentsDebuggingEnabled(true);
</pre>
</pre>
Danach kann man unter Android die Webviews der App im Desktop Chrome mit chrome://inspect einsehen.  
The webviews of the app can then be viewed in Desktop Chrome under Android with chrome://inspect. This permits easier analysis of errors in the presentation of the ad.
Dies ermöglicht Fehler in der Werbedarstellung besser zu analysieren.


Ohne ein Debug Easter Egg in der App kann nach Livegang keine Testschaltung aufgesetzt werden und es können auch keine Probleme analysiert werden. Dies würde die Wartung der App von Seiten der iq digital verhindern und auch dem Mandanten keine Möglichkeit geben, selber seine App mit Testwerbung zu überprüfen.
Without a debug Easter Egg in the app, it is not possible to perform a test insertion after going live, and it is also not possible to analyse any occurring problems. This would prevent maintenance of the app by iq digital and also mean that the client would be unable to check his app himself with test advertising. The keyword function therefore serves to limit the group of people who would be able to see the test insertions.
Die Keyword-Funktion dient daher, den Personenkreis einzuschränken, der die Testschaltungen zu Gesicht bekäme.  


Das Anhängen der Keywords ist beim Punkt [[#Anhängen von Key-Value-Paaren]] genauer erklärt.
Attachment of the keywords is explained in more detail under #Attachment of key-value pairs.


Mehrfache Keywords werden durch Kommata separiert.
Multiple keywords are separated by commas.


Es gibt vielfältige Optionen, wie das Easter-Egg aktiviert werden kann. Mehrfache/unsinnige Taps auf UI-Elemente oder eine ganz spezielle Eingabe ins Suchfeld seien hier beispielhaft genannt. Die iq digital erlaubt sich aber die Vorgabe, dass unter Android und iOS das  Debug-Easter-Egg identisch aktiviert wird. Bei der Art der Aktivierung des Debug-Easter-Egg stehen wir gerne beratend zur Seite.
There are a wide range of options for activation of the Easter Egg. Multiple/Pointless taps on UI elements or highly specific input in the search field are just some examples. However, iq digital has defined a rule that the debug Easter Egg is activated identically under Android and iOS. We are happy to be of assistance with regard to the method via which the debug Easter Egg is activated.


===Wichtige Hinweise zu dieser Anleitung===
===Important notes on these instructions===
Die Adunits für die Werbeplatzierungen werden von uns erst zu Projektstart erstellt und mit Testwerbung belegt. Anschließend werden die Adunits an den Mandanten übermittelt.
We will only compile the ad units for the ad positions and trial-run test advertising on the ad units at the start of the project. The ad units will then be transmitted to the clients. Please do not use the logic that is integrated in the SDK for test ads. The logic does not correspond to the way in which the advertising marketed by iq digital works and will result in misunderstandings. Instead, bookings with test ads are permanently active on the ad units, and these test ads are served by the ad server via a special test keyword in the ad request.
Bitte nicht mit der im SDK fest eingebauten Logik für Test-Werbemittel arbeiten. Diese entspricht nicht der Art und Weise wie die von der iq digital vermarktete Werbung funktioniert und führt zu Missverständnissen.
Stattdessen sind auf den Adunits permanent Buchungen mit Test-Werbemitteln aktiv welche über ein spezielles Test-Keyword im Adrequest vom Adserver ausgeliefert werden.


===Ansprechpartner iq digital===
===Contacts at iq digital===
Die iq digital steht für Fragen und Kommentare gerne zur Verfügung. Sollten wir einmal nicht weiterhelfen können, ist es uns möglich einen Entwickler von Google als Ansprechpartner in die Diskussion mit einzubeziehen.
Please feel free to contact iq digital if you have any questions or comments. In the event that we are unable to help, we have the option of including a developer from Google in the discussion.


====Tim Lohmann (Mobile Developer Ad Technology)====
====Tim Lohmann (Mobile Developer Ad Technology)====
;Telefon:+49 211 887 2336
;Phone:+49 211 887 2336
;E-Mail:tim.lohmann@iqdigital.de
;E-Mail:tim.lohmann@iqdigital.de


===Wichtige Dokumente===
===WImportant documents===
====Liste der Creative Sizes und Keywords für jede  Platzierung:====
====List of creative sizes and keywords for each position:====
*<datum>_dfp_creative_sizes.xlsx
*<date>_dfp_creative_sizes.xlsx
====Liste der Adunits:====
====List of ad units:====
(diese dienen nur als Orientierungshilfe. Die Apps sollten diese Zonen dynamisch aus dem CMS generieren)
(These only serve as guidance. The apps should generate these zones dynamically from the CMS)
<appname> muss durch den entsprechenden App Namen ersetzt werden.
 
*<datum>_adunits_<appname>_android_tablet.txt
<appname> must be replaced by the corresponding app name.
*<datum>_adunits_<appname>_ios_tablet.txt
*<date>_adunits_<appname>_android_tablet.txt
*<datum>_adunits_<appname>_ android_phone.txt
*<date>_adunits_<appname>_ios_tablet.txt
*<datum>_adunits_<appname>_ios_phone.txt
*<date>_adunits_<appname>_ android_phone.txt
*<date>_adunits_<appname>_ios_phone.txt