Salesforce Marketing Cloud

Com o conector do Salesforce Marketing Cloud, você realiza 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 o seguinte:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Verifique se a conectividade de rede está configurada. Para informações sobre padrões de rede, consulte Conectividade de rede.
    • Conceda a função IAM roles/connectors.admin ao usuário que está 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.

    Acessar 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 conferir 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 ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Como opção, ative o Cloud Logging e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. 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.

    8. Tipo de integração da API: o tipo de concessão do fluxo OAuth. As entradas aceitas são "Servidor para servidor" e "App da Web".
    9. ID da conta: o identificador da conta ou MID da unidade de negócios de destino.
    10. Mostrar extensões de dados de crianças: mostra as extensões de dados das contas infantis, se definidas.
    11. Instância: a instância da API Salesforce Marketing Cloud usada.
    12. ListDataExtensions: um booleano que determina se as extensões de dados precisam ser listadas como tabelas ou não.
    13. Consultar todas as contas: consulta todas as contas, incluindo a principal e todas as secundárias, em relação a um evento.
    14. Esquema: especifique a versão do servidor do Salesforce Marketing Cloud para se conectar.
    15. Subdomínio: o subdomínio da API Salesforce Marketing Cloud.
    16. Use a autenticação legada: um valor booleano que determina se a conexão precisa ser feita à API REST do Salesforce Marketing Cloud usando a autenticação legada ou não.
    17. 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:

    18. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    19. 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.

      A conexão do Salesforce Marketing Cloud oferece suporte aos seguintes tipos de autenticação:

      • Nome de usuário e senha
      • OAuth 2.0: Credenciais do cliente
      • OAuth 2.0: código de autorização
      • 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.
  • OAuth 2.0: credenciais do cliente
    • ID do cliente: o ID do cliente do app que você criou.
    • Chave secreta do cliente: o secret do Secret Manager que contém a chave secreta do cliente para o app conectado que você criou.
    • Versão do secret: a versão do secret do cliente.
  • Código de autorização OAuth 2.0
    • ID do cliente: o ID do cliente usado para solicitar tokens de acesso.
    • Escopos: uma lista separada por vírgulas dos escopos desejados.
    • Chave secreta do cliente: a chave secreta do cliente usada para solicitar tokens de acesso.
    • Versão do secret: a versão do secret do cliente.
    • URL de autorização: o URL de autorização gerado ao criar o cliente.

Configurar o Salesforce Marketing Cloud

Para configurar o Salesforce Marketing Cloud, faça login na sua conta ou crie uma nova usando o Login do Salesforce Marketing Cloud. Para saber mais sobre o suporte da comunidade, consulte Comunidade de Trailblazers. Para saber mais sobre as APIs REST do Salesforce Marketing Cloud, consulte API REST do Salesforce Marketing Cloud. Para informações sobre a API SOAP do Salesforce Marketing Cloud, consulte APIs SOAP.

Criar um cliente de API

  1. Na página do perfil do Salesforce Marketing Cloud, clique em Configuração.
  2. No painel à esquerda, selecione Pacotes instalados e clique em Novo.
  3. Insira um nome e uma descrição para a integração.
  4. Escolha Servidor para servidor como o tipo de integração.
  5. Clique em Salvar.
  6. Você pode conferir o ID do cliente, a chave secreta do cliente, o URL base SOAP, o URL base REST e outros detalhes.

Autenticação básica: tipo de conexão

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de autenticação básica.

Nome do campo Detalhes
Local us-east1
Conector Salesforce Marketing Cloud
Versão do conector 1
Nome da conexão sfmcconn1
Descrição SOAP: senha do usuário
Ativar Cloud Logging Sim
Conta de serviço service-account@my-project.iam.gserviceaccount.com
Tipo de integração de API De servidor para servidor
Esquema SOAP
ID da conta ACCOUNT_ID
Mostrar extensões de dados filhos Sim
Instância s11
Listar extensões de dados Sim
Nível de verbosidade 5
Subdomínio SUBDOMÍNIO
Nome de usuário NOME DE USUÁRIO
Senha SENHA
Versão do secret 1

