Early Ad Break Notification API verwenden
Hinweis: Diese API befindet sich noch in der Betaphase. Wenden Sie sich an Ihren Account Manager, wenn Sie Zugriff auf das EABN-Programm anfordern möchten.
Mit der Early Ad Break Notification (EABN) API können Sie Google Ad Manager vor Beginn der Werbeunterbrechung mit den zugehörigen Metadaten über die bevorstehende Werbeunterbrechung informieren. Sie können bis zu eine Stunde vor der Werbeunterbrechung eine Benachrichtigungsanfrage senden. In diesem Handbuch wird erläutert, wie Sie die EABN API aktivieren und verwenden. Außerdem finden Sie hier Anfrage- und Antwortbeispiele.
Achtung: EABN-Anfragen sind unveränderlich. Sobald eine Pause erstellt wurde, kann sie nicht mehr geändert werden. Nachfolgende Anfragen zum Erstellen von Werbeunterbrechungen für dasselbe Ereignis werden abgelehnt, bis die Unterbrechung im Manifest für das Ereignis erscheint.
Aufrufe an die EABN API müssen die folgenden Informationen enthalten:
- Die ID des entsprechenden Livestreams, für den die Werbeunterbrechung erstellt wird. Diese Kennung kann eine der folgenden sein:
- Der „Assetschlüssel“ des Livestreams
- Der „Benutzerdefinierter Asset-Schlüssel“ des Livestreams, mit dem Sie Ihren eigenen Schlüsselbereich verwalten können, indem Sie einen eigenen ID-String angeben.
- Die ID der Contentquelle und die Content ID des Livestreams.
Hinweis: Dieser Kennungstyp muss aktiviert sein. Weitere Informationen erhalten Sie von Ihrem Account Manager.
- Die erwartete Dauer der nächsten Werbeunterbrechung. Die Dauer muss der tatsächlichen Länge der Werbeunterbrechung möglichst nahe kommen.
Zusätzlich zu diesen Pflichtfeldern können Sie auch benutzerdefinierte Targeting-Parameter, den Namen einer anzuwendenden Anzeigen-Pod-Vorlage oder SCTE35-Cue-out-Daten senden, sofern verfügbar.
Vorbereitung
Damit Sie die EABN API verwenden können, müssen Sie ein Dienstkonto erstellen und es Ihrem Google Ad Manager-Netzwerk hinzufügen.
Dienstkonto erstellen
Führen Sie die folgenden Schritte aus, um ein Dienstkonto zum Aufrufen der EABN API zu erstellen: – Wenn Sie ein Google Cloud-Konto haben, verwenden Sie das IAM-Modul, um ein Dienstkonto zu erstellen. Weitere Informationen finden Sie unter Dienstkonten erstellen und verwalten. – Wenn Sie noch kein Google Cloud-Konto haben, führen Sie die folgenden Schritte aus, um über die Google API Console eines zu erstellen:
- Erstellen Sie ein neues Projekt oder wählen Sie ein vorhandenes Projekt aus.
- Klicken Sie auf der Seite Anmeldedaten auf Dienstkonten verwalten.
- Klicken Sie auf der Seite Dienstkonten auf DIENSTKONTO ERSTELLEN.
- Geben Sie auf der Seite Dienstkonto erstellen die Kontodetails ein. Klicken Sie dann auf ERSTELLEN.
Nachdem Sie ein Dienstkonto erstellt haben, kopieren Sie den JSON-Schlüssel des Kontos, der für die Authentifizierung verwendet wird.
Dienstkonto Ihrem Google Ad Manager-Netzwerk hinzufügen
Führen Sie die Schritte unter Dienstkontonutzer für den API-Zugriff hinzufügen aus, um das Dienstkonto Ihrem Netzwerk hinzuzufügen.
API aktivieren
Stellen Sie nach der Erstellung des Dienstkontos Ihrem Account Manager die folgenden Informationen zur Verfügung, damit die API für Ihr Konto aktiviert werden kann:
- E-Mail-Adresse Ihres Google Cloud-Kontos
- Mein Dienstkonto
- Der Netzwerkcode Ihres Google Ad Manager-Netzwerks.
Nachdem die API von Ihrem Account Manager aktiviert wurde, führen Sie die folgenden Schritte aus, um sie zu aktivieren:
- Suchen Sie in der Google API-Bibliothek nach „Google Ad Manager Video API“.
- Klicken Sie auf AKTIVIEREN.
Hinweis: Wenn die API nicht in den Suchergebnissen angezeigt wird, fragen Sie Ihren Account Manager, ob die DAI API in Ihrem Konto aktiviert wurde.
API verwenden
Sie können die EABN API mit JSON-/REST-Anfragen aufrufen.
Autorisierung
Für autorisierte Aufrufe der EABN API müssen Sie die Anmeldedaten für das OAuth2-Dienstkonto mit dem JSON-Schlüssel aus Ihrem Dienstkonto und dem Bereich https://www.googleapis.com/auth/video-ads
generieren. Weitere Informationen finden Sie unter OAuth 2.0 für Server-zu-Server-Anwendungen verwenden.
Sie müssen das resultierende Autorisierungstoken als Auth-Header für jeden Aufruf an die EABN API einfügen.
Frühzeitige Benachrichtigung zur Werbeunterbrechung senden
Wenn du eine frühzeitige Benachrichtigung zur Werbeunterbrechung senden möchtest, sende eine POST-Anfrage an eine der drei gültigen EABN-URLs, je nachdem, wie du den Livestream angeben möchtest. In den folgenden Abschnitten werden die Unterschiede zwischen den URLs erläutert. Außerdem finden Sie Beispiele für Anfragen und Antworten.
URLs
Es gibt drei gültige URLs für die frühzeitige Benachrichtigung über eine Werbeunterbrechung. Du kannst alle drei Typen verwenden, um eine Werbeunterbrechung zu erstellen (POST
) oder eine Liste der zugewiesenen Werbeunterbrechungen abzurufen (GET
).
So verwendest du den Assetschlüssel eines Livestreams:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks
So kannst du den benutzerdefinierten Assetschlüssel eines Livestreams verwenden:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks
So verwenden Sie die Contentquellen-ID und die Content ID:
POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks
GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks
Für alle Parameter gilt:
network_code
steht für den Netzwerkcode Ihres Google Ad Manager-Netzwerks.asset_key
steht für den Assetschlüssel, der auf der Detailseite des Livestreams angezeigt wird.custom_asset_key
steht für den benutzerdefinierten Assetschlüssel Ihres Livestreams.content_source_id
steht für die ID einer Contentquelle in Google Ad Manager.content_id
steht für die ID eines Contents in Google Ad Manager.
Hinweis: Das angegebene content_source_id
/content_id
-Paar muss einem Livestream in Google Ad Manager zugeordnet werden.
Anfragetext – wird nur zum Erstellen einer Werbeunterbrechung verwendet
Object | ||
---|---|---|
| Erforderlich | Die Dauer der Werbeunterbrechung im Standardformat von Google (xx.xxxs, wobei xx.xxx für die Anzahl der Sekunden steht) |
| Optional | Schlüssel/Wert-Paare, die in Anzeigenanfragen für diese Werbeunterbrechung für das Targeting nach benutzerdefinierten Kriterien in AM360 eingefügt werden sollen, getrennt durch
und beigetreten von
.
|
| Optional | Name der Anzeigen-Pod-Vorlage |
| Optional | Base-64-codierte Daten aus dem scte35-Cue-out. Kann Folgendes enthalten:
oder
ausgeführt werden.
|
Beispielanfragen
Werbeunterbrechung erstellen
POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
"expectedDuration": "30s",
"scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
"customParams": "param1=value1¶m2=value2",
"podTemplateName": "podtemplate"
}
Antworttext
Der Antworttext enthält alle Parameter, die im adBreak
-Objekt gesendet werden, sowie ein zusätzliches name
-Feld, das die Google-weite Standard-ID der erstellten Werbeunterbrechung enthält. Dieses Feld wird im folgenden Format zurückgegeben:
networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}
Beispielantwort
HTTP/1.1 200 OK
{
"name": "networks/.../assets/.../adBreaks/1",
"expectedDuration": "30s",
"scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
"customParams": "param1=value1¶m2=value2",
"podTemplateName": "podtemplate"
}
Zugewiesene Werbeunterbrechungen auflisten
GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
Antworttext
Der Antworttext enthält die Werbeunterbrechungen mit einem zusätzlichen breakState
-Feld für jede Werbeunterbrechung, die dem Stream zugewiesen ist. Das Feld breakState
unterstützt die folgenden Werte:
// Ad break decisioning has started.
BREAK_STATE_DECISIONED
// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE
Beispielantwort
HTTP/1.1 200 OK
{
"name": "networks/.../assets/.../adBreaks/1",
"expectedDuration": "30s",
"breakState": "BREAK_STATE_COMPLETE"
}