Descrição do evento event-description

Modelo de dados de mensagens transacionais about-transactional-messaging-datamodel

As mensagens transacionais dependem do modelo de dados do Adobe Campaign e usam duas tabelas separadas adicionais. Essas tabelas, NmsRtEvent e NmsBatchEvent contêm os mesmos campos e permitem gerenciar eventos em tempo real, por um lado, e eventos em lote, por outro.

Métodos SOAP soap-methods

Esta seção detalha os métodos SOAP associados aos schemas do módulo de mensagens transacionais.

Dois métodos SOAP PushEvent ou PushEvents estão vinculados aos dois dataschemas nms:rtEvent e nms:BatchEvent. É o sistema de informações que determina se um evento é do tipo "batch" ou "em tempo real".

O caminho WSDL para acessar ambos os métodos é:

Para obter mais informações sobre a geração de um arquivo WSDL, consulte esta seção.

Ambos os métodos contêm um elemento <urn:sessiontoken> para fazer logon no módulo de mensagens transacionais. Recomendamos usar um método de identificação por meio de endereços IP confiáveis. Para recuperar o token de sessão, execute uma chamada SOAP de logon e depois um token GET seguido de um logoff. Use o mesmo token para várias chamadas RT. Os exemplos incluídos nesta seção estão usando o método de token de sessão que é o recomendado.

Caso você esteja usando um servidor loadbalanced, use a autenticação Usuário/Senha (no nível da mensagem RT). Exemplo:

<PushEvent xmlns="urn:nms:rtEvent">
<sessiontoken>mc/PASSWORD</sessiontoken>
<domEvent>
<rtEvent wishedChannel="41" type="rt_MobileJourney_iOS_Push" registrationToken="c3ddc8aaecc24822df25d0f49865cca61ea3f86c61bfa53ae4d37294e37f4a1c" hashlpId="27EE7571EC14DBA23B9B5CC0EF79BB782DAECF4C03C88E5D92CC9B9DAC4E5DDA" correlationId="415b7593-4f6f-e911-811f-00505691247c" xmlns="">
<mobileApp uuid="236B24DC-C073-412F-8BCB-AC7207096258" _operation="none"/>
<ctx>...</ctx>
</rtEvent>
</domEvent>
</PushEvent>

O método PushEvent é composto de um parâmetro <urn:domevent> que contém o evento.

O método PushEvents é composto de um parâmetro <urn:domeventcollection> que contém os eventos.

Exemplo usando PushEvent:

<urn:PushEvent>

 <sessiontoken>___921f9b38-72ac-49ad-b481-ab32973efc50</sessiontoken>

 <urn:domEvent>

   <rtEvent>

   ...

   </rtEvent>

 </urn:domEvent>

</urn:PushEvent>

Exemplo usando PushEvents:

<urn:PushEvents>

 <sessiontoken>___921f9b38-72ac-49ad-b481-ab32973efc50</sessiontoken>

 <urn:domEventCollection>

   <Events>

     <rtEvent>... </rtEvent>

     <rtEvent>... </rtEvent>

     ...

   </Events>

 </urn:domEventCollection>

</urn:PushEvents>

Os elementos <rtevent> e <batchevent> têm um conjunto de atributos, bem como um elemento filho obrigatório: <ctx> para integração de dados de mensagem.

Os atributos obrigatórios dos elementos <rtevent> e <batchevent> são @type and @email. O valor de @type deve ser igual ao valor da lista discriminada definido ao configurar a instância de execução. Esse valor permite definir o template a ser vinculado ao conteúdo do evento durante a entrega.

<rtevent> configuration example:

<rtEvent type="order_confirmation" email="john.doe@domain.com" origin="eCommerce" wishedChannel="0" externalId="1242" mobilePhone="+33620202020">

Neste exemplo, dois canais são fornecidos: o endereço de email e o número do celular. O wishedChannel permite selecionar o canal que deseja usar ao transformar o evento em uma mensagem. O valor "0" corresponde ao canal de email, o valor "1" ao canal móvel e etc.

Se quiser adiar uma entrega de evento, adicione o campo scheduled seguido da data preferida. O evento será transformado em uma mensagem nessa data.

É recomendável preencher os atributos @wishedChannel e @emailFormat com valores numéricos. A tabela de função que vincula valores numéricos e rótulos é encontrada na descrição do schema de dados.

O elemento <ctx> contém os dados da mensagem. Seu conteúdo XML está aberto, o que significa que ele pode ser configurado dependendo do conteúdo a ser entregue.

Exemplo de dados:

   <ctx>
               <client>
                        <firstname>John</firstname>
                        <lastname>Doe</lastname>
               </client>
               <action>
                         <type>Order confirmation</type>
                          <number>CN23453</number>
               </action>
               <orderdetails>
                          <article num="1">
                                   <name>Generic USB key</name>
                                   <price>20</price>
                           </article>
               </orderdetails>
    </ctx>

Informações retornadas pela chamada SOAP information-returned-by-the-soap-call

Ao receber um evento, o Adobe Campaign gera uma ID de retorno exclusiva. Essa é a ID da versão arquivada do evento.

Se o valor do identificador de retorno for estritamente maior que zero, isso significa que o evento foi arquivado com êxito no Adobe Campaign.

No entanto, se houver falha no processo do evento, o método retornará uma mensagem de erro ou um valor igual a zero.