OAuth 2.0: tipo de conexão

A tabela a seguir lista os valores de configuração de exemplo para o tipo de conexão de credenciais do cliente OAuth 2.0.

Nome do campo Detalhes
Local us-east1
Conector Salesforce Marketing Cloud
Versão do conector 1
Nome da conexão sfmc-rest-conn
Ativar Cloud Logging Não
Conta de serviço service-account@my-project.iam.gserviceaccount.com
Tipo de integração de API De servidor para servidor
Esquema REST
ID da conta ACCOUNT_ID
Mostrar extensões de dados filhos Sim
Instância s11
Listar extensões de dados Sim
Consultar todas as contas Sim
Nível de verbosidade 4
Subdomínio SUBDOMÍNIO
ID do cliente CLIENT_ID
Chave secreta do cliente CLIENT_SECRET
Versão do secret 1

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 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 e um de saída. 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 , 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 compatíveis com a 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

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

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

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 chave EventDefinitionKey em "Administração de eventos" depois que o evento for criado e salvo. Isso vale para eventos padrão e personalizados. Não inclua um ponto na chave de definição do evento.
Dados String Falso Propriedades do evento. Só é necessário se definido em um evento personalizado ou pelo evento.

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

Essa 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

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

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

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

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

Nome do parâmetro Tipo de dados Obrigatório Descrição
JourneyId String Verdadeiro O ID da viagem até a parada, expresso na forma de um GUID (UUID).
JourneyVersion Número inteiro Verdadeiro O número da versão do trajeto a ser interrompido.

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

Nome do parâmetro Tipo de dados Obrigatório Descrição
Chave String Falso Define a definição de envio acionado associado 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 de evento de entrada que vem da resposta ao criar uma TriggeredSendDefinition. É necessário usar essa chave ou a externa.
FromAddress String Falso Endereço de e-mail que vai aparecer como 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 os atributos do assinante definidos para a mensagem.
RequestType String Falso Valores válidos: ASYNC e SYNC. O valor padrão quando não definido é ASYNC. Determina se a solicitação é processada de forma assíncrona.

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.

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

Ação SendTransactionalMessageToRecipient

Ação "SendTransactionalMessageToRecipient": envia uma mensagem para um único destinatário usando 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. Para 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. Escritos como pares de chaves. Os atributos correspondem a atributos de perfil, de conteúdo ou de extensão de dados de envio acionado

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 de ação

Esta seção descreve como realizar algumas das ações neste conector.

