Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.x.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Como obter acesso à Ads API

  1. Cadastre-se em uma conta de desenvolvedor.
  2. Crie um App de desenvolvedor e proteja seu token.
  3. Acesse ads.x.com/help para enviar uma solicitação de acesso à Ads API para cada um dos seus apps de desenvolvedor.
Observação: Se você já desenvolve na X Developer Platform e possui uma conta de desenvolvedor, avance para o passo três.

​
Passo um: Cadastre-se em uma conta de desenvolvedor

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

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

Dentro do seu App de desenvolvedor, será fornecido um conjunto de API Keys (também conhecidas como Consumer Keys). Você também terá a oportunidade 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 só serão exibidos uma vez no Developer Console, por isso é importante armazenar essas credenciais no seu sistema de gerenciamento 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 os antigos. Isso significa que você precisará atualizar quaisquer integrações que tenha configurado com as 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 à funcionalidade específica da X Ads API. Em seguida, você precisará solicitar acesso 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 apps de desenvolvedor.

​
Níveis de acesso

Como parte do processo de solicitação, você precisará especificar qual nível de acesso é necessário. Saiba mais sobre as permissões em nível de App e em nível de conta de anúncios.

​
Conversion Only

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

​
Standard Access

Acesso de leitura e escrita aos endpoints de Analytics, Campaign Management, Creatives, Custom Audiences e Conversion.
Observação: Após o seu app ser aprovado para acesso à Ads API, você precisará regenerar quaisquer tokens de acesso de usuário para fazer solicitações autenticadas corretamente à Ads API.
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 aumento de acesso para acessar endpoints adicionais ou remover os limites de tokens para aplicativos 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úncios às quais o usuário autorizado atualmente tem acesso. Use os IDs de conta de anúncios desta solicitação em solicitações subsequentes à API para ler e gravar dados de uma conta de anúncios específica. Usando o Twurl na linha de comando, a solicitação ficaria assim. 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
     }
   ]
}

​
A seguir …