Salesforce Marketing Cloud

O conector do Salesforce Marketing Cloud permite executar operações de inserção, exclusão, atualização e leitura em um conjunto de dados do Salesforce Marketing Cloud.

Antes de começar

Antes de usar o conector do Salesforce Marketing Cloud, faça as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acesse a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Salesforce Marketing Cloud na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. Tipo de integração da API: o tipo de concessão para o fluxo do OAuth. As entradas aceitas são "De servidor para servidor" e "App da Web".
    8. ID da conta: o identificador da conta, ou MID, da unidade de negócios segmentada.
    9. Display Child Data Extensions: exibe as extensões de dados de contas filhas, se definidas.
    10. Instância: a instância da API Salesforce Marketing Cloud usada.
    11. Listar extensões de dados: um booleano que determina se as extensões de dados devem ser listadas como tabelas ou não.
    12. Consultar todas as contas: consulta todas as contas, incluindo a mãe e todas as filhas, em relação a um evento.
    13. Esquema: especifique a versão do servidor do Salesforce Marketing Cloud para se conectar.
    14. Subdomínio: o subdomínio da API Salesforce Marketing Cloud.
    15. Usar autenticação legada: um booleano que determina se a conexão deve ser feita com a API REST do Salesforce Marketing Cloud usando a autenticação legada ou não.
    16. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    17. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    18. Clique em PRÓXIMA.
  5. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação são compatíveis com a conexão do Salesforce Marketing Cloud:

      • Nome de usuário e senha

      2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    2. Clique em PRÓXIMA.
  6. Revisão: revise os detalhes de conexão e autenticação.
  7. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: nome de usuário para o conector
    • Senha: a senha do Secret Manager que contém a senha associada ao conector.

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:

    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 da entidade, essas operações 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. 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 sete transações por segundo, por nó, e limita todas as transações 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

Nesta seção, listamos todas as ações compatíveis com a conexão do Salesforce Marketing Cloud.

Ação GetJourneyPublicationStatus

Esta ação recebe o status de uma publicação da jornada.

Parâmetros de entrada da ação GetJourneyPublicationStatus

Nome do parâmetro Tipo de dados Obrigatório Descrição
StatusId string Verdadeiro O ID do status de uma publicação da jornada.

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

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 GetJourneyPublicationStatus, consulte Exemplos.

Ação FireEntryEvent

Dispare o evento de entrada que inicia a jornada.

Parâmetros de entrada da ação FireEntryEvent

Nome do parâmetro Tipo de dados Obrigatório Descrição
ContactKey String Verdadeiro O ID que identifica exclusivamente um assinante ou contato
EventDefinitionKey String Verdadeiro Encontre a EventDefinitionKey em "Administração de eventos" depois que o evento for criado e salvo. Isso é válido para eventos padrão e personalizados. Não inclua um ponto na chave de definição do evento.
Dados String Falso Propriedades do evento. Obrigatório apenas se definido em um evento personalizado ou pelo evento.

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

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

Ação "StopJourney"

Interrompe uma jornada em execução

Parâmetros de entrada da ação StopJourney

Nome do parâmetro Tipo de dados Obrigatório Descrição
JourneyId String Verdadeiro O ID da jornada a ser interrompida, expresso na forma de um GUID (UUID)
JourneyVersion Inteiro Verdadeiro O número da versão da jornada que vai parar

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 ação PublishJourney publica uma versão da jornada de maneira assíncrona.

Parâmetros de entrada da ação PublishJourney

Nome do parâmetro Tipo de dados Obrigatório Descrição
JourneyId String Verdadeiro ID da jornada a ser interrompida, expresso na forma de um GUID (UUID).
JourneyVersion Inteiro Verdadeiro O número da versão da jornada que será interrompida.

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

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 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

Nome do parâmetro Tipo de dados Obrigatório Descrição
Chave String Falso Define a definição associada de envio acionado para o envio acionado. Essa propriedade corresponde à chave externa atribuída a um objeto no Marketing Cloud.
SendId String Falso ID da definição de envio do evento de entrada que vem da resposta durante a criação de um TriggeredSendDefinition. Essa chave ou a chave externa é obrigatória.
FromAddress String Falso Endereço de e-mail que vai aparecer como o remetente.
FromName String Falso Nome do remetente
ToAddress String Verdadeiro Endereço de e-mail do destinatário da mensagem.
SubscriberKey String Verdadeiro Identificador exclusivo definido para o destinatário da mensagem.
SubscriberAttributes String Falso Pares de nome e valor para atributos do assinante definidos para a mensagem.
RequestType String Falso Os valores válidos ASYNC e SYNC. O valor padrão, quando não definido, é ASYNC. Determina se a solicitação é processada de modo assíncrono.

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

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 CreateTriggeredSend, consulte Exemplos.

