Dataorienterade API:er data-oriented-apis

Med dataorienterade API:er kan du hantera hela datamodellen.

Översikt över datamodellen overview-of-the-datamodel

Adobe Campaign erbjuder inte ett dedikerat läs-API per entitet (ingen getRecipient- eller getDelivery-funktion, osv.). Använd metoderna för läsning och ändring av QUERY- och WRITER-data för att komma åt modellens data.

Med Adobe Campaign kan du hantera samlingar: frågor gör att du kan återställa en uppsättning information som samlats in i hela basen. Till skillnad från åtkomst i SQL-läge returnerar Adobe Campaign API:er ett XML-träd i stället för datakolumner. Adobe Campaign skapar alltså sammansatta dokument med alla insamlade data.

Det här operativläget erbjuder inte en-till-en-mappning mellan attributen och elementen i XML-dokumenten och kolumnerna i tabellerna i databasen.

XML-dokument lagras i databasens MEMO-typfält.

Beskrivning av modellen description-of-the-model

Du måste känna till Adobe Campaign datamodell för att kunna adressera fälten i databasen i dina skript.

En presentation av datamodellen finns i beskrivningen av Adobe Campaign datamodell.

Fråga och skrivprogram query-and-writer

Följande introduktionsschema innehåller information om utbyten på låg nivå för läsning (ExecuteQuery) och skrivning (Writer) mellan databas och kund (webbsidor eller Adobe Campaign klientkonsol).

ExecuteQuery executequery

För kolumner och villkor kan du använda Frågor.

Detta gör att du kan isolera den underliggande SQL-koden. Frågespråket är inte beroende av den underliggande motorn: vissa funktioner mappas om, vilket kan generera flera SELECT SQL-order.

Mer information finns i Exempel på metoden ExecuteQuery i schemat xtk:queryDef.

Metoden ExecuteQuery presenteras i ExecuteQuery (xtk:queryDef).

Skriv write

Med skrivkommandon kan du skriva enkla eller komplexa dokument, med poster i en eller flera tabeller i basen.

Med transaktionella API:er kan du hantera avstämningar via kommandot updateOrInsert: ett kommando kan du skapa eller uppdatera data. Du kan också konfigurera ändringssammanslagning (merge): i det här operativläget kan du auktorisera partiella uppdateringar.

XML-strukturen ger en logisk vy av data och gör att du kan stega dig förbi den fysiska strukturen i SQL-tabellen.

Write-metoden presenteras i Write/WriteCollection (xtk:session).

ExecuteQuery (xtk:queryDef) executequery--xtk-querydef-

Med den här metoden kan du utföra frågor från data som är kopplade till ett schema. Det krävs en autentiseringssträng (måste vara inloggad) och ett XML-dokument som beskriver frågan som ska skickas som parametrar. Returparametern är ett XML-dokument som innehåller resultatet av frågan i formatet för det schema som frågan refererar till.

Definition av metoden "ExecuteQuery" i schemat "xtk:queryDef":

<method name="ExecuteQuery" const="true">
  <parameters>
    <param desc="Output XML document" name="output" type="DOMDocument" inout="out"/>
  </parameters>
</method>

Format för XML-dokumentet i indatafrågan format-of-the-xml-document-of-the-input-query

XML-dokumentets struktur för frågan beskrivs i schemat "xtk:queryDef". Det här dokumentet beskriver satserna i en SQL-fråga: "select", "where", "order by", "group by", "having".

<queryDef schema="schema_key" operation="operation_type">
  <select>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </select>
  <where>
    <condition expr="expression1"/>
    <condition expr="expression2"/>
    ...
  </where>
  <orderBy>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </orderBy>
  <groupBy>
    <node expr="expression1">
    <node expr="expression2">
    ...
  </groupBy>
  <having>
    <condition expr="expression1"/>
    <condition expr="expression2"/>
    ...
  </having>
</queryDef>

En underfråga ( <subquery>) kan definieras i ett <condition> -element. Syntaxen för en <subquery> -elementet är baserat på syntaxen för ett <querydef>.

Exempel på en <subquery> : </subquery>

<condition setOperator="NOT IN" expr="@id" enabledIf="$(/ignored/@ownerType)=1">
  <subQuery schema="xtk:operatorGroup">
     <select>
       <node expr="[@operator-id]" />
     </select>
     <where>
       <condition expr="[@group-id]=$long(../@owner-id)"/>
     </where>
   </subQuery>
</condition>

En fråga måste referera till ett startschema från attributet schema.

Den önskade typen av åtgärd anges i attributet operation och innehåller ett av följande värden:

Syntaxen XPath används för att hitta data baserat på indatabildmet. Mer information om XPaths finns i Datamodeller.

Exempel på åtgärden get example-with-the--get--operation

Hämtar efternamnet och förnamnet för en mottagare ("nms:receimschema") med ett filter i e-postmeddelandet.

