Sie können Ihre In-Page-HTML-Anzeigenflächen mit Video- oder Overlay-Anzeigenflächen verknüpfen. Diese Beziehung zwischen verknüpften Anzeigenflächen wird als Master-Companion-Beziehung bezeichnet.
Zusätzlich zum Anfordern von Video- und Overlay-Master-Anzeigen können Sie das IMA SDK verwenden, um Companion-HTML-Anzeigen zu präsentieren. Diese Anzeigen werden in einer HTML-Umgebung ausgeliefert.
Companion-Anzeigen verwenden
So verwenden Sie Companion-Anzeigen:
1. Companion-Anzeigen buchen
Sie müssen zuerst die Companion-Anzeigen buchen, die Sie mit Ihren Master-Anzeigen präsentieren möchten. Companion-Anzeigen können in Ad Manager getraffickt werden. Pro Master-Anzeige können Sie bis zu sechs Companion-Anzeigen ausliefern. Diese Technik, bei der ein einzelner Käufer alle Anzeigen auf der Seite kontrolliert, wird auch als Roadblocking bezeichnet.
2. Companion-Anzeigen anfordern
Companion-Anzeigen sind standardmäßig für jede Anzeigenanfrage aktiviert.
3. Companion-Anzeigen einblenden
Es gibt zwei Möglichkeiten, Companion-Anzeigen zu rendern:
Automatisch mit dem Google Publisher-Tag (GPT).
Wenn Sie GPT zur Implementierung Ihrer Companion-Anzeigen verwenden, werden sie automatisch ausgeliefert, sofern auf der HTML-Seite Companion-Anzeigenflächen deklariert sind und diese Anzeigen bei der API registriert sind. Das bedeutet, dass die div-ID im JavaScript und im HTML-Code übereinstimmen muss. Einige Vorteile von GPT sind:
- Companion-Slot-Awareness.
- Companion-Backfill über das Publisher-Netzwerk, wenn die VAST-Antwort weniger Companion-Anzeigen enthält, als definierte Anzeigenflächen auf der HTML-Seite verfügbar sind.
- Companion-Anzeigen automatisch ausfüllen, wenn eine Videoanzeige fehlt.
- Vorab geladene Companion-Anzeigenflächen für Click-to-Play-Videoplayer.
- Automatisches Companion-Rendering, einschließlich
HTMLResourceundiFrameResource.
Manuell über die Ad API.
Companion-Anzeigen mit Google Publisher-Tag verwenden
Über das Google Publisher-Tag (GPT) wird die Auslieferung von HTML-Companion-Anzeigen auf Ihrer Website automatisiert. Wir empfehlen den meisten Publishern, das GPT zu verwenden. Das HTML5 SDK erkennt GPT-Flächen, wenn GPT auf der Hauptwebseite (nicht in einem iFrame) geladen wird. Weitere Informationen zur Verwendung von GPT mit dem IMA SDK finden Sie in der GPT-Dokumentation.
Wenn Sie das HTML5 SDK in einem iFrame hosten
Wenn Sie beide der folgenden Kriterien erfüllen, müssen Sie ein zusätzliches Proxyskript einfügen, damit Ihre GPT-Companion-Anzeigen korrekt dargestellt werden:
- Laden Sie das HTML5 SDK in einem iFrame.
- Laden Sie GPT auf der Hauptwebseite (außerhalb des iFrames).
Damit die Companion-Anzeigen in diesem Szenario ausgeliefert werden, müssen Sie das GPT-Proxyskript laden, bevor Sie das SDK laden:
<script src="https://imasdk.googleapis.com/js/sdkloader/gpt_proxy.js"></script>
Was Sie unbedingt beachten sollten:
- Im iFrame, in dem das SDK geladen wird, darf kein GPT geladen werden.
- GPT muss auf der obersten Seite geladen werden, nicht in einem anderen iFrame.
- Das Proxyskript muss im selben Frame wie GPT geladen werden, also auf der Hauptseite.
Companion-Anzeigenflächen in HTML deklarieren
In diesem Abschnitt wird erläutert, wie Sie Companion-Anzeigen in HTML mit GPT deklarieren. Außerdem finden Sie hier Beispielcode für verschiedene Szenarien. Für das HTML5 SDK müssen Sie Ihrer HTML-Seite JavaScript hinzufügen und die Anzeigenflächen für Companion-Anzeigen deklarieren.
- Beispiel 1: Einfache Implementierung von Anzeigenflächen
- Beispiel 2: Implementierung dynamischer Anzeigenflächen
- Beispiel 3: Vorab geladene Anzeigenflächen
Beispiel 1: Einfache Implementierung von Anzeigenflächen
Im folgenden Beispielcode wird gezeigt, wie Sie die Datei gpt.js in Ihre HTML-Seite einfügen und eine Anzeigenfläche deklarieren. Die deklarierte Anzeigenfläche ist 728 × 90 Pixel groß. GPT versucht, die Anzeigenfläche mit Companion-Anzeigen zu füllen, die in der VAST-Antwort zurückgegeben werden und dieser Größe entsprechen. Nachdem die Anzeigenflächen deklariert wurden, können sie mit der Funktion googletag.display() überall dort gerendert werden, wo sie auf der Seite aufgerufen wird. Da es sich um Companion-Anzeigenflächen handelt, werden Anzeigen nicht sofort ausgeliefert. Stattdessen werden sie neben der Master-Videoanzeige eingeblendet.
Hier ein Beispiel für die Implementierung:
<html>
<head>
<!-- Uncomment the line below for the HTML5 SDK caveat proxy -->
<!--<script src="https://imasdk.googleapis.com/js/sdkloader/gpt_proxy.js"></script>-->
<!-- HEAD part -->
<!-- Initialize the tagging library -->
<script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script>
<!-- Register your companion slots -->
<script>
window.googletag = window.googletag || { cmd: [] };
googletag.cmd.push(function() {
// Supply YOUR_NETWORK and YOUR_UNIT_PATH.
googletag.defineSlot('/YOUR_NETWORK/YOUR_UNIT_PATH', [728, 90], 'companionDiv')
.addService(googletag.companionAds())
.addService(googletag.pubads());
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.pubads().enableVideoAds();
googletag.enableServices();
});
</script>
</head>
<body>
<!-- BODY part -->
<!-- Declare a div where you want the companion to appear. Use
googletag.display() to make sure the ad is displayed. -->
<div id="companionDiv" style="width:728px; height:90px;">
<script>
// Using the command queue to enable asynchronous loading.
// The unit does not actually display now - it displays when
// the video player is displaying the ads.
googletag.cmd.push(function() { googletag.display('companionDiv'); });
</script>
</div>
<body>
</html>
Jetzt ausprobieren
Im folgenden CodePen finden Sie eine funktionierende Implementierung.
Beispiel 2: Implementierung einer dynamischen Anzeigenfläche
Manchmal wissen Sie erst, wie viele Anzeigenflächen Sie auf einer Seite haben, wenn der Seiteninhalt gerendert wurde. Im folgenden Beispielcode wird gezeigt, wie Anzeigenflächen definiert werden, während die Seite gerendert wird. Dieses Beispiel ist mit Beispiel 1 identisch, mit dem Unterschied, dass die Anzeigenflächen dort registriert werden, wo sie tatsächlich angezeigt werden.
<html>
<head>
<!-- Uncomment the line below for the HTML5 SDK caveat proxy -->
<!-- <script src="https://imasdk.googleapis.com/js/sdkloader/gpt_proxy.js"></script> -->
<script async src="https://securepubads.g.doubleclick.net/tag/js/gpt.js"></script>
<!-- HEAD part -->
<!-- Initialize the tagging library -->
<script>
window.googletag = window.googletag || { cmd: [] };
googletag.cmd.push(function() {
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.pubads().enableVideoAds();
googletag.enableServices();
});
</script>
</head>
<body>
<!-- BODY part -->
<!-- Declare a div where you want the companion to appear. Use
googletag.display() to make sure the ad is displayed. -->
<div id="companionDiv" style="width:728px; height:90px;">
<script>
// Using the command queue to enable asynchronous loading.
// The unit does not actually display now - it displays when
// the video player is displaying the ads.
googletag.cmd.push(function() {
// Supply YOUR_NETWORK and YOUR_UNIT_PATH.
googletag.defineSlot('/YOUR_NETWORK/YOUR_UNIT_PATH', [728, 90], 'companionDiv')
.addService(googletag.companionAds())
.addService(googletag.pubads());
googletag.display('companionDiv');
});
</script>
</div>
<body>
</html>
Jetzt ausprobieren
Der folgende Code zeigt eine funktionierende Implementierung.
Beispiel 3: Vorab geladene Anzeigenflächen
In bestimmten Fällen müssen Sie möglicherweise etwas auf der Anzeigenfläche anzeigen, bevor die Companion-Anzeige angefordert wird. Companion-Anzeigen werden normalerweise zusammen mit einer Videoanzeige angefordert. Diese Anfrage kann nach dem Laden der Seite erfolgen. Beispielsweise kann eine Companion-Anzeige erst geladen werden, nachdem der Nutzer auf ein Click-to-Play-Video geklickt hat. In diesem Fall müssen Sie die Möglichkeit haben, eine reguläre Anzeige anzufordern, um die Anzeigenfläche zu füllen, bevor die Companion-Anzeige angefordert wird. In diesem Fall können Sie Standard-Webanzeigen auf der Companion-Anzeigenfläche einblenden. Die Webanzeigen müssen auf die Companion-Anzeigenflächen ausgerichtet sein. Companion-Anzeigenflächen können wie Standard-Webanzeigenflächen ausgerichtet werden.
Hier ein Beispiel für die gerade beschriebene Implementierung:
<html>
<head>
...
<!-- Register your companion slots -->
<script>
window.googletag = window.googletag || { cmd: [] };
googletag.cmd.push(function() {
// Supply YOUR_PRELOAD_NETWORK and YOUR_PRELOAD_UNIT_PATH.
googletag.defineSlot('/YOUR_PRELOAD_NETWORK/YOUR_PRELOAD_UNIT_PATH', [728, 90], 'companionDiv')
.addService(googletag.companionAds())
.addService(googletag.pubads());
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.pubads().enableVideoAds();
googletag.enableServices();
});
</script>
</head>
...
</html>
Jetzt ausprobieren
In diesem CodePen finden Sie eine funktionierende Implementierung.
Companion-Anzeigen mit der Ad API verwenden
In diesem Abschnitt wird beschrieben, wie Sie Companion-Anzeigen mithilfe der Ad API einblenden.
Companion-Anzeigen einblenden
Wenn Sie Companion-Anzeigen einblenden möchten, rufen Sie zuerst über eines der AdEvent-Ereignisse, die vom AdsManager gesendet werden, einen Verweis auf ein Ad-Objekt ab. Wir empfehlen, das Ereignis AdEvent.STARTED zu verwenden, da Companion-Anzeigen zusammen mit der Masteranzeige ausgeliefert werden sollten.
Verwenden Sie dann dieses Ad-Objekt, um getCompanionAds() aufzurufen und ein Array von CompanionAd-Objekten abzurufen. Hier können Sie CompanionAdSelectionSettings angeben, um Filter für die Companion-Anzeigen nach Creative-Typ, Prozentsatz für ungefähre Übereinstimmung, Ressourcentyp und Größenkriterien festzulegen.
Weitere Informationen zu diesen Einstellungen finden Sie in der IMA CompanionAdSelectionSettings API-Dokumentation.
Die von getCompanionAds zurückgegebenen CompanionAd-Objekte können jetzt verwendet werden, um die Companion-Anzeigen auf der Seite gemäß den folgenden Richtlinien anzuzeigen:
- Erstellen Sie auf der Seite eine Companion-Anzeigenfläche
<div>in der erforderlichen Größe. - Rufen Sie in Ihrem Event-Handler für das Ereignis
STARTEDdas ObjektAdab, indem SiegetAd()aufrufen. - Verwenden Sie
getCompanionAds(), um eine Liste der Companion-Anzeigen abzurufen, die sowohl der Größe der Companion-Anzeigenfläche als auchCompanionAdSelectionSettingsentsprechen und dieselbe Sequenznummer wie das Master-Creative haben. Creatives ohne Sequenzattribut werden so behandelt, als hätten sie die Sequenznummer 0. - Rufen Sie den Inhalt aus einer
CompanionAd-Instanz ab und legen Sie ihn als inneres HTML des<div>dieser Anzeigenfläche fest.
Beispielcode
<!--Set a companion ad div in html page. -->
<div id="companion-ad-300-250" width="300" height="250"></div>
<script>
// Listen to the STARTED event.
adsManager.addEventListener(
google.ima.AdEvent.Type.STARTED,
onAdEvent);
function onAdEvent(adEvent) {
switch (adEvent.type) {
case google.ima.AdEvent.Type.STARTED:
// Get the ad from the event.
var ad = adEvent.getAd();
var selectionCriteria = new google.ima.CompanionAdSelectionSettings();
selectionCriteria.resourceType = google.ima.CompanionAdSelectionSettings.ResourceType.STATIC;
selectionCriteria.creativeType = google.ima.CompanionAdSelectionSettings.CreativeType.IMAGE;
selectionCriteria.sizeCriteria = google.ima.CompanionAdSelectionSettings.SizeCriteria.IGNORE;
// Get a list of companion ads for an ad slot size and CompanionAdSelectionSettings
var companionAds = ad.getCompanionAds(300, 250, selectionCriteria);
var companionAd = companionAds[0];
// Get HTML content from the companion ad.
var content = companionAd.getContent();
// Write the content to the companion ad slot.
var div = document.getElementById('companion-ad-300-250');
div.innerHTML = content;
break;
}
}
</script>
Flexible Companion-Anzeigen einblenden
Das IMA SDK unterstützt jetzt flexible Companion-Anzeigen. Die Größe dieser Companion-Anzeigen kann an die Größe der Anzeigenfläche angepasst werden. Sie füllen 100 % der Breite des übergeordneten div-Elements aus und passen dann ihre Höhe an den Inhalt des Companion-Anzeigen-Assets an. Sie werden in Ad Manager mit der Companion-Größe Fluid festgelegt. In der folgenden Abbildung sehen Sie, wo Sie diesen Wert festlegen können.

