Show Menu
THEMEN×

Geschäftsorientierte APIs

Die Business-API ist für jeden Objekttyp spezifisch. Sie wirken sich auf Folgendes aus:
In diesem Abschnitt wird die Verwendung der Dienste "Abonnieren", "Abbestellen"und "SendenAuslieferung"beschrieben.
Die Kampagnen-JSAPI-Dokumentation enthält zusätzliche Informationen zu SOAP-Aufrufen und zur Verwendung von JavaScript in Adobe Campaign sowie einen vollständigen Verweis auf alle in der Anwendung verwendeten Methoden und Funktionen.

Abonnieren (nms:subscription)

Mit diesem Dienst können Sie einen Empfänger bei einem Informationsdienst abonnieren und das Empfängerprofil aktualisieren.
Folgende Parameter sind erforderlich, um den Dienst aufzurufen:
  • eine Authentifizierung,
  • interner Name des Abonnementdienstes,
  • ein XML-Dokument mit den Empfängerinformationen (aus dem Schema "nms:empfänger"),
  • Ein boolescher Wert für die Empfängererstellung, wenn noch kein Wert vorhanden ist.
Beschreibung der Methode "subscribe"im Schema "nms:subscription":
<method name="Subscribe" static="true">
  <parameters>
     <param name="serviceName" type="string"  desc="List of information service names (comma separated)"/>
     <param name="recipient" type="DOMElement" desc="Recipient"/>
     <param name="create" type="Boolean" desc="Create recipient if it does not exist"/>
   </parameters>
</method>

Die Definition des Abgleichschlüssels muss über das Attribut "_​ key "im <recipient> Element des XML-Dokuments eingegeben werden. Der Inhalt dieses Attributs ist eine kommagetrennte XPath-Liste.
Dieser Aufruf gibt keine Daten außer Fehler zurück.

Beispiele

Abonnement mit Abgleichschlüssel des Empfängers auf der E-Mail-Adresse: Das XML-Eingabedokument muss auf die E-Mail-Adresse und die Definition des Schlüssels in diesem Feld verweisen.
<recipient _key="email" email= "john.doe@adobe.com"/>

Aktualisieren des Empfängers und des Abonnements.
<recipient _key="email, [folder-id]" email= "john.doe@adobe.com" folder-id="1305" firstName="John" lastName="Doe"/>

Beispiel für SOAP-Meldungen

  • Abfrage:
    <?xml version='1.0' encoding='ISO-8859-1'?>
    <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <m:Subscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
          <sessiontoken xsi:type='xsd:string'/>
          <service xsi:type='xsd:string'>SVC1</service>
          <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
            <recipient _key="@email" email= "john.doe@adobe.com/>
          </content>
          <create xsi:type='xsd:boolean'>true</create>
        </m:Subscribe>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
    
  • Antwort:
    <?xml version='1.0' encoding='ISO-8859-1'?>
    <SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
      <SOAP-ENV:Body>
        <m:SubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
        </m:SubscribeResponse>
      </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>
    
    

Abmelden (nms:subscription)

Mit diesem Dienst können Sie einen Empfänger von einem Informationsdienst abmelden und das Empfängerprofil aktualisieren.
Folgende Parameter sind erforderlich, um den Dienst aufzurufen:
  • eine Authentifizierung,
  • Interner Name des Dienstes, von dem das Abonnement aufgehoben werden soll,
  • ein XML-Dokument mit den Empfängerinformationen (aus dem Schema "nms:empfänger"),
Beschreibung der Methode "Unsubscribe"im Schema "nms:subscription":
<method name="Unsubscribe" static="true">
  <parameters>
    <param name="serviceName" type="string" desc="List of information service names (comma separated)"/>
    <param name="recipient" type="DOMElement"  desc="Recipient"/>
  </parameters>
</method>

Die Definition des Abgleichschlüssels muss über das Attribut "_key"im Element <recipient> des XML-Dokuments eingegeben werden. Der Inhalt dieses Attributs ist eine kommagetrennte XPath-Liste.
Wenn der Empfänger nicht in der Datenbank vorhanden ist oder der betreffende Informationsdienst nicht abonniert wird, führt der Dienst keine Aktion durch und erzeugt keinen Fehler.
Wenn der Dienstname nicht als Parameter angegeben ist, wird der Empfänger automatisch in der schwarzen Liste (@blackList="1") aufgeführt.
Dieser Aufruf gibt keine Daten außer Fehler zurück.

