Salesforce Marketing Cloud

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

• Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

  No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

• Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:
  • Lista
  • Receber
  • Criar
  • Atualizar
  • Excluir

  Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

• Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector do Salesforce Marketing Cloud pode processar no máximo 7 transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Esta seção lista todas as ações aceitas pela conexão do Salesforce Marketing Cloud.

Ação GetJourneyPublicationStatus

Essa ação recebe o status de uma publicação de jornada.

Parâmetros de entrada da ação GetJourneyPublicationStatus

Parâmetros de saída da ação GetJourneyPublicationStatus

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados.

Para saber como configurar a ação GetJourneyPublicationStatus, consulte Exemplos.

Ação FireEntryEvent

Acione o evento de entrada que inicia a jornada.

Parâmetros de entrada da ação FireEntryEvent

Parâmetros de saída da ação FireEntryEvent

Esta ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados

Para saber como configurar a ação FireEntryEvent, consulte Exemplos.

Ação "StopJourney"

Interrompe uma jornada em andamento

Parâmetros de entrada da ação StopJourney

Parâmetros de saída da ação StopJourney

Esta ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados

Por exemplo, sobre como configurar a ação StopJourney, consulte Exemplos.

Ação PublishJourney

Ação PublishJourney: publica uma versão da jornada de forma assíncrona.

Parâmetros de entrada da ação PublishJourney

Parâmetros de saída da ação PublishJourney

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados.

Para saber como configurar a ação PublishJourney, consulte Exemplos.

Ação "CreateTriggeredSend"

Ação CreateTriggeredSend Cria um objeto de envio acionado que representa uma instância específica de um envio de e-mail acionado.

Parâmetros de entrada da ação CreateTriggeredSend

Parâmetros de saída da ação CreateTriggeredSend

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados.

Por exemplo, sobre como configurar a ação CreateTriggeredSend, consulte Exemplos.

Ação SendTransactionalMessageToRecipient

Ação SendTransactionalMessageToRecipient Envia uma mensagem a um único destinatário por uma definição de envio

Parâmetros de entrada da ação SendTransactionalMessageToRecipient

Parâmetros de saída da ação SendTransactionalMessageToRecipient

Essa ação retorna o status 200 (OK) com um corpo de resposta indicando todos os resultados.

Para saber como configurar a ação SendTransactionalMessageToRecipient, consulte Exemplos.

Exemplos

Esta seção descreve como executar algumas das operações de entidade e neste conector.

Exemplo: saber o status de uma publicação de jornada

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação GetJourneyPublicationStatus e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "StatusId": "3acf1f54-5c9e-4719-b7f7-bfc2e5caf10a"
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

 [{
  "Status": "PublishCompleted",
  "Message": null
}] 

Exemplo: disparar um evento de entrada para iniciar uma jornada

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação FireEntryEvent e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "ContactKey": "Email",
     "EventDefinitionKey": "APIEvent-4d84e619-a629-6b17-945f-9a6e78a1982c",
     "Data": "{\"Email\": \"usr1@test.com\"}"
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

 [{
  "EventInstanceId": "0d6f6dd1-1aaa-4eec-9727-f99550ab68f9"
}]

Exemplo: interromper uma jornada em execução

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação StopJourney e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "JourneyId": "37D2789E-2B1D-433E-8E18-8F47E4D8E865",
     "JourneyVersion": 1.0
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terão um valor semelhante ao seguinte:

  [{
  "Success": true
}] 

Exemplo: publicar uma versão da jornada

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação PublishJourney e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "JourneyId": "0868BF36-3107-460E-9EF1-09633A0592E8",
     "JourneyVersion": 1.0
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terão um valor semelhante ao seguinte:

 [{
  "StatusId": "acb1734d-483e-400a-97d7-0501b94f03b2"
}]  

Exemplo: criar um gatilho para iniciar uma jornada

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateTriggeredSend e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
     "Key": "BU27_SendDefinition1",
     "ToAddress": "usr1@test.com",
     "SubscriberKey": "107",
     "SubscriberAttributes": "{\"FirstName\": \"John\", \"LastName\": \"P\"}"
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector vai ter um valor semelhante a este:

 [{
  "Success": "True",
  "RecipientSendId": "5d06edb1-d07c-48ad-a1f2-d6350eb863f8",
  "Messages": "Queued"
}]  

Exemplo: enviar uma mensagem para um único destinatário

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação SendTransactionalMessageToRecipient e clique em Concluído.
3. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "MessageKey": "T9999009",
     "DefinitionKey": "Send-Definition-SFMC-Demo-2",
     "RecipientContactKey": "107",
     "RecipientTo": "usr1@test.com",
     "Attributes": "FirstName :John"
   }

Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terão um valor semelhante ao seguinte:

[{
  "RequestId": "d8fb9e9e-3ae2-412f-b01e-d198433cfc16"
}] 

Exemplo: listar registros em uma entidade

Este exemplo lista os registros na entidade Assets.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Assets na lista Entity.
3. Selecione a operação LIST e clique em Concluído.
4. Na seção Entrada de tarefas da tarefa Conectores, é possível definir a filterClause de acordo com seu requisito.

   Por exemplo, definir a cláusula de filtro como Location='US' and region='us-east1' lista apenas os registros na localização dos EUA com a região us-east1.

Exemplo: receber um registro de uma entidade

Este exemplo busca um único registro da entidade Assets.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Assets na lista Entity.
3. Selecione a operação GET e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 49851 no campo Valor padrão.

   Aqui, 49851 é a chave primária da entidade Assets.

Exemplo: excluir um registro de uma entidade

Este exemplo exclui um registro da entidade Assets.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Assets na lista Entity.
3. Selecione a operação DELETE e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e digite 49851 no campo Valor padrão.

Exemplo: criar um registro em uma entidade

Este exemplo cria um registro na entidade DataExtensionObject_Custom.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione DataExtensionObject_Custom na lista Entity.
3. Selecione a operação Create e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
       "StudentName":"John",
       "StudentID":"1",
       "Rank":"1"}

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terão um valor semelhante ao seguinte:

    {
         "StudentID": 1
       } 

Exemplo: atualizar um registro em uma entidade

Este exemplo atualiza um registro na entidade Journeys.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Journeys na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Campo Default Value:

   {
     "Name": "SFMC_CRETAE_JOURNEY_V1"
   }

5. Defina o ID da entidade como a entidade das Jornadas . Para definir o ID da entidade, Clique em entityId e digite 0868BF36-3107-460E-9EF1-09633A0592E8 no campo Valor padrão. .

   Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector vai ter um valor semelhante a este:

   {
     "Id": "0868bf36-3107-460e-9ef1-09633a0592e8"
   }

Usar a conexão do Salesforce Marketing Cloud em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. É possível usar a conexão em uma integração pela tarefa de conectores.

• Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
• Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".