Linguagem de consulta do Google Ads

A linguagem de consulta do Google Ads pode consultar a API do Google Ads para

Recursos e seus atributos, segmentos e métricas relacionados usando o
GoogleAdsService Pesquisa ou SearchStream
O resultado de uma consulta do GoogleAdsService é uma lista de instâncias de GoogleAdsRow, em que cada GoogleAdsRow representa um recurso. Se algum atributo ou métrica for solicitado, a linha também incluirá esses campos. Se algum segmento for solicitado, a resposta também mostrará uma linha adicional para cada tupla de recurso de segmento.
Metadados sobre campos e recursos disponíveis em
GoogleAdsFieldService

Esse serviço oferece um catálogo de campos consultáveis com detalhes sobre a compatibilidade e o tipo.

O resultado de uma consulta GoogleAdsFieldService é uma lista de instâncias de GoogleAdsField, em que cada GoogleAdsField contém detalhes sobre o campo solicitado.

Consultar atributos de um recurso

Veja abaixo uma consulta básica dos atributos do recurso de campanha, ilustrando como retornar o ID, o nome e o status da campanha:

SELECT
  campaign.id,
  campaign.name,
  campaign.status
FROM campaign
ORDER BY campaign.id

Essa consulta ordena pelo ID da campanha. Cada GoogleAdsRow resultante representaria um objeto campaign preenchido com os campos selecionados (incluindo o resource_name da campanha específica).

Para descobrir quais outros campos estão disponíveis para consultas de campanha, consulte a documentação de referência de Campaign.

Consultar métricas

Além dos atributos selecionados para um determinado recurso, também é possível consultar métricas relacionadas:

SELECT
  campaign.id,
  campaign.name,
  campaign.status,
  metrics.impressions
FROM campaign
WHERE campaign.status = 'PAUSED'
  AND metrics.impressions > 1000
ORDER BY campaign.id

Essa consulta filtra apenas as campanhas com status PAUSED e que tiveram mais de 1.000 impressões, ao mesmo tempo que fazem a ordenação por ID da campanha. Cada GoogleAdsRow resultante teria um campo metrics preenchido com as métricas selecionadas.

Para conferir uma lista de métricas consultáveis, consulte a documentação do Metrics.

Consultar segmentos

Além dos atributos selecionados para um determinado recurso, também é possível consultar segmentos relacionados:

SELECT
  campaign.id,
  campaign.name,
  campaign.status,
  metrics.impressions,
  segments.date,
FROM campaign
WHERE campaign.status = 'PAUSED'
  AND metrics.impressions > 1000
  AND segments.date during LAST_30_DAYS
ORDER BY campaign.id

Semelhante à consulta de métricas, essa consulta filtra apenas as campanhas com status PAUSED e que tiveram mais de 1.000 impressões. No entanto, essa consulta segmenta os dados por data. Isso faz com que cada GoogleAdsRow resultante represente uma tupla de uma campanha e a data Segment. É importante observar que a segmentação divide as métricas selecionadas, agrupando por cada segmento na cláusula SELECT.

Para conferir uma lista de segmentos que podem ser consultados, consulte a documentação Segments.

Na consulta de um determinado recurso, é possível mesclar outros recursos relacionados, se disponíveis. Esses recursos relacionados são conhecidos como "recursos atribuídos". É possível mesclar recursos atribuídos implicitamente selecionando um atributo na consulta.

SELECT
  campaign.id,
  campaign.name,
  campaign.status,
  bidding_strategy.name
FROM campaign
ORDER BY campaign.id

Essa consulta não apenas seleciona atributos de campanha, mas também extrai atributos relacionados de cada campanha selecionada. Cada GoogleAdsRow resultante representa um objeto campaign preenchido com os atributos de campanha selecionados, bem como o atributo de estratégia de lances bidding_strategy.name selecionado.

Para descobrir quais recursos atribuídos estão disponíveis para consultas de campanhas, consulte a documentação de referência do Campaign.

Mutação com base nos resultados da consulta

Ao consultar um determinado recurso, você pode imediatamente pegar esses resultados retornados como objetos, modificá-los e enviá-los de volta ao método mutate nesse serviço do recurso. Confira abaixo um exemplo de fluxo de trabalho:

  1. Execute uma consulta para todas as campanhas que atualmente estão PAUSED e têm impressões superiores a 1.000.
  2. Consiga o objeto Campaign do campo campaign de cada GoogleAdsRow na resposta.
  3. Altere o status de cada campanha de PAUSED para ENABLED.
  4. Chame CampaignService.MutateCampaigns com as campanhas modificadas para atualizá-las.

Metadados de campo

As consultas enviadas a GoogleAdsFieldService servem para recuperar metadados do campo. Essas informações podem ser usadas para entender como os campos podem ser usados juntos em uma consulta. Como os dados são disponibilizados na API e fornecem os metadados necessários para validar ou criar uma consulta, isso permite que os desenvolvedores façam isso de maneira programática. Esta é uma consulta típica para metadados:

SELECT
  name,
  category,
  selectable,
  filterable,
  sortable,
  selectable_with,
  data_type,
  is_repeated
WHERE name = "<INSERT_RESOURCE_OR_FIELD>"

É possível substituir <INSERT_RESOURCE_OR_FIELD> nessa consulta por um recurso (como customer ou campaign) ou campo (como campaign.id, metrics.impressions ou ad_group.id).

Para ver uma lista de campos consultáveis, consulte a documentação do GoogleAdsField.

Exemplos de código

As bibliotecas de cliente têm exemplos de como usar a linguagem de consulta do Google Ads em GoogleAdsService. A pasta de operações básicas tem exemplos como GetCampaigns, GetKeywords e SearchForGoogleAdsFields. A pasta reporting tem um exemplo de GetKeywordStats.

Próxima
Gramática das consultas