Ação SendTransactionalMessageToRecipient

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

Parâmetros de entrada da ação SendTransactionalMessageToRecipient

Nome do parâmetro Tipo de dados Obrigatório Descrição
MessageKey String Verdadeiro Identificador de mensagem definido pelo usuário.
DefinitionKey String Verdadeiro Identificador exclusivo da definição.
RecipientContactKey String Verdadeiro Identificador exclusivo de um assinante no Marketing Cloud. Cada solicitação precisa incluir uma contactKey. Você pode usar uma chave de assinante existente ou criar uma no momento do envio usando o endereço de e-mail do destinatário
RecipientTo String Falso Endereço do canal do destinatário. No caso de e-mail, é o endereço de e-mail do destinatário
Atributos String Falso Informações usadas para personalizar a mensagem para o destinatário. São gravados como pares de chaves. Os atributos correspondem aos atributos de perfil, de conteúdo ou de extensão de dados de envio acionada

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

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 SendTransactionalMessageToRecipient, consulte Exemplos.

Examples

Nesta seção, descrevemos como executar algumas operações e ações da entidade no conector.

Exemplo: conferir o status de uma publicação da 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "StatusId": "3acf1f54-5c9e-4719-b7f7-bfc2e5caf10a"
}

    4. 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 Task Input 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\"}"
}

    4. 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: parar 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "JourneyId": "37D2789E-2B1D-433E-8E18-8F47E4D8E865",
  "JourneyVersion": 1.0
}

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

      [{
  "Success": true
}]

Exemplo: publicar uma versão da viagem

  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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "JourneyId": "0868BF36-3107-460E-9EF1-09633A0592E8",
  "JourneyVersion": 1.0
}

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

     [{
  "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 Task Input 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\"}"
}

    4. Se a ação for bem-sucedida, o campo connectorOutputPayload da tarefa do conector 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 Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
  "MessageKey": "T9999009",
  "DefinitionKey": "Send-Definition-SFMC-Demo-2",
  "RecipientContactKey": "107",
  "RecipientTo": "usr1@test.com",
  "Attributes": "FirstName :John"
}

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

    [{
  "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 de Entity.
  3. Selecione a operação LIST e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, para definir o filterom conforme necessário.

    Por exemplo, definir a cláusula de filtro como Location='US' and region='us-east1' lista apenas os registros no local dos EUA em que 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 de Entity.
  3. Selecione a operação GET e clique em Concluído.
  4. Na seção Task Input 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 de Entity.
  3. Selecione a operação DELETE e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira 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 Task Input 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á um valor semelhante a este:

     {
      "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 de Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no 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 insira 0868BF36-3107-460E-9EF1-09633A0592E8 no campo Valor padrão.

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

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

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
apiintegration_type ENUM Falso O tipo de concessão para o fluxo do OAuth. As entradas aceitas são "De servidor para servidor" e "App da Web". Os valores aceitos são: servidor para servidor, aplicativo da Web
schema ENUM Verdadeiro Especifique as APIs do Salesforce Marketing Cloud para se conectar. Os valores aceitos são: REST, SOAP
account_id STRING Falso O identificador da conta, ou MID, da unidade de negócios desejada.
display_child_data_extensions BOOLEAN Falso Exibe as extensões de dados de contas filhas, se definidas.
instância STRING Falso A instância da API Salesforce Marketing Cloud usada. Observação: se a instância for maior que s10, será necessário especificar Subdomínio.
list_data_extensions BOOLEAN Falso Um booleano que determina se as extensões de dados devem ser listadas como tabelas ou não.
query_all_accounts BOOLEAN Falso Consulta todas as contas, incluindo a principal e todas as filhas, em relação a um evento.
nível de detalhes STRING Falso O nível de detalhamento da conexão varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes da comunicação (solicitações,respostas e certificados SSL).
subdomínio STRING Falso O subdomínio da API Salesforce Marketing Cloud.
proxy_enabled BOOLEAN Falso Marque essa caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticação no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado na conexão com o proxy do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

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

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

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

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir