V4MOS.AI API
GuiasReferência da APIapp.v4mos.ai
Google Ads

Campanhas

GET
/v1/google/ads/campaigns

Retorna dados de campanhas do Google Ads com métricas de desempenho abrangentes.

Este endpoint fornece insights em nível de campanha, incluindo status, tipo de canal de publicidade, informações de orçamento e principais indicadores de desempenho.

Dimensões disponíveis:

  • Nome do recurso da campanha, ID, nome, status
  • Tipo/subtipo do canal de publicidade
  • Datas de início/fim, índice de otimização
  • Detalhes do orçamento
  • Métricas: cliques, impressões, custo, conversões, CTR, CPC, ROAS, parcela de impressões, taxas de conversão

Limitações:

  • Máximo de 5000 registros por página
  • Suporta filtro por data via createdStart e createdEnd (formato YYYY-MM-DD)
  • Suporta ordenação via orderBy e orderDirection (ASC/DESC)

Filtros:

  • organizationId (obrigatório)
  • userId (opcional)
  • integrationName (opcional)
  • createdStart (opcional)
  • createdEnd (opcional)

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

userId?string

Identificador do usuário (opcional)

integrationName?string

Identificador do nome da integração (opcional)

createdStart?string

Data inicial para filtragem (opcional, formato YYYY-MM-DD)

Formatodate
createdEnd?string

Data final para filtragem (opcional, formato YYYY-MM-DD)

Formatodate
page?integer

Número da página para paginação (opcional)

Padrão1
limit?integer

Número de itens por página (opcional, máx. 5000)

Intervalovalue <= 5000
Padrão500
orderBy?string

Campo de ordenação (opcional)

orderDirection?string

Direção da ordenação (opcional)

Valor em"ASC""DESC"

Corpo da resposta

Resposta de sucesso

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/google/ads/campaigns?organizationId=organization_123&createdStart=2024-01-01&createdEnd=2024-12-31"
{  "data": [    {      "campaign_resource_name": "string",      "campaign_status": "string",      "campaign_advertising_channel_type": "string",      "campaign_name": "string",      "campaign_id": "string",      "campaign_start_date": "2019-08-24",      "campaign_end_date": "2019-08-24",      "campaign_optimization_score": 0,      "metrics_clicks": 0,      "metrics_search_budget_lost_impression_share": 0,      "metrics_search_impression_share": 0,      "metrics_search_rank_lost_impression_share": 0,      "metrics_conversions_from_interactions_rate": 0,      "metrics_conversions_value": 0,      "metrics_conversions": 0,      "metrics_cost_micros": 0,      "metrics_cost_per_conversion": 0,      "metrics_ctr": 0,      "metrics_average_cpc": 0,      "metrics_impressions": 0,      "campaign_budget_amount_micros": 0,      "campaign_budget_resource_name": "string",      "metrics_cost": 0,      "metrics_roas": 0,      "campaign_budget_amount": 0,      "campaign_advertising_channel_sub_type": "string",      "campaign_budget_delivery_method": "string",      "segments_date": "2019-08-24",      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Contas GET

Página anterior

Grupos de anúncios GET

Próxima página