<queryDef schema="nms:recipient" operation="get">
  <!-- fields to retrieve -->
  <select>
    <node expr="@firstName"/>
    <node expr="@lastName"/>
  </select>

  <!-- condition on email -->
  <where>
    <condition expr="@email= 'john.doe@aol.com'"/>
  </where>
</queryDef>

Exempel med åtgärden select example-with-the--select--operation

Returnerar listan med mottagare filtrerade i en mapp och e-postdomänen med en sortering i fallande ordning på födelsedatumet.

<queryDef schema="nms:recipient" operation="select">
  <select>
    <node expr="@email"/>
    <!-- builds a string with the concatenation of the last name and first name separated by a dash -->
    <node expr="@lastName+'-'+@firstName"/>
    <!-- get year of birth date -->
    <node expr="Year(@birthDate)"/>
  </select>

  <where>
     <condition expr="[@folder-id] = 1234 and @domain like 'Adobe%'"/>
  </where>

  <!-- order by birth date -->
  <orderBy>
    <node expr="@birthDate" sortDesc="true"/> <!-- by default sortDesc="false" -->
  </orderBy>
</queryDef>

Uttryck kan vara enkla fält eller komplexa uttryck som aritmetiska operationer eller sammanfogning av strängar.

Om du vill begränsa antalet poster som ska returneras lägger du till attributet lineCount i elementet <querydef>.

Så här begränsar du antalet poster som returneras av frågan till 100:

<queryDef schema="nms:recipient" operation="select" lineCount="100">
...

Om du vill hämta de följande 100 posterna kör du samma fråga igen och lägger till attributet startLine.

<queryDef schema="nms:recipient" operation="select" lineCount="100" startLine="100">
...

Exempel med åtgärden 'count' example-with-the--count--operation

Så här räknar du antalet poster i en fråga:

<queryDef schema="nms:recipient" operation="count"">
  <!-- condition on the folder and domain of the email -->
  <where>
    <condition expr="[@folder-id] = 1234" and @domain like 'Adobe%'"/>
  </where>
</queryDef>

Datagruppering data-grouping

Så här hämtar du e-postadresser som refereras mer än en gång:

<queryDef schema="nms:recipient" operation="select">
  <select>
    <node expr="@email"/>
    <node expr="count(@email)"/>
  </select>

  <!-- email grouping clause -->
  <groupby>
    <node expr="@email"/>
  </groupby>

  <!-- grouping condition -->
  <having>
    <condition expr="count(@email) > 1"/>
  </having>

</queryDef>

Frågan kan förenklas genom att attributet groupBy läggs till direkt i fältet som ska grupperas:

<select>
  <node expr="@email" groupBy="true"/>
</select>

Brackering under förhållanden bracketing-in-conditions

Här är två exempel på hakparenteser på samma villkor.

Det går att ersätta operatorn "OR" med operatorn "IN" när flera villkor gäller för samma fält:

<where>
  <condition>
    <condition expr="@age IN (15, 45)"/>
    <condition expr="@city IN ('Newton', 'Culver City')"/>
  </condition>
</where>

Den här syntaxen förenklar frågan när mer än två data används i villkoret.

Exempel på länkar examples-on-links

Binda parametrarna för var- och select-satsen binding-the-parameters-of-the--where--and--select--clause

Parametrarnas bindning gör att motorn kan ange värden för parametrarna som används i frågan. Detta är mycket användbart, eftersom motorn ansvarar för att värden undgås och det finns en ytterligare fördel med ett cache-minne för de parametrar som ska hämtas.