Beispiel für SOAP-Meldungen

Abfrage:
<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:Unsubscribe xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    <sessiontoken xsi:type='xsd:string'/>
    <service xsi:type='xsd:string'>SVC1</service>
    <content xsi:type='' SOAP-ENV:encodingStyle='http://xml.apache.org/xml-soap/literalxml'>
      <recipient _key="@email" email= "john.doe@adobe.com/>
    </content>
  </m:Unsubscribe>
</SOAP-ENV:Body>

Antwort:
<?xml version='1.0' encoding='ISO-8859-1'?>
<SOAP-ENV:Envelope xmlns:xsd='http://www.w3.org/2001/XMLSchema' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' xmlns:ns='http://xml.apache.org/xml-soap' xmlns:SOAP-ENV='http://schemas.xmlsoap.org/soap/envelope/'>
  <SOAP-ENV:Body>
    <m:UnsubscribeResponse xmlns:m='urn:nms:subscription' SOAP-ENV:encodingStyle='http://schemas.xmlsoap.org/soap/encoding/'>
    </m:UnsubscribeResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

SubmitDelivery (nms:delivery)

Mit diesem Dienst können Sie eine Übermittlungsaktion erstellen und senden.
Folgende Parameter sind erforderlich, um den Dienst aufzurufen:
  • eine Authentifizierung,
  • interner Name der Liefervorlage,
  • ein optionales XML-Dokument mit zusätzlichen Bereitstellungsdaten.
Diese API sollte nicht im Volume aufgerufen werden, da möglicherweise Leistungsprobleme auftreten.
Beschreibung der Methode in ihrem Schema:
<method name="SubmitDelivery" static="true">
  <parameters>
    <param name="scenarioName" type="string" inout="in" desc="Internal name of the delivery template"/>
    <param name="content" type="DOMElement"  inout="in" desc="XML content of the delivery template" />
  </parameters>
</method>

Eine Bereitstellungsvorlage muss über die Adobe Campaign-Client-Konsole erstellt werden. Es enthält die Parameter, die für alle Sendungen gelten (Absenderadresse oder Gültigkeitsdauer der Nachricht).
Das XML-Eingabedokument ist ein Fragment, das der Struktur des Schemas "nms:delivery"folgt. Es enthält alle zusätzlichen Daten, die nicht statisch in der Bereitstellungsvorlage definiert werden konnten (z. B. die Liste der Empfänger für das Targeting).
Dieser Aufruf gibt keine Daten außer Fehler zurück.

XML-Dokumentbeispiel

Dieses Beispiel basiert auf einer benutzerdefinierten Bereitstellungsvorlage einer externen Datenquelle (in diesem Fall einer Datei). Die Konfiguration wird in der Bereitstellungsvorlage vollständig beschrieben, sodass beim Aufruf nur der Inhalt der Datei aus dem <externalsource> Element gesendet werden muss.
<delivery>
  <targets fromExternalSource="true">
    <externalSource>
      MsgId|ClientId|Title|Name|FirstName| Mobile|Email| Market_segment|Product_affinity1 |Product_affinity2|Product_affinity3| Product_affinity4| Support_Number|Amount|Threshold1|000001234|M.| Doe|John|0650201020| john.doe@adobe.com
|1| A1|A2|A3|A4|E12|120000|100000
    </externalSource>
  </target>
</delivery>

Wenn Sie keine Bereitstellungsvorlage haben, können Sie das folgende Beispiel verwenden:
<delivery>
<targets fromExternalSource="true" targetMode="1" noReconciliation="true" addressField="Email" >  
    <fileFormat active="true">  
      <source format="text" type="text">  
        <dataSourceConfig >  
          <dataSourceColumn label="Email" name="Email" type="string"/>  
        </dataSourceConfig>  
      </source>  
      <destination type="xtkDataStore"/>  
    </fileFormat>  
    <externalSource><![CDATA[not-a-repicipient@domain.com]]></externalSource>  
  </targets> 
</delivery>