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

Grupos de anúncios

GET
/v1/google/ads/ad-group

Retorna dados de grupos de anúncios do Google Ads com métricas de desempenho detalhadas.

Este endpoint fornece insights em nível de grupo de anúncios, incluindo status, informações da campanha associada e indicadores de desempenho.

Dimensões disponíveis:

  • Nome do recurso/ID da campanha
  • Nome do recurso/ID do grupo de anúncios, nome, status
  • Métricas: cliques, impressões, custo, conversões, CTR, CPC, custo por conversão, valor das conversões, parcela de impressões, taxas de conversão
  • Segmentos de data

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/ad-group?organizationId=organization_123&createdStart=2024-01-01&createdEnd=2024-12-31"
{  "data": [    {      "campaign_resource_name": "string",      "campaign_id": "string",      "ad_group_resource_name": "string",      "ad_group_status": "string",      "ad_group_id": "string",      "ad_group_name": "string",      "metrics_clicks": 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,      "metrics_cost": 0,      "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  }}

Campanhas GET

Página anterior

Anúncios dos grupos de anúncios GET

Próxima página