MetaAds

Com o conector do MetaAds, você pode se conectar aos dados do Meta / Facebook Ads e realizar operações de criação, leitura, atualização e exclusão nesses dados.

Antes de começar

Antes de usar o conector do MetaAds, faça o seguinte:

• No seu projeto do Google Cloud, faça o seguinte:
  • 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.

      Veja abaixo as regiões compatíveis com o conector:

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

   Observação: você só poderá personalizar os valores do nó de conexão se for um cliente de pagamento por utilização.
   7. ID da conta: o ID da sua conta de anúncios. Se nenhum for especificado, usaremos o ID da primeira conta de anúncios retornado dos Anúncios do Facebook.
   8. Formato agregado: o formato que as colunas de agregação ou de coleção precisam retornar.
   9. Autenticar como página: o nome ou o ID de uma página para autenticar ao fazer solicitações ao Facebook.
   10. Nível de nova tentativa: o nível mais granular do objeto de anúncio em que o driver vai tentar recuperar resultados na nova tentativa.
   11. Destino: um destino padrão, se nenhum for especificado. Usado para algumas tabelas, como "Comments", em que um destino pode ser especificado.
   12. Outra opção é clicar em + Adicionar rótulo para adicionar um rótulo à conexão na forma de um par de chave-valor.
   13. 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 MetaAds é compatível com os seguintes tipos de autenticação:

      • Concessão de código de autenticação do OAuth 2.0

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

   2. Clique em Next.
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.

• Autorização de código OAuth 2.0
  • Token de acesso: o token de acesso usado para autenticar solicitações com conexões baseadas em fluxo de código de autenticação.
  • ID do cliente: o ID do cliente fornecido pelo conector para o 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.

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.

Observação:você pode ver as entidades, as operações e as ações de um conector na tarefa de conectores.

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

Observação: todas as entidades e ações terão um esquema associado a elas. Por exemplo, um esquema de ação terá os detalhes do parâmetro, como: os nomes do parâmetro e tipos de dados correspondentes. O esquema (metadados) de entidades e ações é buscado pela conexão no ambiente de execução do back-end. Se houver atualizações no esquema, elas não serão refletidas automaticamente nas conexões atuais. atualize manualmente o esquema. Atualizar o esquema de uma conexão, abra a página Detalhes da conexão e clique em Atualizar o esquema de conexão.

Limitações do sistema

O conector do MetaAds pode processar seis transações por segundo, por nó, e throttles as transações além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

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

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

• Se você é um cliente de pagamento por uso, configure os valores mínimo e máximo do nó na página "Editar conexão".
• Se você tem uma assinatura entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para uma melhor taxa de transferência, recomendamos verificar se os sistemas de back-end estão configurados de maneira ideal para processar o tráfego necessário.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para saber como configurar ações, consulte os Exemplos de ação.

Observação: os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta connectorOutputPayload da tarefa Connectors após a execução da integração.

Ação CreateAdPreview

Cria um arquivo de esquema para um insight de app.

Parâmetros de entrada da ação CreateAdPreview

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
AdFormat	String	Verdadeiro	O formato do anúncio a ser usado. Os valores permitidos são AUDIENCE_NETWORK_INSTREAM_VIDEO, AUDIENCE_NETWORK_INSTREAM_VIDEO_MOBILE, AUDIENCE_NETWORK_OUTSTREAM_VIDEO, AUDIENCE_NETWORK_REWARDED_VIDEO, DESKTOP_FEED_STANDARD, FACEBOOK_STORY_MOBILE, INSTAGRAM_STANDARD, INSTAGRAM_STORY, INSTANT_ARTICLE_STANDARD, INSTREAM_VIDEO_DESKTOP, INSTREAM_VIDEO_MOBILE, MARKETPLACE_MOBILE, MESSENGER_MOBILE_INBOX_MEDIA, MOBILE_BANNER, MOBILE_FEED_BASIC, MOBILE_FEED_STANDARD, MOBILE_FULL_WIDTH, MOBILE_INTERSTITIAL, MOBILE_MEDIUM_RECTANGLE, MOBILE_NATIVE, RIGHT_COLUMN_STANDARD, SUGGESTED_VIDEO_DESKTOP, SUGGESTED_VIDEO_MOBILE, WATCH_FEED_MOBILE.
AdCreativeId	String	Verdadeiro	O ID do criativo do anúncio que será usado para gerar a visualização.

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

Exemplos de ação

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

Exemplo: criar uma prévia do anúncio

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateAdPreview e clique em Concluído.
3. Na seção Mapeamento de dados, Open Data Mapping Editor e insira um valor semelhante ao seguinte no campo Input:

   {
   "AdCreativeId": "120208552947120478",
   "AdFormat": "AUDIENCE_NETWORK_INSTREAM_VIDEO"
   }

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

[{
  "Url": "https://business.facebook.com/ads/api/preview_iframe.php?d=AQL_quk8kLm_6z2oZ14q9A0led9llzr981NPv-zUHhwZ5IXjO07s7ngrI2y0qI0VZCRH2w9hgCwy5xrbFQlWCy0g-uRpRHvFS0dS0erj2Lg4HI7ZfIRm8h3nZLhJygM",
  "@affectedrows": null
}, {
  "Url": null,
  "@affectedrows": null
}]

Exemplos de operações de entidade

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

Exemplo: listar todas as contas de anúncios

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione AdAccounts na lista Entity.
3. Selecione a operação List e clique em Concluído.

Exemplo: listar todas as campanhas

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Campaigns na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Entrada de tarefa da tarefa Conectores, você também pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (").

Exemplo: acessar um conjunto de anúncios

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione Adsets na lista 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 e insira 120206747969710053 no campo Valor padrão.

   Aqui, 120206747969710053 é um ID de registro exclusivo na entidade User.

Observação: se a entidade tiver uma chave primária composta, será possível especificar uma cláusula de filtro.

Usar a conexão do MetaAds em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa 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

• Entenda como suspender e retomar uma conexão.
• Entenda como monitorar o uso do conector.
• Saiba como acessar os registros do conector.