Microsoft Ads

Palavras-chave

GET
/v1/microsoft-ads/keywords

Uma linha por palavra-chave: tipo de correspondência, status, status editorial, lance e URL final.

Este recurso não tem coluna de data: dateFrom e dateTo são recusados. As linhas são ordenadas por keyword_id, integration_id, inserted_at e paginadas com page/limit; meta.hasNextPage diz se existe outra página. As respostas ficam em cache por 30 minutos.

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Organização dona das contas conectadas.

Formatouuid
integrationId?string

Uma conta conectada desta integração (o integration_id das linhas). Omita para ler todas as contas da organização.

Tamanholength <= 255
page?integer

Número da página, a partir de 1.

Intervalo1 <= value <= 1000000
Padrão1
limit?integer

Linhas por página (máximo 5000).

Intervalo1 <= value <= 5000
Padrão500

Corpo da resposta

Uma página de linhas

application/json
  1. response
data*array<>
meta*
curl -X GET "https://example.com/v1/microsoft-ads/keywords?organizationId=3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b"
{  "data": [    {      "organization_id": "3f2b8c1e-5d4a-4e6f-9a7b-1c2d3e4f5a6b",      "integration_id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",      "user_id": "123456",      "document_id": "123456",      "integration_name": "example",      "ad_group_id": "123456",      "campaign_name": "example",      "ad_group_name": "example",      "keyword_id": "123456",      "keyword": "example",      "match_type": "example",      "status": "example",      "editorial_status": "example",      "bid": "125.50",      "final_url": "example",      "modified_time": "example",      "inserted_at": "2026-10-01T12:00:00.000Z"    }  ],  "meta": {    "page": 1,    "limit": 500,    "hasNextPage": false,    "hasPreviousPage": false  }}