API de Conversões

API do Plano de Controle do Conversions API Gateway para várias contas: referência

As APIs do Plano de Controle referem-se às contas pelo antigo nome de "locatário". Nas seções abaixo, os dois termos são usados como sinônimo.

Depois que for integrado, esse conjunto de APIs permitirá que os anunciantes realizem ações como estas:

  • Gerenciar fontes de dados (por exemplo, criar, visualizar e excluir conexões do Pixel)
  • Ativar/desativar o Pixel para o recebimento e a publicação de eventos
  • Ler o número de eventos (por exemplo, por período e tipo de evento)
  • Gerenciar outras configurações da conta (por exemplo, definir os respectivos subdomínios do Gateway e bloquear/desbloquear domínios para o recebimento e a publicação de eventos)

Na seção Referência da API, capig_domain refere-se a AdminDomainName, que é especificado durante a configuração da pilha.

Obter o token de acesso da API

Forneça o nome da conta e a chave secreta da API obtidas na etapa 2 dos pré-requisitos para obter um token de acesso de curta duração que permite fazer chamadas da API do Plano de Controle. O token expirará depois de 10 horas e precisará ser obtido novamente em uma chamada de API.

Exemplo de solicitação

    
curl -X POST \
-F 'client_id={client_id}' \
-F 'client_secret={client_secret}' \
-F 'grant_type=client_credentials' \
'https://<capig_domain>/clients/token'

Exemplo de resposta

    
{
    "token": <token>
}

Parâmetros disponíveis


CampoDescrição

client_id
String

Obrigatório.

Nome da conta da API obtido na etapa 2 dos pré-requisitos

client_secret
String

Obrigatório.
A chave secreta da API obtida na etapa 2 dos pré-requisitos

Veja também