När en fråga skapas ersätts de bundna värdena med ett tecken (? i ODBC, #[index]# i postgres…) i SQL-frågans brödtext.

<select>
  <!--the value will be bound by the engine -->
  <node expr="@startDate = #2002/02/01#"/>
  <!-- the value will not be bound by the engine but visible directly in the query -->
  <node expr="@startDate = #2002/02/01#" noSqlBind="true"/>
</select>

För att undvika bindning av en parameter måste attributet "noSqlBind" fyllas i med värdet "true".

Utdatadokumentformat output-document-format

Returparametern är ett XML-dokument i formatet för det schema som är associerat med frågan.

Exempel på en retur från schemat "nms:mottagare" för en "get"-åtgärd:

<recipient email="john.doe@adobe.com" lastName"Doe" firstName="John"/>

I en select-åtgärd är det returnerade dokumentet en uppräkning av element:

<!-- the name of the first element does not matter -->
<recipient-collection>
  <recipient email="john.doe@adobe.com" lastName"Doe" firstName="John"/>
  <recipient email="peter.martinez@adobe.com" lastName"Martinez" firstName="Peter"/>
  <recipient...
</recipient-collection>

Exempel på ett dokument som returneras för en räkningstyp:

<recipient count="3"/>

Alias alias

Med ett alias kan du ändra platsen för data i utdatadokumentet. Attributet alias måste ange en XPath i motsvarande fält.

<queryDef schema="nms:recipient" operation="get">
  <select>
    <node expr="@firstName" alias="@firstName"/>
    <node expr="@lastName"/>
    <node expr="[folder/@label]" alias="@My_folder"/>
  </select>
</queryDef>

Returnerar:

<recipient My_folder="Recipients" First name ="John" lastName="Doe"/>

I stället för:

<recipient firstName="John" lastName="Doe">
  <folder label="Recipients"/>
</recipient>

Exempel på SOAP meddelanden example-of-soap-messages

Write/WriteCollection (xtk:session) write---writecollection--xtk-session-

Dessa tjänster används för att infoga, uppdatera eller ta bort en entitet ("write" method) eller en samling entiteter ("WriteCollection" method).

De entiteter som ska uppdateras är associerade med ett dataschema. Indataparametrarna är en autentiseringssträng (måste loggas in) och ett XML-dokument som innehåller de data som ska uppdateras.

Detta dokument kompletteras med anvisningar för hur skrivningsproceduren konfigureras.

Anropet returnerar inga data, förutom fel.

Definition av metoderna "Write" och "WriteCollection" i schemat "xtk:session":

<method name="Write" static="true">
  <parameters>
    <param name="doc" type="DOMDocument" desc="Difference document"/>
  </parameters>
</method>
<method name="WriteCollection" static="true">
  <parameters>
    <param name="doc" type="DOMDocument" desc="Difference collection document"/>
  </parameters>
</method>

Översikt overview

Datavstämningen utförs baserat på definitionen av nycklarna som anges i det associerade schemat. Skrivproceduren söker efter den första valbara nyckeln baserat på de data som anges i indatadokumentet. Enheten infogas eller uppdateras baserat på dess existens i databasen.

Nyckeln för schemat för entiteten som ska uppdateras har slutförts baserat på attributet xtkschema.

Avstämningsnyckeln kan därför framtvingas med attributet _key som innehåller listan med XPaths som utgör nyckeln (avgränsade med kommatecken).

Det går att tvinga fram typen av åtgärd genom att fylla i attributet _operation med följande värden:

Exempel med metoden Write example-with-the--write--method

Uppdatera eller infoga en mottagare (implicit"insertOrUpdate"-åtgärd) med e-postadress, födelsedatum och ort:

<recipient xtkschema="nms:recipient" email="john.doe@adobe.com" birthDate="1956/05/04" folder-id=1203 _key="@email, [@folder-id]">
  <location city="Newton"/>
</recipient>

Ta bort en mottagare:

<recipient xtkschema="nms:recipient" _operation="delete" email="rene.dupont@adobe.com" folder-id=1203 _key="@email, [@folder-id]"/>

Exempel med metoden WriteCollection example-with-the--writecollection--method

Uppdatera eller infoga för flera mottagare:

<recipient-collection xtkschema="nms:recipient">
  <recipient email="john.doe@adobe.com" firstName="John" lastName="Doe" _key="@email"/>
  <recipient email="peter.martinez@adobe.com" firstName="Peter" lastName="Martinez" _key="@email"/>
  <recipient ...
</recipient-collection>

Exempel på länkar example-on-links

Exempel 1 example-1

Kopplar mappen till en mottagare baserat på dess interna namn (@name).

<recipient _key="[folder/@name], @email" email="john.doe@adobe.net" lastName="Doe" firstName="John" xtkschema="nms:recipient">
  <folder name="Folder2" _operation="none"/>
</recipient>

Attributen"_key" och"_operation" kan anges för ett länkat element. Beteendet för det här elementet är detsamma som för huvudelementet i indatarammet.

Definitionen av nyckeln för huvudentiteten ("nms:receive") består av ett fält från en länkad tabell (elementet <folder> schema "xtk:folder") och e-postmeddelandet.

Exempel 2 example-2

Uppdaterar företaget (länkad tabell i"cus:company"-schema) från en mottagare:

<recipient _key="[folder/@name], @email" email="john.doe@adobe.net" lastName="Doe" firstName="John" xtkschema="nms:recipient">
  <company name="adobe" code="ERT12T" _key="@name" _operation="update"/>
</recipient>

Exempel 3 example-3

Lägga till en mottagare i en grupp med grupprelationstabellen ("nms:rcpGrpRel"):

<recipient _key="@email" email="martin.ledger@adobe.net" xtkschema="nms:recipient">
  <rcpGrpRel _key="[rcpGroup/@name]">
    <rcpGroup name="GRP1"/>
  </rcpGrpRel>
</recipient>

XML-samlingselement xml-collection-elements

Som standard måste alla samlingselement fyllas i för att XML-samlingens element ska kunna uppdateras. Data från databasen ersätts med data från indatadokumentet. Om dokumentet bara innehåller de element som ska uppdateras måste du fylla i attributet"_operation" för alla samlingselement som ska uppdateras för att tvinga fram en sammanfogning med databasens XML-data.

Exempel på SOAP meddelanden example-of-soap-messages-1