Server konfigurieren

Um den Webservice nutzen zu können, müssen Sie ihn in der master.config Datei des Servers konfigurieren. Bevor Sie dies tun, berücksichtigen Sie die folgenden Anforderungen:

• Sie müssen die master.config Datei für jeden einzelnen Kunden konfigurieren.

• Sie müssen einen gültigen Security:SymmetricSecurityKey konfigurieren wie im Beispiel unten gezeigt wird.

Führen Sie die folgenden Schritte aus, um die AdServing API zu konfigurieren:

1. Öffnen Sie die master.config Datei auf dem Server.

2. Konfigurieren Sie die folgenden Einstellungen:

   • SSP_URL: Geben Sie die URL des SSP an. Das heißt, die externe Buchungsplattform.

   • SpotGroupName: Geben Sie den Namen der Spotgruppe  an, in die die vom SSP heruntergeladenen Mediendateien als Spots hochgeladen werden.

   • ServiceUserName: Geben Sie den Namen des Benutzers an, der die Spots hochlädt und zur Playliste hinzufügt.

   • PlaylistName: Geben Sie den Namen der Playliste an, der die vom SSP heruntergeladenen Mediendateien als Spots hinzugefügt werden.

   • ExtendSpotValidityInDay: Geben Sie in Tagen an, wie lange hochgeladene Spots gültig sind. Geben Sie beispielsweise 0 ein, wenn der Spot unbegrenzt gültig ist, oder 1, wenn der Spot nur heute gültig ist. Der Standardwert ist 0.

   • MaxLogLevel_File: geben Sie einmalig für alle Kunden das maximale Log-Level an, um anzugeben, welche Art von Informationen Sie protokollieren möchten:

     • 1 für Error

     • 2 für Warning

     • 3 für Info

     • 4 für Debug

     • 5 für Trace

Hinweis zu Logs

Wenn Sie zusätzliche Microsoft-Protokolle zum Debuggen oder für weitere Einblicke benötigen, können Sie die Protokollierung optional auf „Warnung“ setzen. Wir empfehlen jedoch, sie generell auf „Kritisch“ zu setzen, um Leistungsprobleme zu vermeiden.

Beispiel: Konfiguration der Datei master.config

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<configuration>
  <appSettings type="global">
    <add key="Security:SymmetricSecurityKey" value="INSERT-A-KEY-HERE" />
  </appSettings>
  <appSettings type="AdServing">
	<add key="AdServing:Customer:dev:SSP_URL" value="http://ads.ooh.digital/adserver.php?nid=S2AD&pid={boxId}"/>
	<add key="AdServing:Customer:dev:PlaylistName" value="SSP"/>
	<add key="AdServing:Customer:dev:SpotGroupName" value="SSP"/>
	<add key="AdServing:Customer:dev:ServiceUserName" value="admin"/>
	<add key="AdServing:Customer:dev:ExtendSpotValidityInDays" value="1"/>
	<add key="MaxLogLevel_File" value="3"/>
  </appSettings>
</configuration>

Um den AdServing API Webservice zu verwenden, müssen Sie die master.config Datei des Servers und eine kundenspezifische SSP-Konfigurationsdatei konfigurieren.

Führen Sie dazu die folgenden Schritte aus:

1. Öffnen Sie die master.config Datei des Servers.

2. Gehen Sie zur Einstellung AdServing:Customer:<CUSTOMER-ID>:SSP_CONFIG und geben Sie den Pfad zur kundenspezifischen SSP-Konfigurationsdatei an.

3. Optional bearbeiten Sie die folgenden allgemeinen Einstellungen in der master.config Datei:

   • AdServing:DownloadWorkerIntervalMs: Geben Sie das Intervall für die Suche nach neuen Mediendateien, die heruntergeladen und in die IXM Plattform importiert werden müssen, in Millisekunden an. Der Standardwert ist 1000 ms. Wenn Sie weniger als 0 Millisekunden angeben, funktioniert die AdServing API nicht mehr.

   • MaxLogLevel_Console: Geben Sie die maximale Konsolenprotokollebene ein, um anzugeben, welche Art von Informationen Sie protokollieren möchten:

     • 1 für Error

     • 2 für Warning

     • 3 für Info

     • 4 für Debug

     • 5 für Trace

   • MaxLogLevel_File: Geben Sie die maximale Dateiprotokollebene ein, um anzugeben, welche Art von Informationen Sie protokollieren möchten:

     • 1 für Error

     • 2 für Warning

     • 3 für Info

     • 4 für Debug

     • 5 für Trace

Hinweis zu Logs

Wenn Sie zusätzliche Microsoft-Protokolle zum Debuggen oder für weitere Einblicke benötigen, können Sie die Protokollierung optional auf „Warnung“ setzen. Wir empfehlen jedoch, sie generell auf „Kritisch“ zu setzen, um Leistungsprobleme zu vermeiden.

Beispiel: Konfiguration der Datei master.config

