Guia passo a passo

Como obter acesso à Ads API

1. Cadastre-se para uma conta de desenvolvedor.
2. Crie um developer App](/fundamentals/developer-apps) e proteja seu token.
3. Acesse ads.x.com/help para enviar uma solicitação de acesso à Ads API para cada um dos seus developer App(s).

Observação: Se você já está desenvolvendo na X Developer Platform e tem uma conta de desenvolvedor, pule para o passo três.

Passo um: Cadastre-se para uma conta de desenvolvedor

Para fazer uma solicitação a qualquer um dos produtos de API da X, você precisa primeiro se cadastrar para uma conta de desenvolvedor. Dentro do Developer Console, crie um App e um developer App. Isso fornecerá um conjunto de credenciais que você usará para autenticar todas as solicitações à API.

Passo dois: Salve as chaves e tokens do seu App e mantenha-os seguros

Dentro do seu developer App, será fornecido um conjunto de API Keys (também conhecidas como Consumer Keys). Você também terá a chance de gerar um conjunto de Access Tokens que podem ser usados para fazer solicitações em nome da sua conta pessoal da 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 dos detalhes do seu App. Isso facilitará a solicitação de acesso à Ads API no próximo passo.

Observação: Suas chaves e tokens serão exibidos apenas uma vez no Developer Console, portanto é importante armazenar essas credenciais em seu sistema de gerenciamento de senhas assim que forem geradas.

Se você perder ou esquecer as chaves e tokens, precisará regerá-los, o que cria novas chaves e tokens e invalida os antigos. Isso significa que você terá que atualizar quaisquer integrações que tenha configurado com suas credenciais anteriores.

Saiba mais sobre nossas melhores práticas de autenticação.

Passo três: Solicite acesso à Ads API

Neste ponto, você terá acesso básico à X API, mas não às funcionalidades específicas da X Ads API. Em seguida, você precisará solicitar e ser aprovado para o acesso à Ads API. Acesse ads.x.com/help para enviar uma solicitação de acesso à Ads API para cada um dos seus developer App(s).

Níveis de acesso

Como parte do processo de inscrição, você precisará especificar qual nível de acesso necessita. Saiba mais sobre permissões de nível de App e de Ad Account.

Conversion Only

Acesso aos endpoints de Mobile e Web Conversion com acesso de leitura e escrita.

Standard Access

Acesso aos endpoints de Analytics, Campaign Management, Creatives, Custom Audiences e Conversion com acesso de leitura e escrita.

Observação: Após seu app ser aprovado para o acesso à Ads API, você precisará regerar quaisquer user access tokens para fazer solicitações autenticadas à Ads API corretamente.

Observação: Desenvolvedores da Ads API que solicitaram acesso antes de julho de 2023 podem ter diferentes níveis de acesso e permissões, e podem estar limitados a cinco tokens OAuth. Consulte nosso guia sobre aumentar o acesso para acessar endpoints adicionais ou remover os limites de tokens para aplicações existentes.

Faça sua primeira solicitação

Para testar seu acesso à Ads API, faça uma solicitação ao endpoint GET accounts. Esse endpoint retornará as contas de anúncio às quais o usuário autorizado atualmente tem acesso. Use os IDs de conta de anúncio dessa solicitação em solicitações subsequentes à API para ler e escrever dados de uma conta de anúncio específica. Usando o Twurl na linha de comando, a solicitação seria a seguinte.

Solicitação de exemplo

twurl -H ads-api.x.com "/11/accounts"

Resposta de exemplo

{
  "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
     }
   ]
}

A seguir …

• Leia a documentação da Ads API sobre fundamentos como versionamento e hierarquia.
• Confira as várias ferramentas e bibliotecas da Ads API para auxiliar na sua integração com a Ads API.
• Entenda as etapas para aumentar o acesso à Ads API.
• Familiarize-se com os recursos de suporte disponíveis.
• Siga @API para atualizações ao vivo sobre mudanças na API, problemas de serviço e melhorias nos produtos promovidos da X.