om_GetCampaignPeriodDefs_Ad [dstore]

Inhaltsverzeichnis

om_GetCampaignPeriodDefs_Ad

om_GetCampaignPeriodDefs_Ad

Gibt die Definitionen von Gültigkeitszeiträumen einer Verkaufs-Aktion (eine sogenannte „Campaign“) zurück.

Pro Verkaufs-Aktion können mehrere Zeitraum-Definitionen hinterlegt werden (um z.B. „Immer Montags und Donnerstags“ abbilden zu können), jedoch maximal 256 (wie man auch am Datentyp „tinyint“ von „PeriodDefinitionID“ sehen kann) !

Allgemeine Erläuterung zu Gültigkeitszeiträumen von Verkaufs-Aktionen und deren Definition(en) :

Für jede Aktion muß definiert sein, in welchen Zeiträumen sie gültig ist. Die Unterscheidung zwischen den Zeiträumen selbst und ihren Definitionen liegt darin begründet, daß man u.U. wiederkehrende Zeiträume definieren möchte wie z.B. „Jeden Montag zwischen 10 und 15 Uhr“.
Man möchte diese wiederkehrenden Zeiträume auf der einen Seite nicht händisch eintragen, auf der anderen Seite benötigen aber
die Prozeduren, die letztlich für die Anwendung der Aktionen sorgen, die genauen Zeiträume, um die absolut beste Performance zu erzielen.
Zur Verwaltung der Definitionen von Gültigkeitszeiträumen gibt es die Prozedur om_ModifyCampaignPeriodDefs_Ad, die u.a. dafür sorgt, daß aus den Definitionen die tatsächlichen Zeiträume generiert und gespeichert werden. Diese (tatsächlichen Zeiträume) können wiederum mit om_GetCampaignPeriods_Ad eingesehen werden.

Beispiel „Jeden Montag zwischen 10 und 15 Uhr im Zeitraum 29.03.2010 bis 12.04.2010“ :

Die Definition dazu kann so aussehen, daß der Zeitraum „29.03.2010 10:00“ bis „29.03.2010 15:00“ alle 7 Tage (also wöchentlich) bis zum „12.04.2010 15:00“ wiederholt wird, sprich die (relevanten) Werte in der Rückgabemenge wären :

StartDateAndTime : 29.03.2010 10:00
EndDateAndTime : 29.03.2010 15:00
RepeatEveryXTimeUnits : 7
TimeUnit : Tag
RepeatUntil : 12.04.2010 15:00

HTTP-Method	GET
HTTP-Auth	Optional
Alias	om_GetCampaignPeriodDefinitions_Ad
Tags	[om, Get, Campaign, Period, Definitions, Ad]
Engine-Kategorie	order management
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	7.0.7 (2015-01-29)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
CampaignID		ID einer Verkaufs-Aktion, zu der die Definitionen von Gültigkeitszeiträumen ermittelt werden sollen	integer	6.0.0

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
PeriodDefinitionID	ID einer (nur) für die Verkaufs-Aktion „CampaignID“ geltenden Gültigkeitszeitraum-Definition. Anmerkung : stellt quasi nur eine Art „Durchnummerierung“ der Zeitraum-Definitionen für eine Verkaufs-Aktion dar.	tinyint	6.0.0
PeriodDefinitionName	Bezeichnung der Definition „PeriodDefinitionID“, wie z.B. „Jeden Montag zwischen 10 und 15 Uhr (vom 29.03.2010 bis zum 12.04.2010)„	varchar(100)	6.0.0
StartDateAndTime	Startzeitpunkt des Gültigkeitszeitraums und damit gleichzeitig Startzeitpunkt des ersten aus dieser Definition (generierten) tatsächlichen Zeitraums (der u.U. eben mehrfach gemäß „RepeatEveryXTimeUnits“ bis zum Zeitpunkt „RepeatUntil“ wiederholt wird)	datetime	6.0.0
StartDateAndTime_char	„StartDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“	varchar(23)	6.0.0
EndDateAndTime	Endzeitpunkt des Gültigkeitszeitraums und damit gleichzeitig Endzeitpunkt des ersten aus dieser Definition (generierten) tatsächlichen Zeitraums (der u.U. eben mehrfach gemäß „RepeatEveryXTimeUnits“ bis zum Zeitpunkt „RepeatUntil“ wiederholt wird)	datetime	6.0.0
EndDateAndTime_char	„EndDateAndTime“ als „string“ im Format „01.04.2001 17:52:23:548“	varchar(23)	6.0.0
RepeatEveryXTimeUnits	Wert “> 0“ bedeutet, daß der Zeitraum „StartDateAndTime“ bis „EndDateAndTime“ nach dieser Anzahl durch „TimeUnitID“ bestimmten Zeiteinheit (z.B. „Tag“) wiederholt wird und dieses „Wiederholungs-Prinzip“ bis zum Zeitpunkg „RepeatUntil“ fortgeführt wird	tinyint	6.0.0
TimeUnitID	ID einer Zeiteinheit. Gibt die Zeiteinheit für „RepeatEveryXTimeUnits“ an. „NULL“ wenn „RepeatEveryXTimeUnits = 0“ ist. Mögliche Werte : s. om_GetTimeUnitsForCPeriods_Ad	tinyint	6.0.0
TimeUnit	Klartext der Zeiteinheit „TimeUnitID“ (z.B. „Tag“)	varchar(20)	6.0.0
RepeatUntil	Nicht „NULL“ wenn „RepeatEveryXTimeUnits > 0“. Zeitpunkt, bis zu dem der Zeitraum „StartDateAndTime“ bis „EndDateAndTime“ immer wieder nach „RepeatEveryXTimeUnits“ vielen (durch „TimeUnitID“ bestimmten) Zeiteinheiten (z.B. „Tage“) wiederholt wird.	datetime	6.0.0

Sortierung der Rückgabe

(parameterunabängige Sortierung)

StartDateAndTime (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code	Beschreibung	Quelle ⁵⁾
-569	Der Benutzer hat kein Ausführungsrecht für die Prozedur	nur indirekt
-567	Die Prozedur darf z. Zt. nicht ausgeführt werden	nur indirekt
-566	Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werden	nur indirekt
-535	Das Datum liegt nicht in der Vergangenheit	nur indirekt
-530	Der Wert ist nicht konvertierbar	nur indirekt
-510	Der Benutzer ist nicht registriert	nur indirekt
-504	Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochen	nur indirekt
-500	Falsche Parameter	nur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7	2015-01-29	Interne Änderung : Datentyp-Erweiterung des „ReferenceKey“ [für „_mi_StartProcedure“-Aufruf]
6.5.4	2013-04-29	Anpassungen an aktuellen Code-Standard, u.a. wg. UTF8-Unterstützung
6.0.0	2010-03-26	Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

om_GetCampaignPeriodDefs_Ad im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignPeriodDefs_Ad?CampaignID=<value>'

Mit xmllint ⁶⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetCampaignPeriodDefs_Ad?CampaignID=<value>' | xmllint --format -

dStore_php

use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'om_GetCampaignPeriodDefs_Ad',
		array(
			'CampaignID' => <value>
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();

engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'

<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="om_GetCampaignPeriodDefs_Ad">
			<Parameters>
				<Parameter Name="CampaignID"><!-- integer value --></Parameter>
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“

⁶⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Inhaltsverzeichnis