<appSettings type="AdServing">
    <add key="AdServing:Customer:27:SSP_CONFIG"
    value="\\gfstor002.grassfish.local\GFServers\Server\01\configs\ssp-config-27.json"/>
    <add key="AdServing:DownloadWorkerIntervalMs" value="1500"/>
    <add key="MaxLogLevel_Console" value="5"/>
    <add key="MaxLogLevel_File" value = "5" />
</appSettings>

SSP Parameter konfigurieren

Sie müssen die SSP-Parameter wie die URL des SSP in der SSP-Konfigurationsdatei konfigurieren. Die Datei hat folgenden Aufbau:

{
 "sspConfigurations": [
    "sspConfiguration": {
        "sspPriority": int,
        "sspUrl": string,
        "cutMediaUrlBeforeSubString": string,
        "sspRequestHeaders": Dictionary<string, string>,
        "sspCategoryId": int,
        "sspPlaylistId": int,
        "sspSpotGroupId": int,
        "sspServiceUserId": int,
        "extendSpotValidityInDays": int
    }
  ]
}

IDs ermitteln

Bevor Sie die SSP-Konfigurationsdatei konfigurieren können, müssen Sie die IDs der IXM Plattform-Kategorie, Playliste, Spotgruppe und des SSP-Benutzers für alle SSPs abrufen. Sie geben diese IDs in die Datei ein.

Wenn das System IDs anstelle von Namen verwendet, können Sie einfach die Namen von Playlisten oder Spotgruppen in der IXM Plattform ändern, ohne dass sich dies auf ID und SSP auswirkt. Das bedeutet auch, dass derselbe SSP-Adminbenutzer für mehrere SSP-Anbieter funktioniert.

Führen Sie die folgenden Schritte aus, um die IDs abzurufen:

1. Öffnen Sie in der IXM Plattform das Bearbeitungsfenster der Kategorie, Playliste, Spotgruppe oder des Benutzers, deren ID Sie benötigen.

2. Öffnen Sie die Entwicklertools in Ihrem Browser. Gehen Sie beispielsweise in Google Chrome zu Google Chrome anpassen und verwalten > Weitere Tools > Entwicklertools.

3. Wählen Sie im Fenster Entwicklertools die Registerkarte Netzwerk aus.

4. Lesen Sie die ID aus der Liste ab und notieren Sie diese für die Dateikonfiguration im nächsten Kapitel.

5. Wiederholen Sie die Schritte 1 bis 4, bis Sie die erforderlichen IDs der Kategorie, Playliste, Spotgruppe und des Benutzers haben.

Validität der Konfigurationsdatei sichern

Your configuration is validated with the help of validation rules. If one or more of these validation rules are violated, the AdServing API logs an error message and stops.

Ihre Konfiguration wird mit Hilfe von Validierungsregeln validiert. Wenn eine oder mehrere dieser Validierungsregeln verletzt werden, protokolliert die AdServing API eine Fehlermeldung und stoppt.

Es gelten folgende Regeln:

• Mehrere sspConfiguration-Elemente in einer Datei dürfen nicht dieselben Werte enthalten für: SspPriority, SspUrl und SspCategoryId. Stellen Sie sicher, dass diese Elemente in der Konfigurationsdatei unterschiedliche Werte haben.

• Keiner der angegebenen Konfigurationsparameter darf fehlen. Dies schließt die optionalen Parameter CutMediaUrlBeforeSubString, SspRequestHeaders und ExtendSpotValidityInDays aus.

• Alle angegebenen Konfigurationsparameter müssen einen Wert haben.

• Keiner der angegebenen Konfigurationsparameter darf einen Wert haben, der nicht mit dem angegebenen Datentyp übereinstimmt.

• Die grundlegende Syntax des JSON muss gültig sein.

Konfigurationsdatei konfigurieren

Führen Sie die folgenden Schritte aus, um die SSP-Parameter in der SSP-Konfigurationsdatei zu konfigurieren:

1. Öffnen Sie die SSP config Datei.

2. Legen Sie die folgenden Einstellungen fest:

Beispiel: Konfiguration der SSP-Konfigurationsdatei

{
	"SspConfigurations": [
		{
			"SspPriority": 1,
			"SspUrl":"https://test.grassfish.tv/testdata/ssp/units/",
			"CutMediaUrlBeforeSubString": "?",
			"SspRequestHeaders": {
				"hs-auth": " api-key 1234567890"
				},
			"SspCategoryId": 1593,
                     "SspPlaylistId": 259,
			"SspSpotGroupId": 958,
			"ExtendSpotValidityInDays": 3,
			"SspServiceUserId": 1489
		},
		{
			"SspPriority": 2,
			"SspUrl": " https://test.grassfish.tv/random/ssp/schedule/",
			"CutMediaUrlBeforeSubString": "?",
			"SspCategoryId": 1592,
			"SspPlaylistId": 263,
			"SspSpotGroupId": 957,
			"ExtendSpotValidityInDays": 3,
			"SspServiceUserId": 1489
		}
	]
}