Exemplo: conferir o status da publicação de uma 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"
    }
    
  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: acionar 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\"}"
    }
    
  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: interromper uma jornada em andamento

  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 da tarefa 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 vai ter um valor semelhante a este:

      [{
      "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 da tarefa 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 acionador 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\"}"
    }
    
  4. 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 da tarefa 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 vai ter um valor semelhante a este:

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

Exemplos de operação de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Operações de entidade com suporte

Esta seção lista as operações de entidade compatíveis com o conector do Salesforce Marketing Cloud e mostra como realizar algumas das operações de entidade nesse conector.

Entidade Operação
DataExtensionObject_Custom Listar, acessar, excluir, criar, atualizar
Campaign Listar, buscar, excluir
CampaignAssets Listar, buscar, excluir
Journeys Listar, acessar, excluir, criar, atualizar
Lista Listar, criar, atualizar
Publicação Lista
Assinante Lista, Criar
SubscriberList Lista
ListSubscriber Lista
JourneyActivities Consultar, excluir
Campanhas Criar
Recursos Listar, acessar, excluir, criar, atualizar

Exemplo: listar todos os recursos

  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 tarefa da tarefa Conectores, é possível definir a filterClause de acordo com o requisito do cliente.

  5. Use aspas simples (") para incluir o valor de uma cláusula de filtro, que precisa ser transmitido diretamente, como CategoryName='Content Builder'. Aqui, "Nome da categoria" é o nome da coluna e "Criador de conteúdo" é o valor.

    É possível usar a cláusula de filtro para filtrar registros com base nas colunas. Por exemplo, para filtrar registros, use a cláusula de filtro a seguir: Location='US' e region='us-east1'

    Em alguns casos, a transmissão de um ID de entidade pode gerar um erro. Nesses casos, use a cláusula de filtro, como id=172.

Exemplo: receber um registro de recursos

  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. Defina o ID da entidade como 49851.0, que é a chave a ser transmitida. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 49851.0 no campo Valor padrão.

    O valor do ID da entidade precisa ser transmitido diretamente, como Id= 49851.0. Aqui, 49851.0 é o valor exclusivo da chave primária, que precisa ser transmitido.

Exemplo: excluir um registro de recursos

  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. Defina o ID da entidade como 49851.0, que é a chave a ser transmitida. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em EntityId e insira 49851.0 no campo Valor padrão.

    O valor do ID da entidade precisa ser transmitido diretamente, como ID= 49851.0. Aqui, 49851.0 é o valor exclusivo da chave primária, que precisa ser transmitido.

Exemplo: criar um registro 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":"Cruz",
    "StudentID":"1",
    "Rank":"1"}
    

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "StudentID": 1
    } 

Exemplo: criar um registro de recursos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Assets 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:
    {
      "Name": "Googlecloud_Created_HTMLEmail_Testing_V1",
      "TypeName": "htmlemail",
      "TypeId": 208.0
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Id": 60188.0
    }

Exemplo: criar um registro de campanhas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Campaigns 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:
    {
      "Name": "Campaigns - Tested via Googlecloud",
      "CampaignCode": "annual2023",
      "Color": "0000ff",
      "Favorite": false
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Id": 247.0
    } 

Exemplo: criar um registro de jornadas

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Journeys 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:
    {
      "Version": 1.0,
      "Name": "API_Journey_Googlecloud_Retest_1",
      "CreatedDate": "2023-04-26 04:20:29.87",
      "ModifiedDate": "2023-05-10 07:45:06.04",
      "LastPublishedDate": "2023-04-26 04:37:18.0",
      "Description": "API_Journey_Googlecloud_Retest_1",
      "WorkFlowApiVersion": 1.0,
      "Tags": null,
      "Goals": "",
      "Triggers": "[{\"id\": \"c79154a3-a0d2-435e-a6ad-bed46474620a\", \"key\": \"TRIGGER\", \"name\": \"API_Journey_Googlecloud\", \"description\": \"\", \"type\": \"APIEvent\", \"outcomes\": [], \"arguments\": {\"startActivityKey\": \"{Context.StartActivityKey}\", \"dequeueReason\": \"{Context.DequeueReason}\", \"lastExecutedActivityKey\": \"{Context.LastExecutedActivityKey}\", \"filterResult\": \"true\"}, \"configurationArguments\": {\"schemaVersionId\": 0, \"criteria\": \"\", \"filterDefinitionId\": \"00000000-0000-0000-0000-000000000000\"}, \"metaData\": {\"sourceInteractionId\": \"00000000-0000-0000-0000-000000000000\", \"eventDefinitionId\": \"8153cf00-ebf6-4c18-b52f-573eb724df87\", \"eventDefinitionKey\": \"APIEvent-4d84e619-a629-6b17-945f-9a6e78a1982c\", \"chainType\": \"None\", \"configurationRequired\": false, \"iconUrl\": \"/images/icon_journeyBuilder-event-api-blue.svg\", \"title\": \"\", \"entrySourceGroupConfigUrl\": \"jb:///data/entry/api-event/entrysourcegroupconfig.json\"}}",
      "Defaults": "[{\"email\": [\"{Event.APIEvent-4d84e619-a629-6b17-945f-9a6e78a1982c.\"Email"}\"], \"properties\": {\"analyticsTracking\": {\"enabled\": false, \"analyticsType\": \"google\", \"urlDomainsToTrack\": []}}}]"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Id": "aa03afe4-6a28-481f-bec4-564712127414"
    }

