Pular para o conteúdo principal

Como obter acesso à X Ads API

  1. Inscreva-se em uma conta de desenvolvedor.
  2. Crie um(a) App de desenvolvedor e proteja seu token.
  3. Acesse ads.x.com/help para enviar uma solicitação de acesso à X Ads API para cada uma de suas Apps de desenvolvedor.
Observação: Se você já está desenvolvendo na X Developer Platform e tem uma conta de desenvolvedor, vá direto para a etapa três.

Etapa 1: inscreva-se para uma conta de desenvolvedor

Para fazer uma solicitação a qualquer produto de API da X, você deve primeiro se inscrever para uma conta de desenvolvedor. No portal do desenvolvedor, crie um Projeto e um App de desenvolvedor. Isso fornecerá um conjunto de credenciais que você usará para autenticar todas as solicitações à API.

Etapa dois: Salve as chaves e tokens da sua App e mantenha-os seguros

Na sua App de desenvolvedor, você receberá um conjunto de API Keys (também conhecidas como Consumer Keys). Você também poderá gerar um conjunto de Access Tokens que podem ser usados para fazer solicitações em nome da sua conta pessoal na X, e um Bearer Token que pode ser usado para autenticar endpoints que exigem OAuth 2.0 Bearer Token. Como essas chaves e tokens não expiram a menos que sejam regenerados, sugerimos criar variáveis de ambiente ou usar um gerenciador de senhas seguro. Anote também o seu App ID, que pode ser encontrado na URL da página de detalhes da sua App. Isso facilitará a solicitação de acesso à X Ads API na próxima etapa.
Observação: Suas chaves e tokens serão exibidos apenas uma vez no portal do desenvolvedor, portanto, é importante armazenar essas credenciais no seu gerenciador de senhas assim que forem geradas.Se você perder ou esquecer as chaves e tokens, será necessário regenerá-los, o que cria novas chaves e tokens e invalida as antigas. Isso significa que você terá que atualizar quaisquer integrações que tenha configurado com suas credenciais anteriores.Saiba mais sobre nossas práticas recomendadas de autenticação.

Etapa três: solicitar acesso à Ads API

Neste ponto, você terá acesso básico à X API, mas não à funcionalidade específica da X Ads API. Em seguida, será necessário solicitar e obter aprovação para acesso à Ads API. Visite ads.x.com/help para enviar uma solicitação de acesso à Ads API para cada uma de suas Apps de desenvolvedor.

Níveis de acesso

Como parte do processo de inscrição, você precisará especificar qual nível de acesso precisa. Saiba mais sobre permissões no nível de App e no nível de conta de anúncios.

Somente Conversão

Acesso aos endpoints de conversão para mobile e web, com permissões de leitura e gravação.

Acesso padrão

Acesso aos endpoints de Analytics, Campaign Management, Creatives, Custom Audiences e Conversion, com permissões de leitura e escrita.
Observação: Após sua App ser aprovada para acesso à X Ads API, você precisará regenerar quaisquer user access tokens para fazer requisições autenticadas à Ads API corretamente.
Observação: Desenvolvedores da Ads API que solicitaram acesso antes de julho de 2023 podem ter níveis diferentes de acesso e permissões e podem estar limitados a cinco tokens OAuth. Consulte nosso guia sobre aumentar o acesso para obter acesso a endpoints adicionais ou remover limites de tokens para aplicativos existentes.

Faça sua primeira solicitação

Para testar seu acesso à X Ads API, faça uma solicitação ao endpoint GET accounts. Esse endpoint retornará as contas de anúncios às quais o usuário atualmente autorizado tem acesso. Use os ids de contas de anúncios retornados nessa solicitação em chamadas subsequentes à API para ler e escrever data para uma conta de anúncios específica. Usando o Twurl na linha de comando, a solicitação seria semelhante ao seguinte. Exemplo de solicitação
twurl -H ads-api.x.com "/11/accounts"
Exemplo de resposta
{
  "request": {
    "params": {}
  },
  "data": [
   {
    "name": "Furni",
    "business_name": null,
    "timezone": "America/Los_Angeles",
    "timezone_switch_at": "2016-04-06T07:00:00Z",
    "id": "18ce54ayf0z",
    "created_at": "2016-04-07T14:40:15Z",
    "salt": "b88939e5cabbca720159cb3659d73c06",
    "updated_at": "2017-02-08T08:49:53Z",
    "business_id": null,
    "approval_status": "ACCEPTED",
    "deleted": false
     }
   ]
}

Próximos passos …

I