Referência da API de Audiences

Referência da API

Keyword Insights

GET insights/keywords/search

Dado um grupo de keywords, obtém o volume de Tweets associado, bem como um conjunto de 30 keywords relacionadas. O volume de Tweets corresponde apenas às keywords de entrada, não às keywords relacionadas. Um intervalo máximo de tempo (end_time - start_time) de 7 dias é permitido. Observe que os resultados são delimitados por uma única geo (país). URL do recurso https://ads-api.x.com/12/insights/keywords/search

enum

required

Especifica a granularidade dos dados retornados para o intervalo de tempo indicado por start_time e end_time. Por exemplo, quando definido como HOUR, você recebe um datapoint para cada hora entre start_time e end_time.

Valores possíveis: DAY, HOUR

string

required

Uma string separada por vírgulas de keywords para restringir a busca. Todas as keywords são combinadas por OR.

Nota: Um máximo de 10 keywords (keywords e negative_keywords combinadas) pode ser usado.

string

required

Restringe os dados obtidos aos coletados na janela entre start_time e end_time. Expresso em ISO 8601.

string

Restringe os dados obtidos aos coletados na janela entre start_time e end_time. Expresso em ISO 8601.

Nota: Assume o horário atual por padrão.

string

Um valor de segmentação que você obtém do endpoint GET targeting_criteria/locations para restringir os resultados em termos de onde o usuário da conta está localizado. Observe que atualmente apenas localizações a nível de país são suportadas.

string

Uma string separada por vírgulas de keywords a serem excluídas. Todas as negative keywords são combinadas por OR.

Nota: Um máximo de 10 keywords (keywords e negative_keywords combinadas) pode ser usado.

Exemplo de requisição

GET https://ads-api.x.com/12/insights/keywords/search?end_time=2018-02-02&granularity=DAY&keywords=developers&start_time=2018-02-01

Exemplo de resposta

Exemplo de resposta

    {
      "request": {
        "params": {
          "start_time": "2018-02-01T00:00:00Z",
          "end_time": "2018-02-02T00:00:00Z",
          "granularity": "DAY",
          "keywords": [
            "developers"
          ]
        }
      },
      "data": {
        "related_keywords": [
          "dev",
          "developer",
          "coders",
          "mysql",
          "devs",
          "#technology",
          "#developers",
          "security",
          "programmers",
          "#tech",
          "javascript",
          "#iot",
          "#bigdata",
          "cloud",
          "devops",
          "php",
          "developer",
          "programmer",
          "engineer",
          "big data",
          "agile",
          "app",
          "programming",
          "ios",
          "maker",
          "startups",
          "developer's",
          "java",
          "#devops",
          "startup"
        ],
        "tweet_volume": [
          15707
        ]
      }
    }

Para o conteúdo completo desta referência técnica extensa (Tailored Audience Permissions, Targeted Audiences, Custom Audiences Users, Custom Audience Permissions, Custom Audiences, Do Not Reach Lists), consulte a documentação em inglês em /x-ads-api/audiences/reference. Todos os parâmetros de endpoint, exemplos de requisição/resposta e detalhes técnicos permanecem os mesmos entre as versões em inglês e português.

Getting Started

Products

Fundamentals

Partners & Customers

Resources

Referência da API de Audiences