Exemplo: criar um registro de lista

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione List 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:
    {
      "ID": "04052023.0",
      "ObjectID": "82349658-b482-404f-8c67-e555aadee0f4",
      "PartnerKey": "null",
      "CreatedDate": "2023-03-16 10:52:48.097",
      "ModifiedDate": "2023-03-17 10:30:34.497",
      "Client_ID": "5.14012689E8",
      "Client_PartnerClientKey": null,
      "ListName": "Googlecloud_Created_Subscriber_List",
      "Description": "null",
      "Category": "15449.0",
      "Type": "Public",
      "CustomerKey": "Googlecloud_BCONE",
      "ListClassification": "ExactTargetList",
      "AutomatedEmail_ID": "null"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Id": 4052023.0
    }

Exemplo: criar um registro de assinante

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Subscriber 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:
    {
      "EmailAddress": "baklavainthebalkans@gmail.com",
      "SubscriberKey": "KB1"
    }

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Success": true
    }

Exemplo: atualizar um registro 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 Update 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":"Charlie",
    "Rank":"1"
    }
    
  5. Defina o ID da entidade como, por exemplo, 103032, que é a chave primária a ser transmitida. Para definir o ID da entidade, na seção Entrada da tarefa da tarefa Connectors, clique em entityId e insira 10 no campo Valor padrão.

    Se a entidade tiver chaves primárias ou de negócios compostas, em vez de especificar o entityId, você também pode definir a filterClause como Rank='1' and StudentID='10'.

  6. Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
        "StudentID": 1
    }
    

Exemplo: atualizar um registro de recursos

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione "Recursos" na lista Entity.
  3. Selecione a operação Update 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:
    {
      "Description": "June2023-Updated"
    }
    
  5. Defina o ID da entidade como a entidade dos recursos . Para definir o ID da entidade, clique em entityId e insira 52080 no campo Valor padrão.

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "Id": 52080.0
    }
    

Exemplo: atualizar um registro do 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 da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
      "Name": "SFMC_CRETAE_JOURNEY_FROM_Googlecloud_Updated_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 parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

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

Exemplo: atualizar um registro de lista

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione List na lista Entity.
  3. Selecione a operação Update 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:
    {
      "Description": "UpdatedDescription"
    }
    
  5. Defina o ID da entidade como a entidade da lista . Para definir o ID da entidade, clique em entityId e insira 1234 no campo Valor padrão.

    Se a integração for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    {
      "ID": 1234.0
    }
    

Usar o Terraform para criar conexões

Use o recurso do Terraform para criar uma nova conexão.

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

Para conferir um exemplo de modelo do Terraform para criação de conexão, consulte exemplo de modelo.

Ao criar essa conexão usando o Terraform, defina 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 do fluxo OAuth. As entradas aceitas são "Server-to-Server" e "Web-App". Os valores aceitos são: "Server-to-Server", "Web-App"
schema ENUM Verdadeiro Especifique as APIs do Salesforce Marketing Cloud com que você quer se conectar. Os valores aceitos são: REST, SOAP
account_id STRING Falso O identificador da conta, ou MID, da unidade de negócios de destino.
display_child_data_extensions BOOLEAN Falso Mostra as extensões de dados das contas infantis, 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, o subdomínio precisará ser especificado.
list_data_extensions BOOLEAN Falso Um booleano que determina se as extensões de dados precisam 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 de comunicação (solicitação,resposta e certificados SSL).
subdomínio STRING Falso O subdomínio da API Salesforce Marketing Cloud.
proxy_enabled BOOLEAN Falso Marque esta 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 no proxy ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticar no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticar no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado ao se conectar ao proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL

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

Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.

  • Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
  • Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, 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