Dokumentation

Adcontroller: Unterschied zwischen den Versionen

← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(18 dazwischenliegende Versionen von 4 Benutzern werden nicht angezeigt)
Zeile 11: Zeile 11:
Wenn lediglich redaktionelle Elemente derselben Seite asynchron nachladen werden (z.B. Bildergalerien ohne Page-Refresh), bietet der AdController zu diesem Zweck eine Callback-Funktion zum Nachladen der Anzeigenpositionen an. Hier können die Schritte aus Abschnitt [[#Single_Page_Applikation_(Kein_Pageload)| Single Page Applikation (Kein Pageload)]] ignoriert werden. Der Publisher verantwortet die Event-Bindung zum Triggern des Callback nach gemeinsamer Absprache mit iq digital ([[#Callback-Funktion_zum_Nachladen_der_Anzeigenpositionen| siehe Abschnitt Callback-Funktion zum Nachladen der Anzeigenpositionen]]).
Wenn lediglich redaktionelle Elemente derselben Seite asynchron nachladen werden (z.B. Bildergalerien ohne Page-Refresh), bietet der AdController zu diesem Zweck eine Callback-Funktion zum Nachladen der Anzeigenpositionen an. Hier können die Schritte aus Abschnitt [[#Single_Page_Applikation_(Kein_Pageload)| Single Page Applikation (Kein Pageload)]] ignoriert werden. Der Publisher verantwortet die Event-Bindung zum Triggern des Callback nach gemeinsamer Absprache mit iq digital ([[#Callback-Funktion_zum_Nachladen_der_Anzeigenpositionen| siehe Abschnitt Callback-Funktion zum Nachladen der Anzeigenpositionen]]).


<div class="page-break"></div>
===Hosting & Einbindung AdController===
===Hosting & Einbindung AdController===


Es bestehen zwei Möglichkeiten für das Hosting/Einbindung des AdController Script-Deployments auf Ihren Seiten:
Es bestehen zwei Möglichkeiten für das Hosting/Einbindung des AdController Script-Deployments auf Ihren Seiten:


*Abruf des AC-Script-Deployments vom Web-Server des Seitenbetreibers (empfohlen)
**Für das Hosting und den unmittelbaren Abruf des AC-Deployment vom iq-CDN wird eine direkte Implementierung des Adcontrollers über den Webserver des Seitenbetreibers empfohlen. Voraussetzung ist eine weiterhin flexible Anbindung des AC- Deployment als PRELIVE- und SANDBOX-Version (siehe "Auslieferungsmodus") durch den iq-Entwickler mittels iqdeployment-Parameter. Es gibt hierzu bereits unterschiedliche Umsetzungen im Einsatz, die wir gerne gemeinsam mit Ihnen abstimmen.
*Abruf des AC-Script-Deployments von einem externen Web-Host der iq digital (AWS-CDN)
*Abruf des AC-Script-Deployments von einem externen Web-Host der iq digital (AWS-CDN)
**Hosting und Abruf des AC-Deployment vom iq-CDN
**Sollte die zuvor genannte Variante aus technisch-organisatorischen Gründen nicht möglich sein, bitte Kontakt mit uns aufnehmen. In Absprache kann in Ausnahmefällen hiervon abgewichen werden. Hosting und Abruf des AC-Deployment vom iq-CDN  
*Abruf des AC-Script-Deployments vom Web-Server des Seitenbetreibers (empfohlen)
**Alternativ zum Hosting und unmittelbaren Abruf des AC-Deployment vom iq-CDN wird eine direkte Implementierung des Adcontrollers über den Webserver des Seitenbetreibers empfohlen. Voraussetzung ist eine weiterhin flexible Anbindung des AC- Deployment als PRELIVE- und SANDBOX-Version (siehe "Auslieferungsmodus") durch den iq-Entwickler mittels iqdeployment-Parameter. Es gibt hierzu bereits unterschiedliche Umsetzungen im Einsatz, die wir gerne gemeinsam mit Ihnen abstimmen.


===Caching AdController===
===Caching AdController===
Zeile 45: Zeile 46:


     var iqd_mode = (function () {
     var iqd_mode = (function () {
        var dm = window.location.href.toLowerCase();
      let mode = 'live';
        return (dm.indexOf('iqdeployment=') > 1) ? dm.split('iqdeployment=')[1].split('&')[0] : 'live';
      const currentUrlSearchParams = new URLSearchParams(window.location.search);
 
      if (currentUrlSearchParams.has('iqdeployment')) {
        mode = currentUrlSearchParams.get('iqdeployment').replace(/\W/g, '');
      }
 
      return mode;
     })();
     })();


Zeile 57: Zeile 64:
</syntaxhighlight>
</syntaxhighlight>


<div class="page-break"></div>
====Einbindung auf einer responsive Seite (Beispiel Implementierung)====
====Einbindung auf einer responsive Seite (Beispiel Implementierung)====


<syntaxhighlight lang='html'>
<syntaxhighlight lang='html'>
  <script>
  <script>
            function isDesktop() {
    function isDesktop() {
              var width = (window.innerWidth > 0) ? window.innerWidth : screen.width;
        var width = (window.innerWidth > 0) ? window.innerWidth : screen.width;
              return width >= 850;
        return width >= 850;
            }
    }
 
    function isMobileOrTablet() {
        return !isDesktop();
    }
 
    function isTablet() {
        return isMobileOrTablet() && window.outerWidth >= 480 && window.hasOwnProperty('orientation');
    }


            function isMobileOrTablet() {
    function isMobile() {
              return !isDesktop();
        return isMobileOrTablet() && !isTablet();
            }
    }


            function isTablet() {
    function getPlatform() {
              return isMobileOrTablet() && window.outerWidth >= 480 && window.hasOwnProperty('orientation');
        if (isDesktop()) {
            }
            return 'desktop';
        }
        if (isTablet()) {
            return 'tablet';
        }
        return 'mobile';
    }


            function isMobile() {
    function IQSLoader(url) {
              return isMobileOrTablet() && !isTablet();
        var script = document.createElement("script")
            }
        script.type = "text/javascript";
        script.src = url;
        document.getElementsByTagName("head")[0].appendChild(script);
    }


            function getPlatform() {
    var iqd_mode = (function () {
              if(isDesktop()) {
      let mode = 'live';
                return 'desktop';
      const currentUrlSearchParams = new URLSearchParams(window.location.search);
              }
              if(isTablet()) {
                return 'tablet';
              }
              return 'mobile';
            }


            function IQSLoader(url) {
      if (currentUrlSearchParams.has('iqdeployment')) {
              var script = document.createElement("script")
        mode = currentUrlSearchParams.get('iqdeployment').replace(/\W/g, '');
              script.type = "text/javascript";
      }
              script.src = url;
              document.getElementsByTagName("head")[0].appendChild(script);
            }


            var iqd_mode = (function() {
      return mode;
              var dm = window.location.href.toLowerCase();
    })();
              return (dm.indexOf('iqdeployment=') > 1) ? dm.split('iqdeployment=')[1].split('&')[0] : 'live';
            })();


            if (isDesktop()) {
    if (isDesktop()) {
              IQSLoader("https://s3.eu-central-1.amazonaws.com/prod.iqdcontroller.iqdigital/[cdn_partnersite_Folgt_durch_iq]/" + iqd_mode + "/iqadcontroller.js.gz");
        IQSLoader(
            } else {
            "https://s3.eu-central-1.amazonaws.com/prod.iqdcontroller.iqdigital/[cdn_partnersite_Folgt_durch_iq]/" +
              IQSLoader("https://s3.eu-central-1.amazonaws.com/prod.iqdcontroller.iqdigital/[cdn_partnersite_Folgt_durch_iq]/" + iqd_mode + "/iqadcontroller.js.gz");
            iqd_mode + "/iqadcontroller.js.gz");
            }
    } else {
        IQSLoader(
            "https://s3.eu-central-1.amazonaws.com/prod.iqdcontroller.iqdigital/[cdn_partnersite_Folgt_durch_iq]/" +
            iqd_mode + "/iqadcontroller.js.gz");
    }
</script>
</script>
</syntaxhighlight>
</syntaxhighlight>
Zeile 114: Zeile 132:
     (function () {
     (function () {
         window.AdController = {
         window.AdController = {
             i: null, // page info q: [], // render queue
             i: null, // page info
             f: false, // is finalized s: false, // is staged
            q: [], // render queue
             n: false, // is initialized r: null, // ready function c: [], // command queue
             f: false, // is finalized  
            s: false, // is staged
             n: false, // is initialized  
            r: null, // ready function  
            c: [], // command queue
             setPageInfo: function (i) {
             setPageInfo: function (i) {
                 window.AdController.i = i;
                 window.AdController.i = i;
Zeile 156: Zeile 178:
Um unter Anderem die anzuwendende Konfiguration für die aktuelle Angebotsseite festzustellen, werden dem AdController über dieses Objekt notwendige Informationen des Seitenbetreibers übergeben.
Um unter Anderem die anzuwendende Konfiguration für die aktuelle Angebotsseite festzustellen, werden dem AdController über dieses Objekt notwendige Informationen des Seitenbetreibers übergeben.
Das vom Seitenbetreiber bereitzustellende Mandanten-CMS-Objekt übermittelt die seitenspezifischen Informationen zur Auswahl der gültigen bzw. spezifischen AdController-Konfiguration und inventargerechten Anzeigenanforderung.
Das vom Seitenbetreiber bereitzustellende Mandanten-CMS-Objekt übermittelt die seitenspezifischen Informationen zur Auswahl der gültigen bzw. spezifischen AdController-Konfiguration und inventargerechten Anzeigenanforderung.


<i><p>Code-Beispiel zur Umsetzung im <head>-Tag des Dokuments nach der AdController Einbindung:</p></i>
<i><p>Code-Beispiel zur Umsetzung im <head>-Tag des Dokuments nach der AdController Einbindung:</p></i>
Zeile 186: Zeile 207:


Enthalten seitenspezifische Informationen für die erforderliche Inventarisierung der Publisher-Site im Ad Server und den AdRequest- URL-Builder zur Anforderungen der auf dieses Inventar gebuchten Anzeigen. Die Level-Informationen sind in Abhängigkeit der Ressort- bzw. Umfeld-Tiefen zu füllen insofern vermarktungsrelevant.  
Enthalten seitenspezifische Informationen für die erforderliche Inventarisierung der Publisher-Site im Ad Server und den AdRequest- URL-Builder zur Anforderungen der auf dieses Inventar gebuchten Anzeigen. Die Level-Informationen sind in Abhängigkeit der Ressort- bzw. Umfeld-Tiefen zu füllen insofern vermarktungsrelevant.  
Beispiel: Wenn die Seite eine Rubrik 'Politik' hat und diese eine Unterrubrik 'Außenpoltik', dann wäre den Wert für level2:'politik' und für level3:'aussenpolitik'
Beispiel: Wenn die Seite eine Rubrik 'Politik' hat und diese eine Unterrubrik 'Außenpolitik', dann wäre den Wert für level2:'politik' und für level3:'aussenpolitik'
 
<span style="color:red;">'''Achtung:'''</span> Es fehlt absichtlich level1, da dieser Teil der Adunit von der iqdigital innerhalb des Adcontrollers festgelegt wird.


====Schlüssel: isWrapperApp====
====Schlüssel: isWrapperApp====
Zeile 209: Zeile 232:
Alle Informationen im CMS-Objekt sind ausschließlich klein zu schreiben; Leerzeichen, Sonderzeichen und Umlaute sind nicht erlaubt. Die einzige Ausnahme ist das "_" Zeichen (Unterstrich/Underscore).
Alle Informationen im CMS-Objekt sind ausschließlich klein zu schreiben; Leerzeichen, Sonderzeichen und Umlaute sind nicht erlaubt. Die einzige Ausnahme ist das "_" Zeichen (Unterstrich/Underscore).


FALSCH: Archäologie RICHTIG: archaeologie
FALSCH: Archäologie RICHTIG: archaeologie | FALSCH: Psychologie-Hirnforschung RICHTIG: psychologie_hirnforschung
FALSCH: Psychologie-Hirnforschung RICHTIG: psychologie_hirnforschung
 


<div class="page-break"></div>
<div class="page-break"></div>
Zeile 265: Zeile 286:


<div class="page-break"></div>
<div class="page-break"></div>
==Anzeigenplatzierungen==


===Signale & Anzeigestruktur===
==Anzeigen-Containermodell==
 
Die Positionierung der Platzhaltercontainer der Anzeigen in der Publisher Seite erfolgt nach dem im Voraus abgestimmten Vertaggungsplan.
Die eigentliche Integration der Container sollte dem folgenden Muster gemäß geschehen.
 
<syntaxhighlight lang='html'>


====AdController.render(..)====
<div class="iqdcontainer" data-placement="pos_[N U M M E R]" data-device="[D E V I C E T Y P E]"></div>


Nach Initialisierung des AdControllers ist dieser bereit für das Absetzen einer Anzeigenanforderung an den AdServer. Auslöser einer Anzeigenanforderung ist die jeweilige Anzeigenplatzierung mit entsprechender AdController.render-Methode. In der Render-Phase des AdControllers werden die Level-Informationen des CMS-Mandanten-Objects an den AdRequest-URL-Builder des AdControllers übergeben und mit weiteren Konfigurationsparametern des Deployments zu einem AdServer-konformen Anzeigen-Request zusammengeführt und versendet.
</syntaxhighlight>


Welche Anzeigenplatzierungen für das jeweilige Layout Ihrer Website umzusetzen ist, ist im Vorfeld mit iq digital hinsichtlich Vermarktungsmöglichkeiten zu besprechen. Die Anzeigenplatzierung ist durch ein eindeutiges DOM-Element mit exemplarischer id=iqadtileT I L E N U M B E R in Ihrem HTML-MarkUp zu implementieren. Der übergebene Positionsschlüssel innerhalb des AdCongroller.render-Aufrufs bewirkt eine asynchrone Einbindung via DOM-Insertion der gelieferten Anzeige im Zielcontainer
Zur richtigen Identifizierung aller Platzhalter müssen folgende Informationen allen Platzhalter Div-Containern mitgegeben werden:


Bitte fügen Sie keinen weitere DOM oder Script-Bestandteile innerhalb dieser Anzeigencontainer ein. Die Anzeigen-Kennzeichnung der Werbeplatzierungen erfolgt optimalerweise durch iq digital. Gerne besprechen wir diesen Punkt gemeinsam mit Ihnen.
# Die Klasse "'''iqdcontainer'''". Durch diese Klasse werden alle Divs Werbeplatzhalter gekennzeichnet.
# Das Data Attribute "'''data-placement'''". Über dieses Data-Attribut können die jeweiligen Positionen in der Seite eindeutig erfasst werden.
# Das Data Attribute "'''data-device'''". Über dieses Data-Attribut wird gekennzeichnet, ob der Werbeplatz für die Desktop, Mobile oder Tablet Werbeausspielung gedacht ist. Mögliche Werte: '''desktop | tablet | mobile'''


====TopBanner Konstrukt====
===SonderPositionen===


Anzeigenplatzierung TopBanner Konstrukt, beinhaltet die erste Position iqadtile1 und beide Sky Postionen (bitte 1:1 genauso implementieren)
====Header und Footer====


Alle Positionen im Footer und Header bekommen keine Zahl in "data-placement", sondern jeweils "pos_header" oder "pos_footer", wodurch sie eindeutig bestimmt sind.
<syntaxhighlight lang='html'>
<syntaxhighlight lang='html'>
<!-- please use this construct for the top positions (iqadtile1), the sky right part (iqadtile2) & the left sky part (iqadtile20) -->
<div id="iqd_mainAd">
    <div id="iqd_align_Ad">
        <div id="iqd_topAd">
            <div id="iqadtile1">
                <script>
                    AdController.render('iqadtile1');
                </script>
            </div>
        </div>
        <div id="iqd_leftAd">
            <div id="iqadtile20">
                <script>
                    AdController.render('iqadtile20');
                </script>
            </div>
        </div>
        <div id="iqd_rightAd">
            <div id="iqadtile2">
                <script>
                    AdController.render('iqadtile2');
                </script>
            </div>
        </div>
    </div>
</div>
</syntaxhighlight>


====weitere Anzeigepositionen====
<div class="iqdcontainer" data-placement="pos_header" data-device="[D E V I C E T Y P E]"></div>


Alle weitere Platzierungen nach folgender Muster umsetzen
<div class="iqdcontainer" data-placement="pos_footer" data-device="[D E V I C E T Y P E]"></div>


<syntaxhighlight lang='html'>
<!-- please use this pattern for all other positions -->
<div id="iqadtileT I L E N U M B E R">
    <script>
        if (typeof AdController !== 'undefined') {
          AdController.render('iqadtileT I L E N U M B E R');
        }
    </script>
</div>
</syntaxhighlight>
</syntaxhighlight>


====AdController.finalize(..)====
==Anzeigenplatzierungen Signalfunktionen==
 
===AdController.finalize(..)===


Die Web-Seite signalisiert dem AdController mit dem AdController.finalize-Aufruf, dass die Render-Phase abgeschlossen werden kann, da keine weiteren Anzeigen-Anforderungen von der Seite implementiert sind. In Einzelfällen kann es dazu kommen, dass die geplante AdController-Konfiguration für die aktuelle Seite von den tatsächlich implementierten Anzeigeplatzierungen abweicht. In diesem Fall werden die Abweichungen durch den AdController evaluiert, abgefangen und bei Bedarf protokolliert. Abweichungen können immer dann Auftreten, wenn für das betroffene Angebot keine spezifische $handle-Zuordnung geplant wurde. Das kann auch ein durch iq digital gewünschtes Szenario sein.
Die Web-Seite signalisiert dem AdController mit dem AdController.finalize-Aufruf, dass die Render-Phase abgeschlossen werden kann, da keine weiteren Anzeigen-Anforderungen von der Seite implementiert sind. In Einzelfällen kann es dazu kommen, dass die geplante AdController-Konfiguration für die aktuelle Seite von den tatsächlich implementierten Anzeigeplatzierungen abweicht. In diesem Fall werden die Abweichungen durch den AdController evaluiert, abgefangen und bei Bedarf protokolliert. Abweichungen können immer dann Auftreten, wenn für das betroffene Angebot keine spezifische $handle-Zuordnung geplant wurde. Das kann auch ein durch iq digital gewünschtes Szenario sein.
Zeile 336: Zeile 330:


<div class="page-break"></div>
<div class="page-break"></div>
====IQDComplete() - Page-Load Signal====
===IQDComplete() - Page-Load Signal===


Sobald alle Inhalte auf der Seite (auch verzögert dynamisch geladener Content), die zur Höhenberechnung der Seite beitragen, geladen worden sind, soll ein Signal an iq digital gesendet werden:
Sobald alle Inhalte auf der Seite (auch verzögert dynamisch geladener Content), die zur Höhenberechnung der Seite beitragen, geladen worden sind, soll ein Signal an iq digital gesendet werden:
Abgerufen von „http://docs.iqd-ao.de/de/index.php?title=Adcontroller“