Flexible GPT-Companion-Anzeigen
Wenn Sie GPT-Companion-Anzeigen verwenden, können Sie eine flexible Companion-Anzeigenfläche deklarieren, indem Sie den zweiten Parameter der Methode defineSlot() aktualisieren.
<!-- Register your companion slots -->
<script>
googletag.cmd.push(function() {
// Supply YOUR_NETWORK and YOUR_UNIT_PATH.
googletag.defineSlot('/YOUR_NETWORK/YOUR_UNIT_PATH', ['fluid'], 'companionDiv')
.addService(googletag.companionAds())
.addService(googletag.pubads());
googletag.companionAds().setRefreshUnfilledSlots(true);
googletag.pubads().enableVideoAds();
googletag.enableServices();
});
</script>
Flexible Companion-Anzeigen der Ad API
Wenn Sie die Ad API für Companion-Anzeigen verwenden, können Sie eine flexible Companion-Anzeigenfläche deklarieren, indem Sie google.ima.CompanionAdSelectionSettings.SizeCriteria auf den Wert SELECT_FLUID aktualisieren.
<script>
...
// Get the ad from the event.
var ad = adEvent.getAd();
var selectionCriteria = new google.ima.CompanionAdSelectionSettings();
selectionCriteria.resourceType = google.ima.CompanionAdSelectionSettings.ResourceType.STATIC;
selectionCriteria.creativeType = google.ima.CompanionAdSelectionSettings.CreativeType.IMAGE;
selectionCriteria.sizeCriteria = google.ima.CompanionAdSelectionSettings.SizeCriteria.SELECT_FLUID;
// Get a list of companion ads for an ad slot size and CompanionAdSelectionSettings
// Note: Companion width and height are irrelevant when fluid size is used.
var companionAds = ad.getCompanionAds(0, 0, selectionCriteria);
var companionAd = companionAds[0];
...
}
}
</script>